Share Diagram

From Creately Developer

Jump to: navigation, search

Contents

Description

This method adds collaborators for a document that is specified by the Document ID.

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. User should either be the owner or a collaborator of the document.

Request Parameters

Parameter Description Required Default Value
action Must contain the value "sharedoc". Will indicate that this is a Document Share action. Mandatory N/A
docid The unique identifier of the document that needs to be shared. Mandatory N/A
sharetouid A comma(,) separated list of Creately User ID's of who the document needs to be shared with. Optional if "sharetoemail" is given Empty
sharetoemail A comma(,) separated list of email addresses of who the document needs to be shared with. If the given email address has a Creately account, the document will be shared. If the email does not have a account, the share action will be scheduled for the user for when the user sign's up Optional if "sharetouid" is given Empty
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 The response containing a success message. No additional data will be sent

Response Parameters

Tag Description
success Indicates if the request was successfully processed. May have true or false.
errorcode 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 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 Share Document method are:1018, 1401, 1410, 1411, 1412

Examples

Example 1

Request

https://creately.com/api/document?apikey=2njk4234j23hkj23h4j2k3423jk4h&sig=jkn435654jk2j1kjh3mjk9&usr=johndoe@achme.com&action=sharedoc&docid=ihf4kj2&sharetoemail=katerussel@achme.com,damionpaul@achme.com

Response

	<creately-api-response>
 		<success>true</success>
 	</creately-api-response>
Personal tools