General information

Default HTTP Header

Parameter name	Parameter type	What’s an API-key?
`authorization`	string?	authorization token to authorize clients. It’s required for each request. This is the preferred way to authorize the client
~~api-key~~	~~string?~~	Api-key is used to authorize clients. It's required for each request.

Frequently used phrases

symptom check: An analysis of the patient’s symptoms without any assumption of a certain disease.
illness check: An analysis based on the assumption, that the patient suffers from a certain illness.
check: Symptom check or illness check.
illness survey: A set of questions about factors that can have effect on certain diseases.
symptom survey: A set of questions asking for details of certain symptoms.

Type notation

The API communicates with JSON, with its benefits and limitations applied to the data received & sent by it. This API document uses JSON types with additional postfixes after basic types including further information about the contents of values. The following postfixes are used:

?: Optionality. The value can have the defined type - or null - or is not present in the object.
|: OR operator. In the case of A | B, it means that the given property can be type A or type B as well.
(localized text): Used only for string and string[] types. The string is safe to show on the user interface
(localized HTML text): Used only for string and string[] types. The string might include HTML tags and after HTML processing is safe to show on the user interface.
(image URL): Used only for string type. The string is the URL of an image. XUND API operates with images stored in internal CMS.
(integer): Used only for number type. The number is an integer.
(float): Used only for number type. The number is float
(datetime): String represents a date and time (ISO8601)

Other type notation:

keyof Model: string literal, where the possible values are the property names of referred Model. Example:

CODE

Model:
{id: string; name: string; email: string?}

keyof Model: "id" | "name" | "email"

Array<type>: An array, where the elements' type is <type>