This call is used to add Members
(Users) to an existing Group. A User
can add self to a Group only if he is the Owner of that Group. User cannot
perform any operation on self if he is not the Owner of the Group.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOAddMember ToGroup |
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 |
|
GroupIndex |
Root |
Index of the Group to which Users
are to be added. |
Integer > 0 |
N/A |
|
Users |
Root |
Outer tag consisting of Users to be
added to a group. |
|
|
|
User |
Users |
Outer tag enclosing the individual
user to be added to a group. |
|
|
|
UserIndex |
User |
Index of the User who is to be added
to the specified Group. |
Integer > 0 |
N/A |
|
RoleIndex |
User |
Index of the Role which is to be
added to the specified Group. |
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. |
|
AddedUsers |
Root |
Returns information about the Users
who have been added to the Group successfully. |
|
AddedUser |
AddedUsers |
Outer tag enclosing the individual
user who has been added to the Group successfully. |
|
UserIndex |
AddedUser |
Index of the User added successfully
to the Group. |
|
RoleIndex |
AddedUser |
Index of the role of the user added
to the group. |
|
FailedUsers |
Root |
Returns information about the Users
who could not be added to the Group successfully. |
|
FailedUser |
FailedUsers |
Outer tag enclosing the individual
user who could not be added to the Group successfully. |
|
UserIndex |
Failed User |
Index of the User who could not be
added to the Group. |
|
RoleIndex |
Failed User |
Index of the role of the user added
to the group. |
|
StatusCode |
Failed User |
Status Code of the failed operation. |
|
Code |
Message |
Comments |
|
-50074 |
Invalid parameters. |
Some parameters passed to the call are invalid. For
example, if Users who are to be added to the Group are not provided in the
Input or the specified Group Index is passed as null. |
|
-50116 |
Insufficient privileges for the current operation. |
Logged in User does not have Privileges for performing
the operation. |
|
-50013 |
Group not found. |
The Group to which the User is to be added does not
exist. |
|
-50117 |
Properties of System Groups cannot be modified. |
A member cannot be explicitly added to ‘Everyone’ Group. |
|
-50066 |
Group has expired. |
The Group to which the User is to be added has
expired. |
|
-50058 |
Specified User does not exist. |
The User, to be added to a Group does not exist. |
|
-50063 |
Specified User has expired. |
The User to be added to a Group has expired. |
|
-50064 |
Specified User is not alive. |
The User to be added to a Group is not alive. |
Warnings returned
from call
|
Code |
Message |
Comments |
|
50017 |
Not All Users Added |
All the specified Users are not added
because either some User who are to be added to the Group already exists in
the Group or the target User is the logged in User and is not the Owner of
the Group. Exact reason for the failure will be sent in the Status Code. |
Codes returned in the
form of status code
|
Code |
Message |
Comments |
|
-50062 |
Logged in User cannot perform
operation on self. |
Target User is the logged in User
and is not the Owner of the Group. |
|
-50114 |
User is already a member of the
Group. |
User specified in the input is
already a member of the 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. |