Staff:
Url: .../v1/staff
Returns a list of staff objects associated with the current organization
Returns:
{
type: staff
url: /v1/staff
count: [number of items returned]
items: []
0: {
user_id: [user id]
first_name: [first name]
last_name: [last name]
title: [title]
email: [email address]
permission_level: [permission level as text]
permission_value: [permission level as int]
last_login_date: [date]
last_activity_date: [date]
last_activity_type: [activity type]
last_activity_submission_id: NN
url: /v1/staff/[user id]
}
Url: .../v1/staff/{id}
Returns a staff object containing information about the staff member with the requested id
Parameters:
id:
The staff id (Guid)(required)
Returns:
{
user_id: [user id]
first_name: [first name]
last_name: [last name]
title: [staff title]
email: [email address]
permission_level: [permission level text]
permission_value: NN
last_login_date: [date]
last_activity_date: [date]
last_activity_type: [activity type]
last_activity_submission_id: NN
url: /v1/staff/[user id]
}
Url: .../v1/staff/{id}/history
Returns a list of history objects created by the staff member with the specified id
Parameters:
id:
The staff id (Guid)(required)
Returns:
{
type: history
url: /v1/staff/[user id]/history
count: [number of items returned]
items: []
0: {
submission_id: NNNNNN
history_type: [history type name]
history_date: [date created UTC]
is_private: [true/false]
is_visible_to_submitter: [true/false]
email_message: [email message text if one was sent]
note: [note text]
description: [history description]
replace_data: [replacement data for template parameters]
user: {
user_id: [user id]
first_name: [first name]
last_name: [last name]
email: [email address]
}
}
Url: .../v1/staff/{id}/assignments?page={page}
Returns a list of submission objects assigned to the specified staff member
Parameters:
id:
The staff member id
page:
The page you wish to view in the paged list (int)(optional)
Returns:
{
url: /v1/staff//assignments
submission_id: NNNNN
date_created: [create date]
title: [title]
file_id: [file id]
status: [WithDrawn, In-Progress, Accepted, Declined]
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]
}
}