Request parameter tables

Element XML-RPC Data Type DescriptionAPI Methods
sidstring

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

All except login
usernamestringThe usernamelogin
passwordstringThe passwordlogin
namestringThe name of the folder that contains the submissions, maximum 200 characters

group.add

folder.add

folder_groupstringThe name of the folder group that contains the folder

folder.add

group.folders

descriptionstringA description of the folder groupfolder.add
idintId 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_quotesbooleanExclude quotes from the folder or report

folder.add

report.get

report.get_document

exclude_biblobooleanExclude the bibliography from the folder or report

folder.add

folder.put

report.get

exclude_phrasesbooleanExclude phrases from the folder or report

folder.add

folder.put

report.get

exclude_small_matches*booleanExclude small matches from the folder or report

folder.add

folder.put

report.get

exclude_by_percentbooleanSet 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_percentbooleanThe 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_countbooleanThe 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_abstractbooleanExclude the abstract from the folder or report

folder.add

folder.put

exclude_methodsbooleanExclude the methods and materials section from the folder or report

folder.add

folder.put

shared_witharray of integersIds of users the folder is to be shared withfolder.sharing
add_to_indexbooleanAdds the folder to the search index Required if the account has a private nodefolder.add
first_namestringFirst name for a user, maximum 4096 charactersuser.add
last_namestringLast name for a user, maximum 4096 charactersuser.add
timezoneintNumeric timezone ID, defaults to 126 ‘America/Los_Angeles’. See the appendix for available timezones user.add
submit_toint1=> ’Generate Report Only’ 2=> ’to Document Repository Only’ (private storage node required) 3=> ‘to Document Repository & Generate Report’ (private storage node required)document.add
uploadsarray of arraysAn array of document data. Each array element contains an elements as follows: title, author_first, author_last, filename, uploaddocument.add
titlestring The title of the document, maximum 256 charactersdocument.add
author_firststringThe document author’s first name, maximum 200 charactersdocument.add
author_laststringThe document author’s last name, maximum 200 charactersdocument.add
uploadbase64The base64-encoded documentdocument.add
callback_urlstring A url which will be fetched with the document id when the report is generated. For asynchronous uploading.document.add
ostringOrder by parameter, accepts a folder, group, or user attribute to order the results by

folder.list

group.list

user.list

pstring Specify which page of a pager results set to return

folder.list

group.list

user.list

rstringSpecify number of rows to return

folder.list

group.list

user.list

dstringReverse 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).

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