Skip to main content
Version: 2.2.0

newAccessPermission

This method allows adding access permissions to a determined document. To use it, it is necessary to follow the standard documented below:

Java class
Requestweb/wwwroot/ws/java/document/NewAccessPermissionRequestType.java
Returnweb/wwwroot/ws/java/document/NewAccessPermissionResponseType.java

Request:

ID #RequiredDescription
IDDOCUMENTXDocument ID #.
IDUSERXUser ID or department/position ID #.
USERTYPEXUser type:
â–ª 1 - User;
â–ª 2 - Department;
â–ª 3 - Position;
â–ª 4 - Department/Position;
â–ª 5 - Team.
â–ª6 - All.
PERMISSIONXPermission types:
â–ª 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.
E.g.: 1,2,3
PERMISSIONTYPEXAction type:
â–ª 1 - Allow;
â–ª 2 - Deny.
FGADDLOWERLEVELEnter the value 1 for the permission to consider the sublevels of the department.
IDCATEGORYDocument category ID #.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:newAccessPermission>
<!--You may enter the following 7 items in any order-->
<urn:iddocument>?</urn:iddocument>
<urn:iduser>?</urn:iduser>
<urn:usertype>?</urn:usertype>
<urn:permission>?</urn:permission>
<urn:permissionstype>?</urn:permissionstype>
<urn:fgaddlowerlevel>?</urn:fgaddlowerlevel>
<urn:idcategory>?</urn:idcategory>
</urn:newAccessPermission>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
returnSUCCESS: 1: Operation successfully performed.
FAILURE: Returns a message regarding the error that occurred.