...
Parameter | dhis2 attribute | description |
|---|---|---|
coordinates | User location or Latitude,Longitude near to which we want to find the organization Units. comma separate value | |
points | array of coordinates / decimal | |
latitude | ||
longitude | ||
Organization Unit | ||
uid | core | OrgUnit UID | UID generated by DHIS2 for a organization unit |
code | core | Org Unit Code | Code assigned to the organization unit |
uidshortName | core | OrgUnit UIDUID generated by DHIS2 for a Org Unit shortName | Short name of the organization unit |
Ancestor (Organization Unit) | ||
ancestor.uid | core | OrgUnit UID for ancestor | When UID / code for the ancestor is provided, then all the locator / facilities under it are populated |
ancestor.code | core | OrgUnit code for ancestor | |
...
Parameter | Option Value | Default Option | Description | pageSize |||
|---|---|---|---|---|---|---|
paging | boolean | true | Defines if pagination is required | |||
page | number | 1 | Defines which page number to return. | |||
pageSize | number | 10 | Defines the total PageSize for the response | |||
distance | number | 510 | Defines radius within which you need to generate the organization Units | |||
unit | m | km | mi | km | Define the unit for the distance | |||
level | number | 7 | Defines hierarchy level of the orgUnit | |||
phoneNumber | text (phone Number) | N/A | DHIS2 core element | Defines the phone number of the location | |||
DHIS2 custom ou attribute | ||||||
type | text | Defines the type of the location. | ||||
tags | text (csv) | N/A | Defines the tags the locations are associated with. | services | text (csv) | N/A |
Defines the services offered by the locations. | contraception | text (csv) | N/A | Defines the contraceptives services offered by the locations. (implementation pending) | ||
area | text | N/A | Defines the area where the locations is located. | |||
subArea | text | N/A | Defines the subArea where the locations is located. | |||
text (phone Number) | N/A | Defines the whatsapp number of the location | ||||
text | url | N/A | Defines the fb url for the location | ||||
...
| Code Block | ||
|---|---|---|
| ||
{
"pageSizepaging": 10true,
"distancepage": 51,
"unitpageSize": 10,
"km",ancestor": {
"coordinatesid": "lat,lnga23acb2452xyz",
"ancestor.code": "KE"
},
"servicesorganisationunit": {
"id"service1,service2 "q13we2452wsd",
"uidshortName": 'q13we2452wsd' "Sub Hospital"
},
"codecoordinates": "CODE-123"lat,lng,
"points": [lat,lng],
"contraceptiondistance": "iud5,imp",
"tagsunit": "km"tag1,tag2"
"level": 7,
"typephoneNumber": "Public180999093107",
"area": "Managua",
"subArea": "Ciudad Sandino",
"phonenumbertype": "Public",
"tags": "tag1,tag2",
"services": "180999093107service1,service2",
"wapwhatsapp": "977984123145",
"facebook": "https://fb.me/facility1",
"latitude": lat,
"longitude": lon
} |
Response:
| Code Block | ||
|---|---|---|
| ||
{
"status": 200,
"pager": {...}
"outletsorganisationUnits": [
{
"dhisCodeid": "KE-CODE-123xkcEJARvo2O",
"dhisIdparentId": "xkcEJARvo2O15561086",
"servicesStandardcode": "CCS,CNT,ANC,STI,HVS,HVTKE-CODE-123",
"outletTypename": "PublicFacility Clinic (KE-CODE-123)",
"ouShowContactInfoshortName": "TLFFacility Clinic",
"pathdescription": ""null,
"outletNameopeningDate": "Facility Clinic2023-02-11",
"phoneNumberclosedDate": null,
"+254541483334" "comment": null,
"postgresIdurl": "1511345870"null,
"locatorTypecontactPerson": "OUT"null,
"locationaddress": {"street1, city, subarea, area",
"areaemail": "Nairobimymail@gmail.com",
"phoneNumber": "+254541483334",
"areaSubpath": "Starehe",
"level": "7",
"address "area": "street1, city, subarea, area",Nairobi",
"subArea": "Starehe",
"latitude": "-1.28575",
"longitude": "39.81234",
"geometry": "{\"type\":\"Point\",\"coordinates\":[39.81234,-1.28575]}",
"dhisNamedistance": "Facility Clinic (KE-CODE-123)"0.0,
"openingHours": "Mon-Fri,8:00,17:00;Sat,9:00,14:00;Public Holiday,9:00,14:00;Sun,Closed",
"openingDateservices": "2023-02-11CCS,CNT,ANC,STI,HVS,HVT",
"ouTagslocationType": "MSIOUT",
"providerstype": []"Public",
"ouContraceptivestags": "KEUNV"IMP,OCP,IUD,INJ,STL,EMC,
"fb": null,
"whatsapp": null,
"showContactInfo": "TLF"
}
]
} |
Note: The attributes sequence might be different from the sequence listed above.