POST /v1/services/:id | XUND API Documentation

This endpoint can be used get details of a service.

Request

Request Header additional fields

Parameter name	Parameter type	Parameter description
`language`	ClientLanguage	The expected language of the response

Request URL parameters

Parameter name	Parameter type	Parameter description
`id`	string	The id of the requested `Service`

Request body parameters

Parameter name	Parameter type	Parameter description
`countryCode`	CountryCode?	A country code supported by XUND
`location`	Location?	An object of latitude-longitude pair

Exactly one of countryCode or location parameters is mandatory.

Response

Response Body data structure

Property name	Property type	Property description
`id`	string	ID of the service
`title`	string?	Title of the doctor, when available
`firstName`	string?	First name of the doctor, defined only if the service is not a facility This field is currently only supported in Germany and will be undefined in Austria
`lastName`	string?	Last name of the doctor, defined only if the service is not a facility This field is currently only supported in Germany and will be undefined in Austria
`name`	string	Name of the Service
`type`	GenericSpecializationType	Generic Specialization Type of the Service
`gender`	Gender?	Gender of the doctor, if type supports this value
`phone`	string?	Phone number of medical service (if exists)
`email`	string?	E-mail of the medical service, (if exists)
`url`	string?	URL of the service, if available
`location`	`{` `country:` CountryCode `zip: string` `city: string` `address: string` `province: string?` `latitude: number` `longitude: number` `}`	Location details of the service
`specializations`	`Array<{` `id: string` `name: string` `type:` GenericSpecializationType `}>?`	Array of service specializations
`insurers`	string[]?	Optional IDs of service’s supported insurers
`openingHours`	DetailedOpeningHours	Opening hours, for each day of the week, in format of arrays of open sections, with user friendly `detailedData` property. Day 0 means Monday
`monogram`	string	Monogram of the Service
`profileImageUrl`	string?	Publicly available profile photo / logo of the service

Example response

JSON

{
    "id": "00032e86-6083-41ed-b299-18de924f0676",
    "name": "Dr. Joachim Bacher",
    "type": "DOCTOR",
    "gender": "MALE",
    "phone": "0444272333",
    "email": null,
    "location": {
        "country": "AT",
        "zip": "2100",
        "city": "Korneuburg",
        "address": "Wiener Str. 1",
        "province": "Niederösterreich",
        "latitude": 48.3501996,
        "longitude": 16.3065274
    },
    "specializations": [
        {
            "id": "ac10b3f9-67e6-4579-bae9-35621a25b467",
            "name": "General Practitioner",
            "type": "DOCTOR"
        }
    ],
    "insurers": [],
    "openingHours": {
        "0": [
            {
                "start": "08:00",
                "finish": "12:00"
            },
            {
                "start": "16:00",
                "finish": "18:00"
            }
        ],
        "1": [
            {
                "start": "07:30",
                "finish": "12:00"
            },
            {
                "start": "16:00",
                "finish": "18:00"
            }
        ],
        "2": [
            {
                "start": "07:30",
                "finish": "12:00"
            }
        ],
        "3": [],
        "4": [
            {
                "start": "09:00",
                "finish": "12:00"
            }
        ],
        "5": [],
        "6": [],
        "detailedData": {
            "type": "ALREADY_CLOSED",
            "isOpen": false,
            "text": "Already closed"
        }
    },
    "monogram": "JB"
}