To cancel
private sharing of a document for a particular user.
Request URL : POST
Method
XML : http://export.writer.zoho.com/api/private/xml/cancelsharing/[documentID]?apikey=[API Key]&ticket=[Ticket]
JSON : http://export.writer.zoho.com/api/private/json/cancelsharing/[documentID]?apikey=[API Key]&ticket=[Ticket]
Request parameters
:
To cancel private sharing of a
document for a particular user we need to submit a form data to Writer with the
following fields:
Field
|
Description
|
documentId
|
Unique ID of the shared
document.
|
emailid
|
[string] - Email ID/Zoho ID of the user whose
sharing access is to be revoked.
|
Sample Form (POST Method)
<form method="POST"
action="http://export.writer.zoho.com/api/private/xml/cancelsharing/[documentId]?apikey=[APIKEY]&ticket=[Ticket]">
<input type="hidden" name="emailid" value="[Email ID/Zoho
ID]">
<input type="submit" value="CancelShare" class="divbutton"
name="submit">
</form>
* It is mandatory to pass the apikey and ticket
parameters to access the cancelsharing api.
Response fields
The
schema document for the API response is located at: http://export.writer.zoho.com/schema/restapi/save.xsd
Field
|
Description
|
documentId
|
Unique ID associated with the shared
document.
|
documentName
|
Name of document. |
Sample Response
The
following is the sample XML response for the above
method:
<?xml
version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/cancelsharing/8892000000065001">
<result>
<documentId>8892000000065001</documentId>
<documentName>CreatorFormInWriter</documentName>
</result>
</response>
Equivalent JSON
response
{
"response":
{
"uri": "/api/private/json/cancelsharing/8892000000065001",
"result":
{
"documentId":"8892000000065001",
"documentName":"CreatorFormInWriter"
}
}
}
Errors
Canceling sharing access of a
document from a user method may return general errors. Other HTTP error code may be
1404.
