NGOGetIdFromName

This call is used to get an Object's Index by providing its name. User has to pass object’s Object’s nName and tType in input.

 

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.

NGOGetId

FromName

N/A

CabinetName

Root

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

The name of the Cabinet.

N/A

UserDBId

Root

UserDatabase ID, which that is returned in the NGOConnect

Cabinet call.

 

N/A

ObjectType

Root

Type of Object whose id Id is to be retrieved.

‘C’ - Cabinet

‘D’– Document

‘F’ – Folder

‘A’ –

Annotation
‘T’ – Data

Class

 

ObjectName

Root

Name of the object whose index Index is to retrieve.

Object Name

N/A

Index

Root

Parent Folder index Index of the folder in which the object is to searched in case ObjectType=’D’ or ‘F’.

 

DocumentIndex in case ObjectType=’A’

Integer > =0

N/A

MainGroupIndex

Root

Reserved for internal use.

Integer>=0

N/A

PageNo

Root

Page nNumber on which the aAnnotation gGroup has to be searched. Used in case of aAnnotations.

Integer >=0

0

CreatedByApp

Name

Root

Document extension Extension in case object to search is Document

Extension of the document.

NULL

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

NGOGetIdFromName

Status

Root

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

ObjectIndex

Root

Index of the object corresponding to the name Name specified.

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameters.

Some of the parameters entered were incorrect. This exception is raised when the object Object name Name is passeds as null.

-50016

Group not found.

Specified group Group does not exist.

-50023

Document not found.

The specified document does not exist.

-50022

Insufficient rights for the current operation.

The User does not possess sufficient rights Rights on the document.

-50017

Folder not found.

Specified Ffolder does not exist.

-50018

Insufficient rights for the current operation.

The User does not possess sufficient rights Rights on the folder.

-50028

Data Class not found.

The specified Data Definition does not exist.

-50032

Insufficient rights for the current operation.

The User does not have sufficient rights Rights on the specified data Data definitionDefinition.

-50034

Annotation not found.

The specified annotation Annotation does not exist.

-50013

Group not found.

The specified group Group does not exist.

-50058

Specified User does not exist.

The specified User does not exist.

-50054

Invalid object type.

The specified object Object Ttype is invalid.

-50061

Insufficient rights for current operation.

The specified User does not possess sufficient rights Rights on the annotationAnnotation.

-50076

Invalid object access type.

Access type Type of the object whose index Index is required is not valid.