Healthsites API Version 2

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

# Install the Python client library
$ pip install coreapi

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

api

schema > list

GET /api/schema/

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

# Interact with the API endpoint
$ coreapi action api schema &gt; list

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 = ["api", "schema &gt; list"]
result = client.action(schema, action)

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 = ["api", "schema &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

v2 > countries > autocomplete > list

GET /api/v2/countries/autocomplete

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

# Interact with the API endpoint
$ coreapi action api v2 &gt; countries &gt; autocomplete &gt; list

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 = ["api", "v2 &gt; countries &gt; autocomplete &gt; list"]
result = client.action(schema, action)

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 = ["api", "v2 &gt; countries &gt; autocomplete &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

v2 > csv-import-progress > list

GET /api/v2/csv-import-progress/

API to get the progress of data import from csv.

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

# Interact with the API endpoint
$ coreapi action api v2 &gt; csv-import-progress &gt; list

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 = ["api", "v2 &gt; csv-import-progress &gt; list"]
result = client.action(schema, action)

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 = ["api", "v2 &gt; csv-import-progress &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > list

GET /api/v2/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 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 &gt; facilities &gt; list -p api-key=... -p page=... -p country=... -p extent=... -p output=... -p from=... -p to=... -p flat-properties=... -p tag-format=...

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 = ["api", "v2 &gt; facilities &gt; list"]
params = {
    "api-key": ...,
    "page": ...,
    "country": ...,
    "extent": ...,
    "output": ...,
    "from": ...,
    "to": ...,
    "flat-properties": ...,
    "tag-format": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; list"]
var params = {
    api-key: ...,
    page: ...,
    country: ...,
    extent: ...,
    output: ...,
    from: ...,
    to: ...,
    flat-properties: ...,
    tag-format: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > read

GET /api/v2/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

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

# Interact with the API endpoint
$ coreapi action api v2 &gt; facilities &gt; read -p osm_type=... -p osm_id=...

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 = ["api", "v2 &gt; facilities &gt; read"]
params = {
    "osm_type": ...,
    "osm_id": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; read"]
var params = {
    osm_type: ...,
    osm_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > create

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

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 &gt; facilities &gt; create -p osm_type=... -p osm_id=...

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 = ["api", "v2 &gt; facilities &gt; create"]
params = {
    "osm_type": ...,
    "osm_id": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; create"]
var params = {
    osm_type: ...,
    osm_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > autocomplete > list

GET /api/v2/facilities/autocomplete/

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

# Interact with the API endpoint
$ coreapi action api v2 &gt; facilities &gt; autocomplete &gt; list

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 = ["api", "v2 &gt; facilities &gt; autocomplete &gt; list"]
result = client.action(schema, action)

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 = ["api", "v2 &gt; facilities &gt; autocomplete &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > bulk > create > list

GET /api/v2/facilities/bulk/create

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 &gt; facilities &gt; bulk &gt; create &gt; list -p api-key=... -p page=... -p country=... -p extent=... -p output=... -p from=... -p to=... -p flat-properties=... -p tag-format=...

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 = ["api", "v2 &gt; facilities &gt; bulk &gt; create &gt; list"]
params = {
    "api-key": ...,
    "page": ...,
    "country": ...,
    "extent": ...,
    "output": ...,
    "from": ...,
    "to": ...,
    "flat-properties": ...,
    "tag-format": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; bulk &gt; create &gt; list"]
var params = {
    api-key: ...,
    page: ...,
    country: ...,
    extent: ...,
    output: ...,
    from: ...,
    to: ...,
    flat-properties: ...,
    tag-format: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > bulk > create > create

POST /api/v2/facilities/bulk/create

Upload multiple healthsites/facilities data.

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

# Interact with the API endpoint
$ coreapi action api v2 &gt; facilities &gt; bulk &gt; create &gt; create

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 = ["api", "v2 &gt; facilities &gt; bulk &gt; create &gt; create"]
result = client.action(schema, action)

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 = ["api", "v2 &gt; facilities &gt; bulk &gt; create &gt; create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > by-uuid > read

GET /api/v2/facilities/by-uuid/{uuid}

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 &gt; facilities &gt; by-uuid &gt; read -p uuid=...

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 = ["api", "v2 &gt; facilities &gt; by-uuid &gt; read"]
params = {
    "uuid": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; by-uuid &gt; read"]
var params = {
    uuid: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > by-uuid > create

POST /api/v2/facilities/by-uuid/{uuid}

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 &gt; facilities &gt; by-uuid &gt; create -p uuid=...

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 = ["api", "v2 &gt; facilities &gt; by-uuid &gt; create"]
params = {
    "uuid": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; by-uuid &gt; create"]
var params = {
    uuid: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > cluster > list

GET /api/v2/facilities/cluster

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 &gt; facilities &gt; cluster &gt; list

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 = ["api", "v2 &gt; facilities &gt; cluster &gt; list"]
result = client.action(schema, action)

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 = ["api", "v2 &gt; facilities &gt; cluster &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > count > list

GET /api/v2/facilities/count

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 &gt; facilities &gt; count &gt; list -p country=... -p extent=... -p output=... -p from=... -p to=... -p flat-properties=... -p tag-format=...

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 = ["api", "v2 &gt; facilities &gt; count &gt; list"]
params = {
    "country": ...,
    "extent": ...,
    "output": ...,
    "from": ...,
    "to": ...,
    "flat-properties": ...,
    "tag-format": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; count &gt; list"]
var params = {
    country: ...,
    extent: ...,
    output: ...,
    from: ...,
    to: ...,
    flat-properties: ...,
    tag-format: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > shapefile > detail > list

GET /api/v2/facilities/shapefile/{country}/detail

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 &gt; facilities &gt; shapefile &gt; detail &gt; list -p country=...

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 = ["api", "v2 &gt; facilities &gt; shapefile &gt; detail &gt; list"]
params = {
    "country": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; shapefile &gt; detail &gt; list"]
var params = {
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > shapefile > download > list

GET /api/v2/facilities/shapefile/{country}/download

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 &gt; facilities &gt; shapefile &gt; download &gt; list -p country=...

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 = ["api", "v2 &gt; facilities &gt; shapefile &gt; download &gt; list"]
params = {
    "country": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; shapefile &gt; download &gt; list"]
var params = {
    country: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > facilities > statistic > list

GET /api/v2/facilities/statistic

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 &gt; facilities &gt; statistic &gt; list -p country=... -p extent=... -p output=... -p from=... -p to=... -p flat-properties=... -p tag-format=...

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 = ["api", "v2 &gt; facilities &gt; statistic &gt; list"]
params = {
    "country": ...,
    "extent": ...,
    "output": ...,
    "from": ...,
    "to": ...,
    "flat-properties": ...,
    "tag-format": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; facilities &gt; statistic &gt; list"]
var params = {
    country: ...,
    extent: ...,
    output: ...,
    from: ...,
    to: ...,
    flat-properties: ...,
    tag-format: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > gather > enrollment > list

GET /api/v2/gather/enrollment/

API to get the Gather ODK server settings.

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

# Interact with the API endpoint
$ coreapi action api v2 &gt; gather &gt; enrollment &gt; list

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 = ["api", "v2 &gt; gather &gt; enrollment &gt; list"]
result = client.action(schema, action)

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 = ["api", "v2 &gt; gather &gt; enrollment &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

v2 > gmaps > search > geoname > list

GET /api/v2/gmaps/search/geoname

Search Location using geoname as query

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

# Interact with the API endpoint
$ coreapi action api v2 &gt; gmaps &gt; search &gt; geoname &gt; list

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 = ["api", "v2 &gt; gmaps &gt; search &gt; geoname &gt; list"]
result = client.action(schema, action)

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 = ["api", "v2 &gt; gmaps &gt; search &gt; geoname &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

v2 > migration-progress > list

GET /api/v2/migration-progress/

API to get the progress of data migration for a user.

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

# Interact with the API endpoint
$ coreapi action api v2 &gt; migration-progress &gt; list

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 = ["api", "v2 &gt; migration-progress &gt; list"]
result = client.action(schema, action)

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 = ["api", "v2 &gt; migration-progress &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

v2 > pending > reviews > read

GET /api/v2/pending/reviews/{id}

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 &gt; pending &gt; reviews &gt; read -p id=...

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 = ["api", "v2 &gt; pending &gt; reviews &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; pending &gt; reviews &gt; read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > pending > reviews > delete

DELETE /api/v2/pending/reviews/{id}

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 &gt; pending &gt; reviews &gt; delete -p id=...

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 = ["api", "v2 &gt; pending &gt; reviews &gt; delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; pending &gt; reviews &gt; delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > user > changesets > list

GET /api/v2/user/{username}/changesets

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 &gt; user &gt; changesets &gt; list -p username=...

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 = ["api", "v2 &gt; user &gt; changesets &gt; list"]
params = {
    "username": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; user &gt; changesets &gt; list"]
var params = {
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > user > reviews > list

GET /api/v2/user/{username}/reviews

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 &gt; user &gt; reviews &gt; list -p username=...

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 = ["api", "v2 &gt; user &gt; reviews &gt; list"]
params = {
    "username": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; user &gt; reviews &gt; list"]
var params = {
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

v2 > user > updates > list

GET /api/v2/user/{username}/updates

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 &gt; user &gt; updates &gt; list -p username=...

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 = ["api", "v2 &gt; user &gt; updates &gt; list"]
params = {
    "username": ...,
}
result = client.action(schema, action, params=params)

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 = ["api", "v2 &gt; user &gt; updates &gt; list"]
var params = {
    username: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

profile-update

create

POST /profile-update/

API for listing all database record of source reference.

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

# Interact with the API endpoint
$ coreapi action profile-update create

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 = ["profile-update", "create"]
result = client.action(schema, action)

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 = ["profile-update", "create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})