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
Request	web/wwwroot/ws/java/document/ShareDocumentRequestType.java
Return	web/wwwroot/ws/java/document/ShareDocumentResponseType.java

Request:

ID	Required	Description
DocumentID	X	Document ID #
CategoryID		Document category ID #
Recreate	X	Recreate sharing link: 1 - Yes; 2 - No.
Public	X	Public sharing link: 1 - Yes; 2 - No.
Download	X¹	Save locally: 1 - Yes; 2 - No.
Original		Use original file: 1 - Yes; 2 - No.
ValidityDate		Public 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:

ID	Description
Status	SUCCESS: SUCCESS FAILURE: FAILURE
Code	Displayed 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.
Detail	Message detailing the error or success in the execution of the method.
RecordID	SUCCESS: Document sharing link FAILURE: Empty