Submissions:
Url: .../v1/submissions?id={id}&sort={sort}&dir={dir}&page={page}&count={count}&status={status}&assignedTo={assignedTo}&search={search}&category_id[0]={category_id[0]}&category_id[1]={category_id[1]}&include={include}
Returns a paged list of submissons associated with the current organization
Parameters:
id:
sort:
The attribute to sort by, 'submitted', 'category', or 'submitter' (string)(optional)
dir:
The direction you with to sort in, 'desc' or 'asc' (string)(optional)
page:
The page you wish to view in the paged list (int)(optional)
count:
The number of submissions per page (int)(optional)(200 limit)
status:
The status of the submissions to return: 'new', 'inprogress', 'accepted', 'declined', 'completed', 'withdrawn'
assignedTo:
search:
Submission title, author name, or submitter email address to search for (string)(optional). Only submissions matching this search in one or more of these fields will be returned.
category_id:
The submission category id (int)(optional). Only submissions in this category will be returned.
include:
A comma-separated list of additional objects to include with the response. Options are 'history', 'forms', and 'deletedFields'. (optional)
Returns:
{
current_page: 1
total_pages: [total pages]
total_items: [total item count]
items_per_page: [items per page]
items: [] - the start of the submissions array
0: {
url: .../v1/submissions/NNNNN
submission_id: [submission id]
date_created: [created date]
title: [submission title]
file_id: [file id]
status: [status of the submission: New, In-Progress, Withdrawn, Accepted, Declined]
is_archived: [true or false]
category: { - the category information for this submission
url: .../v1/categories/NNNNN
category_id: [category id]
name: [category name]
description: [category description]
blind_level: [the user permission level ?]
blind_value: [the permission level below which has limited submission visiblity]
}-
submitter: { - the submitter information for this submission
user_id: [user id]
first_name: [first name]
last_name: [last name]
email: [email address
}-
payment: - payment information for this submission
votes: { - voting information for this submission
count: N
score: N
average: N
}
assignments: - assignment information for this submission
labels: { - labels set for this submission
type: label
url: /v1/submissions/69469/labels
count: N
items: []
0: {
label_text: [label text]
label_color1: [first label color]
label_color2: [second label color]
}
}
form: form fields
files: [] - the files attached to this submission
0: {
id: [file id]
form_field_id: [field id]
guid: [file guid]
file_name: [ file name ]
file_extension: [file extension]
file_size: [file size in bytes]
mime_type: [file mime type]
url: .../v1/submissions/NNNNNN/file/[file id]
}
forms: url to all form data
history: url to all activity history
}
Url: .../v1/submissions/{id}?include={include}
Returns a submission object containing information about the submission with the requested id
Parameters:
id:
The submission id
include:
A comma-separated list of additional objects to include with the response. Options are 'history', 'forms', and 'deletedFields'. (optional)
Returns:
{
url: /v1/submissions/NNNNN
submission_id: NNNNN
date_created: [create date]
title: [title]
file_id: [file id]
status: [WithDrawn, In-Progress, Accepted, Declined]
submission_content: The body of an emailed submission
is_archived: [true/false]
category: { [category object]
url: /v1/categories/NNNNN
category_id: NNNNN
name: [category title]
description: [category description]
blind_level: [permission level text]
blind_value: [permission level int]
}
submitter: { [submitter object]
user_id: [user id]
first_name: [first name]
last_name: [last name]
email: [email address]
}
payment: [payment info]
votes: {
count: [total number of votes]
score: [calculated score]
average: [calculated average]
}
assignments: [assignment information]
labels: {
type: [label info]
url: /v1/submissions/NNNNN/labels
count: [number of labels on this submission]
items:
0: {
label_text: [label text]
label_color1: [label color in web format]
label_color2: [second label color in web format]
}
}
form: [form data]
files: []
0: {
guid: [file id]
file_name: [file name]
file_extension: [file extension]
file_size: [file size in bytes]
mime_type: [file mime type]
url: /v1/submissions/NNNNN/file/[file id]
}
forms: [url to all form data]
history: [url to all activity history]
}
Url: .../v1/submissions/{id}/history
Returns a list of history objects associated with the submission with the requested id
Parameters:
id:
The submission id (int)(required)
Returns:
{
type: [object name]
url: /v1/submissions/NNNNN/history
count: [number of history items]
items: [number returned]
0: {
submission_id: NNNNN
history_type: [item type]
history_date: [date created]
is_private: [true / false]
is_visible_to_submitter: [true / false]
email_message: [message sent if this was emailed]
note: [note text]
description: [description template]
replace_data: [data to insert into template]
user: {
user_id: [user info]
first_name: [first name]
last_name: [last name]
email: [email address]
}
}
Url: .../v1/submissions/{id}/forms?include={include}
Parameters:
id:
include:
Returns:
Url: .../v1/submissions/{id}/forms/{formId}?include={include}
Returns a list of form objects associated with the submission with the requested id. To view only the primary submission form, use form id = 0. To view any additional form, use that forms id.
Parameters:
id:
The submission id (int)(required)
formId:
0 for the primary form, or a form id of any additional form for the submission. (optional)
include:
By default, deleted fields will not be returned even if they have existing data. Specify 'deletedFields' to return all form fields. (optional)
Returns:
{
type: form
url: /v1/submissions/{submissionId}/forms/{formId}
count: [items returned]
items: []
0: {
label: [form field label]
data: [form field data]
blind: [true / false]
order: [field order index - 1-based]
}
}
Url: .../v1/submissions/{id}/assignments
Returns a list of assignment objects associated with the submission with the requested id
Parameters:
id:
The submission id (int)(required)
Returns:
{
type: assignment
url: /v1/submissions/NNNNNN/assignments
count: [item count[
items: []
0: {
user_id: [assigned user id]
staff_name: [name]
permission_level: [permission level text]
permission_value: [permission level int]
}
}
Url: .../v1/submissions/{id}/labels
Returns a list of label objects associated with the submission with the requested id
Parameters:
id:
The submission id (int)(required)
Returns:
{
type: label
url: /v1/submissions/NNNNNN/labels
count: [number of labels returned]
items: []
0: {
label_text: [label text]
label_color1: [first label color]
label_color2: [second label color]
}
}
Url: .../v1/submissions/{id}/file/{guid}
Get the File Stream of the file associated with the Submission with the requested ID
Parameters:
id:
The submissiond id (int)(required)
guid:
The guid of the requested file (Guid)(required)
Returns:
Returns the file contents. The MIME type header is returned.