Get Diagram Share Details

From Creately Developer

Jump to: navigation, search

Contents

Description

This method allows you to get the share details of a existing document.


Request

Request Details

URL https://creately.com/api/document
HTTP Method POST
Supported Authentication CT or SA
API Permissions This API call will not require any permissions
User Permissions The user will need to have access permission to the given document. The user will need to either own or be a collaborator of the document.

Request Parameters

Parameter Description Required Default Value
action Must contain the value "getsharedusers". Will indicate that this is a Get Diagram Share Details action. Mandatory N/A
docid The unique identifier of the document for which the details are needed. Mandatory N/A
returnxml A boolean value indicating "true" or "false". Specifies if response should be a XML. Response will be sent in a XML if the value is true. Response will be sent in a serial string if the value is false. Optional true

NOTE: Parameters required by the authentication method must be provided. See what parameters are required in Authentication

Response

Response Details

Type XML
Content All share details of the document will be returned on successful response.

Response Parameters

Tag Parent Tag Description
success creately-api-response Indicates if the request was successfully processed. May have true or false
registered-users creately-api-response The list of Creately user who have share access to the requested document.
uid registered-users The user id of a collaborator of the requested document.
not-registered-user creately-api-response The list of user who are not registered Creately users, who have share access to the requested document.
usr not-registered-user The email address of a collaborator of the requested document.
errorcode creately-api-response Will be available if the success parameter was false. Will contain a valid API Error code. Valid error codes are listed in API Error Codes
message creately-api-response Will be available if the success parameter was false. Will contain a string message for the error

Errors

Refer to Errors related to Document API calls in the Error Codes
Possible errors for Get share diagram details method are: 1401, 1403, 1407, 1409

Examples

Example 1

Request

https://creately.com/api/document?apikey=2njk4234j23hkj23h4j2k3423jk4h&sig=jkn435654jk2j1kjh3mjk9&usr=johndoe@achme.com&action=getsharedusers&docid=f5dm432g

Response

        <creately-api-response>
            <success>true</success>
            <registered-users>
                 <uid>32h4b2-0a10-435h5-94e3-23hj4bhj54345</uid>
                 <uid>6kj3mn-5jk33-43jk35-wer3-34jh543hjb534</uid>
                 <uid>php2n3-3nkk3-eojnw-nj34-23jn423423sfe8</uid>
            </registered-users>
            <not-registered-user>
                 <usr>katherinemat@achme.com</usr>
                 <usr>nickmarter@achme.com</usr>
            </not-registered-user>
       </creately-api-response>

Personal tools