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 Index.

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 that is returned in the NGOConnect Cabinet call.		N/A
CurrentDate Time	Root	Current Date and Time when the Reference 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 Type of Object.	D-Document F-Folder	D
ObjectIndex	Root	It is the Index of the Object whose Shortcuts have to be created.	Integer > 0	N/A

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.
Documents	Root	A List of Documents returned between <Documents> and </Documents> tags.
Document	Documents	The details of a document returned between <Document> and </Document> tags.
DocumentIndex	Document	Document Index.
DocumentVersionNo	Document	If the document has Versions, then Version Number else the default first Version 1.0.
NoOfPages	Document	Numbers of Pages of the document.
DocumentName	Document	Name of the document.
Owner	Document	Owner of the document.
OwnerIndex	Document	User Index of the Owner of the Object.
CreationDateTime	Document	~~Creation~~ Date and Time when the document was created.
RevisedDateTime	Document	~~Revised~~ Date and Time when the document was revised.
AccessDateTime	Document	~~Access~~ Date and Time when the document was last accessed
ExpiryDateTime	Document	Expiry Date and Time of the document.
ReferenceFlag	Document	Reference Flag of the document.
VersionFlag	Document	Version Flag of the document.
DocumentType	Document	Type of the document.
ISIndex	Document	Image Index of the document.
DocumentSize	Document	The Size of the document.
DocOrderNo	Document	The Order, in which the documents are 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 Index that locks it.
Comment	Document	Comments attached to the document.
FTSFlag	Document	Full Text Search Flag enabled or not.
DocStatus	Document	The Status of the document.
CheckoutBy	Document	Specifies whether the document is Checked Out or not.
FinalizedFlag	Document	Finalized Flag of the document.
FinalizedDateTime	Document	The Date and Time when 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 Checked Out 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 References.
FailedReference	Failed References	Details of the failed Reference.
ObjectIndex	Failed References	Object Index whose Reference was not created.
StatusCode	Failed References	Status Code that contains information about the Error.

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.
LoginUserRights	Reference	Rights of the Logged in user on the folder

Errors returned from call

Code	Message	Comments
-50017	Folder not found.	Given Destination Folder Index not found.
-50074	Invalid parameters.	Invalid parameter passed in the Input. This exception is raised when the User has not specified any folder or document for which References are to be created.
-50076	Invalid object access type.	Access Type of the Document / Folder whose Reference 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 References were not created.

Codes returned in the form of status code

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

NGOCreateReferences

Image Index of the document.

The Size of the document.

The Order, in which the documents are added in the Folder.

The Log of the document is enabled.

Specifies whether the Document is locked or not.

Specifies the User Index that locks it.

Comments attached to the document.

Full Text Search Flag enabled or not.

The Status of the document.

Specifies whether the document is Checked Out or not.

Finalized Flag of the document.

The Date and Time when the document was finalized.

Rights string of the logged in User.

The Author of the document.

List of failed References.

Details of the failed Reference.

Object Index whose Reference was not created.

Status Code that contains information about the Error.