NGOChangeDocumentOrder

This call is meant for changing the order of documents in a particular Folder. Document List contains all the documents of a particular Folder. The Document List and their new Order Number that is to be assigned to them should be passed along with the Folder Index of the folder where all those document lies.

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.	NGOChange DocumentOrder	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 NGOConnect Cabinet call.		N/A
FolderIndex	Root	Index of the Folder, in which the Order Number of the documents is to be changed.		N/A
Documents	Root	It specifies the information about all the documents whose Order Number is to be changed.		N/A
Document	RootDocuments	It specifies the information about the document whose Order Number is to be changed using various tags.		N/A
DocumentIndex	Document	Index of the document whose Order Number is to be changed.		N/A
DocOrderNo	Document	New Order Number that is to be assigned to a document in a given Folder.		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.
Documents	Root	It specifies the information about the documents in a folder whose order has been changed.
Document	Documents	It specifies the complete information about the document whose order has been changed using various tags.
DocumentIndex	Document	Index of the document whose order has been changed.
ParentFolderIndex	Document	Specifies the Index of the Parent Folder of the document whose order has been changed.
DocumentVersionNo	Document	Specifies the current Version of the document whose order has been changed.
NoOfPages	Document	Specifies the number of pages in the document.
DocumentName	Document	Name of the document.
OwnerIndex	Document	Index of the Owner of the document whose order has been changed.
CreationDateTime	Document	Creation Date and Time of the document.
RevisedDateTime	Document	Revision Date and Time of the document.
AccessDateTime	Document	Date and Time when the document was last accessed.
ExpiryDateTime	Document	Date and Time when the document will expire.
DataDefinition	Document	It contains the data regarding the Data Class associated with the document.
DataDefNameDataDefIndex	DocumentDataDefinition	IndexName of the Data Class associated with the document.
VersionFlag	Document	Specifies whether Versioning of the document is allowed. Y – Versioning is allowed. N – Versioning is not allowed.
AccessType	Document	Specifies the scope of accessing the document. S – Shared P – Private I – Inherited
DocumentType	Document	Specifies the type of the document. I – Image N – Non Image A – Reserved
CreatedByApp	Document	Not used.
ISIndex	Document	Specifies a unique Combination of Image Index and Volume Index for a document stored on Image Server separated by #. For example, 3#79
DocumentSize	Document	Size of the document in bytes.
DocOrderNo	Document	New order of the document in which it is added in the folder.
FTSDocumentIndex	Document	Reserved for internal use.
ODMADocumentIndex	Document	Reserved for internal use.
EnableLog	Document	Flag that specifies whether Log is to be generated for the document whose order has been changed. Y – Log is generated. N – Log not generated.
DocumentLock	Document	Flag that specifies whether any User has locked the document. Y – Document is locked. N – Document is not locked.
LockByUser	Document	Index of the User who has locked the document.
Comment	Document	Comments added by the User on the document.
Author	Document	Name of the author of the document.
FTSFlag	Document	Reserved for internal use.
DocStatus	Document	Specifies the status of the document. R – Read A – Unread
CheckOutStatus	Document	Indicates whether the document has been checked out or not. ‘N’ – No, ‘Y’ – Yes
CheckoutBy	Document	Index of the User who has checked out the document
FinalizedFlag	Document	Flag, which specifies whether the document is finalized. Y – Document is finalized. N – Document is not finalized.
FinalizedBy	Document	Index of the User who has finalized the document.
FinalizedDateTime	Document	Date and Time when the document was finalized
LoginUserRights	Document	Rights of the logged in User on the document.
ACLMoreFlag	Document	Not used (Used for internal purpose only).

Errors returned from call

Code	Message	Comments
-50017	Folder not found.	The folder, of which the Document Order is to be changed, does not exist.
-50023	Document not found.	The document whose order is to be changed does not exist.
-50024	Document order not specified.	The reordering of documents was not proper as the number of documents in that folder and the number of distinct values for the DocOrderNo were not equal.
-50132	Document has been deleted.	The document whose document order was to be changed has been deleted.
-50086	Document has expired.	The document whose document order was to be changed has expired.
-50071	Document has been checked out.	The document whose Document Order was to be changed is checked out.
-50027	Properties of the Document have been finalized.	The document whose Document Order was to be changed has been finalized.
-50026	Document is in use.	The document whose Document Order was to be changed is locked.