Healthsites API Version 3

To access the api, you need api-key for it.

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.8851fb9336c9.js"></script>
<script src="/api/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

facilities

list

GET /api/v3/facilities/

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 accessing 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)
`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)
`output`	Output format for the request. (json/xml/geojson, default: json)

# Load the schema document
$ coreapi get https://healthsites.io/api/docs/

# Interact with the API endpoint
$ coreapi action facilities list -p api-key=... -p page=... -p country=... -p extent=... -p from=... -p to=... -p flat-properties=... -p tag-format=... -p output=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["facilities", "list"]
var params = {
    api-key: ...,
    page: ...,
    country: ...,
    extent: ...,
    from: ...,
    to: ...,
    flat-properties: ...,
    tag-format: ...,
    output: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://healthsites.io/api/docs/")

# Interact with the API endpoint
action = ["facilities", "list"]
params = {
    "api-key": ...,
    "page": ...,
    "country": ...,
    "extent": ...,
    "from": ...,
    "to": ...,
    "flat-properties": ...,
    "tag-format": ...,
    "output": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v3/facilities/

Create new facility.

# Load the schema document
$ coreapi get https://healthsites.io/api/docs/

# Interact with the API endpoint
$ coreapi action facilities create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["facilities", "create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://healthsites.io/api/docs/")

# Interact with the API endpoint
action = ["facilities", "create"]
result = client.action(schema, action)

statistic

GET /api/v3/facilities/statistic/

Get facility statistic information.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`api-key` required	API KEY for accessing healthsites api.
`country`	Filter by country
`extent`	Extent of map that is used for filtering data. (format: minLng, minLat, maxLng, maxLat)
`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)
`output`	Output format for the request. (json/xml/geojson, default: json)

# Load the schema document
$ coreapi get https://healthsites.io/api/docs/

# Interact with the API endpoint
$ coreapi action facilities statistic -p api-key=... -p country=... -p extent=... -p from=... -p to=... -p flat-properties=... -p tag-format=... -p output=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["facilities", "statistic"]
var params = {
    api-key: ...,
    country: ...,
    extent: ...,
    from: ...,
    to: ...,
    flat-properties: ...,
    tag-format: ...,
    output: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://healthsites.io/api/docs/")

# Interact with the API endpoint
action = ["facilities", "statistic"]
params = {
    "api-key": ...,
    "country": ...,
    "extent": ...,
    "from": ...,
    "to": ...,
    "flat-properties": ...,
    "tag-format": ...,
    "output": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v3/facilities/{osm_type}/{osm_id}

Returns a facility detail.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`osm_type` required
`osm_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`api-key` required	API KEY for accessing healthsites api.

# Load the schema document
$ coreapi get https://healthsites.io/api/docs/

# Interact with the API endpoint
$ coreapi action facilities read -p osm_type=... -p osm_id=... -p api-key=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["facilities", "read"]
var params = {
    osm_type: ...,
    osm_id: ...,
    api-key: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://healthsites.io/api/docs/")

# Interact with the API endpoint
action = ["facilities", "read"]
params = {
    "osm_type": ...,
    "osm_id": ...,
    "api-key": ...,
}
result = client.action(schema, action, params=params)

update

POST /api/v3/facilities/{osm_type}/{osm_id}

Update a facility.

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 facilities update -p osm_type=... -p osm_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["facilities", "update"]
var params = {
    osm_type: ...,
    osm_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://healthsites.io/api/docs/")

# Interact with the API endpoint
action = ["facilities", "update"]
params = {
    "osm_type": ...,
    "osm_id": ...,
}
result = client.action(schema, action, params=params)

shapefile

download

GET /api/v3/shapefile/{country}

Download shapefile.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`country` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`api-key` required	API KEY for accessing healthsites api.

# Load the schema document
$ coreapi get https://healthsites.io/api/docs/

# Interact with the API endpoint
$ coreapi action shapefile download -p country=... -p api-key=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["shapefile", "download"]
var params = {
    country: ...,
    api-key: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://healthsites.io/api/docs/")

# Interact with the API endpoint
action = ["shapefile", "download"]
params = {
    "country": ...,
    "api-key": ...,
}
result = client.action(schema, action, params=params)

user

read

GET /api/v3/user/

Return logged in user detail.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`api-key` required	API KEY for accessing healthsites api.

# Load the schema document
$ coreapi get https://healthsites.io/api/docs/

# Interact with the API endpoint
$ coreapi action user read -p api-key=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["user", "read"]
var params = {
    api-key: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://healthsites.io/api/docs/")

# Interact with the API endpoint
action = ["user", "read"]
params = {
    "api-key": ...,
}
result = client.action(schema, action, params=params)