NGOGetAttachments

This transaction can be used to get the list of Attachments on a document. To get a single Attachment, specify the AttachmentName. The Attachments can be retrieved for a particular Version also.

 

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.

NGOGet

Attachment

N/A

CabinetName

Root

Name of the Cabinet to which the User wants to connect.

The name of the Cabinet.

N/A

UserDBId

Root

UserDatabase ID that is returned in the NGOConnect

Cabinet call.

 

N/A

DocumentIndex

Root

Unique Index of the document for which User wants to get the List of Attachment.

 

N/A

Attachment

Name

Root

Name of the Attachment that the User wants to fetch.

 

 

PageNo

Root

Page Number for which the User wants to get the List of Attachments.

 

0

VersionNo

Root

Version Number for which the User wants to fetch Attachments.

 

Current Version

 

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.

NoOfAttachments

Root

Total number of attachments to a document.

Attachments

Root

Contains information about all the Attachments with the document.

Attachment

Attachments

Contains information about individual Attachments with the document.

ObjectIndex

Attachment

NOT Used

ObjectType

Attachment

NOT Used

PageNo

Attachment

Page Number of the document on which Attachment is present.

ISIndex

Attachment

Image Index and Volume Index of the attachment separated by #.

AttachmentName

Attachment

Name of the Attachment.

 

Errors returned from call

Code

Message

Comments

-50025

Document Not Found

Document, for which the User wants to add Attachments, does not exists in the System.

-50022

Insufficient rights for the current operation.

User must have Read Rights on the document for which attachments are to be added.