GetCommentList API
The GetCommentList API retrieves all of the comments associated with a document.
To retrieve comments for a document, the user must have permission to view the document
(either as a reviewer or as an approver). If the user does not have permission to
view the document, an error message is returned. Document authors can enable other users to
view documents by inviting them to review or approve the documents.
Applications should call GetCommentList no more frequently than once every fifteen
minutes per client.
Parameters
This call takes the following query string parameters:
|
Parameter
|
Description
|
|
token |
The user's authentication token. Required. |
|
doc_id |
The integer ID of the document. Required. |
You can retrieve the integer ID of a document by calling one of the document list methods, such as GetActionableDocumentList.
XML Example
This URL executes a GetCommentList call.
Here is the return XML from this call.