Manuals, Tutorials, and More

Home > iThenticate > iThenticate API Guide > API Method Reference

API Method Reference

Login

 

The login method is used to authenticate a session. A session is initiated by supplying valid authentication credentials (username and password) to the login method and a session id (sid) is returned that must be included when making additional requests.


Method Name: login


Arguments: username, password


Returns: sid, api_status, response_timestamp


Errors: Returns errors on unsuccessful login attempts. The error handling is split between the errors field and the messages field. Some possible combinations are:

  • If the password is too short, an error will be present in the errors element indicating the password was too short, and no informational message will exist in the messages element.
  • If the username was not a valid email address, an errors element will be presented indicating that fact, and no informational message will exist.
  • The existence of errors is usually accompanied by a status code of ‘500’. 

 

Messages: Unsuccessful login attempts may also return error messages in this messages element. Some possible messages are as follow:

 

  • If the username was of the correct form, but does not exist in the system, the generic message “Sorry, failed to log in.” will be returned in the messages element. This error message (in the messages element, NOT the errors element) will also be returned if the username was valid and the password was incorrect (note that this will not be the case for an INVALID password, one that is too short or does not contain the characters needed for a valid password).
  • If the API client has not been authorized to connect with the IP address it is using, the error message (in the messages element, NOT the errors element) will be Access denied from 127.0.0.1”, with the invalid IP address presented in the message
  • (127.0.0.1 used as an example).
  • Multiple messages may be presented, for situations where invalid username/password combinations are submitted, as well as invalid access attempts. However, both errors and messages will not be presented simultaneously (the API client MUST examine all possible combinations of messages and errors, except for messages and errors simultaneously, to determine if an error condition exists). However, as a convenience approach, checking for the existence of the sid element is usually sufficient to guarantee a successful login. 
  • The existence of (error) messages is usually accompanied by an api_status element value of ‘401’.

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>login</methodName>
     <params>
         <param><value><struct>
             <member>
             <name>password</name>
             <value><string>bar</string></value>
             </member>
     <member>
     <name>username</name>
     <value><string>foo@example.com</string></value>
     </member>
             </struct></value></param>
     </params>
</methodCall>

Example Response 

 

<struct>
 <member>
     <name>sid</name>
     <value><string>ce22ce7de1963cc838c29869eec81a46fec4d847</string></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
</struct>

Create Folder Group

 

Use this method to create a folder group.


Method Name: group.add


Arguments: sid, name


Returns: sid, api_status, response_timestamp, id


Errors: None


Messages: Message indicating successful folder creation

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>group.add</methodName>
     <params>
     <param><value><struct>
         <member>
         <name>sid</name>
         <value><string>7f5257b23706f66a3484df1078daaddf78f3a435</string></value>
         </member>
     <member>
         <name>name</name>
         <value><string>2627_test_group_314</string></value>
     </member>
         </struct></value></param>
     </params>
</methodCall>

Example Response 

 

<struct>
 <member>
     <name>sid</name>
     <value><string>7f5257b23706f66a3484df1078daaddf78f3a435</string></value>
 </member>
 <member>
     <name>messages</name>
     <value><array><data>
     <value><string>Folder Group Created</string></value>
     </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
 <member>
     <name>id</name>
     <value><int>119</int></value>
 </member>
</struct>

List Folder Groups

 

Use this method to list all folder groups owned by this user.


Method Name: group.list


Arguments: sid


Returns: sid, api_status, response_timestamp, groups


Errors: None


Messages: None

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>group.list</methodName>
     <params>
     <param><value><struct>
         <member>
         <name>sid</name>
         <value><string>52d868fce4a8f16db1c69a5918cc1affc4b61b19</string></value>
         </member>
         </struct></value></param>
     </params>
</methodCall>

Example Response

 

