The response template for each operation colour coded as follows:
Required elements that always return a single value.
Required elements that return either a single value or an array.
Optional elements that always return a single value
Optional elements that return either a single value or an array.
HTTP Response Codes:
HTTP 200 OK - results are returned
HTTP 403 if authorization failed
HTTP 400 if request was invalid
HTTP 404 if nothing could be found
HTTP 500 if internal server error occurred
Requests sent through this interface are allowed to run for a maximum of 30 seconds only. After this time has elapsed, the documentation interface in this page will return an HTTP 504 Gateway Time-out.
However, requests made directly to the API (i.e. beta.openphacts.org) are allowed to run for a maximum of 15 minutes; in our experience this is sufficient time for the vast majority of requests to complete.
We recommend using HTTP Post for batch mode in particular. HTTP Get has a limit on URL size.
Sign in to your account for quick access to useful values.