Skip to main content
Version: 2.2.0

checkAccessPermission

This method allows verifying whether the user has permission to the document. To use it, it is necessary to follow the standard documented below:

Java class
Requestweb/wwwroot/ws/java/document/CheckAccessPermissionRequestType.java
Returnweb/wwwroot/ws/java/document/CheckAccessPermissionResponseType.java

Request:

ID #RequiredDescription
IDDOCUMENTXDocument ID #.
IDUSERXUser ID.
PERMISSIONSTYPEXPermission type:
1 - Edit;
2 - Delete;
3 - Revise;
4 - Acknowledgment;
5 - Distribute copy;
6 - View;
7 - Cancel;
8 - Archive;
9 - Print;
10 - Training;
11 - Create training;
12 - Save locally;
13 - Sign;
14 - Notification;
15 - Add comments;
16 - Evaluate applicability.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:checkAccessPermission>
<!--You may enter the following 3 items in any order-->
<urn:iddocument>?</urn:iddocument>
<urn:iduser>?</urn:iduser>
<urn:permissiontype>?</urn:permissiontype>
</urn:checkAccessPermission>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
returnSUCCESS: 1: Access allowed
FAILURE: 0: Message with the error found.