<struct>
 <member>
     <name>sid</name>
     <value><string>52d868fce4a8f16db1c69a5918cc1affc4b61b19</string></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value></member>
 <member>
     <name>groups</name>
     <value>
         <array>
         <data>
             <value>
             <struct>
                 <member>
                 <name>name</name>
                 <value><string>13073_test_group_947</string></value>
                 </member>
                 <member>
                 <name>id</name>
                 <value><int>120</int></value>
                 </member>
             </struct>
     </value>
 <value>
     <struct>
         <member>
         <name>name</name>
         <value><string>2531_test_group_633</string></value>
         </member>
         <member>
         <name>id</name>
         <value><int>116</int></value>
         </member>
     </struct>
 </value>
     </data>
     </array>
 </value>
 </member>
</struct>

List Folders

 

Use this method to list all folders owned by this user.


Method Name: folder.list


Arguments: sid


Returns: sid, api_status, response_timestamp, folders, groups, pager


Errors: None


Messages: None

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>folder.list</methodName>
     <params>
     <param><value><struct>
         <member>
         <name>sid</name>
         <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
         </member>
         </struct></value></param>
     </params>
</methodCall>

Example Response 

 

<struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
     <name>folders</name>
     <value><array><data>
     <value><struct>
         <member>
         <name>group</name>
         <value><struct>
             <member>
             <name>name</name>
             <value><string>2531_test_group_633</string></value>
             </member>
             <member>
             <name>id</name>
             <value><int>116</int></value>
             </member>
         </struct></value>
         </member>
 <member>
     <name>name</name>
     <value><string>2531_testfolder_438</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>259</int></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>
</struct>

Create Folder

 

Use this method to create a new folder.


Method Name: folder.add


Arguments: sid, name, folder_group, description, exclude_quotes, add_to_index, exclude_biblio, exclude_phrases, exclude_small_matches, exclude_abstracts, exclude_methods


Returns: sid, api_status, response_timestamp


Errors: Returns an error message if an invalid folder group is specified


Message: Returns a message on folder creation success, no message on errors

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>folder.add</methodName>
     <params><param>
         <value><struct>
         <member>
         <name>sid</name>
         <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
         </member>
 <member>
     <name>folder_group</name>
     <value><int>123</int></value>
 </member>
 <member>
     <name>name</name>
     <value><string>6016_testfolder_773</string></value>
 </member>
 <member>
     <name>description</name>
     <value><string>API client test folder</string></value>
 </member>
 <member>
     <name>exclude_quotes</name>
     <value><boolean>1</boolean></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

Example Response 

 

<struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
     <name>messages</name>
     <value><array><data>
         <value><string>Folder created</string></value>
     </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
 <member>
     <name>id</name>
     <value><int>262</int></value>
</member>
</struct>

Adjust Folder Settings 

 

Use this method to adjust a folder’s settings.


Method Name: folder.put


Arguments: sid, id, name, description, exclude_quotes, add_to_index, exclude_biblio, exclude_phrases, exclude_small_matches, exclude_abstracts, exclude_methods


Returns: sid, api_status, response_timestamp


Errors: Returns an error message if an invalid folder group is specified


Message: Returns a message on folder creation success, no message on errors

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>folder.put</methodName>
     <params><param>
     <value><struct>
         <member>
         <name>sid</name>
         <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
         </member>
         <member>
         <name>id</name>
         <value><int>262</int></value>
         </member>
 <member>
     <name>name</name>
     <value><string>6016_testfolder_773</string></value>
 </member>
 <member>
     <name>description</name>
     <value><string>API client test folder</string></value>
 </member>
 <member>
     <name>exclude_quotes</name>
     <value><boolean>0</boolean></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

Example Response 

 

<struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
     <name>messages</name>
     <value><array><data>
     <value><string>Folder created</string></value>
     </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
 <member>
     <name>id</name>
     <value><int>262</int></value>
</member>
</struct>

Share Folder

 

Set folder sharing.


Method Name: folder.sharing


