POST /v1/services/virtual | XUND API Documentation

Virtual Services endpoint can be used to get filtered Virtual Services.

Request

Request Header additional fields

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

Request body parameters

All the parameters are optional, except type and location.

Parameter name	Parameter type	Parameter description
`types`	VirtualServiceType[]	The requested virtual service types
`name`	string?	Medical Service name filter value
`specializations`	string[]?	Medical Service specializations filter
`openingHours`	TypeScript `{ mon?: string[] tue?: string[] wed?: string[] thu?: string[] fri?: string[] sat?: string[] sun?: string[] }`	Optional filtering of Virtual Services by opening hours, see Filters documentation for details.
`location?`	Location	An object of latitude-longitude pair. Mutually exclusive with countryCode.
`countryCode?`	CountryCode	A valid two letter Country Code. Mutually exclusive with location.
`skip`	number?	Number of elements to skip from the beginning of the results – usable for pagination.
`top`	number?	Number of elements to return – usable for pagination.

Response

Response Body data structure

Property name	Property type	Property description
`count`	number	Number of total results, without `skip` and `top` request parameters.
`items`	VirtualService[]	The Virtual Service result array, that can be limited by `skip` and `top` request parameters.

The items property is an array of VirtualServices. See VirtualService model for documentation.

Example response

Click to expand...

JSON

{
    "count": 1,
    "items": [
        {
            "id": "as9e4444-7x2a-1xxd-a46d-4fa2ac1x000x",
            "name": "Full Allergology Check",
            "description": "Test Description",
            "monogram": "FA",
            "url": "https://service.provider.com/allergology-check",
            "type": "URL",
            "specializations": [
                {
                    "id": "cs9exx31-7x2a-14xd-ax6d-4fa2ac440006",
                    "name": "Allergology",
                    "type": "DOCTOR"
                }
            ]
        }
    ]
}