NGOAddGlobalIndexToDocument

This call can associate the GlobalIndexes that exist in System with a document.

 

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.

NGOGet

GlobalIndex

ListTo

Document

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

DocumentIndex

Root

Index of the document.

Integer >0

N/A

CurrentDate

Time

Root

Current Date and Time at which call is made to server

Valid Date in the format- YYYY-MM-DD HH:MM:SS

Current Date and Time of the server

RightsFlag

Root

Indicates whether user rights on the specified document are to be checked or not.

‘Y’ - Yes, ‘N’ - No

Y or N

Y

Fields

Root

Parent Tag covering the Field Tag for accomodationg various fields

 

N/A

Field

Fields

It is an outer tag that contains the information related to a particular field using different tags.

 

N/A

IndexId

Field

Index of the Data Field.

 

N/A

IndexValue

Field

Value of the Data Field.

 

 

IndexType

Field

Type of the Data Field.

 

I – Integer Type

T – Text Type

S – String Type.

L – Long Type

D – Date Type

B – Boolean Type.

F – Float Type

X – Document Index.

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

Unique option for the call.

Status

Root

Status of the call. If it is 0, then the call is successful.

 

Errors returned from call

Code

Message

Comments

-50023

Document not found.

Document with which the User wants to associate the Global Index does not exist.

-50132

Document has been deleted.

Document with which the User wants to associate the Global Index has been deleted.

-50022

Insufficient rights for the current operation.

User who is associating the Global Index with document does not have Rights on the document. User must have Change Rights on document to associate Global Index with it.

-50043

GlobalIndex not found.

Global Index with which the User wants to associate does not exist in the System.

-50044

GlobalIndex already exist.

Specified Global Index is already associated with the Document.

-50086

Document has expired.

Document to which Global Index is to be associated has expired.

-50071

Document has been checked out.

Document to which Global Index is to be associated is checked out.

-50027

Properties of the Document have been finalized.

Properties of the document to which Global Index is to be associated has been finalized.

-50026

Document is in use.

Some User locks the document, with which the Global Index has to be associated.