Arguments: sid, id, shared_with


Returns: sid, api_status, response_timestamp


Errors: Returns an error message if an errors occurs


Message: Returns a message on folder sharing success

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>folder.sharing</methodName>
     <params><param>
         <value><struct>
         <member>
         <name>sid</name>
         <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
         </member>
 <member>
     <name>id</name>
     <value><int>262</int></value>
 </member>
 <member>
     <name>shared_with</name>
     <value><array><data>
         <int>262</int>
         <int>263</int>
     </data></array></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

 Example Response

 

<struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
    <name>api_status</name>
    <value><int>200</int></value>
 </member>
 <member>
    <name>messages</name>
    <value><array><data>
        <value><string>Your sharing preferences have been updated</string></value>
    </data></array></value>
 </member>
</struct>

List Group Folders 

 

Use this method to list the folders in a folder group.


Method Name: group.folders


Arguments: sid, id


Returns: sid, api_status, response_timestamp, groups, folders, pager


Errors: Returns an error message if an invalid folder_group id is specified


Messages: None

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>group.folders</methodName>
     <params><param>
     <value><struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>123</int></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

Example Response

 

<struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
     <name>folders</name>
     <value><array><data>
     <value><struct>
 <member>
     <name>group</name>
     <value><struct>
 <member>
     <name>name</name>
     <value><string>6016_test_group_169</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>123</int></value>
 </member>
 </struct></value>
 </member>
 <member>
     <name>name</name>
     <value><string>6016_testfolder_773</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>262</int></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>
</struct>

Get Folder

 

Use this method call to get a folder and it’s associated objects.


Method Name: folder.get


Arguments: sid, id


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


Errors: Returns an error message if an invalid folder id is specified


Messages: None

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>folder.get</methodName>
     <params><param>
     <value><struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>262</int></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

Example Response 

 

<struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
     <name>documents</name>
     <value><array><data></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>0</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>6016_test_group_169</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>123</int></value>
 </member>
 </struct></value>
 </member>
 <member>
     <name>name</name>
     <value><string>6016_testfolder_773</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>262</int></value>
 </member></struct></value>
 </member>
</struct>

 Account Status

 

Use this method to get the current account status.


Method Name: account.get


Arguments: sid


Returns: sid, api_status, response_timestamp, account


Errors: None


Messages: None

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>account.get</methodName>
     <params><param>
     <value><struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

Example Response

 

<struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
     <name>account</name>
     <value><struct>
 <member>
     <name>words_per_Page</name>
     <value><int>1500</int></value>
 </member>
 <member>
     <name>report_limit</name>
     <value><int>10000</int></value>
 </member>
 <member>
     <name>report_count</name>
     <value><int>1534</int></value>
 </member>
 <member>
     <name>user_limit</name>
     <value><int>10000</int></value>
 </member>
 <member>
     <name>resubmission_limit</name>
     <value><int>10000</int></value>
 </member>
 <member>
     <name>resubmission_count</name>
     <value><int>1050</int></value>
 </member>
 <member>
     <name>valid_until</name>
     <value><string>2009-04-19T00:00:00</string></value>
 </member>
 <member>
     <name>user_count</name>
     <value><int>8</int></value>
 </member>
 <member>
     <name>unit_name</name>
     <value><string>Page</string></value>
 </member>
 </struct></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
</struct>

Add User

 

Use this method to add a user to the account. Only the administrator user is authorized to use this method.


Method Name: user.add


Arguments: sid, email, first_name, last_name


Optional arguments: timezone, report_group, can_submit_documents, share_folders, can_index_documents*, is_admin, password (optional - if no password is specified users will receive an activation email with a temporary password)


*can_index_documents is an option only for accounts that have a customer repository enabled for the account.


Returns: sid, api_status, response_timestamp, id


Errors: Returns an error message if invalid arguments are passed, detailing which arguments were invalid.


