NGOMoveFolder

This call is used to move a folder from one location to another.

 

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.

NGOMove

Folder

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

CurrentDateTime

Root

Current Date and Time.

Valid date in the format yyyy-mm-dd hh:mm:ss

Current Date and Time.

FolderIndex

Root

Index of the folder to be moved.

Integer > 0

N/A

DestFolderIndex

Root

Index of the destination folder where the specified folder is to be moved.

Integer > 0

N/A

CheckOutFlag

Root

It specifies whether to move the folder, when some checked out document exist within the folder or in any of its subfolders.

N – Don’t Move folder if any checked out document exists within that folder or any of its subfolders.

Y – Move folder even if any checked out document exists within that folder or any of its subfolders.

‘Y’

ParentFolderIndex

Root

Index of the Parent Folder of the folder that is to be moved.

Integer > 0

 

NameLength

Root

The maximum length of the Folder Name supported by JTS is 255 characters but, if the User wishes that the maximum length of folders added is lesser than 255 characters then it can be specified in this tag .The Folder Name, if larger than this NameLength, then Folder Name is truncated to the specified length.

Integer < 255

Not considered

LockFlag

Root

If document inside the folder is locked, then folder is to be moved or not.

Y or N

 

RightsFlag

Root

Whether login user’s rights are to be checked or not.

Y or N

Y

DuplicateName

Root

Whether a duplicate name is to be generated for this folder or not.

Y or N

Y

 

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.

Folder

Root

Outer tag contains information about the moved folder.

LockFlag

Folder

Whether the specified folder has been locked or not.

CheckOutFlag

Folder

Whether the specified folder has a Checked Out document or not.

FolderIndex

Folder

Index of the folder.

ParentFolderIndex

Folder

Index of parent of the folder.

NoOfSubFolders

Folder

Number of subfolders present in the folder.

NoOfDocuments

Folder

Number of documents present in the folder.

FolderName

Folder

Name of the folder.

Owner

Folder

Owner of the folder.

OwnerIndex

Folder

Index of the Owner of the folder.

CreationDateTime

Folder

Date and Time at which the folder was created

RevisedDateTime

Folder

Date and Time at which the folder was last modified.

AccessDateTime

Folder

Date and Time at which the folder was last accessed.

DeletedDateTime

Folder

Date and Time of deletion of the folder.

ImageVolumeIndex

Folder

Volume Index of the Image Server where the documents added in this folder will be added, if no Volume Index is supplied in the Add Document call. 

FolderType

Folder

Indicates the Type of the folder.

FolderLock

Folder

Indicates if any User has locked the folder.

LockByUser

Folder

Index of the User who has locked the folder.

Location

Folder

Folder Type of the parent folder.

ExpiryDateTime

Folder

Date and Time after which the folder will expire.

VersionFlag

Folder

Indicates whether Versioning will be allowed for the documents added in this folder or not.

Comment

Folder

Comments associated with the folder.

FinalizedFlag

Folder

Indicates whether the Folder is finalized or not.

FinalizedBy

Folder

Index of the User who has finalized the folder.

FinalizedDateTime

Folder

Date and Time when the folder was finalized.

LoginUserRights

Folder

Rights of the login User on the folder.

ACLMoreFlag

Folder

Reserved for internal use.

EnableFtsFlag

Folder

Reserved for internal use.

DataDefinition

Folder

Information of the Data Class associated with the folder.

DataDefIndex

Data

Definition

Index of the Data Class associated with the folder.

NoOfReferenced

Documents

Folder

Number of document shortcuts present in the specified folder.

NoOfReferenced

Folders

Folder

Number of folder shortcuts present in the specified folder.

 

Errors returned from call

Code

Message

Comments

-50017

Folder not found.

Either the folder that is to be moved or the destination folder does not exist.

-50021

Folder is in use.

Destination folder is locked.

-50019

Properties of the Folder have been finalized.

Properties of the destination Folder have been finalized. User cannot move a folder once it is finalized.

-50067

Cannot move folder.

The folder could not be moved.

-50171

Folder is deleted or moved.

The folder to be moved has been deleted or moved.

-50018

Insufficient Rights for the current operation.

The logged in User does not have sufficient Rights for the operation. The User needs to have Write Rights on the destination folder.

-50076

Invalid object access type.

 

Access type of destination folder or some document in the folder to be moved is improper. This error arises in the process of checking rights.