NGOCreateReferences

This transaction is used to create shortcuts, also referred as References of a set of documents or a folder in other folder. The ObjectType is D for document and F for Folder. And the Object Index is the corresponding iIndex.

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.	NGOCreate References	N/A
CabinetName	Root	Name of the Cabinet to which the User wants to connect.		N/A
UserDBId	Root	UserDatabase ID, whichthat is returned in the NGOConnect Cabinet call.		N/A
CurrentDate Time	Root	Current Date and Time when the rReference was created.	Yyyy-mm-dd hh:mm:ss	Current date and time
Destination Folder	Root	Destination Folder Index where the shortcut has to be created.	Integer >= 1	N/A
ObjectType	Root	It indicates the tType of oObject.	D-Document F-Folder	D
ObjectIndex	Root	It is the iIndex of the oObject whose Sshortcuts have to be created.	Integer > 0	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. Else if less than zero, error is reported. Else warning is reported.
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 iIndex.
DocumentVersionNo	Document	If the document has Versions, then Version nNumber else the default first Version 1.0.
NoOfPages	Document	Numbers of pPages of the are there in document.
DocumentName	Document	Name of the document.
Owner	Document	Owner of the document.
OwnerIndex	Document	User Index of the oOwner of the Object.
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 whenof the document was last accessed
ExpiryDateTime	Document	Expiry dDate and tTime of the document.
ReferenceFlag	Document	Reference fFlag of the document.
VersionFlag	Document	Version fFlag of the document.
DocumentType	Document	Type of the document.
ISIndex	Document	Image iIndex of the document.
DocumentSize	Document	The Size of the document.
DocOrderNo	Document	The Order, in which the documents are added in the Folder. of the document in which it is added in the folder.
ODMADocumentIndex	Document	Reserved for internal use.
EnableLog	Document	The Log of the document is enabled.
DocumentLock	Document	Specifies whether the Document is locked or not.
LockByUser	Document	Specifies the User iIndex that locks it.
Comment	Document	Comments attached to the document.
FTSFlag	Document	Full tText sSearch fFlag enabled or not.
DocStatus	Document	The Status of the document.
CheckoutBy	Document	Specifies whether the document is Checked Oout or not.
FinalizedFlag	Document	Finalized fFlag of the document.
FinalizedDateTime	Document	Finalized The Ddate anda tTime ofwhen 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.
CreatedByApp	Document	Reserved for internal use.
FTSDocumentIndex	Document	Reserved for internal use.
ACL	Document	String comprising the Rights of Users / Groups on the current document.
FinalizedBy	Document	Name of the User who has finalized the object.
DataDefName	Document	Name of the Data Class associated with the object.
FailedReferences	Root	List of failed rReferences.
FailedReference	Failed References	Details of the failed rReference.
ObjectIndex	Failed References	Object iIndex whose rReference was not created.
StatusCode	Failed References	Status cCode that contains information about the Eerror.

Errors returned from call

Code	Message	Comments
-50017	Folder not found.	Given dDestination Folder Index not found.
-50074	Invalid parameters.	Invalid parameter passed in the iInput. This exception is raised when the User has not specified any folder or document for which rReferences are to be created.
-50076	Invalid object access type.	Access tType of the dDocument / fFolder whose rReference is to be added or the folder in which the rReference is to be added is not valid.
-50076	Invalid object access type.	Access tType of the document / folder whose rReference is to be added or the folder in which the reference is to be added is not valid.

Warnings returned from call

Code	Message	Comments
50019	Not All References Added	All the rReferences were not created.

Codes returned in the form of status code

Code	Message	Comments
-50017	Folder not found.	When the fFolder for which the User wants to create rReference does not exist in the sSystem or is in User’s tTrash.
-50020	Reference to the Folder already exist.	Reference of the fFolder already exists in the f Folder where it is to be created.
-50023	Document not found.	Document whose rReference is to be created does not exist.
-50122	Reference to the Document already exist.	The rReference of the document whose rReference is to be created in a particular fFolder, already exists in that fFolder.
-50018	Insufficient rights for the current operation.	User does not have sufficient rRights on the fFolder offor which the rReference is to be created or the fFolder in which rReference of the folder / document is to be created.
-50022	Insufficient rights for the current operation.	User does not have sufficient rRights on the document offor which the rReference is to be created.