Categories:
Url: .../v1/categories
Returns a list of category objects associated with the current organization
Returns:
{
type: category
url: /v1/categories
count: [number of categories returned]
items: []
0: {
url: /v1/categories/NNNNNN
form_url: [url to the submission form]
category_id:[NNNNNN]
name: [category name]
description: [category description]
blind_level: [permission level]
blind_value: [permission level]
start_date: [submission start date]
expire_date: [submission end date]
active: [true / false]
order: [category display order index]
}
}
Url: .../v1/categories/{id}
Returns a categories object containing information about the requested category
Parameters:
id:
The category id (int)(required)
Returns:
{
url: /v1/categories/NNNNN
form_url: [url for the submission form]
category_id: NNNNN
name: [category name]
description: [category description]
blind_level: [blind level]
blind_value: [blind level]
start_date: [category submission start date]
expire_date: [category submission end date]
active: [true / false]
order: [category display index]
formfields: {
type: formfield
url: /v1/categories/NNNNN/form
count: [number of form fields returned]
items: [] [the form fields for this category]
0: {
label: [form field label]
description: [form field description]
field_type: [field type name]
blind: [false / true]
order: [form field display index]
}
}
Url: .../v1/categories/{id}/submitters?page={page}&count={count}
Returns a paged list of users who have submitted to the category
Parameters:
id:
The category id (int)(required)
page:
The page you wish to view in the paged list (int)(optional)
count:
The number of users per page (int)(optional)
Returns:
{
current_page: [page index]
total_pages: [available pages]
total_items: [number of items returned]
items_per_page: [number of items per page]
items: []
0: {
user_id: [user id]
first_name: [first name]
last_name: [last name]
email: [email address]
}
}
Url: .../v1/categories/{id}/form
Returns a list of formfield objects associated with the submission with the requested id
Parameters:
id:
The submission id (int)(required)
Returns:
{
type: form
url: /v1/categories/NNNNN/form
count: [number of items returned]
items: []
0: {
label: [form field label]
description: [form field description]
field_type: [field type]
blind: [false / true]
order: [field display index[
}