AQuIA Documentation
API Changelog
This changelog lists all additions and updates to the AQuIA API, in chronological order. For more information about the API, view the documentation guide.
API v1 Announcement - 28 June 2023
- A new endpoint in v1 has been added- results/by_site/{id}/analyte_group/{name}
API v1 Announcement - 21 Apr 2023
- New API documentation! Version 1 is now finalized, and any breaking changes will be reserved for a new version.
- The endpoints results/by_site and results/by_site/{id}/summary now have optional parameters startDate and endDate.
- The endpoint results/by_site has an optional filter parameter as well. See the documentation for more information.
API v1 Update - 22 Mar 2022
- Endpoint HEAD results/by_site/{id}/has_results/{casrn} has been removed. It has been replaced by GETresults/by_site/{id}/has_results/. This is a breaking change if you were using the HEAD endpoint.
Previous Endpoint | New Endpoint | |
Endpoint Verb | HEAD | GET |
Endpoint REST | api/v1/results/by_site/{id}/has_results/{casrn} | api/v1/results/by_site/{id}/has_results/ |
Optional CasRN Example | Example:api/v1/results/by_site/{id}/has_results/FLOW. Can also use a comma-separated list: api/v1/results/by_site/{id}/has_results/FLOW,534-52-1 | Example:api/v1/results/by_site/{id}/has_results/?casrn=FLOW. Can also use a comma-separated list: api/v1/results/by_site/{id}/has_results/?casrn=FLOW,534-52-1 |
Return if data present, no CasRN | 200 OK | {"hasResults":true} |
Return if data present, one CasRN | 200 OK | {"hasResults":true} |
Return if data present, multiple CasRNs | 200 OK | {"hasResults":true,"analytes":[{"casrn":"FLOW","hasResults":true},{"casrn":"534-52-1","hasResults":false},{"casrn":"7782-44-7","hasResults":true}]} |
Return no data present, no CasRN | 404 Not Found (Bug in API) | {"hasResults":false} |
Return no data present, one CasRN | 404 Not Found | {"hasResults":false} |
Return invalid site id | 404 Not Found | 404 Not Found |
This page was created 4/21/2023 1:13:36 PM
and was last updated 6/28/2023 9:45:00 AM