Request parameter tables

Element XML-RPC Data Type Description API Methods
sid string

Session identifier, 40 characters (a-z, 0-9)

All except login
username string The username login
password string The password login
name string The name of the folder that contains the submissions, maximum 200 characters

group.add

folder.add

folder_group string The name of the folder group that contains the folder

folder.add

group.folders

description string A description of the folder group folder.add
id int Id of the newly created element

folder.get

folder.trash

user.drop

document.get

document.trash

report.get

group.get

group.drop

document_remove_from_index

exclude_quotes boolean Exclude quotes from the folder or report

folder.add

report.get

report.get_document

exclude_biblo boolean Exclude the bibliography from the folder or report

folder.add

folder.put

report.get

exclude_phrases boolean Exclude phrases from the folder or report

folder.add

folder.put

report.get

exclude_small_matches* boolean Exclude small matches from the folder or report

folder.add

folder.put

report.get

exclude_by_percent boolean Set to true to exclude small matches by percent. Set to false to exclude small matches by word count.

folder.add

folder.put

report.get

exclude_percent boolean The percent that the small match would be to be excluded from the report (a value between 1 and 100)

folder.add

folder.put

report.get

exclude_word_count boolean The word count that the small match would be to be excluded from the report (a value between 1 and 1000)

folder.add

folder.put

report.get

exclude_abstract boolean Exclude the abstract from the folder or report

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 base64-encoded document 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

* If exclude_small_matches is true, then exclude_by_percent has to be set to either true or false (true if excluding by percent, false if excluding by word count). If exclude_by_percent is true, then exclude_percent must be set to the percentage value (between 1 and 100). If exclude_by_percent is false, then exclude_word_count must be set to the word count value (between 1 and 1000).

Need to contact a human?

Get in touch