The LocatorAPI currently has three endpoints. The locator API can currently support querying:
Locators or OrgUnits near by
List of Areas in a country
List of subAreas within the country and the area
Locators near me
This endpoint provides list of organization units around the provided coordinates.
url : api/v1/locator
method: POST
authorization: will be provided by admin
payload:
{
"number": 10,
"distance": 5,
"unit": "km",
"coordinates": "lat,lng",
"iso": "KE",
"services": "service1,service2",
"uid": 'q13we2452wsd',
"code": "CODE-123",
"contraception": "iud,imp",
"tags": "tag1,tag2",
"type": "Public",
"area": "Managua",
"subArea": "Ciudad Sandino",
"phonenumber": "180999093107",
"wap": "977984123145",
"facebook": "https://fb.me/facility1"
}
response:
{
"returnCode": "200",
"outlet": [
{
"dhisCode": "KE-CODE-123",
"dhisId": "xkcEJARvo2O",
"servicesStandard": "CCS,CNT,ANC,STI,HVS,HVT",
"outletType": "Public",
"ouShowContactInfo": "TLF",
"path": "",
"outletName": "Facility Clinic",
"phoneNumber": "+254541483334",
"postgresId": "1511345870",
"locatorType": "OUT",
"location": {
"area": "Nairobi",
"areaSub": "Starehe",
"address": "street1, city, subarea, area",
"latitude": "-1.28575",
"longitude": "39.81234"
},
"dhisName": "Facility Clinic (KE-CODE-123)",
"openingHours": "Mon-Fri,8:00,17:00;Sat,9:00,14:00;Public Holiday,9:00,14:00;Sun,Closed",
"openingDate": "2023-02-11",
"ouTags": "MSI",
"providers": [],
"ouContraceptives": "IMP,OCP,IUD,INJ,STL,EMC"
}
]
}
Areas in the country
Provides list of areas in the country.
url : api/v1/area
method: POST
authorization: will be provided by admin
payload:
{
"country": "KE",
"pageNo": 1,
"pageSize": 5,
"facilityType": "Public",
"tags": "KEUNV"
}
response:
{
"response": {
"returnCode": "200",
"totaNosofPages": 10,
"areas": [
{
"area": "Baringo",
"country": "Kenya"
},
{
"area": "Bomet",
"country": "Kenya"
},
{
"area": "Bungoma",
"country": "Kenya"
},
{
"area": "Busia",
"country": "Kenya"
},
{
"area": "Elgeyo Marakwet",
"country": "Kenya"
}
],
"links": [
{
"rel": "self",
"href": "/locator-dev/api/area?1=1&country=KE&pageNo=1&pageSize=5"
},
{
"rel": "next",
"href": "/locator-dev/api/area?1=1&country=KE&pageNo=2&pageSize=5"
}
],
"totalNosOfRecords": 48,
"currentPageNo": "1",
"status": "Showing 5 Areas"
}
}
SubAreas in the country
Provides list of areas in the country.
url : api/v1/subArea
method: POST
authorization: will be provided by admin
payload:
{
"country": "GT",
"area": "Guatemala",
"pageNo": 1,
"pageSize": 5,
"facilityType": "Public",
"tags": "KEUNV"
}
response:
{
"response": {
"returnCode": "200",
"totaNosofPages": 10,
"subAreas": [
{
"subArea": "Amatitlán",
"area": "Guatemala",
"country": "GT"
},
{
"subArea": "Antigua Guatemala",
"area": "Guatemala",
"country": "GT"
},
{
"subArea": "Fraijanes",
"area": "Guatemala",
"country": "GT"
},
{
"subArea": "Guatemala Zona 1",
"area": "Guatemala",
"country": "GT"
},
{
"subArea": "Guatemala Zona 10",
"area": "Guatemala",
"country": "GT"
}
],
"links": [
{
"rel": "self",
"href": "/locator-dev/api/subArea?1=1&country=GT&area=Guatemala&pageNo=1&pageSize=5"
},
{
"rel": "next",
"href": "/locator-dev/api/subArea?1=1&country=GT&area=Guatemala&pageNo=2&pageSize=5"
}
],
"totalNosOfRecords": 48,
"currentPageNo": "1",
"status": "Showing 5 Areas"
}
}
You can also find the POSTMAN examples here.