NGOGetFolderIdForName

This call returns the Folder Index for the folder whose Name is supplied.

 

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

FolderIdForName

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabase ID, which is returned in the NGOConnectCabinet call.

 

N/A

FolderName

Root

Name of the folder whose Index is to be obtained.

 

N/A

ParentFolderIndex

Root

Index of the Parent Folder of the folder whose Index is to be obtained.

 

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.

FolderIndex

Root

Index of the folder whose name was supplied.

 

Errors returned from call

Code

Message

Comments

-50017

Folder not found.

Folder whose Index is to be found does not exist.

-50018

Insufficient rights for the current operation.

The logged in User does not have sufficient Rights on the folder for which Index is to be found. This Error will occur when the User has None Rights on this folder.

-50076

Invalid object access type.

 

Access type of  folder whose index is to be found is  improper . This error arises in the process of rights checking on the folder .