API DOCUMENTATION

The Namibia Master Health Facility API allows you to call methods that respond in REST. The API mainly retrieves data from this platform.

The data itself is data of Namibia Master Health Facility List, that contains mandatory, core and other attributes, so the values can vary from each instance but name, type, geo_data, ownership, code and date_modified are mandatory attributes that are available on each facility.

1. FACILITIES

1.1 getting all facilities

Get all of facilties, returning with details of each of facility. By default, it will be retrieve with Json format

URL Sample

http://mfl.mhss.gov.na/api/facilities.json

http://mfl.mhss.gov.na/api/facilities.xml

GET Parameters (optional)

format - parameter that is used to change return format. [json/xml]

1.2 Get all facilities within boxed geographical area (Region)

Get all of facilties within boxed geographical area (Region), returning with details of each of facility. By default, it will be retrieve with Json format

http://mfl.mhss.gov.na/api/facilities/region/:id.json

http://mfl.mhss.gov.na/api/facilities/region/:id.xml

GET Parameters (required)

format - parameter that is used to change return format. [json/xml]

id - id of region

1.3 Get all facilities within boxed geographical area (District)

Get all of facilties within boxed geographical area (District), returning with details of each of facility. By default, it will be retrieve with Json format

http://mfl.mhss.gov.na/api/facilities/district/:id.json

http://mfl.mhss.gov.na/api/facilities/district/:id.xml

GET Parameters (required)

format - parameter that is used to change return format. [json/xml]

id - id of district

1.4 Get Facility Detail

Get facility details using id. By default, it will be retrieve with Json format

http://mfl.mhss.gov.na/api/facilities/id/:id.json

http://mfl.mhss.gov.na/api/facilities/id/:id.xml

GET Parameters (required)

format - parameter that is used to change return format. [json/xml]

id - id of facility

2. SERVICES

2.1 Get all services

Get all of services, returning with details of each service. By default, it will be retrieve with Json format

URL Sample

http://mfl.mhss.gov.na/api/services.json

http://mfl.mhss.gov.na/api/services.xml

GET Parameters (optional)

format - parameter that is used to change return format. [json/xml]

2.2 Get all facilities offering a services

Get all facilities offering a services, returning with service details and a facility list of where the service is offered. By default, it will be retrieve with Json format

http://mfl.mhss.gov.na/api/services/facilities/:id.json

http://mfl.mhss.gov.na/api/services/facilities/:id.xml

GET Parameters (required)

format - parameter that is used to change return format. [json/xml]

id - id of service

2.3 Get Service Detail

Get services details using id. By default, it will be retrieve with Json format

http://mfl.mhss.gov.na/api/services/id/:id.json

http://mfl.mhss.gov.na/api/services/id/:id.xml

GET Parameters (required)

format - parameter that is used to change return format. [json/xml]

id - id of service

3. INFRASTRUCTURES

3.1 Get all infrastructures

Get all of the Infrastructures, returning with details of each infrastructure. By default, it will be retrieve with Json format

URL Sample

http://mfl.mhss.gov.na/api/infrastructures.json

http://mfl.mhss.gov.na/api/infrastructures.xml

GET Parameters (optional)

format - parameter that is used to change return format. [json/xml]

3.2 Get all facilities with a specific infrastructure available

Get all facilities a specific infrastructure available, returning with service details and a facility list of where infrastructure is available. By default, it will be retrieve with Json format

http://mfl.mhss.gov.na/api/infrastructures/facilities/:id.json

http://mfl.mhss.gov.na/api/infrastructures/facilities/:id.xml

GET Parameters (required)

format - parameter that is used to change return format. [json/xml]

id - id of infrastructure

3.3 Get Infrastructure Detail

Get infrastructure details using id. By default, it will be retrieve with Json format

http://mfl.mhss.gov.na/api/infrastructures/id/:id.json

http://mfl.mhss.gov.na/api/infrastructures/id/:id.xml

GET Parameters (required)

format - parameter that is used to change return format. [json/xml]

id - id of infrastructure