Общие типы данных on Travel API - Документация

Денежные операции

Mon, 01 Jan 0001 00:00:00 +0000

Денежные операции#

Типы для работы с денежными суммами и валютами.

MonetaryAmount#

Денежная сумма с указанием валюты.

Поле	Тип	Обязательно	Описание
`currencyCode`	string	Да	Код валюты (ISO 4217, например: RUB, USD, EUR)
`value`	decimal	Да	Сумма

Примеры#

1{
2 "currencyCode": "RUB",
3 "value": 15000.50
4}

1{
2 "currencyCode": "USD",
3 "value": 199.99
4}

Использование#

Этот тип используется во всех операциях, где требуется указать денежную сумму:

Время

Mon, 01 Jan 0001 00:00:00 +0000

Время#

Типы для работы со временем.

TimeRange#

Временной диапазон в пределах дня.

Поле	Тип	Обязательно	Описание
`from`	string	Да	Начало диапазона в формате HH:MM (24-часовой формат)
`to`	string	Да	Конец диапазона в формате HH:MM (24-часовой формат)

Примеры#

Время вылета с 10:00 до 18:00:

1{
2 "from": "10:00",
3 "to": "18:00"
4}

Утренние рейсы с 06:00 до 12:00:

1{
2 "from": "06:00",
3 "to": "12:00"
4}

Использование#

Используется для ограничения времени вылета при поиске:

Документы

Mon, 01 Jan 0001 00:00:00 +0000

Документы#

Типы для работы с документами пассажиров.

Document#

Документ, удостоверяющий личность пассажира.

Поле	Тип	Обязательно	Описание
`lastName`	string	Да	Фамилия как в документе
`firstName`	string	Да	Имя как в документе
`middleName`	string	Нет	Отчество как в документе
`type`	DocumentType	Да	Тип документа
`series`	string	Нет	Серия документа (если применимо)
`number`	string	Да	Номер документа
`birthDate`	date	Нет	Дата рождения
`issueDate`	date	Нет	Дата выдачи документа
`expireDate`	date	Нет	Дата окончания срока действия
`country`	string	Да	Код страны (ISO 3166-1 alpha-2)

DocumentType#

Тип документа, удостоверяющего личность.

Системные типы

Mon, 01 Jan 0001 00:00:00 +0000

Системные типы#

Системные типы данных API.

Error#

Информация об ошибке.

Поле	Тип	Обязательно	Описание
`code`	string	Да	Код ошибки
`message`	string	Да	Сообщение об ошибке
`description`	string	Нет	Детальное описание ошибки
`errorId`	string (GUID v7)	Да	Уникальный идентификатор ошибки

Примеры#

1{
2 "error": {
3 "code": "NO_AVAILABILITY",
4 "message": "Нет доступных рейсов",
5 "description": "Для заданных параметров поиска не найдено доступных предложений",
6 "errorId": "018c5f2e-9b3a-7f4d-8e2c-1a2b3c4d5e6f"
7 }
8}

1{
2 "error": {
3 "code": "AUTHENTICATION_FAILED",
4 "message": "Authentication failed",
5 "errorId": "018c5f2e-9b3a-7f4d-8e2c-1a2b3c4d5e6f"
6 }
7}

Использование#

Поле error присутствует в ответе при возникновении ошибки. API возвращает HTTP 200 даже при ошибках, поэтому необходимо проверять наличие поля error в теле ответа.