Messages: Returns a message indicating the user was added. No messages will be present if errors occurred in the transaction.

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>user.add</methodName>
     <params><param>
     <value><struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
     <member>
     <name>email</name>
     <value><string>joe@user.com</string></value>
 </member>
 <member>
     <name>password</name>
     <value><string>swizzlestick123</string></value>
 </member>
 <member>
     <name>timezone</name>
     <value><int>126</int></value>
 </member>
 <member>
     <name>last_name</name>
     <value><string>User</string></value>
 </member>
 <member>
     <name>first_name</name>
     <value><string>Joe</string></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

 Example Response

 

<struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
     <member>
     <name>messages</name>
     <value><array><data>
     <value><string>Joe User Created</string></value>
     </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
 <member>
     <name>id</name>
     <value><int>22</int></value>
 </member>
</struct>

List Users

 

This method lists users in the account. Only the administrator user is authorized to use this method.


Method Name: user.list


Arguments: sid


Returns: sid, api_status, response_timestamp, users


Errors: None


Message: None

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>user.list</methodName>
     <params><param>
         <value><struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

Example Response 

 

<struct>
 <member>
     <name>sid</name>
     <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
 <member>
 <name>users</name>
     <value><array><data>
     <value><struct>
 <member>
     <name>email</name>
     <value><string>api_test_user@test.api.ithenticate.com</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>17</int></value>
 </member>
 <member>
     <name>last_name</name>
     <value><string>User</string></value>
 </member>
 <member>
     <name>first_name</name>
     <value><string>API Test</string></value>
 </member>
 </struct></value>
 <value><struct>
     <member>
     <name>email</name>
 <value><string>joe@user.com</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>22</int></value>
 </member>
 <member>
     <name>last_name</name>
     <value><string>User</string></value>
 </member>
 <member>
     <name>first_name</name>
     <value><string>Joe</string></value>
 </member>
 </struct></value>
 </data></array></value>
 </member>
</struct>

Submit Document

 

This method is used to submit a document to a given folder for submission to the document processing system.

 

Method Name: document.add

 

Arguments: sid, folder, submit_to, uploads

 

Returns: sid, api_status, response_timestamp, uploaded

 

Errors: Returns an error message if invalid input arguments are passed 

 

Messages: Returns messages indicating successful document submission. No messages will be present if errors occurred

 

Submission Requirements:

 

  • File must be less than 20 MB
  • The maximum document length is 400 pages.
  • File Types allowed: MS Word, WordPerfect, PostScript, PDF, HTML, RTF, OpenOffice (ODT) and plain text. 

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>document.add</methodName>
     <params><param>
         <value><struct>
             <member>
             <name>sid</name>
             <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value>
             </member>
 <member>
     <name>uploads</name>
     <value><array><data>
     <value><struct>
     <member>
     <name>filename</name>
     <value><string>/tmp/CVxcXdk3lT.txt</string></value>
 </member>
 <member>
     <name>author_last</name>
     <value><string>Neuman</string></value>
 </member>
 <member>
     <name>upload</name>
     <value><base64>Zm9vIGJhciBiaXo=</base64></value>
 </member>
 <member>
     <name>title</name>
     <value><string>6016 ithenticate test doc 509</string></value>
 </member>
 <member>
     <name>author_first</name>
     <value><string>Alfred</string></value>
 </member>
 </struct></value>
 </data></array></value>
 </member>
 <member>
     <name>submit_to</name>
     <value><int>1</int></value>
 </member>
 <member>
     <name>folder</name>
     <value><int>262</int></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

Example Response

 

