Approver.com

GetDocumentList API

The GetDocumentList API retrieves a list of all the documents in a user's queue. A user's document queue is comprised of documents created by that user, documents that others have invited the user to review or approve (actionable documents), as well as documents the user has already reviewed or approved (completed documents).

The My Documents page provides a complete listing of the user's document queue. To retrieve a subset of documents from the user's queue, use the GetActionableDocumentList call, which retrieves only actionable documents.

At present, there is no way to programmatically retrieve documents themselves. However, if you know the integer ID of the document, you can create a URL that links to the document on Approver.com. To access a document through the browser when its integer ID is known, use the URL http://approver.com/document.aspx?id=nn where nn is the numeric ID of the document.

The ability to retrieve documents programmatically is planned for a future release of the API.

Applications should call GetDocumentList no more frequently than once every fifteen minutes per client.

Parameters

This call takes the following query string parameters:

Return Values

This call returns a <documents> node that contains a collection of <document> nodes. Each <document> node contains the numeric ID of the document as an attribute. The child nodes of the <document> node are:

XML Example

This URL executes a GetDocumentList call.

Here is the return XML from this call.