Versions Compared

Version Old Version 8 New Version Current
Changes made by

Utsav Ashish Koju

Rodolfo Melia

Saved on

Key

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

Locator API v1.0 has been used for measuring performance but the parameters are updated to match v2.0 to avoid future confusion. Please refer to “Using the API” section for more details regarding v2.0 parameters

...

Feature

DHIS2

Custom API

LocatorAPI V2

DHIS2 SQLView

URL

Response

URL

Response

URL

Response Time

URL

Response Time

Search Org Units close to a Lat/Long

NOT POSSIBLE

{{LocatorAPI_host}}/api/v1/locator?pageSize=10&coordinates=-10.466433,36.130097&distance=50&unit=km

1905ms

{{server}}/api/v2/locators?coordinates=-1.307806, 36.824361

792ms

{{dhis_server}}/api/sqlViews/{{organisationUnit_view}}/data.json?var=level:7&var=organisationunitUid:null&var=organisationunitShortname:null&var=organisationunitCode:null&var=phonenumber:null&var=longitude:36_824361&var=latitude:-1_307806&var=ancestorUid:null&var=ancestorCode:null&var=area:null&var=subArea:null&var=type:null&var=tags:null&var=facebook:null&var=whatsapp:null&var=services:null&var=distance:100000

198ms

Search by Org Unit standard attribute - code

{{dhis2_host}}/api/organisationUnits.json?filter=code:eq:TZ-LOC-USSD-0062

585ms

{{LocatorAPI_host}}/api/v1/locator?code=TZ-LOC-USSD-0062

266ms

{{server}}/api/v2/locators?organisationunit.uid=oGXNQLvxHdG

183ms

{{dhis_server}}/api/sqlViews/{{organisationUnit_view}}/data.json?var=level:7&var=organisationunitUid:oGXNQLvxHdG&var=organisationunitShortname:null&var=organisationunitCode:null&var=phonenumber:null&var=longitude:null&var=latitude:null&var=ancestorUid:null&var=ancestorCode:null&var=area:null&var=subArea:null&var=type:null&var=tags:null&var=facebook:null&var=whatsapp:null&var=services:null&var=distance:0

238ms

Search by Org Unit standard attribute - phoneNumber

{{dhis2_host}}/api/organisationUnits.json?filter=phoneNumber:like:255763069592

500ms

{{LocatorAPI_host}}/api/v1/locator?phoneNumber=255763069592

408ms

{{server}}/api/v2/locators?phoneNumber=+254711043000

249ms

{{dhis_server}}/api/sqlViews/{{organisationUnit_view}}/data.json?var=level:7&var=organisationunitUid:null&var=organisationunitShortname:null&var=organisationunitCode:null&var=phonenumber:254711043000&var=longitude:null&var=latitude:null&var=ancestorUid:null&var=ancestorCode:null&var=area:null&var=subArea:null&var=type:null&var=tags:null&var=facebook:null&var=whatsapp:null&var=services:null&var=distance:0

103ms

Search by Org Unit standard attribute - 2 or more (code & name)

{{dhis2_host}}/api/organisationUnits.json?filter=code:like:TZ-LOC-USSD&filter=name:like:uzi%20Dispensary

99ms

{{LocatorAPI_host}}/api/v1/locator?facilityName=uzi%20Dispensary&code=TZ-LOC-USSD

289ms

{{server}}/api/v2/locators?organisationunit.shortName=Mathari Hospital

254ms

{{dhis_server}}/api/sqlViews/{{organisationUnit_view}}/data.json?var=level:7&var=organisationunitUid:null&var=organisationunitShortname:Mathari Hospital&var=organisationunitCode:null&var=phonenumber:null&var=longitude:null&var=latitude:null&var=ancestorUid:null&var=ancestorCode:null&var=area:null&var=subArea:null&var=type:null&var=tags:null&var=facebook:null&var=whatsapp:null&var=services:null&var=distance:0

108ms

Search by Org Unit custom attribute - text (single value)

{{dhis2_host}}/api/organisationUnits.json?filter=attributeValues.attribute.id:eq:NtzCfaijlfH&filter=attributeValues.value:like:Public&pageSize=10

11.36s

{{LocatorAPI_host}}/api/v1/locator?pageSize=10&type=Public

551ms

{{server}}/api/v2/locators?type=Public&pageSize=10

