...
Parameter | Option Value | Default Option | Description |
|---|---|---|---|
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 | 10 | 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 | N/A | Defines the tags the locations are associated with. |
text | NA | Returns all the organization which has all of the tags provided. | |
services | text | N/A | Defines the services offered by the locations. Returns all the organization which has at least one of the service provided. |
text | Returns all the organization which has all of the services provided. | ||
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 | |
responseFhir | boolean | No | Defines if the response would be in FHIR or DHIS2 format |
...