Previous Topic: getPermissionGroupsNext Topic: addComment


getComments

The following parameters apply to the getComments method:

Parameter

Type

Description

SID

Integer

Identifies the session retrieved from logging in.

docIds

String

Identifies the document IDs for all the comments you want to retrieve.

Note: Use commas to separate, for example, "400001,400002".

Description

Gets all the comments from documents.

Returns

A <UDSObjectList> node with zero or more <UDSObject> nodes describing O_COMMENTS with the following <Attributes> child nodes:

XML Element Value

Data Type

Description

id

Integer

Identifies the unique identifier for the comment most recently added.

DOC_ID

Integer

Identifies the document IDs for the comment recently added.

USER_ID

Integer

Identifies the ID of the person who submitted the comment.

USER_NAME

String

Identifies the user name of the person who submitted the comment.

EMAIL_ADDRESS

String

Identifies the email address of the person who submitted the comment.

COMMENT_TEXT

String

Identifies the text for the comment recently added.

COMMENT_TIMESTAMP

Date

Identifies the date and time the comment was added.