Manuals, Tutorials, and More

Home > iThenticate > iThenticate API Guide > Request and Response Parameter Tables

Request and Response Parameter Tables

API Request Parameters

 

Element XML-RPC Data Type Description API Methods
sid string Exclude the methods and materials section from the folder or report All except login
username string Ids of users the folder is to be shared with login
password string Adds the folder to the search index Required if the account has a private node login
name string First name for a user, maximum 4096 characters

group.add

folder.add

folder_group int Last name for a user, maximum 4096 characters

folder.add

group.folders

description string Numeric timezone ID, defaults to 126 ‘America/Los_Angeles’. See the appendix for available timezones folders.add
id int 1=> ’Generate Report Only’
2=> ’to Document Repository Only’ (private storage node required)
3=> ‘to Document Repository & Generate Report’ (private storage node required)

folder.get

folder.trash

user.drop

document.get

document.trash

report.get

group.get group.drop

document_remove_from_ index

exclude_quotes boolean An array of document data. Each array element contains an elements as follows: title, author_first, author_last, filename, upload

folder.add

report.get

report.get_document

exclude_biblio

boolean The title of the document, maximum 256 characters

folder.add

folder.put

report.get

exclude_phrases boolean The document author’s first name, maximum 200 characters

folder.add

folder.put

report.get

exclude_small_matches boolean The document author’s last name, maximum 200 characters

folder.add

folder.put

report.get

exclude_abstract boolean The base64 encoded document content

folder.add

folder.put

exclude_methods boolean Exclude the methods and materials section from the folder or report

folder.add

folder.put

shared_with array of integers Ids of users the folder is to be shared with folder.sharing
add_to_index boolean Adds the folder to the search index Required if the account has a private node folder.add
first_name string First name for a user, maximum 4096 characters user.add
last_name string Last name for a user, maximum 4096 characters user.add
timezone int Numeric timezone ID, defaults to 126 ‘America/Los_Angeles’. See the appendix for available timezones user.add
submit_to int

1=> ’Generate Report Only’ 2=> ’to Document Repository Only’ (private storage node required)

3=> ‘to Document Repository & Generate Report’ (private storage node required)

document.add
uploads array of arrays An array of document data. Each array element contains an elements as follows: title, author_first, author_last, filename, upload document.add
title string The title of the document, maximum 256 characters document.add
author_first string The document author’s first name, maximum 200 characters document.add
author_last string The document author’s last name, maximum 200 characters document.add
upload base64 The document author’s last name, maximum 200 characters document.add
callback_url string A url which will be fetched with the document id when the report is generated. For asynchronous uploading. document.add
o string Order by parameter, accepts a folder, group, or user attribute to order the results by

folder.list

group.list

user.list

p string Specify which page of a pager results set to return

folder.list

group.list

user.list

r string Specify number of rows to return

folder.list

group.list

user.list

d string Reverse the sort order for a record list

folder.list

group.list

user.list

API Response Parameters

 

Element XML-RPC Data Type Description API Methods
sid string Session identifier, 40 characters (a-z, 0-9) login
api_status int

200: Success

500: Application error

401: Authentication failure

403: Authorization failure

404: Does not exist or has been deleted

all
messages array List of one or more informational messages. These messages may or may not contain error conditions not listed in the errors field. all
errors struct List of one or more error messages. These are typically due to input data validation failures and thus associated with the specific input field, but may general in nature and require inspection of the messages field. all
response_timestamps dateTime.iso8601 An iso8601 XMLRPC field in UTC (with a ‘Z’ appended), returned only for responses that have a 200 api_status code. all
id int Id of the newly created element

group.add

folder.add

document.add

group.list

group.folder

user.add

groups array An array of group elements group.list
group struct A struct of group element attributes id, name all that return groups
folders array An array of folder elements

folder.list

group.list

folder struct A struct of folder element attributes id, name

folder.get

folder.list

group.list

pager struct Contains the following members: entries_per_page, total_entries, current_page

folder.list

group.list

entries_per_page int Number of entries per pager page any that return a pager
total_entries int Total number of records returned by the pager element any that return a pager
current_page int Current page of result set any that return a pager
account struct Contains members describing the account status account.get
users array An array of user elements user.list
user struct A struct of user element attributes (id, email, first_name, last_name)

user.list

user.get

report_url string A url to view the report which requires user authentication report.get
view_only_url string A view only report url which expires in a set amount of time report.get
view_only_expires dateTime.iso8601 The expiration time in minutes from the response_timestamp field at which the view_only_url expires. report.get
documents array An array of document structs. Each document struct has the following attributes: id, is_pending, author_first, author_last, uploaded_time, processed_time, percent_match, title, parts document.get
parts array An array of document part (section) structs. Each document part (section) struct has the following attributes: doc_id, score, words, folder, group, id, name document.get
doc_id int Document part (section) id document.get
max_percent_match int The largest source match percentage for the document document.get
score int Document part (section) score document.get
words int Number of words in document part (section) document.get
uploaded array An array of upload structs corresponding to uploads. Each upload struct has the following attributes: id, mime_type, filename, folder document.add
mime_type string The MIME type determined for an uploaded document ant that return an uploaded struct
is_pending int The number of document sections/ parts remaining to be processed by the document processing system after a document is uploaded. document.get
filename string The document filename any that return an uploaded struct

 

 

You must to post a comment.
Last modified
09:33, 23 May 2016

Tags

This page has no custom tags.

Classifications

(not set)