Partners API

This API is used to return data for the Partnership Matrix.

GET /api/partners?{params}

Return a list of partners and information based on the following search params. Country, ProvinceRegion, ImplementationUnit, DistrictCode, EndemicityLymphaticFilariasis, EndemicityOnchocerciasis, EndemicitySoilTransmittedHelminthiasis, EndemicitySchistosomiasis, EndemicityTrachoma and / or DonorName.

Below is an example of the response.

    [
        {
            "Id": 871,
            "Country": "COMORES",
            "ProvinceRegion": "Anjouan",
            "ImplementationUnit": "Domoni",
            "DistrictCode": 11754,
            "EndemicityLymphaticFilariasis": "Endemic (MDA not started)",
            "EndemicityOnchocerciasis": "Non endemic",
            "EndemicitySoilTransmittedHelminthiasis": "Endemic",
            "EndemicitySchistosomiasis": "Non-endemic",
            "EndemicityTrachoma": "",
            "DonorName": "ESPEN/OMS",
            "PartnersLymphaticFilariasis": "1",
            "PartnersOnchocerciasis": "",
            "PartnersSoilTransmittedHelminthiasis": "1",
            "PartnersSchistosomiasis": "",
            "PartnersTrachoma": "",
            "Comments": ""
        }
    ]

Params

    e.g. /api/partners?Country=COMORES&DistrictCode=11754&DonorName=ESPEN/OMS

    Country: Country Name, e.g. Madagascar
    ProvinceRegion: Province / Region Name, e.g Anjouan
    ImplementationUnit: String, e.g. Domoni
    DistrictCode: Integer, e.g. 11754
    EndemicityLymphaticFilariasis: String, e.g. Endemic (MDA not started), Endemic (under MDA), Non endemic
    EndemicityOnchocerciasis: String, e.g. Endemic (MDA not started), Endemic (under MDA), Non endemic, Consider Oncho Elimination Mapping
    EndemicitySoilTransmittedHelminthiasis: String, e.g. Endemic, Low endemicity, Moderate endemicity, High endemicity, Non-endemic
    EndemicitySchistosomiasis: String, e.g. Endemic, Low endemicity, Moderate endemicity, High endemicity, Non-endemic
    EndemicityTrachoma: String
    DonorName: Name of Donor, e.g. ESPEN/OMS, USAID, USAID/DFID, etc.