NGOAddGroup

This call is used to add a new User group Group to the systemSystem. User must have privilege Privilege to add group Group in the systemSystem.

 

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.

NGOAddGroup

 

CabinetName

Root

Name of the Cabinet to which the User wants to connect.

 

 

UserDBId

Root

UserDatabase IDUserDatabase ID, which that is returned in the NGOConnect

Cabinet call.

 

 

LimitCount

Root

Specifies the maximum number of groups Groups that can be added in the systemSystem.

Integer > 0

No check is made for limit on number of groups Groups.

Group

Root

Information about the new group Group to be added.

 

 

MainGroupIndex

RootGroup

This parameter is Reserved. The default value can be sent.

Integer >= 0

0

GroupName

Group

Name of the new group Group to be added.

 

New Group (incremental no). For e.g.xample, if gGroup with name ‘New Group’ is already present, then it will create a gGroup with the name New Group (1)

CreationDateTime

Group

Date and Time of creation of the groupGroup.

A valid date Date in the format yyyy-mm-dd hh:mm:ss

Current Date and Time.

ExpiryDateTime

Group

Date and Time when the new group Group will expire.

A valid date 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 Privilege is to be given to the group Group or not.

None of the privilege Privilege is given to the new groupGroup

Comment

Group

Any comment to be associated with the groupGroup.

 

Blank

GroupType

Group

Type of the Group.

‘G’- General

‘A’- Reserved

 

‘G’

 

Output Parameters description

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.

GroupIndex

GroupRoot

Index of the new Groupgroup.

MainGroupIndex

RootGroup

This parameter is Reserved.

GroupName

RootGroup

Name of the new Groupgroup.

CreationDateTime

RootGroup

Date and Time of creation of the new Groupgroup.

ExpiryDateTime

RootGroup

Date and Time of expiry of the new Groupgroup.

Privileges

RootGroup

Privileges of the new Groupgroup.

OwnerIndex

RootGroup

Index of the Owner of the Groupgroup.

OwnerName

RootGroup

Name of the Owner of the Groupgroup.

Comment

RootGroup

Any comment associated with the Groupgroup.

GroupType

RootGroup

Type of the Groupgroup.

 

Errors returned from call

Code

Message

Comments

-50016

Group not found.

Group specified in MainGroupIndex tag does not exist in the systemSystem.

-50074

Invalid Parameters

Some parameters passed to the call are invalid. For example,E.g. Group Type other than ‘G’ or ‘A’ is given.

-50014

Group name already exists.

Group with the same name 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 gGroups is already present in the sSystem.

-50116

Insufficient privileges for the current operation.

User does not have privileges Privileges to add a Groupgroup..