NGOChangeGroupProperty

This call is used to modify the Properties of an existing Group. Only those tags should be sent in the call for which the corresponding Group Properties are to be changed. For the tags that are not sent in this call, original Properties of the Group are retained.

 

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.

NGOChange

GroupProperty

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

Group

Root

Information about the modified Properties of the Group.

 

N/A

GroupIndex

Group

Index of the Group whose Properties are to be changed.

Index > 0

N/A

GroupName

Group

New name of the Group.

 

 

ExpiryDateTime

Group

Date and Time of Expiry of the Group.

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

 

Privileges

Group

Specifies the various Privileges assigned to the Group.

String of seven bits, each 1 or 0 depending upon whether that particular Privilege is to be given to the Group or not.

 

OwnerIndex

Group

Index of Owner of the Group.

Integer > 0

 

Comment

Group

Any comments associated with the Group.

Char 22 should be sent to remove the comments.

 

ParentGroupIndex

Group

Parent Group Index of the group.

 

 

 

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.

Group

Root

Returns information about the Group whose Properties are to be modified through the call.

GroupIndex

Group

Index of the Group.

MainGroupIndex

Group

This parameter is Reserved.

GroupName

Group

Name of the Group.

CreationDateTime

Group

Date and Time when the Group was created.

ExpiryDateTime

Group

Date and Time of expiry of the Group.

Privileges

Group

Privileges of the Group.

OwnerIndex

Group

Index of Owner of the Group.

OwnerName

Group

Name of Owner of the Group.

Comment

Group

Comment associated with the Group.

GroupType

Group

Type of the Group namely ‘G’ for General, ‘A’ – Reserved

ParentGroupIndex

Group

ParentGroupIndex for the group.

 

Errors returned from call

Code

Message

Comments

-50016

Group not found.

The Group Index specified in the call is invalid.

-50140

Member cannot change Group's expiry date.

A User who is a member of the Group cannot change its Expiry Date.

-50139

Expiry date cannot be less than current date.

User has specified an Expiry Date less than the current Date that is invalid.

-50066

Group has expired.

The Group whose Properties are to be modified has already expired.

-50128

Member of the Group cannot modify privileges of its own Group.

A User who is a member of the Group cannot change the Group Privileges.

-50014

Group name already exists.

User wants to change the Name of the Group and the new Name already exists in the System.

-50074

Invalid parameters.

Some parameters passed to the call are invalid.

-50117

Properties of System Groups cannot be modified.

Properties of Systems’ Groups like ‘Administrator’, ‘Everyone’ and ‘Public’ cannot be modified.

-50116

Insufficient privileges for the current operation.

User does not have Privileges to modify the Group. This exception can also be raised when the Owner of the Group is changed. The new Owner must have Add / Modify / Delete Privileges for the Group.

-50058

Specified User does not exist.

The new Owner specified does not exist in the System.

-50063

Specified User has expired.

The new Owner specified has expired.

-50064

Specified User is not alive.

The new Owner specified is not alive.

-50078

User is not Administrator.

This exception will occur when the User, other than the Administrator, changes the Properties of the System Group.

-50013

Group not found.

The Group whose Properties are to be changed does not exist.