Get details
of a document shared by you.
Request URL :
XML : http://export.writer.zoho.com/api/private/xml/share/[documentID]?apikey=[API Key]&ticket=[Ticket]
JSON : http://export.writer.zoho.com/api/private/json/share/[documentID]?apikey=[API Key]&ticket=[Ticket]
Response fields
The
schema document for the API response is located at: http://export.writer.zoho.com/schema/restapi/share.xsd
Field
|
Description
|
documentId
|
Unique ID associated with the document that is
shared to others.
|
documentName
|
Name of one of the documents that is being
shared by you.
|
sharedto
|
List of Email IDs/Zoho IDs to whom the
document has been shared by you.
|
writepermission
|
Displays the access privileges granted to the
shared user. If the value is "True" then the shared users have Write permission
else they can access the document in Read-only
mode.
|
Sample Response
The
following is the sample response for the above method:
<?xml version="1.0"
encoding="UTF-8" ?>
<response uri="/api/private/xml/share/8892000000064025">
<result>
<sharedetail>
<documentId>8892000000064025</documentId>
<documentName>Search</documentName>
<EmailShared>
<sharedto>[jaganath, mark]</sharedTo>
<writepermission>True</writePermission>
</EmailShared>
</sharedetail>
</result>
</response>
Equivalent JSON
response
{
"response":
{
"uri": "/api/private/json/share/8892000000064025",
"result":
{
"sharedetail":
{
"documentId":"8000000006005",
"documentName":"Search",
"EmailShared":
{
"sharedto":"[jaganath, mark]",
"writepermission":"true",
}
}
}
}
}
Errors
Displaying share details of a document method may
return general errors. Likely HTTP error code is 1404.
