NGOSetRights

This call is used to set the rRights of a User or a gGroup on a particular oObject like Cabinet, Folder, Document, DataDefinition or Annotation. It takes objectindex, object type (Cabinet, Document, Folder, Annotation), UserAcl and TypeOfProcess (Add, Modify, Delete).

 

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.

NGOSetRights

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 NGOConnect

Cabinet call.

 

N/A

ObjectType

Root

Information about the tType of the oObject on which the Rights are to be assigned. we are giving rights.

‘C’- Cabinet,

‘D’-Document,

‘F’-Folder,

 ‘A’-Annotation

‘T’ – Data Class

N/A

ObjectIndex

Root

Index of the oObject on which rights are being set.

Integer >= 0

N/A

TypeOfProcess

Root

It specifies the tType of the pProcess . Wwhether the Process is its addition of rRights or modification or/ deletion of the existing Rrights.

‘A’-Add

‘M’-Modify,

 ‘D’-Delete

 

N/A

MakerChecker

Flag

Root

Reserved for internal use.

 

 

UserGroupACL

Root

It contains information about the User or gGroup to which om rRights are 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 string like 010000.

 

N/A

LogGeneration

UserGroup

ACL

Whether log would be generated or not.

‘Y’ – Yes

‘N’ – No

 

 

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

-50074

Invalid parameters

Some of the parameter passed in input the Input is not valid

-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 to which Rights are assigned has expired. is expired to whom rights are assigned.

-50001

Cabinet not found.

Cabinet does not exists.

-50017

Folder not found.

Object on which User wants to set rights Rights is not found.

-50119

System defined properties cannot be changed.

System- defined properties Properties cannot be changed.

-50023

Document not found

Object on which User wants to set rights Rights is not found.

-50132

Document has been deleted.

Document has been deleted.

-50034

Annotation not found

Annotation for which to set rRights have to be set does not exist in the sSystem.

-50028

Data Class not found

Data Class for which to set rRights have to be set does not exist in the sSystem.

-50130

User cannot assign rights to himself.

User cannot assign rRights toon himself.

-50153

Rights already exist.

This exception can come when User specify TypeOfProcess as “A” and Rights already exist for the specified User or gGroup.

-50156

Invalid process on Rights.

When a particular process (A, M or D) is not applicable to lList.

-50058

Specified User does not exist.

The specified User for which the User wants to set rRights does not exist.

-50063

Specified User has expired.

The specified User for which the User wants to set Rights User for which rights are to be set has expired.

-50064

Specified User is not alive.

The specified User for which the User wants to set Rights User for which rights are to be set is not alive.

-50133

Folder has been deleted.

Folder has been deleted. Its location is trashTrash.

-50168

User cannot assign rights.

This exception is raised when User tries to set rights on an object that he himself doesn’t posses.User does not have Rights to assign Rights on an Object.