GetReviewerList API
The GetReviewerList API retrieves a list of people who are authorized to view a
document (this includes reviewers and approvers, as
well as the document's author).
This list corresponds to the data found in the "Who's Working on this Document?"
panel found on document.aspx.
Applications should call GetReviewerList no more frequently than once every fifteen
minutes per client.
Parameters
This call takes the following query string parameters:
|
Parameter
|
Description
|
|
app_key |
Your application key. Required. |
|
token |
The user's authentication token. Required. |
|
doc_id |
The integer ID of the document. |
Return Values
This call returns a <reviewers> node that contains a collection of <reviewer>
nodes. The child nodes of the <reviewer> node are:
|
Parameter
|
Description
|
|
username |
The reviewer's Approver.com user name. |
|
fullname |
The reviewer's full (first and last) name. |
|
viewed |
Denotes whether the user has viewed this document or not. True or False. |
|
role |
An integer denoting the role of the user for this document:
| 1 |
Author |
| 2 |
Approver |
| 3 |
Reviewer |
|
|
creationdate |
The date and time the user was requested to review or approve the document (not
necessarily
the date/time the document was created). This date is expressed in
RFC 1123 format. |
|
lastmodified |
The date and time the invitation to review the document was last modified (not necessarily
the
date/time the document was last modified). This date is expressed in
RFC 1123 format. |
XML Example
This URL executes a GetReviewerList call.
Here is the return XML from this call.