<struct>
 <member>
     <name>sid</name>
     <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value>
 </member>
 <member>
     <name>messages</name>
     <value><array><data>
     <value><string>Uploaded 1 document successfully</string></value>
     </data></array></value>
 </member>
 <member>
     <name>uploaded</name>
     <value><array><data>
     <value><struct>
 <member>
     <name>filename</name>
     <value><string>/tmp/0dxBM2vB3i.txt</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>2161</int></value>
 </member>
 <member>
     <name>folder</name>
     <value><struct>
 <member>
     <name>name</name>
     <value><string>7497_testfolder_199</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>265</int></value>
 </member>
 </struct></value></member>
 <member>
     <name>mime_type</name>
     <value><string>text/plain</string></value>
 </member>
 </struct></value>
 </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
</struct>

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>

Get Similarity Report

 

This method returns a set of urls to report data for a document section.


Method: report.get


Arguments: id (document part/section id), sid, exclude_biblio, exclude_quotes, exclude_small_matches


Returns: sid, api_status, response_timestamp, report_url, view_only_url, view_only_expires, exclude_quotes, exclude_biblio, exclude_small_matches


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

 

Messages: None

 

Note: When retrieving the view_only_url for a report you may add a query parameter “report_type” to specify which report viewing mode to open the Similarity Report in. The available report types are: similarity, content, largest, and summary. Here is an example of the view_only url with the addition of a report_type query parameter:
 

https://app.ithenticate.com/view_rep...t_type=content


If the report_type parameter is not used the Similarity Report will open in the default report viewing mode that was set for the account

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>report.get</methodName>
     <params><param>
     <value><struct>
     <member>
         <name>sid</name>
         <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value>
     </member>
 <member>
     <name>id</name>
     <value><int>8896</int></value>
 </member>
<member>
     <name>exclude_quotes</name>
     <value><boolean>1</boolean></value>
 </member>
 <member>
     <name>exclude_biblio</name>
     <value><boolean>1</boolean></value>
 </member>
 <member>
     <name>exclude_small_matches</name>
     <value><boolean>1</boolean></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>

Example Response

 

<struct>
 <member>
     <name>sid</name>
     <value><string>432d8b581da65ae89f9683803e750884d022c568</string></value>
 </member>
 <member>
     <name>status</name>
     <value><int>200</int></value>
 </member>
 <member>
     <name>view_only_expires</name>
     <value><dateTime.iso8601>2008-06-27T20:54:24Z</dateTime.iso8601></value>
 </member
 <member>
     <name>response_timestamp_</name>
     <value><dateTime.iso8601>2008-06-27T20:34:24Z</dateTime.iso8601></value>
 </member>
 <member>
     <name>report_url</name>
     <value><string>http://api.ithenticate.com/report/1233814/similarity</string></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
 <member>
     <name>view_only_url</name>
     <value><string>https://api.ithenticate.com/view_report/6DE5D6A2-4488-11DD</string>
     </value>
 <member>
</struct>

Get Similarity Report for first Document Section

 

This method returns the “report_url” data for the first document section

 

Method: report.get_document

 

Arguments: id (document part/section id), sid, exclude_biblio, exclude_quotes, exclude_small_matches


Returns: sid, api_status, response_timestamp, report_url, view_only_url,view_only_expires, exclude_quotes, exclude_biblio, exclude_small_matches


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


Message: None

Example Request  

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>report.get_document</methodName>
     <params><param>
     <value><struct>
 <member>
     <name>sid</name>
     <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value>
 </member>
 <member>
     <name>id</name>
     <value><int>8896</int></value>
 </member>
 <member>
     <name>exclude_quotes</name>
     <value><boolean>1</boolean></value>
 </member>
     <member>
     <name>exclude_biblio</name>
     <value><boolean>1</boolean></value>
 </member>
 <member>
     <name>exclude_small_matches</name>
     <value><boolean>1</boolean></value>
 </member>
 </struct></value>
 </param></params>
</methodCall>


Example Response  

 

