The following parameters apply to the addComment method:
|
Parameter |
Type |
Description |
|---|---|---|
|
SID |
Integer |
Identifies the session retrieved from logging in. |
|
comment |
String |
Identifies the comment to add. |
|
docId |
Integer |
Identifies the document ID for the comment you want to add. |
|
|
String |
Indicates the email address of the person who submitted the comment. Leave blank if you want the email address retrieved from the database based on the user ID parameter. |
|
username |
String |
Indicates the user name of the person who submitted the comment. Leave blank if you want the user name retrieved from the database based on the user id parameter. |
|
contactId |
String |
Indicates the ID of the person submitting the comment. If this contact ID exists in the database, the associated email and user name are retrieved and placed in the email and user name fields. If this ID does not exist, the email and user name parameters are used instead, if supplied. Use zero (0) if you are not using this parameter. Contact ID is UUID in string format. |
Description
Adds a comment to a particular document.
Returns
A <UDSObject> node with the following<Attributes> child nodes describing the comment most recently added:
|
XML Element Value |
Data Type |
Description |
|---|---|---|
|
id |
Integer |
Identifies the unique identifier for the comment most recently added. |
|
DOC_ID |
Integer |
Identifies the document ID for the comment most 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. |
|
Copyright © 2013 CA.
All rights reserved.
|
|