ОПИСАНИЕ ДАННЫХ СЕАНСА
отправляемого через систему уведомлений на URL в формате JSON
версия от 04.12.2024
Система уведомлений отправляет данные методом POST. На указанном адресе система пользователя должна принимать
передаваемые платформой данные, и в случае успеха, присылать в ответ код 200 ОК.
Иначе, в течение суток сервер BIL24 будет периодически повторять отправку уведомления.
Типы полей:
число int - целое значение в диапазоне от -2 147 483 648 до 2 147 483 647
число Uint - целое беззнаковое значение в диапазоне от 0 до 2 147 483 647
число long - целое значение в диапазоне от -9 223 372 036 854 775 808 до 9 223 372 036 854 775 807
число Ulong - целое беззнаковое значение в диапазоне от 0 до 9 223 372 036 854 775 807
число cur - вещественное значение, содержащее до 4 знаков после точки, например 134.7445
boolean - литерал принимающий значения true или false
строка - строковое значение неограниченной длины
Состав полей уведомления:
| Поле | Тип | Обязательность | Описание |
| id | число Ulong | Обязательное | id уведомления |
| created | строка | Обязательное | дата и время создания уведомления в формате ISO-8601 в часовом поясе UTC+00:00 |
| type | строка | Обязательное | тип триггера: event.created (сеанс создан), event.changed (сеанс изменен), event.deleted (сеанс удален) |
| data | массив | Обязательное | массив данных сеансов |
Данные сеанса для триггеров "Сеанс создан" (event.created), "Сеанс изменен" (event.changed), "Сеанс удален"
(event.deleted):
Все три триггера имеют идентичную структуру данных. Элементы массива data содержат следующие поля:
| Поле | Тип | Обязательность | Описание |
| actionEventId | число Ulong | Обязательное | id сеанса в системе BIL24 |
| externalEventId | строка | Обязательное | id сеанса во внешней билетной системе (ВБС). Значение "0" означает, что подключение к ВБС не используется. |
| cityId | число Ulong | Обязательное | id города |
| cityName | строка | Обязательное | название города |
| venueId | число Ulong | Обязательное | id места проведения (площадки) |
| venueName | строка | Обязательное | название места проведения |
| seatingPlanId | число Ulong | Обязательное | id схемы зала |
| seatingPlanName | строка | Обязательное | название схемы зала |
| organizerId | число Ulong | Обязательное | id организатора |
| organizerName | строка | Обязательное | название организатора |
| actionId | число Ulong | Обязательное | id представления (мероприятия) |
| actionName | строка | Обязательное | название представления |
| gatewayId | число Ulong | Обязательное | id подключения к внешней билетной системе (ВБС). Значение 0 означает, что подключение к ВБС не используется. |
| currency | строка | Обязательное | код валюты в стандарте ISO 4217 (например, RUB, USD, EUR, ILS) |
| showTime | строка | Обязательное | местное (по месту проведения) дата и время начала сеанса в формате ISO-8601 без часового пояса |
| sellStartTime | строка | Обязательное | дата и время начала продаж в формате ISO-8601 в часовом поясе UTC+00:00 |
| sellEndTime | строка | Обязательное | дата и время окончания продаж в формате ISO-8601 в часовом поясе UTC+00:00 |
| eTicket | boolean | Обязательное | true - если доступны электронные билеты, false - требуется печать билетов |
| fullNameRequired | boolean | Обязательное | true - требуется полное имя покупателя при оформлении заказа |
| phoneRequired | boolean | Обязательное | true - требуется номер телефона покупателя при оформлении заказа |
| fanIdRequired | boolean | Обязательное | true - требуется Fan ID при оформлении заказа |
| visitorDocRequired | boolean | Обязательное | true - требуется документ посетителя при оформлении заказа |
| visitorBirthdateRequired | boolean | Обязательное | true - требуется дата рождения посетителя при оформлении заказа |
| sellEnabled | boolean | Обязательное | true - продажа билетов разрешена, false - продажа приостановлена |