NGOIsFolderExist

This call checks whether a folder having the given property exists or not. Search is made for the folder having the given properties. If the folder exists for these criteria, its folderindex is returned along with the status of the call.

 

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.

NGOIsFolderExist

N/A

CabinetName

Root

Name of the Cabinet to which User wants to connect.

 

N/A

UserDBId

Root

UserDBId for the user session

 

N/A

FolderIndex

Root

FolderIndex whose existence is to be verified.

Integer > 0

N/A

ParentId

Root

Parent folder index of the specified folder.

 

N/A

CreationDate

Time

Root

Creation datetime of the given folder.

 

N/A

FolderName

Root

Folder name whose existence is to be verified.

 

N/A

Options

Root

This parameter enables us to verify the existence of given folder on the basis of various criteria.

If Options = 0, search on FolderIndex.

If Options = 1, search on FolderName and CreationDateTime.

If Options = 2, search on FolderName, FolderIndex and CreationDateTime.

If Options = 3, search on FolderIndex and ParentFolderIndex.

If Options = 4, search on FolderName and ParentFolderIndex.

 

N/A

 

Output Parameters description

Name

Parent Tag

Description

Option

Root

NGOIsFolderExist

Status

Root

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

FolderIndex

Root

Index of the given folder returned indicating the existence of the given folder.

 

Errors returned from call

Code

Message

Comments

-50074

Invalid parameters.

The value for some input parameters is not correct or is invalid.