/
Locator API - Usage
Locator API - Usage
- Rodolfo Melia
- Utsav Ashish Koju
Owned by Rodolfo Melia
The Locator API has five endpoints. The endpoint for browsing the web API is /api/ and all the api resource are currently available under version 1 i.e /v2/.
| URL |
| |
|---|---|---|---|
| 1 |
| GET / POST | |
| 2 |
| GET | |
| 3 |
| GET / POST | |
| 4 |
| GET / POST | |
| 5 |
| GET |
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. |
Method | Example | Payload |
|---|---|---|
GET |
| n/a |
POST |
| {
"paging": "true",
"page": "5",
"pageSize": "5"
} |
Response:
{
"status": 200,
"pager": {
"page": 2,
"pageCount": 120,
"total": 243,
"pageSize": 5,
"nextPage": "{{host}}/api/v2/locator?paging=true&page=3&pageSize=5",
"prevPage": "{{host}}/api/v2/locator?paging=true&page=1&pageSize=5"
},
"organisationUnits": {...}
}