NGOChangeDataDefinition

This call is used to modify the Properties or Fields of a Data Definition. The Field List specified with the XML will be treated as final List for fields of that Data Definition; it will overwrite the previous fields associated with the Data Definition. Only those fields that are to be changed should be sent. ding, which are to be changed. If you want tTo delete all fields then send –1 in first IndexId tag.

 

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

DataDefinition

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID, whichthat is returned in the NGOConnect

Cabinet call.

 

N/A

DataDefinition

Root

It contains Information for a DataDefinition.

 

N/A

LimitOnField

Count    

DataDefinition

Maximum number of Fields that can be attached with a Data Class.

Integer >= 1

No check is made for limit count on fields.

DataDefIndex

Data

Definition

Index of Data Class.

 

N/A

DataDefName

Data

Definition

Name of the Data Definition.

 

N/A

Comment

Data

Definition

Any Comment associated with the Data Definitiondata definition.

 

 

EnableLogFlag

Data

Definition

Maintain log Log of the Data Class.

Y or N

N

Type

Data

Definition

Type of Data Definition.

Blank or ACT

 

GroupId

Data

Definition

Group index associated with the Data Definitiondata definition. It is reserved for internal use. User can set default value for it.

Integer >= 0

0

Extra

Data

Definition

Extra information stored with the Data Definitiondata definition.

 

 

Fields

Data

Definition

It contains Information about all the Fields of a Data Class.

 

N/A

Field

Fields

It contains Information for a particular Field.

 

N/A

IndexName

Field

Name of the field.

 

 

IndexType

Field

Type of the field.

Integer, Boolean, Date, Float, Long, String, Text, X (Document Index)

 

 

IndexLength

Field

Size of the field.

Depends on iIndex tType.

 

IndexAttribute

Field

Constraint of the field.

0 – null

1 - not null

2 - unique null, 3 - unique not null.

 4, 5- same as 0,1 respectively except that they are search keys.

 

UsefulInfoFlag

Field

If a field is marked as usefulinfo, value of that field can be seen in the document table under in the UseFullData column.

Y or N

 

UsefulInfoSize

Field

Size of the field.

 

 

IndexFlag

Field

Information about iIndex flag whether it would be Global or Data Class level.

G- Global

D- Data

 

 

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. Else if less than zero, error is reported. Else warning is reported.

DataDefinition

Root

Starting tag for the Data Definition details.

DataDefIndex

Data

Definition

Index of the added data Data definitionDefinition, if not existed. Else existed Data Definition index.

DataDefName

Data

Definition

Name of the added data Data definitionDefinition, if not existed. Else existed data definition’ name..

Comment

Data

Definition

Comments associated with the added Ddata dDefinition. , if not existed. Else comments of the existed data definition.

EnableLogFlag

Data

Definition

EnableLogFlag of the added dData dDefinition., if not existed. Else of existed data definition.

Type

Data

Definition

Type of the added Data Definitiondata definition. , if not existed. Else of existed data definition.

GroupId

Data

Definition

GroupId of the added Data Definitiondata definition. , if not existed. Else of existed data definition.

Extra

Data

Definition

Extra info of the added Data Definitiondata definition. , if not existed. Else of existed data definition.

Fields

Data

Definition

Starting tag of the field’s details.

Field

Fields

Starting tag of the field details.

IndexId

Field

Index of the associated field.

IndexName

Field

Name of the associated field.

IndexType

Field

Type of the associated field.

IndexLength

Field

Size of the associated field.

IndexAttribute

Field

Attribute of the associated field.

UsefulInfoFlag

Field

Usefulinfoflag of the associated field.

UsefulInfoSize

Field

UsefulInfoSize of the associated field.

IndexFlag

Field

Whether global or Data Class Llevel field info.

 

Errors returned from call

Code

Message

Comments

-50016

Group not found.

Group index the User trying to associate with the Data Definition does not exist.

-50031

Data Class with the same name already exists.

Data Definition class with the given name is already exists.

-50032

Insufficient rights for the current operation.

Insufficient rights Rights for the Data Definitiondata definition. User must have Cchange rRights on Data Definitiondata definition.

-50176

Limit on number of Fields exceeded.

The number of Data Class exceeds the limit of Data Class.

-50028

Data Class not found.

Data Class for the given index Index was not found.

-50074

Invalid parameters.

This exception will occurcome when the User has not specified Data Definition iIndex in input.

-50116

Insufficient privileges for the current operation.

Insufficient pPrivileges to modify Data Definitiondata definition.