API Контроль

Название	Тип	По умолчанию	Описание
signature	string	Нет	Подпись.

Название	Тип	Описание
organisations	array	Список организаций (ключ — идентификатор организации).
- id	integer	Идентификатор организации.
- alias	string	Алиас организации.
- name	string	Название организации.

Название	Тип	По умолчанию	Описание
organisationId или organisationAlias	integer\|string	Нет	Идентификатор или алиас организации.
ticketCode	string	Нет	Код билета.
controlBeforeSessionTimeStart	integer	3600	Время до начала проведения детализации, когда становиться разрешён контроль. Внимание! По билетам оплаченным с помощью Пушкинской банковской карты данный параметр автоматически уменьшается до двух часов, если указано значение больше.
controlAfterSessionTimeStart	integer	3600	Время после начала проведения детализации, в течении которого остаётся разрешён контроль. Внимание! Если детализация работает до окончания времени проведения (workUntilTimeEnd), то даный параметр игнорируется.
control	string	null	Изменение факта контроля: null — не менять; enter — изменить на вход; exit — изменить на выход; change — изменить на противоположное.
signature	string	Нет	Подпись.

Название	Тип	Описание
result	string	Результат: ticket-not-exist — билет не существует; ticket-exist-and-enter — билет существует и по нему зафиксирован вход (гашение); ticket-exist-and-exit — билет существует и по нему зафиксирован выход; ticket-exist-but-already-enter — билет существует и по нему уже зафиксирован вход (гашение); ticket-exist-but-already-exit — билет существует и по нему уже зафиксирован выход; ticket-exist-but-session-passed — билет существует, но детализация уже прошла; ticket-exist-but-session-not-now — билет существует, но детализация пройдёт не скоро.
event	null\|array	Мероприятие.
- id	integer	Идентификатор.
- name	string	Название.
session	null\|array	Детализация.
- id	integer	Идентификатор.
- timeStart	integer	Время начала проведени, в формате Unix timestamp.
- timeEnd	integer	Время окончания проведения, в формате Unix timestamp null — не указано; Число — значение.
- workUntilTimeEnd	integer	Работа до окончания времени проведения
- timezone	integer	Часовой пояс места проведения.
- countEnterTickets	null\|integer	Приблизительное количество погашенных билетов: null — не расчитано; число — значение.
- countNotEnterTickets	null\|integer	Приблизительное количество не погашенных билетов: null — не расчитано; число — значение.
ticket	null\|array	Билет.
- id	integer	Идентификатор.
- code	string	Код.
- type	string	Тип билета: sell — продажа; invite — пригласительный.
- place	string	Место.
- beforeControl	bool	Значение контроля до выполнения запроса: none — контроля небыло; enter — зафиксирован вход; exit — зафиксирован выход.
- control	bool	Значение контроля после выполнения запроса: none — контроля небыло; enter — зафиксирован вход; exit — зафиксирован выход.
- sesonticket	bool	Билет в составе абонемента.
- puskinCard	bool	Билет куплен по Пушкинской банковской карте.
- lavrentevCard	bool	Билет куплен по Лаврентьевской карте.
- user	null\|array	Пользователь.
- - fullName	string	ФИО.
- - birthday	string	День рождения.

Название	Тип	По умолчанию	Описание
organisationId или organisationAlias	integer\|string	Нет	Идентификатор или алиас организации.
ticketId или ticketCode	integer\|string	Нет	Идентификатор или код билета.
description	string	Нет	Описание нарушения.
signature	string	Нет	Подпись.

Название	Тип	Описание
result	string	Результат: ticket-not-exist — билет не существует; by-ticket-accepted-violation — по билету зафексировано нарушение; by-ticket-already-accepted-violation — по билету уже зафиксировано нарушение.

Название	Тип	По умолчанию	Описание
organisationId или organisationAlias	integer\|string	Нет	Идентификатор или алиас организации.
periodTimeStart	integer	Текущее время минус 1 день	Начало периода в котором проходят детализации, время в формате Unix timestamp.
periodTimeEnd	integer	Текущее время плюс 30 дней	Окончание периода в котором проходят детализации, время в формате Unix timestamp.
signature	string	Нет	Подпись.

Название	Тип	Описание
events	array	Мероприятия (ключ — идентификатор).
- id	integer	Идентификатор.
- name	string	Название.
- sessions	array	Детализации (ключ — идентификатор).
- - id	integer	Идентификатор.
- - timeStart	integer	Время начала проведения, в формате Unix timestamp.
- - timeEnd	integer	Время окончания проведения, в формате Unix timestamp: null — не указано; Число — значение.
- - workUntilTimeEnd	bool	Работа до окончания времени проведения.
- - timezone	integer	Часовой пояс места проведения.
- - tickets	array	Билеты.
- - - id	integer	Идентификатор.
- - - code	string	Код.
- - - type	string	Тип: sell — продажа; invite — пригласительный.
- - - place	string	Место.
- - - control	string	Факт контроля: none — вход не осуществлён; enter — осуществлён вход; exit — осуществлён выход после входа.
- - - sesonticket	bool	Билет в составе абонемента.
- - - puskinCard	bool	Билет куплен по Пушкинской банковской карте.
- - - lavrentevCard	bool	Билет куплен по Лаврентьевской карте.
- - - user	null\|array	Пользователь.
- - - - fullName	string	ФИО.
- - - - birthday	string	День рождения.

Название	Тип	По умолчанию	Описание
organisationId или organisationAlias	integer\|string	Нет	Идентификатор или алиас организации.
tickets	array	Нет	Билеты.
- code	string	Нет	Код.
- time	integer	Нет	Время контроля, в формате Unix timestamp.
- control	string	Нет	Контроль: enter — зафиксирован вход; exit — зафиксирован выход.
signature	string	Нет	Подпись.

Название	Тип	Описание
success	array	Массив успешно обработанных кодов билетов.
notSuccess	array	Массив не успешно обработанных кодов билетов (ключ — код билета).
- alias	array	Алиас проблемы.
- text	array	Описание проблемы.

¶ Введение

¶ Организации

¶ Список организаций

¶ Билет

¶ Контроль

¶ Нарушение по Пушкинской банковской карте

¶ Данные для автономного контроля

¶ Автономный контроль