NGOPostDocument

This call is used to post a set of documents to the Inbox Folder of a User. If a Data Class is associated with the document to be posted and the logged in User does not have Read Rights on the Data Class, then the document is copied to the target User’s Inbox without the DataClass otherwise it is moved with the DataClass.

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.

NGOPost

Document

N/A

CabinetName

Root

Name of the Cabinet to which 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

CurrentDateTime

Root

Date and Time at which the operation is being performed.

Valid Date in the format- yyyy-mm-dd hh:mm:ss

Current System Date and Time

UserIndex

Root

Index of the User to whose Inbox the documents are to be posted.

Integer > =0

N/A

DocumentIndex

Root

Index of the document to be posted.

Integer >= 0

NULL

NameLength

Root

The maximum length of document name supported by JTS is 255 characters but, if the User wishes that the maximum length of document name is lesser than 255 characters then it can be specified in the tag. The Document Name, if larger than the NameLength, will then be truncated to the specified length. This parameter is required when we have to generate a new name for the document, as some document with the same name already exists in the Inbox of the User specified.

Integer >0

NULL

ParentFolderIndex

Root

The Index of Parent Folder to which the document belongs.

Integer >=0

NULL

RightsFlag

Root

If RightFlag is 'Y' then only owner or supervisor can post the document else user having read and change rights can do so.

‘Y’ – Yes

‘N’ – No

 

 

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.

 

Errors returned from call

Code

Message

Comments

-50023

Document not found.

One of the specified documents does not exist.

-50138

User not Owner or supervisor.

The User who is trying to post the documents is not the Owner or Supervisor.

-50017

Folder not found.

Destination folder does not exist in the System.

-50021

Folder is in used.

Destination folder has been locked for some purpose.

-50019

Properties of the Folder have been finalized.

Properties of destination Folder have been finalized.

-50170

Document is deleted or moved.

Document to be copied / moved has been deleted or moved to some other folder.

-50132

Document has been deleted.

Document to be copied / moved has been moved to User’s Trash Folder.

-50070

Cannot copy document.

Document could not be copied because either the source folder or destination folder has improper type.

-50022

Insufficient rights for the current operation.

Insufficient Rights on document.

-50018

Insufficient rights for the current operation.

Insufficient Rights on folder.

-50072

Document already exists.

Document to be moved already exist in the destination Folder.

-50136

 

Document reference already exists.

Reference of the document to be moved already exists in the destination Folder.

-50023

Document not found.

 

Document to be moved does not exist in the System.

-50133

 

Folder has been deleted.

Destination Folder has been deleted.

-50068

Cannot move document.

Cannot move the document, as the type of either the source or destination Folder is improper.

-50026

Document is in use.

 

Document is locked.

-50071

Document has been checked out.

Some User has checked out document.

-50028

Data Class not found.

DataDefinition associated with the document to be posted does not exist. This error occurs while checking Rights on the Data Definition associated with the document.

-50076

Invalid object access type.

Access type of DataDefinition associated with the document is improper. This error occurs while checking Rights on the data definition associated with the document to be posted.