Versions Compared

Version Old Version 5 New Version 6
Changes made by

Utsav Ashish Koju

Rodolfo Melia

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 /v2/.

URL

1

Locators or OrgUnits near by

api/v2/locator

2

List of Areas in a country

api/v2/area

3

List of subAreas in the country and area

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

...