API endpoints documentation

sessions

Authenticate a user and obtain an authentication token used for authenticated calls to other API endpoints

1. Request parameters
   {"session":{"email":"","password":""}}
   
   
2. Response output
   {"id":"","created_at":"","updated_at":"","email":"","first_name":"","last_name":"","token":""}
   
   

Endpoints

• POST: /users/sign_in.json
• DELETE: /users/sign_out.json
• POST: /sessions.json

organizations

Returns a list of organizations for this platform

1. Request parameters
   {"organization":{"name":"","short_description":"","description":"","primary_country":"","state":"","nearest_town_city":"","street_address":"","contact_details":"","email":"","phone":"","website":"","approved":"","region":"","logo":""}}
   
   
2. Response output
   {"id":"","created_at":"","updated_at":"","owner_id":"","name":"","program_name":"","description":"","short_description":"","slug":"","primary_country":"","state":"","nearest_town_city":"","street_address":"","contact_details":"","email":"","phone":"","website":""}
   
   

Endpoints

• GET: /organizations/:organization_id/region.json
• GET: /organizations/:organization_id/edit-region-geojson.json
• GET: /organizations/:organization_id/locations.json
• GET: /organizations/:organization_id/locations_map.json
• GET: /organizations/:organization_id/contributors.json
• GET: /organizations.json
• POST: /organizations.json
• GET: /organizations/:uuid.json
• PATCH: /organizations/:uuid.json
• PUT: /organizations/:uuid.json
• DELETE: /organizations/:uuid.json

datasets

Returns a list of datasets for this platform

1. Request parameters
   {"dataset":{"name":"","description":"","start_date":"","frequency":"","frequency_details":"","standards_guideline_id":"","apply_rules_of_thumb":"","concerns":"","certification_requirements":"","local_contexts":"","share_with_datastream":"","share_with_watershedreports":"","share_with_uk_opendata":"","joinable":"","region":[{}],"impact_intended_audience":[{}],"impact_intended_use":[{}],"selected_standard_ids":[{}]}}
   
   
2. Response output
   {"id":"","created_at":"","updated_at":"","owner_id":"","organization_id":"","form_id":"","name":"","description":"","slug":"","permalink":"","start_date":"","certification_requirements":"","last_observation_at":"","share_with_datastream":"","integrated_with_datastream":"","datastream_dataset_url":"","dormant":"","source_template_name":"","form":[{"id":"","created_at":"","updated_at":"","name":"","protocol":"","template":"","uuid":"","show_testers":"","show_sample_id":"","form_parameters":[{"id":"","created_at":"","updated_at":"","required":"","samples":"","row_order":"","parameter":[{"id":"","created_at":"","updated_at":"","name":"","qualitative":"","category":"","parameter_options":[{"id":"","created_at":"","updated_at":"","value":"","label":""}]}],"test_method":[{"id":"","created_at":"","updated_at":"","name":""}],"equipment":[{"id":"","created_at":"","updated_at":"","name":"","range_bottom":"","range_top":"","range_limit":""}]}]}]}
   
   

Endpoints

• GET: /organizations/:organization_id/datasets.json
• POST: /organizations/:organization_id/datasets.json
• GET: /datasets/:dataset_id/locations.json
• GET: /datasets/:dataset_id/observations.json
• GET: /datasets/:dataset_id/region.json
• GET: /datasets/:dataset_id/edit-region-geojson.json
• GET: /datasets.json
• POST: /datasets.json
• GET: /datasets/:uuid.json
• PATCH: /datasets/:uuid.json
• PUT: /datasets/:uuid.json
• DELETE: /datasets/:uuid.json

locations

Returns the available locations for this platform

1. Request parameters
   {"location":{"name":"","description":"","organization_id":"","latitude":"","longitude":"","body_of_water":"","water_body_type":"","site_id":"","reference_photo":"","reference_photo_date":"","investigative":"","land_uses":[{}],"bank_vegetations":[{}],"collector_assignments":[{}],"collector_invitations":[{}]}}
   
   
2. Response output
   {"id":"","created_at":"","updated_at":"","name":"","slug":"","permalink":"","dataset_id":"","latitude":"","longitude":"","country":"","body_of_water":"","water_body_type":"","investigative":"","tested_parameters":"","tested_equipment":"","reference_photo_url":"","first_observation_at":"","last_observation_at":""}
   
   

Endpoints

• POST: /datasets/:dataset_id/locations.json
• GET: /locations/:location_id/observations.json
• GET: /locations/:location_id/embed-data-table.json
• GET: /locations/autocomplete.json
• GET: /locations.json
• POST: /locations.json
• GET: /locations/:uuid.json
• PATCH: /locations/:uuid.json
• PUT: /locations/:uuid.json
• DELETE: /locations/:uuid.json
• GET: /location/select-dataset.json

forms

Forms

1. Response output
   {"id":"","created_at":"","updated_at":"","name":"","protocol":"","template":"","uuid":"","show_testers":"","show_sample_id":"","form_parameters":[{"id":"","created_at":"","updated_at":"","required":"","samples":"","row_order":"","parameter":[{"id":"","created_at":"","updated_at":"","name":"","qualitative":"","category":"","parameter_options":[{"id":"","created_at":"","updated_at":"","value":"","label":""}]}],"test_method":[{"id":"","created_at":"","updated_at":"","name":""}],"equipment":[{"id":"","created_at":"","updated_at":"","name":"","range_bottom":"","range_top":"","range_limit":""}]}]}
   
   

Endpoints

• GET: /datasets/:dataset_id/form/import-template.json
• GET: /datasets/:dataset_id/form.json

observations

Returns the observations recorded for this platform

1. Request parameters
   {"observation":{"form_id":"","observed_at":"","observed_at_local":"","testers":"","sample_id":"","notes":"","photos":[{}],"readings_attributes":[{"form_parameter_id":"","parameter_sub_question_id":"","unit_id":"","test_method_id":"","equipment_id":"","value":"","equipment_limit_override":"","other_value":"","qualitative_value":"","values":[{}]}]}}
   
   
2. Response output
   {"id":"","created_at":"","updated_at":"","owner_id":"","location_id":"","dataset_id":"","form_id":"","observed_at":"","observed_at_local":"","notes":"","checked":"","qa_notes":"","qa_admin_notes":"","qa_admin_notes_author_id":"","qa_admin_notes_updated_at":"","tested_parameters":"","photos":"","permalink":"","readings":[{"id":"","created_at":"","updated_at":"","parameter":"","unit":"","value":"","equipment":"","equipment_limit":""}]}
   
   

Endpoints

• POST: /locations/:location_id/observations.json
• GET: /observations.json
• GET: /observations/:uuid.json
• PATCH: /observations/:uuid.json
• PUT: /observations/:uuid.json
• DELETE: /observations/:uuid.json

point_of_interests

Point Of Interests

1. Response output
   {"id":"","created_at":"","updated_at":"","name":"","dataset_id":"","receiving_water_course":"","has_upstream":"","has_downstream":"","url":"","lat":"","lng":"","current_status":"","current_status_at":""}
   
   

Endpoints

• GET: /poi.json
• GET: /poi/:uuid.json