XUND API Documentation

GET /v1/specializations/convertFromXundSpecializationsAndGetDetails

This endpoint is to convert internal specialization ids to a given country’s local specializations.

Request

Request header additional fields

Parameter name

Parameter type

Parameter description

language

ClientLanguage

The expected language of the response

Request query parameters

Parameter name

Parameter type

Parameter description

countryCode

CountryCode?

Country code to retrieve the specialization list for

location

Location?

Location to retrieve the specialization list for

xundSpecializationIds

string[]

The specialization ids to get localized specializations for

Exactly one of countryCode or location parameter is mandatory.

Response

The response is a map of specialization id → local specializations

Response body data structure

Property name

Property type

Property description

[specializationId: string]

LocalSpecialization[]

Keys are ids of generic specializations, values are their local specialization equivalents

Example response

Click to expand...
JSON
{
    "84ed952b-cadf-42ad-a70d-71fdc6d5894d": [
        {
            "id": "705f3fc8-8b39-4349-bc75-10d4ec2b6519",
            "name": "Gastroenterology and Hepatology",
            "type": "DOCTOR"
        },
        {
            "id": "12b1b8af-45ad-41d1-9d39-9818c42f7031",
            "name": "Internal medicine, Gastroenterology and Hepatology",
            "type": "DOCTOR"
        }
    ],
    "85d0eae0-4123-4350-9c90-a5981f89363a": [
        {
            "id": "adfda966-1799-43b9-a40a-e4d6a11a9338",
            "name": "General surgery and visceral surgery",
            "type": "DOCTOR"
        },
        {
            "id": "e3043fe7-c9ea-4f94-b9de-612101a4d69b",
            "name": "Visceral Surgery",
            "type": "DOCTOR"
        }
    ]
}