Using the API

The Locator API has the following 3 endpoints. The endpoint for browsing the web API is /api/ and all the api resource are currently available under version 1 i.e /v1/.

		URL
1	Locators or OrgUnits near by	`api/v1/locator`
2	List of Areas in a country	`api/v1/area`
3	List of subAreas in the country and area	`api/v1/subArea`

Common features

Pagination:

Locator API supports pagination across all the endpoints listed above and is enabled by default.

Parameter	Option Values	Default Option	Description
paging	true \| false	true	Indicates weather to return lists of elements in pages
page	number	1	Defines which page number to return
pageSize	number	10	Defines the number of elements to return for each page.

example:

GET Request

method: GET

url: api/v1/locator?paging=true&page=2&pageSize=5

POST Request

method: POST

url: api/v1/locator

payload:

{
  "paging": "true",
  "page": "5",
  "pageSize": "5"
}

Response:

{
  "status": 200,
  "pager": {
    "page": 2,
    "pageCount": 120,
    "total": 243,
    "pageSize": 5,
    "nextPage": "{{host}}/api/v1/locator?paging=true&page=3&pageSize=5",
    "prevPage": "{{host}}/api/v1/locator?paging=true&page=3&pageSize=5"
  },
  "data": {...}
}