This call is used to add a User to
various Groups.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOAdda MemberTo Groups |
N/A |
|
CabinetName |
Root |
Name of the Cabinet to which the User
wants to connect. |
|
N/A |
|
UserDBId |
Root |
UserDatabase ID that is returned in the NGOConnect Cabinet call. |
|
N/A |
|
Groups |
Root |
Information about the Groups in
which User is to be added. |
|
N/A |
|
GroupIndex |
Groups |
Index of the Group in which the User
is to be added. |
Integer > 0 |
N/A |
|
RoleIndex |
Groups |
Index of the Role associated with
the group. |
Integer > 0 |
N/A |
|
UserIndex |
Root |
Index of the User who is to be added
to the specified Groups. |
Integer > 0 |
N/A |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
Unique option for the call. |
|
Status |
Root |
Status of the call. If the Status is
0, then the call is successful. |
|
AddedGroups |
Root |
Returns information about the Groups
to which the User has been added successfully. |
|
GroupIndex |
Added Groups |
Group Index to which the User has
been added successfully. |
|
RoleIndex |
AddedGroups |
Index of the role of the added Group. |
|
FailedGroups |
Root |
Returns information about the Groups
to which the User could not be added successfully. |
|
GroupIndex |
Failed Groups |
Index of the Group to which the User
could not be added. |
|
RoleIndex |
Failed Groups |
Role index of the failed group. |
|
StatusCode |
Failed Groups |
Status code of the failed operation |
|
Code |
Message |
Comments |
|
-50074 |
Invalid parameters. |
Some parameters passed to the call are invalid. E.g.
if group list to which the User is to be added is not given in the Input. |
|
-50003 |
User does not exist. |
User who is to be added to groups does not exist. |
|
-50000 |
Unknown Error |
Some other error, apart from those already listed, has
occurred. |
Warnings returned
from call
|
Code |
Message |
Comments |
|
50017 |
Not All Users Added. |
User not added to all groups. Exact
reason of failure will be sent in the status code. |
Codes returned in the
form of status code
|
Code |
Message |
Comments |
|
-50013 |
Group not found. |
Group to which User is to be added
doesn’t exist. |
|
-50114 |
User is already a member of the
Group. |
User is already a member of the
group. |
|
-50116 |
Insufficient privileges for the
current operation. |
Login User doesn’t have privileges
for adding a member to a group. |
|
-50202 |
The Role does not Exist. |
The specified role does not exist. |
|
-50203 |
The User is Associated with the Role. |
The specified user is already associated with the
Role. |
|
-50207 |
Cannot add Multiple Users to the specified Role. |
Multiple users can’t be added to the specified Role. |