GetActionableDocumentList API
An actionable document is a document that requires a user's attention. Currently there are two kinds of actionable documents. If you are a designated as a document
reviewer and you have not yet viewed that document, that document is actionable
for you.
If you are designated as a document approver and you have not yet approved the document,
the document is also actionable for you.
Actionable documents appear at the top of a user's My Document queue to ensure they
get the user's attention when they log in.
The GetActionableDocumentList API retrieves a list of documents that are actionable
by the current user. If there are no documents that are actionable by the current
user, the call returns an empty <documents> node.
Parameters
This call takes the following query string parameters:
|
Parameter
|
Description
|
|
app_key |
Your application key. Required. |
|
token |
The user's authentication token. Required. |
Return Values
This call returns a <documents> node that contains a collection of <document>
nodes. The child nodes of the <document> node are:
|
Parameter
|
Description
|
|
name |
The name of the document. |
|
author |
The author of the document. The author's user name is returned in this node's "username"
attribute. |
|
action |
The action that the user needs to take (either "Please review" or "Please approve"). |
|
creationdate |
The date and time the user was requested to review or approve the document (not
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 the
date/time the document was last modified). This date is expressed in
RFC 1123 format. |
XML Example
This URL executes a GetActionableDocumentList call.
Here is the return XML from this call.