NGOGetFormList

This call will return the list of all fForms associated with a dDatadDefinition.

 

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.

NGOGetForm

List

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

Index of the Data Definition for which all the fForms data associated with the Data Class is to be fetched.

 

N/A

StartFrom

Root

It is used for fetching fForms in batches. It specifies a number starting from which the next batch of fForms is to be fetched.

 

N/A

NoOfRecordsTo

Fetch

Root

It specifies the number of records to be fetched in a batch.

 

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.

NoOfRecordsFetched

Root

Number of records fetched in this call.

TotalNoOfRecords

Root

Total Number of records present.

Forms

Root

It contains the information about a large number of fForms.

Form

Forms

It contains the complete information about a particular fForm using various tags.

FormIndex

Form

Index of the fForm.

FormName

Form

Name of the fForm.

FormType

Form

Not Used.

Owner

Form

Owner of the fForm.

CreationDateTime

Form

Date and Time when the fForm was registered for the dDatadDefinition.

RevisedDateTime

Form

Date and Time when the fForm was last revised.

AccessedDateTime

Form

Date and Time when the fForm was last accessed.

DataDefIndex

Form

Index of the DataDefinition datadefinition with which the form isForm is associated.

DataDefName

Form

Name of the DataDefinition datadefinition with which the form isForm is associated.

Comment

Form

Comments added with the Formform.

LockByUser

Form

Name of the user who has locked the Form.

LockedBy

Form

Index of the user who has locked the Form.

LockMessage

Form

Message to be displayed if the Form is Locked.

Locked

Form

Whether the Form is locked or not.

‘Y’ – Yes

‘N’ - No

 

Errors returned from call

Code

Message

Comments

-50032

Insufficient rights for the current operation.

User does not have sufficient rRights to do the operation. User must have rRead rRights on the Data Class to which the list of Formforms attached is to be fetched.

-50028

Data Class not found.

The Data Class for which the list of attached Formforms was to be fetched does not exist.