NGOGetDataDefProperty

This call is used to returns the properties Properties and the fFields associated with the given Data Class.

 

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.

NGOGetData

DefProperty

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID, which that is returned in the NGOConnect

Cabinet call.

 

N/A

DataDefIndex

Root

Data Class iIndex whose pProperty is required.

Integer >= 1

N/A

 

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

Contains information for the data Data definitionDefinition.

DataDefIndex

Data

Definition

Index of the data definitionData Definition

DataDefName

Data

Definition

Name of the data definitionData Definition.

LoginUserRights

Data

Definition

Rights of the logged in User.

Comment

Data

Definition

Comments associated with the data definitionData Definition.

EnableLogFlag

Data

Definition

EnableLogFlag of the data definitionData Definition.

Type

Data

Definition

Type of the data definitionData Definition.

GroupId

Data

Definition

GroupId associated with the data definitionData Definition.

Extra

Data

Definition

Extra info of the data definitionData Definition.

Fields

Data

Definition

Contains information about fields.

Field

Fields

Contains information about a particular field.

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 Global or Data Class level Level field info.

 

Errors returned from call

Code

Message

Comments

-50028

Data Class not found.

Data Class for the given index Index was not found.

-50032

Insufficient rights for the current operation.

Insufficient rights Rights for the data definitionData Definition. User must have read Read rights Rights on Data Class to fetch the properties Properties of Data Class.