NGOAddAttachment

This call is used to add an Attachment with a document. User can also attach Attachment to a specific page.

 

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.

NGOAdd

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 the User wants to attach some Attachments.

 

N/A

Attachment

Root

It is an Outer tag which Information about the Attachments.

 

N/A

CurrentDateTime

Attachment

Date and Time of the Attachment

 

N/A

ObjectType

Attachment

Not Used.

 

Blank

PageNo

Attachment

Page Number for which the User wants to attach the Attachments.

 

0

ISIndex

Attachment

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

 

0

Attachment

Name

Attachment

Name of the Attachment.

 

Blank

 

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.

Attachment

Root

Contains information about the Attachment.

ObjectIndex

Attachment

NOT Used.

ObjectType

Attachment

NOT Used.

PageNo

Attachment

Page Number of the document where new Attachment is added.

ISIndex

Attachment

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

Owner

Attachment

Owner of the document.

LoginUserRights

Attachment

Rights of the logged in User on the Document.

NoOfObjects

Attachment

Number of Attachments on an object.

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 exist in the System.

-50071

Document has been checked out.

Attachments cannot be added to a checked out document.

-50022

Insufficient rights for the current operation.

User must have Change Rights on document for which Attachments are to be added.

-50032

Insufficient rights for the current operation.

User does not have Rights on Data Class associated with document for which Attachments are to be added. User must have Read Rights on Data Class associated with document.

-50056

Page not found.

Page specified in input to which the User wants to attach data, does not exists for the document.