Locator API - Release Notes
Version:
v2.1.5
Release Date:
July 29, 2024
New Features:
API Enhancements: The API now returns both OU openingHours and openingHours (v2) attribute.
OU OpeningHours is mapped to openingHoursv1
Opening Hours (v2) is mapped to openingHours
Version:
v2.1.4
Release Date:
June 16, 2024
New Features:
ServicePrice Attribute: We have introduced a new attribute,
ServicePrice
, to our health facility services listings. This addition is designed to provide clear and upfront information about the cost of services offered at each health facility.
Version:
v2.1.3
Release Date:
May 14, 2024
Bug Fixes
Improved Tag Filtering and Special Character Support: We've refined how we filter by tags. Now, when you search using tags, our system will look for an exact match within the list of tags. This means you'll get more precise results. This change applies to the general tags, as well as the area and sub-area tags. Additionally, our system now recognizes special characters like
&
,|
, and,
in tag searches. This allows for more complex search queries. For example, you can use&
to specify that all tags must be present,|
to specify any tag can be present, and,
to specify at least one tag must be present.
Version:
v 2.1.2
Release Date:
May 13, 2024
Bug Fixes:
Tags and Services Filters Enhancement: We have fixed an issue with the tags and services filters in our search functionality. Previously, these filters were only working correctly when multiple search terms were provided, separated by a comma ( , ), ampersand (&), or pipe (|). Now, these filters will also work as expected when a single search term is provided. This fix enhances the flexibility and usability of our search feature, allowing for more precise and varied search queries.
Endpoint Specific Search Terms: Please note that the ability to use multiple search terms is only supported by the /locators
endpoint. The /areas
and /subareas
endpoints only support search by a single term.
Version:
v 2.1.1
Release Date:
May 8, 2024
Bug Fixes
Subareas Empty Result Handling: Previously, when the result for subareas was empty, the system was throwing an exception. This has been fixed in this release. Now, when the result is empty, the system will return an empty response instead of an error.
Post Request Parameter Issue: There was an issue with the post request where the system was indicating that the 'Ancestor' parameter was missing. This issue has been resolved in this release.
Version:
v 2.1
Release Date:
March 28, 2024
New Features:
Configs Endpoint: A new endpoint /api/v2/configs has been added. This endpoint allows users to download and persist the TOML configuration file to the resource folder. The configuration file is now externalized as a private GitHub repository. The country's level information from the configuration file is used for later queries.
Stats Information: Stats information has been added to the output json. This includes matchesTotal, matchesNull, and matchesNoNull. To generate these stats, users need to pass a new parameter stats=true. This feature is only available for the area and subAreas endpoints.
Version:
v 2.0 (initial release)
Release Date:
February 1, 2024
New Features:
Locators Endpoint: The /api/v2/locators endpoint supports both GET and POST methods. It returns all the facilities matching the provided search criteria.
Providers Endpoint: The /api/v2/providers endpoint supports the GET method. It returns a list of providers working in the facility.
Areas Endpoint: The /api/v2/areas endpoint supports both GET and POST methods. It returns all the areas within the country.
SubAreas Endpoint: The /api/v2/subAreas endpoint supports both GET and POST methods. It returns all the subareas within the country and the area.
Proxy Images Endpoint: The /api/v2/proxy/images/{resourceId} endpoint supports the GET method. It fetches the image from the DHIS2 server and returns that image.
FHIR Format Support: The API now provides an option to download the results in FHIR format.
Spring Boot Framework: This version of the API is built upon the Spring Boot framework, providing enhanced performance and scalability.
API Documentation: The API documentation has been implemented using Swagger and can be generated using the /api/v2/docs endpoint.
Bug Fixes:
No bug fixes in this release as this is the initial release.
Known Issues:
No known issues at the time of this release.