Get document status

Get Document Status

This method is used to retrieve status information regarding a document and all its parts.

Method Name: document.get

Arguments: sid, id

Returns: sid, api_status, response_timestamp, id, pager, documents, folder

Errors: Returns an error message if an invalid document id is passed

Message: None

Example Request

<?xml version=”1.0” encoding=”UTF-8”?><methodCall> <methodName>document.get</methodName> <params><param> <value><struct> <member> <name>sid</name> <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value> </member> <member> <name>id</name> <value><int>2161</int></value> </member> </struct></value> </param></params></methodCall>

Example Response

This response contains match data from a document being processed.

<struct> <member> <name>sid</name> <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value> </member> <member> <name>documents</name> <value><array><data><value><struct> <member> <name>uploaded_time</name> <value><dateTime.iso8601>2008-06-05T15:13:11</dateTime.iso8601></value> </member> <member> <name>author_last</name> <value><string>Neuman</string></value> </member> <member> <name>is_pending</name> <value><int>1</int></value> </member> <member> <name>processed_time</name> <value><dateTime.iso8601>2008-06-05T15:30:02</dateTime.iso8601></value> </member> <member> <name>parts</name> <value><array><data> <value><struct> <member> <name>doc_id</name> <value><int>1210614</int></value> </member> <member> <name>score</name> <value><int>40</int></value> </member> <member> <name>max_percent_match</name> <value><int>10</int></value> </member> <member> <name>id</name> <value><int>1234465</int></value> </member> <member> <name>words</name> <value><int>15000</int></value> </member> </struct></value> <value><struct> <member> <name>doc_id</name> <value><int>1210614</int></value> </member> <member> <name>score</name> <value><int>100</int></value> </member> <member> <name>id</name> <value><int>1234466</int></value> </member> <member> <name>words</name> <value><int>15000</int></value> </member> </struct></value> <value><struct> <member> <name>doc_id</name> <value><int>1210614</int></value> </member> <member> <name>score</name> <value><int>100</int></value> </member> <member> <name>id</name> <value><int>1234468</int></value> </member> <member> <name>words</name> <value><int>12150</int></value> </member> </stuct></value> </data></array></value> </member> <member> <name>percent_match</name> <value><int>73</int></value> </member> <member> <name>title</name> <value><string>fasc0b</string></value> </member> <member> <name>id</name> <value><int>2161</int></value> </member> <member> <name>author_first</name> <value><string>Alfred</string></value> </member> </struct></value></data></array></value> </member> <member> <name>api_status</name> <value><int>200</int></value> </member> <member> <name>pager</name> <value><struct> <member> <name>total_entries</name> <value><int>1</int></value> </member> <member> <name>current_page</name> <value><int>1</int></value> </member> <member> <name>entries_per_page</name> <value><int>25</int></value> </member> </struct></value> </member> <member> <name>folder</name> <value><struct> <member> <name>group</name> <value><struct> <member> <name>name</name> <value><string>9133_test_group_858</string></value> </member> <member> <name>id</name> <value><int>1497</int></value> </member> </struct></value> </member> <member> <name>name</name> <value><string>9133_testfolder_858</string></value> </member> <member> <name>id</name> <value><int>46266</int></value> </member> </struct></value> </member></struct>

Thank you! Your feedback will help us to improve this guide.

Was this page helpful?


We're sorry to hear that

If you have the time, we'd love to know how we could improve it.

Need to contact a human?

Get in touch