NGOMoveReferences

This transaction can be used to change the location of References (shortcuts). If Folder References are being moved i.e the Object Type is ‘F’, different XML is being generated.

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 References	N/A
CabinetName	Root	Name of the Cabinet to which the User wants to connect.		N/A
UserDBId	Root	UserDatabase ID, which that is returned in the NGOConnect Cabinet call.		N/A
CurrentDate Time	Root	Current dDate and tTime.	yyyy-mm-dd hh:mm:ss	Current Datedata and tTime
SourceFolder	Root	Source fFolder iIndex, from where shortcut has to be moved.	Integer >= 0	N/A
Destination Folder	Root	Destination fFolder iIndex, where shortcut has to be moved.	Integer >= 0	N/A
ObjectType	Root	Type of the shortcut.	F-Folder D-Document	D
ObjectIndex	Root	Object iIndex whose shortcut has to be moved.	Integer >= 0	N/A

Output Parameters description (For Folder References)

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. Else, if less than zero, error is reported. Else warning is reported.
NoOfObjects	Root	The number of shortcuts moved.
FolderReferences	Root	Parent Tag that contains all the References
Reference	FolderReferences	Information containing a particular folder whose reference has been moved.
FolderIndex	Reference	Index of the folder.
FolderName	Reference	Name of the folder.
FileDateTime	Reference	Date and Time when the Folder was Filed.
Rights	Reference	Rights of the folder.

Output Parameters description (For Document References)

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. Else, if less than zero, error is reported. Else warning is reported.
NoOfObjects	Root	The Nnumbers of shortcuts moved.
Documents	Root	A List of Documents was returned between <Documents> and </Documents> tags.
Document	Documents	AThe details of a document was returned between <Document> and </Document> tags.
DocumentIndex	Document	Document index.
DocumentVersionNo	Document	If the document has Versions, then Version nNumber else the default first Version 1.0.
NoOfPages	Document	Numbers of pages of the document. are there in document.
DocumentName	Document	Name of the document.
Owner	Document	Owner of the document.
OwnerIndex	Document	User Index of the Owner of the document. (User index)
CreationDateTime	Document	Creation dDate and tTime ofwhen the document was created.
RevisedDateTime	Document	Revised dDate and tTime ofwhen the document was revised.
AccessDateTime	Document	Access dDate and tTime ofwhen the document was last accessed.
ExpiryDateTime	Document	Expiry dDate and tTime of expiry of the document.
ReferenceFlag	Document	Reference fFlag of the document.
VersionFlag	Document	Version fFlag of the document.
DocumentType	Document	Type of the document.
CreatedByAppName	Document	The eExtension of the document.
ISIndex	Document	Image iIndex of the document.
DocumentSize	Document	The Size of the document.
DocOrderNo	Document	The Order in which of the document in which it is added was added in the fFolder..
ODMADocument Index	Document	Reserved for internal use.
EnableLog	Document	Log of the document is enabled.
DocumentLock	Document	Specifies whether the Document is locked or not.
LockByUser	Document	User iIndex that locks it.
Comment	Document	Comments attached to the document.
FTSFlag	Document	Full tText sSearch fFlag is enabled or not.
DocStatus	Document	The Status of the document.
CheckoutBy	Document	It is the Index of the User who has Checked Oout the document. or not.
FinalizedFlag	Document	Finalized flag Flag of the document.
FinalizedDateTime	Document	Finalized dDatea and tTime when of the document was finalized.
LoginUserRights	Document	Rights string of the logged in User.
Author	Document	The Author of the document.
CheckoutStatus	Document	Indicates whether the document has been cChecked oOut or not. ‘N’ – No, ‘Y’ – Yes
DataDefIndex	Document	Index of the Data class associated with the given document.
DataDefName	Document	Name of the Data Class associated with the object.
CreatedByApp	Document	Reserved for internal use.
UsefulInfo	Document	Information associated with the Document.
Location	Document	Folder Type of the parent folder.
FinalizedBy	Document	Name of the User who has finalized the object.
FTSDocumentIndex	Document	Reserved for internal use.

Errors returned from call

Code	Message	Comments
-50017	Folder not found.	Given dDestination Folder Index or sSource fFolder not found in the sSystem.
-50018	Insufficient rights for the current operation.	Insufficient rRights on the sSource or dDestination fFolder. User must have cChange rRights on sSource fFolder and wWrite rRights on the dDestination fFolder.
-50020	Reference to the Folder already exists.	Reference of the fFolder already exists on the given dDestination fFolder.
-50122	Reference to the Document already exists.	Reference of the document already exists on the given dDestination fFolder.
-50076	Invalid object access type.	Access tType of the Folder from where the rReference is to be moved or the fFolder in which the reference is to be moved or the folder or document whose reference is to be moved is not valid.