iThenticateDeveloperWebsite
Submit document
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 100 MB
- The maximum document length is 800 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>