NGOSetACL

This call is used to set rRights for a User or a gGroup on any oObject like dDocument, fFolder, aAnnotation or cCabinet. This call will consider the lList sent as the final lList and will overwrite the previous existing rRights on that oObject. It takes objectindex, objecttype (Cabinet, Document, Folder, Annotation, DataDefinition) and set of Acl lList. An Acl contains information about User or gGroup the includeing iIndex of the User (or gGroup), tType (User or Group) and 6 digit6-digit rRights string. This call can be used efficiently when the User wants to set rights Rights for multiple Users and groups Groups on an object Object.

Input Parameter description	View sample InputXml
Output Parameter description	View sample OutputXml
Errors and Warnings

Input Parameters description

Name	Parent Tag	Description	Valid Values	Default Values
Option	Root	Unique option for the call.	NGOSetAcl	N/A
CabinetName	Root	Name of the Cabinet to which the User wants to connect.		N/A
UserDBId	Root	UserDatabase ID , whichthat is returned in the NGOConnectCabinet call.		N/A
ObjectType	Root	Information about the tType of the othe Object on which we are giving rightsthe Rights are assigned.	‘C’- Cabinet, ‘D’-Document, ‘F’-Folder, ‘A’-Annotation ‘T’- DataDefinition	N/A
ObjectIndex	Root	Index of the object Object on which rights Rights are being set.	Integer >= 0	N/A
RetainPrevious ACL	Root	User wants to retain the previous ACL.	‘X’-Retaining previous Acl, i.e. append this Acl to the previous one ‘Y’ – do not retain previous Acl i.e. replace the previous ACL	‘N’
LogGeneration	Root	Whether log has to be generated or not.	‘Y’ – Yes ‘N’ - No
UserGroupACLs	Root	It contains a set of UserGroupAcl tags		N/A
UserGroupACL	UserGroup ACLs	It contains information about the User or gGroup to whom rRights are to be assigned.		N/A
UserGroupIndex	UserGroup ACL	Index of the User or groupGroup.	Integer >= 0	N/A
UserGroupType	UserGroup ACL	User or Group.	U-User G-Group	N/A
Rights	UserGroup ACL	6 -digit rights Rights string like 010000.		N/A

Output Parameters description

Name	Parent Tag	Description
Option	Root	Unique Option for the Call.
Status	Root	Status of the call. If it is 0, then the call is successful.

Errors returned from call

Code	Message	Comments
-50017	Folder not found.	Folder iIndex for which the usewr wants to set rRights does not exist.
-50074	Invalid parameters	Some of the parameter passed in the iInput is not valid. For example, g ObjectType or UserGroupType ioshas some value other then than “U or “G”.
-50073	Cannot assign rights to Admin	When the User wants to assign rRights to a User of an aAdmin gGroup.
-50013	Group not found.	Group does not exist.
-50066	Group has expired	The Group is expired to whom to which the rRights are to be assigned has expired.
-50001	Cabinet not found.	Cabinet does not exists.
-50017	Folder not found.	Object on which the User wants to set rRights are not found.
-50119	System defined properties cannot be changed.	System- defined pProperties cannot be changed.
-50023	Document not found	Object on which the User wants to set rRights are not found.
-50132	Document has been deleted.	Document has been deleted.
-50034	Annotation not found	Annotation for which to set the rRights have to be set does not exist in the sSystem.
-50028	Data Class not found	Data Class for which the Rights have to be set to set rights does not exist in the systemSystem.
-50130	User cannot assign rights to himself.	Users cannot assign rights Rights on themselves. to himself.
-50058	Specified User does not exist.	The specified User for whom the which User wants to set rights Rights does not exist.
-50063	Specified User has expired.	The specified User for whom the Rights have to be set User for which rights are to be set has expired.
-50064	Specified User is not alive.	The specified User for whom the Rights have to be set User for which rights are to be set is not alive.
-50133	Folder has been deleted.	Folder has been deleted. Its location is Ttrash.
-50168	User cannot assign rights.	User does not have Rights to set Rights on an Object. This exception is raised when User tries to set rights on an object that he himself doesn’t posses.