251ms

{{dhis_server}}/api/sqlViews/{{organisationUnit_view}}/data.json?var=level:7&var=organisationunitUid:null&var=organisationunitShortname:null&var=organisationunitCode:null&var=phonenumber:null&var=longitude:null&var=latitude:null&var=ancestorUid:null&var=ancestorCode:null&var=area:null&var=subArea:null&var=type:Public&var=tags:null&var=facebook:null&var=whatsapp:null&var=services:null&var=distance:0

330ms

Search by Org Unit custom attribute - text (coma separated)

POSSIBLE, but answer could be inaccurate

{{dhis2_host}}/api/organisationUnits.json?filter=attributeValues.attribute.id:eq:mQizDsaeEGi&filter=attributeValues.value:like:OCP,IUD&fields=:all

18.42s

{{LocatorAPI_host}}/api/v1/locator?pageSize=10&service=OCP,IUD

611ms

{{server}}/api/v2/locators?services=ANC,CNT,DLV&pageSize=10

248ms

{{dhis_server}}/api/sqlViews/{{organisationUnit_view}}/data.json?var=level:7&var=organisationunitUid:null&var=organisationunitShortname:null&var=organisationunitCode:null&var=phonenumber:null&var=longitude:null&var=latitude:null&var=ancestorUid:null&var=ancestorCode:null&var=area:null&var=subArea:null&var=type:null&var=tags:null&var=facebook:null&var=whatsapp:null&var=services:DLV&var=distance:0

SQL view doesn’t accept comma separated value to prevent SQL injection

333ms

Search by Org Unit custom attribute - number/

POSSIBLE, but answer could be inaccurate {{dhis2_host}}/api/organisationUnits.json?filter=attributeValues.attribute.id:eq:fN5GReisc6D&fields=:all&filter=attributeValues.value:like:254733683043&pageSize=10

11.38s

{{LocatorAPI_host}}/api/v1/locator?pageSize=10&whatsapp=254733683043

485ms

{{server}}/api/v2/locators?whatsapp=2348032630667

199ms

{{dhis_server}}/api/sqlViews/{{organisationUnit_view}}/data.json?var=level:7&var=organisationunitUid:null&var=organisationunitShortname:null&var=organisationunitCode:null&var=phonenumber:null&var=longitude:null&var=latitude:null&var=ancestorUid:null&var=ancestorCode:null&var=area:null&var=subArea:null&var=type:null&var=tags:null&var=facebook:null&var=whatsapp:2348032630667&var=services:null&var=distance:0

122ms

Search by Org Unit custom attribute - 2 or more

NOT POSSIBLE

{{LocatorAPI_host}}/api/v1/locator?pageSize=10&type=Public&service=CNT

389ms

{{server}}/api/v2/locators?type=Public&service=CCS,CNT,ANC,STI,HVS,HVT,DLV&pageSize=10

251ms

{{dhis_server}}/api/sqlViews/{{organisationUnit_view}}/data.json?var=level:7&var=organisationunitUid:null&var=organisationunitShortname:null&var=organisationunitCode:null&var=phonenumber:null&var=longitude:null&var=latitude:null&var=ancestorUid:null&var=ancestorCode:null&var=area:null&var=subArea:null&var=type:Public&var=tags:null&var=facebook:null&var=whatsapp:null&var=services:anc&var=distance:0

399ms

Search by Org Unit standard + custom attribute

{{dhis2_host}}/api/organisationUnits.json?filter=name:ilike:Hospital&filter=attributeValues.attribute.id:eq:NtzCfaijlfH&filter=attributeValues.value:like:Private&pageSize=10&fields=:all

571ms

{{LocatorAPI_host}}/api/v1/locator?pageSize=10&type=Private&name=Hospital

470ms

{{server}}/api/v2/locators?type=Private&pageSize=10&organisationunit.shortName=Hospital

241ms

{{dhis_server}}/api/sqlViews/{{organisationUnit_view}}/data.json?var=level:7&var=organisationunitUid:null&var=organisationunitShortname:Hospital&var=organisationunitCode:null&var=phonenumber:null&var=longitude:null&var=latitude:null&var=ancestorUid:null&var=ancestorCode:null&var=area:null&var=subArea:null&var=type:Public&var=tags:null&var=facebook:null&var=whatsapp:null&var=services:null&var=distance:0

201ms

...