This call is used to add a new User Group to the System. User must have Privilege to add Group in the System.
|
|
|
Name |
Parent Tag |
Description |
Valid Values |
Default Values |
|
Option |
Root |
Unique option for the call. |
NGOAddGroup |
|
|
CabinetName |
Root |
Name of the Cabinet to which the User wants to connect. |
|
|
|
UserDBId |
Root |
UserDatabase ID that is returned in the NGOConnect Cabinet call. |
|
|
|
LimitCount |
Root |
Specifies the maximum number of Groups that can be added in the System. |
Integer > 0 |
No check is made for limit on number of Groups. |
|
Group |
Root |
Information about the new Group to be added. |
|
|
|
MainGroupIndex |
Group |
This parameter is Reserved. The default value can be sent. |
Integer >= 0 |
0 |
|
ParentGroupIndex |
Group |
Parent Group Index of the new Group |
Integer >= 0 |
0 |
|
GroupName |
Group |
Name of the new Group to be added. |
|
New Group (incremental no). For example, if Group with name ‘New Group’ is already present then it will create a Group with the name New Group (1) |
|
CreationDateTime |
Group |
Date and Time of creation of the Group. |
A valid Date in the format yyyy-mm-dd hh:mm:ss |
Current Date and Time. |
|
ExpiryDateTime |
Group |
Date and Time when the new Group will expire. |
A valid Date in the format yyyy-mm-dd hh:mm:ss |
12/31/2099 |
|
Privileges |
Group |
Specifies the various privileges assigned to the group |
String of seven bits, each 0 or 1 depending upon whether that particular Privilege is to be given to the Group or not. |
None of the Privilege is given to the new Group |
|
Comment |
Group |
Any comment to be associated with the Group. |
|
Blank |
|
GroupType |
Group |
Type of the Group. |
‘G’- General ‘A’- Reserved
|
‘G’ |
|
Name |
Parent Tag |
Description |
|
Option |
Root |
Unique option for the call. |
|
Status |
Root |
Status of the call. If the Status is 0, the call is successful. |
|
GroupIndex |
Root |
Index of the new Group. |
|
MainGroupIndex |
Root |
This parameter is Reserved. |
|
GroupName |
Root |
Name of the new Group. |
|
CreationDateTime |
Root |
Date and Time of creation of the new Group. |
|
ExpiryDateTime |
Root |
Date and Time of expiry of the new Group. |
|
Privileges |
Root |
Privileges of the new Group. |
|
OwnerIndex |
Root |
Index of the Owner of the Group. |
|
OwnerName |
Root |
Name of the Owner of the Group. |
|
Comment |
Root |
Any comment associated with the Group. |
|
ParentGroupIndex |
Root |
This parameter is Reserved. |
|
GroupType |
Root |
Type of the Group. |
|
Code |
Message |
Comments |
|
-50016 |
Group not found. |
Group specified in MainGroupIndex tag does not exist in the System. |
|
-50074 |
Invalid Parameters |
Some parameters passed to the call are invalid. For example, Group Type other than ‘G’ or ‘A’ is given. |
|
-50014 |
Group name already exists. |
Group with the same Name as specified in the call already exists. |
|
-50178 |
Limit on number of Groups exceeded. |
This exception occurs when the User specifies some LimitCount value in input and that number of Groups is already present in the System. |
|
-50116 |
Insufficient privileges for the current operation. |
User does not have Privileges to add a Group. |