<struct>
 <member>
     <name>sid</name>
     <value><string>432d8b581da65ae89f9683803e750884d022c568</string></value>
 </member>
 <member>
     <name>status</name>
     <value><int>200</int></value>
 </member>
 <member>
     <name>view_only_expires</name>
     <value><dateTime.iso8601>2008-06-27T20:54:24Z</dateTime.iso8601></value>
 </member>
 <member>
     <name>response_timestamp</name>
     <value><dateTime.iso8601>2008-06-27T20:34:24Z</dateTime.iso8601></value>
 </member>
 <member>
     <name>report_url</name>
     <value><string>https://api.ithenticate.com/report/1233814/similarity</string></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
 <member>
     <name>view_only_url</name>
     <value><string>https://api.ithenticate.com/view_report/6DE5D6A2-4488-11DD</string> 
     </value>
 </member>
</struct>

Drop User

 

A method call to drop a user from the account. Only the administrator user is authorized to use this method.


Method Name: user.drop


Arguments: sid, id


Returns: sid, api_status, response_timestamp


Errors: Returns an error if an invalid user id was passed


Message: Returns a message indicating the user was deleted. No message will be returned if errors occurred

Example Request

 

Example Request

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

Example Response

 

<struct>
 <member>
     <name>sid</name>
     <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value>
 </member>
 <member>
     <name>messages</name>
     <value><array><data>
     <value><string>User Joe User Deleted</string></value>
 </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
</struct>

Trash a Document

 

This method moves a document to the trash folder.


Method: document.trash


Arguments: sid, id


Returns: sid, api_status, response_timestamp


Errors: Returns an error if an invalid document id was passed


Message: Returns a message indicating the document was trashed. No message will be present if errors occurred

Example Request

 

<?xml version=”1.0” encoding=”UTF-8”?>
<methodCall>
 <methodName>document.trash</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

 

<struct>
 <member>
     <name>sid</name>
     <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value>
 </member>
 <member>
     <name>messages</name>
     <value><array><data>
     <value><string>Document moved to trash</string></value>
     </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
</struct>

 Trash a Folder

 

This method moves a folder to the trash folder group. The folder must be empty of documents.


Method: folder.trash


Arguments: sid, id


Returns: sid, api_status, response_timestamp


Errors: An error will be returned if the folder is not empty


Message: Returns a message indicating the group was deleted.

Example Request

 

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

Example Response 

 

<struct>
 <member>
     <name>sid</name>
     <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value>
 </member>
 <member>
     <name>messages</name>
     <value><array><data>
     <value><string>Folder “7497_testfolder_199” Moved to Trash</string></value>
     </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
</struct>

Delete a Folder Group

 

This method deletes a folder group. The group must be empty of folders to be deleted.


Method: group.drop


Arguments: sid, id


Returns: sid, api_status, response_timestamp


Errors: An error will be returned if the folder is not empty


Message: Returns a message indicating the group was deleted

Example Request

 

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

Example Response 

 

<struct>
 <member>
     <name>sid</name>
     <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value>
 </member>
 <member>
     <name>messages</name>
     <value><array><data>
     <value><string>Group “7497_test_group_794” removed</string></value>
     </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
</struct>

Remove Documents from Private Node

 

This method removes document/s from the private node. This method only applies to
accounts that have purchased the private node.


Method: document.remove_from_index


Arguments: sid, id


Returns: sid, api_status, response_timestamp


Errors: Returns an error if an invalid document id was passed


Message: Returns a message indicating the document was removed from the private node. No message will be present if errors occurred

Example Request

 

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

Example Response

 

<struct>
 <member>
     <name>sid</name>
     <value><string>5d58f1491c3355c6dfbdeccd76429a6c3a94cdc1</string></value>
 </member>
 <member>
     <name>messages</name>
     <value><array><data>
     <value><string>Document queued for removal from your index</string></value>
 </data></array></value>
 </member>
 <member>
     <name>api_status</name>
     <value><int>200</int></value>
 </member>
</struct>
You must to post a comment.
Last modified
11:22, 24 May 2016

Tags

This page has no custom tags.

Classifications

(not set)