Healthsites API Version 2
# Install the command line client
$ pip install coreapi-cli
api
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api schema > list
v2 > countries > autocomplete > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
api-key required | API KEY for access healthsites api. |
q required | Query . |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > countries > autocomplete > list -p api-key=... -p q=...
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > csv-import-progress > list
v2 > facilities > list
Returns a list of facilities with some filtering parameters.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
api-key required | API KEY for access healthsites api. |
page required | A page number within the paginated result set. |
country | Filter by country |
extent | Extent of map that is used for filtering data. (format: minLng, minLat, maxLng, maxLat) |
output | Output format for the request. (json/xml/geojson, default: json) |
from | Get latest modified data from this timestamp. |
to | Get latest modified data from this timestamp. |
flat-properties | Put true to show properties in flat |
tag-format | Tag format that want to be used. (osm/hxl. default : osm) |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > list -p api-key=... -p page=... -p country=... -p extent=... -p output=... -p from=... -p to=... -p flat-properties=... -p tag-format=...
v2 > facilities > read
Returns a facility detail.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
osm_type required | |
osm_id required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > read -p osm_type=... -p osm_id=...
v2 > facilities > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
osm_type required | |
osm_id required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > create -p osm_type=... -p osm_id=...
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > autocomplete > list
v2 > facilities > bulk > create > list
FOR TESTING ONLY
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
api-key required | API KEY for access healthsites api. |
page required | A page number within the paginated result set. |
country | Filter by country |
extent | Extent of map that is used for filtering data. (format: minLng, minLat, maxLng, maxLat) |
output | Output format for the request. (json/xml/geojson, default: json) |
from | Get latest modified data from this timestamp. |
to | Get latest modified data from this timestamp. |
flat-properties | Put true to show properties in flat |
tag-format | Tag format that want to be used. (osm/hxl. default : osm) |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > bulk > create > list -p api-key=... -p page=... -p country=... -p extent=... -p output=... -p from=... -p to=... -p flat-properties=... -p tag-format=...
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > bulk > create > create
v2 > facilities > by-uuid > read
Get facility by uuid
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > by-uuid > read -p uuid=...
v2 > facilities > by-uuid > create
Update facility by uuid
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > by-uuid > create -p uuid=...
v2 > facilities > cluster > list
Returns JSON representation of clustered points for the current map view Map view is defined by a *bbox*, *zoom* and *iconsize*
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > cluster > list
v2 > facilities > count > list
Returns count of facilities with some filtering parameters.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
country | Filter by country |
extent | Extent of map that is used for filtering data. (format: minLng, minLat, maxLng, maxLat) |
output | Output format for the request. (json/xml/geojson, default: json) |
from | Get latest modified data from this timestamp. |
to | Get latest modified data from this timestamp. |
flat-properties | Put true to show properties in flat |
tag-format | Tag format that want to be used. (osm/hxl. default : osm) |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > count > list -p country=... -p extent=... -p output=... -p from=... -p to=... -p flat-properties=... -p tag-format=...
v2 > facilities > shapefile > detail > list
API for checking process of generating shapefile
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
country required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > shapefile > detail > list -p country=...
v2 > facilities > shapefile > download > list
API for checking process of generating shapefile
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
country required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > shapefile > download > list -p country=...
v2 > facilities > statistic > list
Returns statistic of facilities with some filtering parameters.
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
country | Filter by country |
extent | Extent of map that is used for filtering data. (format: minLng, minLat, maxLng, maxLat) |
output | Output format for the request. (json/xml/geojson, default: json) |
from | Get latest modified data from this timestamp. |
to | Get latest modified data from this timestamp. |
flat-properties | Put true to show properties in flat |
tag-format | Tag format that want to be used. (osm/hxl. default : osm) |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > facilities > statistic > list -p country=... -p extent=... -p output=... -p from=... -p to=... -p flat-properties=... -p tag-format=...
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > filter-osm-data > list
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > gather > enrollment > list
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > gmaps > search > geoname > list
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > migration-progress > list
v2 > pending > reviews > read
Returns detail of pending review
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > pending > reviews > read -p id=...
v2 > pending > reviews > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > pending > reviews > delete -p id=...
v2 > user > changesets > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
username required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > user > changesets > list -p username=...
v2 > user > reviews > list
Returns list of user data that is in review. This list is about the data that uploaded by user but was not success with a reason
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
username required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > user > reviews > list -p username=...
v2 > user > updates > list
Returns list of user data that is in pending state. Pending update in here is the data that success uploaded into osm but still not pulled by docker osm cache
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
username required |
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action api v2 > user > updates > list -p username=...
profile-update
# Load the schema document
$ coreapi get https://healthsites.io/api/docs/
# Interact with the API endpoint
$ coreapi action profile-update create