API guide

Data is stored in documents compromising of a single Item. Firstly, each Item stores all the meta-data associated with the project it is associated with. Nested beneath the Item are Form(s). The Form contains all the meta-data required for the form. Beneath each Form are the Question(s). Questions contain all the information about the Question as well as a ‘response’ field which is the raw response input by the user.

key type description
project_id uuid ID of unique project.
project_shortlink shortlink Shortlink based on flickr base58
project_name string Name of project
project_desc string Description of project
start_date date Due date of the project.
end_date date Deadline of the project
project_prefs object Preferences of the item.
project_repeat_id uuid Shared ID if project repeated.
project_created date Date project created.
     
item_id uuid ID of unique item
item_name string Name of item.
item_shortlink shortlink Shortlink based on flickr base58
item_desc string Description of item.
lat float Latitude of item.
lon float Longitude of item.
item_name_id uuid Item ID shared between projects
item_pos integer Order for displaying items in project
item_prefs object Short for “preferences”, these are the settings for the item
item_created date Date item created.
     
form_id uuid ID of unique form
form_shortlink shortlink Shortlink based on flickr base58.
     
form_name_id uuid ID of form name
form_desc string Description of form.
name string Name of form
form_rep_id uuid Shared ID if form replicated
container_shortlink shortlink Shortlink to container based on flickr base58.
container_id uuid ID of container
container_desc string Description of container
container_int_id uuid ID of container instance
container_name string Name of container
container_location string Current location of conatiner
destination_location string Desintation of container
date_received date Date container received at destination
substance string Type of substance is the form questioning
     
form_perfs object Short for “preferences”, these are the settings for the form
form_pos integer Order for displaying forms
monitoring_purpose array reason for recording response
form_type string type of form collect – routine, adhoc etc
form_version integer Version of form – incremented each time form is updated
     
response_id uuid Unique id of the response.
form_shortlink shortlink Shortlink based on flickr base58.
question_desc string Description of question.
question string Name of question.
pos integer Position of the question in the form.
batch_id uuid If in batch – give UUID.
     
required boolean Is a response required (or optional)?
max float Max input value for response.
min float Min input value for response.
response_qualifier string Less than or more than symbol if response matches clamp high or low values.
clamp_high float If response value higher, round down to this value.
clamp_low float If response value lower, round up to this value.
decimal_places integer Number of decimal places allowed in response value.
round boolean Should response be rounded.
response_type string Type of reponse input e.g. date, number, text…
displayed boolean Should question by displayed (some calculated responses may not be require to be displayed to users).
response_created date Date when response was created
placeholder string Placeholder for response.
placeholder_update boolean If placeholder can be updated by user.
multi_response boolean Allow multiple responses for this question.
multi_unique boolean If multiple response allowed, each response must have unique value.