NGOGetCabinetProperty

This call is used for retrieving the Properties of the Cabinet by giving Cabinet Name as an Input parameter.

 

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.

NGOGetCabinet

Property

N/A

CabinetName

Root

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

 

N/A

UserDBId

Root

UserDatabse ID, which is returned in the NGOConnectCabinet call.

 

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.

Cabinet

Root

Contains information about the Cabinet between the <Cabinet> and </Cabinet> tag.

CabinetName

Cabinet

It indicates the name of the Cabinet.

CabinetType

Cabinet

It indicates the type of the Cabinet (Image and/or Document Cabinet).

VersionFlag

Cabinet

Specifies whether Auto Versioning is allowed or not.

ImageVolumeIndex

Cabinet

It indicates the VolumeId of the entire Cabinet. Whenever a new folder is added to the Cabinet and the User does not specify Volume Id, it inherits this value from the Cabinet.

CreationDateTime

Cabinet

It indicates the number of documents in the Cabinet.

LoginUserRights

Cabinet

It indicates the Rights of the logged in User.

FTSDatabasePath

Cabinet

Reserved for internal use.

SecurityLevel

Cabinet

It indicates the level of Security in the Cabinet.

CabinetLockFlag

Cabinet

Flag that specifies whether the Cabinet is locked or not.

LockByUser

Cabinet

It indicates the User Index of the User who has locked the Cabinet.

Privileges

Cabinet

Privileges of the User logged on to the Cabinet.

LoginUserIndex

Cabinet

Reserved for internal use.

 

Errors returned from call

Code

Message

Comments

-50002

Invalid Rights on Cabinet.

The User who has connected to the Cabinet does not have Rights on the Cabinet. User must have Read Rights on the Cabinet.