Skip to main content
Version: 2.2.0

shareDocument

This method allows adding/editing/recreating a document sharing link.

To use it, it is necessary to follow the standard documented below.

Java class
Requestweb/wwwroot/ws/java/document/ShareDocumentRequestType.java
Returnweb/wwwroot/ws/java/document/ShareDocumentResponseType.java

Request:

IDRequiredDescription
DocumentIDXDocument ID #
CategoryIDDocument category ID #
RecreateXRecreate sharing link:
1 - Yes;
2 - No.
PublicXPublic sharing link:
1 - Yes;
2 - No.
DownloadX¹Save locally:
1 - Yes;
2 - No.
OriginalUse original file:
1 - Yes;
2 - No.
ValidityDatePublic link validity date. Date format must be Y-M-D (Year-Month-Day).
info
  • X¹ - Required in case "Public" is set to 1.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:shareDocument>
<!--You may enter the following 7 items in any order-->
<urn:DocumentID>?</urn:DocumentID>
<urn:CategoryID>?</urn:CategoryID>
<urn:Recreate>?</urn:Recreate>
<urn:Public>?</urn:Public>
<urn:Download>?</urn:Download>
<urn:Original>?</urn:Original>
<urn:ValidityDate>?</urn:ValidityDate>
</urn:shareDocument>
</soapenv:Body>
</soapenv:Envelope>

Return:

IDDescription
StatusSUCCESS: SUCCESS
FAILURE: FAILURE
CodeDisplayed code:
â–ª 1 - No error (operation performed successfully);
â–ª -1 - Missing required data;
â–ª -2 - Invalid value;
â–ª -3 - Category not found;
â–ª -4 - Document not found;
â–ª -5 - There is more than one document with this ID #;
â–ª -6 - The document category does not allow public links;
â–ª -7 - The system does not allow downloading the original file;
â–ª -8 - Invalid date;
â–ª -9 - The date cannot be earlier than the current date;
â–ª -10 - Error when generating the sharing link.
DetailMessage detailing the error or success in the execution of the method.
RecordIDSUCCESS: Document sharing link
FAILURE: Empty