API

The Healthsites API allows you to call methods that respond in REST. The API mostly retrieves data from healthsites. The data itself is data of healthsites. Here is example of a healthsite data:

{
     "geom": [29.457, -1.9152], 
     "version": 3, 
     "values": {  "services": "specialized care, general acute care, rehabilitation care, old age/hospice care", 
                  "physical_address": "West, Rutsiro  District", 
                  "name": "Rutsiro CS"
               }, 
     "uuid": "1e8f429139464d4997841899ad7707d3", 
     "date_modified": "2015-09-01T18:25:05.531Z"
}, 

geom, version, uuid and date_modified is mandatory attributes. Values contains core and other attributes, so the values can vary for other healthsites

FACILITIES

getting all facilities

Get all of facilties in healthsites, returning with details of each of facility. By default, it will be retrieve with Json format

URL

http://healthsites.io/api/v1/healthsites/facilities

GET Parameters (required)

page - each page contains maximum 100 healthsites

GET Parameters (optional)

format - parameter that is used to change return format. [json/xml]

Sample

https://healthsites.io/api/v1/healthsites/facilities?page=1

getting all facilities within boxed geographical area

Get all of facilties within boxed geographical area, returning with details of each of facility. By default, it will be retrieve with Json format

Result set will be truncated to 1000 records. If you need larger datasets, please use our data extract page.

URL

http://healthsites.io/api/v1/healthsites/facilities

GET Parameters (required)

extent : Geographical area that in decimal degree

GET Parameters (optional)

facility_type - use this parameter to filter by facility type format - parameter that is used to change return format. [json/xml]

Sample

https://healthsites.io/api/v1/healthsites/facilities?extent=-4.0,12.0,12.0,18.0

SEARCH

Search facilities

search facilities by key words. By default, it will be retrieve with Json format

URL

http://healthsites.io/api/v1/healthsites/search

GET Parameters (required)

search_type - Specify which type of feature you wish to search for. [facility, placename] name - keyword for searching

GET Parameters (optional)

format - parameter that is used to change return format. [json/xml]

Sample

https://healthsites.io/api/v1/healthsites/search?search_type=placename&name=Cape%20Town

https://healthsites.io/api/v1/healthsites/search?search_type=facility&name=bandung

FACILITY

Get Facility Detail

get facility details using uuid. By default, it will be retrieve with Json format

URL

http://healthsites.io/api/v1/healthsites/facility/details

GET Parameters (required)

uuid - uuid of facility

GET Parameters (optional)

format - parameter that is used to change return format. [json/xml]

Sample

https://healthsites.io/api/v1/healthsites/facility/details?uuid=47d5bd1449d143c99b9ba0042d31cfdd

Get Synonyms Of facilty

get synonyms or duplication of facility. By default, it will be retrieve with Json format

URL

http://healthsites.io/api/v1/healthsites/facility/details

GET Parameters (required)

uuid - uuid of facility

GET Parameters (optional)

format - parameter that is used to change return format. [json/xml]

Sample

https://healthsites.io/api/v1/healthsites/facility/synonyms?uuid=47d5bd1449d143c99b9ba0042d31cfdd