ПРОТОКОЛ БИЛЕТНОЙ СИСТЕМЫ

API (All Powerful Incantation)
Версия от 13.08.2019

ОПИСАНИЕ
ОБЩАЯ СХЕМА ИСПОЛЬЗОВАНИЯ ПРОТОКОЛА
ВИД ОТВЕТА
АВТОРИЗАЦИЯ (command = AUTH)
СОЗДАНИЕ ПОЛЬЗОВАТЕЛЯ (command = CREATE_USER)*
ПОЛУЧЕНИЕ СПИСКА ГОРОДОВ (command = GET_CITIES)
ПОЛУЧЕНИЯ СПИСКА ТИПОВ МЕСТ ПРОВЕДЕНИЯ (command = GET_VENUE_TYPES)
ПОЛУЧЕНИЕ СПИСКА МЕСТ ПРОВЕДЕНИЯ (command = GET_VENUES)
ПОЛУЧЕНИЕ СПИСКА МЕРОПРИЯТИЙ (command = GET_ALL_ACTIONS)*
ПОЛУЧЕНИЕ СПИСКА МЕРОПРИЯТИЙ (command = GET_ACTIONS_V2)
ПОЛУЧЕНИЕ ИНФОРМАЦИИ О МЕРОПРИЯТИИ, РАСШИРЕННЫЙ МЕТОД (command = GET_ACTION_EXT)
ПОЛУЧЕНИЕ СПИСКА МЕСТ ПО ID СЕАНСА (command = GET_SEAT_LIST)
ПОЛУЧЕНИЕ КООРДИНАТ МЕСТ ПО ID СЕАНСА (command = GET_SCHEMA)
ДОБАВЛЕНИЕ ПРОМОКОДОВ (command = ADD_PROMO_CODES)
БРОНИРОВАНИЕ МЕСТ В СХЕМЕ ЗАЛА С РАЗМЕЩЕНИЕМ (command = RESERVATION)
БРОНИРОВАНИЕ МЕСТ В СХЕМЕ ЗАЛА БЕЗ РАЗМЕЩЕНИЯ (command = RESERVATION)
РАЗБРОНИРОВАНИЕ МЕСТА (command = RESERVATION)
ПОЛУЧЕНИЕ СПИСКА ЗАБРОНИРОВАННЫХ МЕСТ (command = GET_CART)
СОЗДАНИЕ ЗАКАЗА (command = CREATE_ORDER)
СОЗДАНИЕ ЗАКАЗА (command = CREATE_ORDER_EXT)*
ОТМЕНА ЗАКАЗА (command = CANCEL_ORDER)*
ОПЛАТА ЗАКАЗА (command = PAY_ORDER)*
ПОЛУЧЕНИЕ ЗАКАЗОВ ПОЛЬЗОВАТЕЛЯ (command = GET_ORDERS)
ПОЛУЧЕНИЕ ЗАКАЗОВ ПОЛЬЗОВАТЕЛЯ (command = GET_ORDERS_EXT)
ПОЛУЧЕНИЕ СПИСКА СЕАНСОВ, ПО КОТОРЫМ БЫЛИ КУПЛЕНЫ БИЛЕТЫ (command = GET_ACTION_EVENTS_GROUPED_BY_TICKETS)
ПОЛУЧЕНИЕ КУПЛЕННЫХ БИЛЕТОВ ПО ID ПРЕДСТАВЛЕНИЯ (command = GET_TICKETS_BY_ACTION_EVENT)
ПОЛУЧЕНИЕ ШАБЛОНА БИЛЕТА В ФОРМАТЕ SVG
ПОЛУЧЕНИЕ КУПЛЕННЫХ БИЛЕТОВ ПО ID ЗАКАЗА (command = GET_TICKETS_BY_ORDER)
ПОЛУЧЕНИЕ ИНФОРМАЦИИ ПО ПРОДАННЫМ БИЛЕТАМ ЗА КОНКРЕТНЫЙ ДЕНЬ (command = GET_TICKETS_BY_DAY)
ПОЛУЧЕНИЕ ИНФОРМАЦИИ О ПОЛЬЗОВАТЕЛЕ (command = GET_USER_INFO)
ОТПРАВКА БИЛЕТОВ НА ПОЧТУ (command = SEND_TICKETS_TO_EMAIL)
УДАЛЕНИЕ (command = DELETE)
ПОЛУЧЕНИЕ ИНФОРМАЦИИ О ЗАКАЗЕ (command = GET_ORDER_INFO)
ПОЛУЧЕНИЕ ПОЧТЫ (command = GET_EMAIL)
ОТПРАВКА GCM ТОКЕНА НА СЕРВЕР (command = SET_PUSH_TOKEN)
ПОЛУЧИТЬ НОВОСТИ (command = GET_NEWS)
ПРОВЕРКА КДП (command = CHECK_KDP)
ПОЛУЧЕНИЕ ДАННЫХ ДЛЯ ФИЛЬТРА (command = GET_FILTER)
ПРИВЯЗКА ПОЧТЫ (command = BIND_EMAIL)
ПОДТВЕРЖДЕНИЕ ПОЧТЫ (command = CONFIRM_EMAIL)
ПОЛУЧЕНИЕ КАРТ (МЭК) (command = GET_MECS)
ПОЛУЧЕНИЕ ПРОМОКОДОВ (command = GET_PROMO_CODES)
ВОЗВРАТ БИЛЕТОВ (command = REFUND_TICKETS)*
СТАТУС ЗАКАЗА
ПРОТОКОЛ В ФАЙЛЕ docx
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 09.05.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 20.05.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 15.06.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 22.06.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 23.06.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 08.07.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 22.07.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 16.08.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 02.09.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 25.10.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 25.11.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 15.12.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 27.12.2016
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 04.02.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 05.05.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 18.05.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 08.06.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 06.07.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 13.07.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 22.07.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 09.08.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 23.08.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 02.10.2017
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 18.02.2018
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 01.03.2018
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 12.03.2018
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 19.08.2018
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 16.10.2018
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 06.12.2018
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 12.12.2018
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 23.04.2019
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 21.05.2019
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 10.06.2019
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 23.07.2019
ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 13.08.2019

ОПИСАНИЕ

Для взаимодействия осуществляются HTTPS POST запросы в формате JSON в кодировке UTF-8. Ответ возвращается в формате JSON в кодировке UTF-8.

URL тестовой зоны https://api.bil24.pro:1240/json
URL реальной зоны https://api.bil24.pro/json

Типы полей:
число 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 - вещественное значение, содержащее до 2 знаков после точки, например 134.66
boolean - литерал принимающий значения true или false
строка - строковое значение неограниченной длины

ОБЩАЯ СХЕМА ИСПОЛЬЗОВАНИЯ ПРОТОКОЛА

Команды протокола делятся на сессионные и несессионные.
Список несессионных команд:
1. GET_FILTER
2. GET_CITIES
3. GET_VENUE_TYPES
4. GET_VENUES
5. GET_ALL_ACTIONS
6. GET_ACTIONS_V2
7. GET_ACTION_EXT
8. GET_SEAT_LIST
9. GET_TICKETS_BY_DAY

Нет необходимости выполнять команду AUTH раньше какой-либо из перечисленных команд. Для их выполнения не нужен идентификатор сессии (sessionId).

Для выполнения сессионных команд нужно иметь sessionId. Получить его первоначально нужно с помощью команды AUTH (для билетных систем CREATE_USER). Полученные данные пользователя рекомендуется сохранить и использовать повторно. Сессия пользователя определяется sessionId и действует бессрочно.

В общем случае, sessionId понадобится перед командой BIND_EMAIL (RESERVATION для билетных систем).

ВИД ОТВЕТА

На все запросы возвращается результат в формате JSON:
{
 "resultCode": 0,
 "description": "OK"
 "command": "COMMAND"
 …………………………
}

Данные поля присутствуют в каждом ответе.
Если resultCode не равен 0, то поле description содержит описание ошибки. Других полей не будет.
Значения поля resultCode:

ПРИ КАЖДОМ ЗАПРОСЕ указывать два обязательных поля:

АВТОРИЗАЦИЯ (command = AUTH)

Описание: авторизация пользователя. Для интерфейса Билетная система вместо данного метода необходимо использовать метод CREATE_USER.
Поля запроса:

Состав полей ответа:

Данные для запроса брать из cookies, если ранее уже выполнялся данный запрос. Если запрос выполняется первый раз, то userId и sessionId в запросе не передавать.
Пример запроса:
{
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "AUTH",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "AUTH",
 "frontendType": 2,
 "resultCode": 0,
 "description": "OK"
}
После получения ответа, сохранить данные и использовать в запросах, где необходимы эти поля.

СОЗДАНИЕ ПОЛЬЗОВАТЕЛЯ (command = CREATE_USER)*

Описание: метод создает нового пользователя, который в дальнейшем может использоваться для бронирования мест, создания и оплаты заказа и получения билетов. Используется вместо метода AUTH для интерфейса Билетная система.
*только для интерфейса Билетная система

Поля запроса:

Состав полей ответа:

Пример запроса:
{
 "command": "CREATE_USER",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "CREATE_USER",
 "resultCode": 0,
 "description": "OK"
}
После получения ответа, сохранить данные и использовать в запросах, где необходимы эти поля.

ПОЛУЧЕНИЕ СПИСКА ГОРОДОВ (command = GET_CITIES)

Описание: получение списка всех городов, присутствующих в системе. Для получения списка только тех городов, в которых есть актуальные события, необходимо использовать метод GET_FILTER. Использование метода GET_FILTER является предпочтительным.
Поля запроса:

Состав полей ответа:

cityList:

Пример запроса:
{
 "command": "GET_CITIES",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "cityList": [
  {
   "cityId": 1,
   "cityName": "Сочи"
  },
  {
   "cityId": 2,
   "cityName": "Краснодар"
  }
 ],
 "command": "GET_CITIES",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЯ СПИСКА ТИПОВ МЕСТ ПРОВЕДЕНИЯ (command = GET_VENUE_TYPES)

Описание: получение списка всех типов мест проведения, присутствующих в системе.
Поля запроса:

Состав полей ответа:

venueTypeList:

ПОЛУЧЕНИЕ СПИСКА МЕСТ ПРОВЕДЕНИЯ (command = GET_VENUES)

Описание: получение списка всех мест проведения, присутствующих в системе. Для получения актуальных мест проведения, необходимо использовать метод GET_FILTER.
Поля запроса:

Состав полей ответа:

venueList:

ПОЛУЧЕНИЕ СПИСКА МЕРОПРИЯТИЙ (command = GET_ALL_ACTIONS)*

Описание: метод возвращает все данные метода GET_FILTER, плюс список всех доступных мероприятий. Метод позволяет отказаться от использования методов GET_FILTER, GET_ACTIONS_V2 и GET_ACTION_EXT.
*Только для интерфейса Билетная система


Поля запроса:

Состав полей ответа:

cityList:

venueList:

kindList:

actionList:

actionEventList:

categoryLimitList:

categoryList:

ПОЛУЧЕНИЕ СПИСКА МЕРОПРИЯТИЙ (command = GET_ACTIONS_V2)

Описание: метод возвращает список представлений по городу. Для интерфейса Билетная система рекомендуется использовать GET_ALL_ACTIONS вместо данного метода.
Поля запроса:

Состав полей ответа:

actionList:

* КДП (код доступа к представлению - временное решение). Перед открытием схемы зала или нажатием кнопки забронировать (в схеме зала без размещения) пользователь должен ввести КДП (метод для проверки КДП - CHECK_KDP)
Пример запроса:
{
 "cityId": 1,
 "command": "GET_ACTIONS_V2"
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "actionList": [
  {
    "actionId": 193,
    "actionName": "Любовь Успенская",
    "fullActionName": "Королева городского романса",
    "duration": 120,
    "kindId": 0,
    "kindName": "События",
    "posterName": "Название постера",
    "smallPosterUrl": "https://api.bil24.pro:1240/image?type=smallPoster&actionId=193&hash=gznpw8zi9rog7k7e923ko32ap",
    "bigPosterUrl": "https://api.bil24.pro:1240/image?type=bigPoster&actionId=193&hash=hwyb7h53x926q0tiiopdgjpp0",
    "minSum": 1500,
    "firstEventDate": "27.05.2016",
    "lastEventDate": "27.05.2016",
    "rating": 10,
    "kdp": false,
    "cityId": 1,
    "cityName": "Сочи",
    "actionEventTime": "19:30",
    "venueMap": {
     "1": "Зимний театр"
    }
  },
  {
    "actionId": 219,
    "actionName": "Кармен",
    "fullActionName": "Ледовый мюзикл",
    "duration": 180,
    "kindId": 0,
    "kindName": "События",
    "posterName": "Название постера",
    "smallPosterUrl": "https://api.bil24.pro:1240/image?type=smallPoster&actionId=219&hash=sc8zn3tgamlvtpdjbgprv3dy2",
    "bigPosterUrl": "https://api.bil24.pro:1240/image?type=bigPoster&actionId=219&hash=qwejy8em5q5clku76dyxshd58",
    "minSum": 1000,
    "firstEventDate": "10.06.2016",
    "lastEventDate": "02.10.2016",
    "rating": 10,
    "kdp": false,
    "cityId": 1,
    "cityName": "Сочи",
    "actionEventTime": "18:30",
    "venueMap": {
     "7": "ЛД \"Айсберг\""
    }
  }
 ],
  "command": "GET_ACTIONS_V2",
  "resultCode": 0,
  "description": "OK"
}

ПОЛУЧЕНИЕ ИНФОРМАЦИИ О МЕРОПРИЯТИИ, РАСШИРЕННЫЙ МЕТОД (command = GET_ACTION_EXT)

Описание: метод возвращает информацию о представлении в конкретном городе, места где оно проводится и сеансы. Для интерфейса Билетная система рекомендуется использовать GET_ALL_ACTIONS вместо данного метода.
Поля запроса:

* userId - на схеме зала будут окрашены места данного пользователя
Состав полей ответа:

action:

*kdp - Код доступа к представлению (КДП). Если параметр равен true, то забронировать места можно только если ввести КДП
venueList:

actionEventList:

Существует 3 вида схем:
1. Только без размещения. placementUrl будет отсутствовать, смотрим categoryLimitList.
2. Только с размещением. Смотрим placementUrl, categoryLimitList будет пустой.
3. Комбинированная. Смотрим placementUrl и categoryLimitList.

categoryLimitList:

categoryList:

*availability - количество доступных мест в категории. Если remainder отсутствует, то ориентируемся на availability. Если remainder присутствует, то нужно внимательно использовать эти параметры. К примеру общее ограничение remainder на 3 категории может быть 100, но и в каждой категории availability также может быть 100.

Список сеансов actionEventList возвращается в отсортированном виде по дате проведения.

Пример запроса:
{
 "cityId": 1,
 "actionId": 80,
 "userId": 1269,
 "command": "GET_ACTION_EXT",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "action": {
  "actionId": 193,
  "actionName": "Любовь Успенская",
  "fullActionName": "Королева городского романса",
  "kindId": 0,
  "kindName": "События",
  "cityId": 1,
  "cityName": "Сочи",
  "duration": 120,
  "posterName": "Королева городского романса",
  "description": ""Настоящая Любовь"",
  "smallPosterUrl": "https://api.bil24.pro:1240/image?type=smallPoster&actionId=193&hash=gznpw8zi9rog7k7e923ko32ap",
  "bigPosterUrl": "https://api.bil24.pro:1240/image?type=bigPoster&actionId=193&hash=hwyb7h53x926q0tiiopdgjpp0",
  "rating": 10,
  "kdp": false,
  "venueList": [
    {
    "venueId": 1,
    "venueName": "Зимний театр",
    "address": "г. Сочи, ул. Театральная, 2",
    "geoLat": "43.572313",
    "geoLon": "39.730626",
    "imageUrl": "https://api.bil24.pro:1240/image?type=venue&id=1&hash=rrre3fih28k8n68kmjwkdhe91",
    "description": "У каждого города есть своя "визитная карточка".",
    "actionEventList": [
     {
      "actionEventId": 681,
      "day": "27.05.2016",
      "time": "19:30",
      "placementUrl": "https://api.bil24.pro:1240/image?type=seatingPlan&userId=21173&actionEventId=681",
      "eTicket": true,
      "categoryLimitList": []
     }
     ]
   }
   ]
 },
 "command": "GET_ACTION_EXT",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ СПИСКА МЕСТ ПО ID СЕАНСА (command = GET_SEAT_LIST)

Поля запроса:

Состав полей ответа:

categoryList:

categoryLimitList:

seatList:

location:

ПОЛУЧЕНИЕ КООРДИНАТ МЕСТ ПО ID СЕАНСА (command = GET_SCHEMA)

Описание: Метод возвращает информацию обо всех местах с размещением, с координатами каждого места, включая координаты x,y. Метод дает возможность построить собственную схему зала. Рекомендуется использовать только если нет возможности использовать готовые схемы svg, которые можно получить по протоколу.

Поля запроса:

Состав полей ответа:

seatList:

ДОБАВЛЕНИЕ ПРОМОКОДОВ (command = ADD_PROMO_CODES)

Описание: Добавление промокодов для применения пользователем. За один раз можно добавить до 10 промокодов включительно. Регистр символов промокода значения не имеет. В ответе будет столько же промокодов и в том же регистре, как в запросе, поделенные на 3 группы: новые промокоды для пользователя, уже существующие у пользователя промокоды и ошибочные промокоды.

Поля запроса:

Состав полей ответа:

БРОНИРОВАНИЕ МЕСТ В СХЕМЕ ЗАЛА С РАЗМЕЩЕНИЕМ (command = RESERVATION)

Описание: бронирование мест в схеме зала с размещением. Перед созданием заказа необходимо забронировать хотя бы одно место. При получении ошибки в ответе гарантируется, что ни одно место из списка не было забронировано (транзакционные свойства бронирования). Если список мест содержит ранее успешно забронированные места, они исключаются из списка. Все места в списке должны принадлежать одному сеансу.

Поля запроса:

Состав полей ответа:

seatList:

location:

Пример запроса:
{
 "type": "RESERVE_BY_PLACE",
 "seatList": [
    100
 ],
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "RESERVATION",
 "fid": 1,
  "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "type": "RESERVE_BY_PLACE",
 "command": "RESERVATION",
 "resultCode": 0,
 "description": "OK"
}

БРОНИРОВАНИЕ МЕСТ В СХЕМЕ ЗАЛА БЕЗ РАЗМЕЩЕНИЯ (command = RESERVATION)

Описание: бронирование мест в схеме зала без размещения. Перед созданием заказа необходимо забронировать хотя бы одно место. При получении ошибки в ответе гарантируется, что ни одно место из списка не было забронировано (транзакционные свойства бронирования). Бронирование производится указанием ценовой категории и количества мест в данной категории. При одновременном бронировании мест в нескольких ценовых категориях, все ценовые категории должны принадлежать одному сеансу. Ценовые категории должны быть без размещения, в противном случае необходимо использовать метод бронирования мест в схеме зала с размещением.

Поля запроса:

Состав полей ответа:

seatList:

location:

Пример запроса:
{
 "type": "RESERVE",
 "categoryQuantityMap": {
   "1072": 1
 },
 "userId": 139,
 "sessionId": "8f91a3ae4d43f7250537a13c4c4745ea",
 "command": "RESERVATION",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780",
 "kdp": 123
}
Пример ответа:
{
 "type": "RESERVE",
 "command": "RESERVATION",
 "resultCode": 0,
 "description": "OK"
}

РАЗБРОНИРОВАНИЕ МЕСТА (command = RESERVATION)

Поля запроса:

Состав полей ответа:

seatList:

location:

Пример 1. запроса снятия брони со всех мест:
{
 "type": "UN_RESERVE_ALL",
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "RESERVATION",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример 2. запроса снятия брони со всех мест конкретного сеанса:
{
 "type": "UN_RESERVE_ALL",
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "actionEventId": 5,
 "command": "RESERVATION"
}
Пример 3. запроса снятия брони со списка мест:
{
 "type": "UN_RESERVE",
 "seatList": [
   4790
 ],
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "RESERVATION",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "command": "RESERVATION",
 "type": "UN_RESERVE",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ СПИСКА ЗАБРОНИРОВАННЫХ МЕСТ (command = GET_CART)

Описание: метод возвращает места, забронированные пользователем, сгруппированные по сеансам.

Поля запроса:

Состав полей ответа:

actionEventList:

seatList:

*Если схема зала местовая, то поля sector, row, number будут присутствовать в ответе.

Пример запроса:
{
 "userId": 1,
 "sessionId": "ce91f8ec80d1ddb2abf03d02470cc8b2",
 "command": "GET_CART",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "time": 588,
 "totalSum": 1200,
 "totalServiceCharge": 0,
  "actionEventList": [
  {
   "actionEventId": 344,
   "day": "02.06.2016",
   "time": "18:00",
   "actionName": "SOPRANO ШОУ",
   "fullActionName": "Михаил Турецкий представляет вечер любви",
   "smallPosterUrl": "https://api.bil24.pro:1240/image?type=smallPoster&actionId=80&hash=r9qfi771jid3pf0or7vxc8xrb",
   "bigPosterUrl": "https://api.bil24.pro:1240/image?type=bigPoster&actionId=80&hash=m3b37t9tynyes52fxx7zw6gdl",
   "cityId": 1,
   "cityName": "Сочи",
   "venueId": 10,
   "venueName": "Зимний театр",
   "serviceCharge": 0,
   "seatList": [
    {
      "seatId": 524692,
     "categoryPriceName": "Шестая",
     "price": 600,
     "sector": "Сектор Партер",
     "row": "Ряд 9",
     "number": "Место 11",
     "serviceCharge": 0
     },
    {
     "seatId": 524691,
     "categoryPriceName": "Шестая",
      "price": 600,
     "sector": "Сектор Партер",
     "row": "Ряд 9",
      "number": "Место 10",
     "serviceCharge": 0
    }
    ]
   }
  ],
 "command": "GET_CART",
 "resultCode": 0,
 "description": "OK"
}

СОЗДАНИЕ ЗАКАЗА (command = CREATE_ORDER)

Описание: cоздание заказа из забронированных мест. Для интерфейса Билетная система вместо данного метода необходимо использовать метод CREATE_ORDER_EXT.

Поля запроса:

Состав полей ответа:

Пример запроса:
{
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "successUrl": "https://site.ru/success.php",
 "failUrl": "https://site.ru/fail.php",
 "command": "CREATE_ORDER",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "formUrl": "https://test.paymentgate.ru/testpayment/merchants/bil24/mobile_payment_ru.html?mdOrder=b8bb4b76-3a73-4816-92d4-954aa7d01e&pageView=MOBILE",
 "statusExtStr": "NEW",
 "statusExtInt": 0,
 "command": "CREATE_ORDER",
 "resultCode": 0,
 "description": "OK"
}

СОЗДАНИЕ ЗАКАЗА (command = CREATE_ORDER_EXT)*

Описание: Создание заказа из забронированных мест. Используется вместо метода CREATE_ORDER для интерфейса Билетная система. После создания заказ принимает статус NEW.
*только для интерфейса Билетная система

Поля запроса:

Состав полей ответа:

Пример запроса:
{
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "CREATE_ORDER_EXT",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "orderId": 64,
 "discount": 10,
 "serviceCharge": 99,
 "sum": 1000,
 "totalSum": 1089,
 "quantity": 5,
 "command": "CREATE_ORDER_EXT",
 "resultCode": 0,
 "description": "OK"
}

ОТМЕНА ЗАКАЗА (command = CANCEL_ORDER)*

Описание: отмена ранее созданного заказа. Отменить можно только заказ со статусом NEW. В результате запроса заказ примет статус CANCELLING или CANCELLED. При попытке отменить заказ не со статусом NEW, ошибки не произойдет, статус заказа не изменится, а в ответе придет актуальный статус заказа. Когда статус заказа примет значение CANCELLED, места, входящие в заказ, станут свободными.
*только для интерфейса Билетная система

Поля запроса:

Состав полей ответа:

Пример запроса:
{
 "orderId": 64,
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "CANCEL_ORDER",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "orderId": 64,
 "statusExtStr": "CANCELLED",
 "statusExtInt": -2,
 "command": "CANCEL_ORDER",
 "resultCode": 0,
 "description": "OK"
}

ОПЛАТА ЗАКАЗА (command = PAY_ORDER)*

Описание: оплата ранее созданного заказа. Оплатить можно только заказ со статусом NEW. В результате запроса заказ примет статус PROCESSING или PAID. При попытке оплатить заказ не со статусом NEW, ошибки не произойдет, статус заказа не изменится, а в ответе придет актуальный статус заказа.
*только для интерфейса Билетная система

Поля запроса:

Состав полей ответа:

Пример запроса:
{
 "orderId": 64,
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "PAY_ORDER",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "orderId": 64,
 "statusExtStr": "PAID",
 "statusExtInt": 2,
 "command": "PAY_ORDER",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ ЗАКАЗОВ ПОЛЬЗОВАТЕЛЯ (command = GET_ORDERS)

Поля запроса:

Состав полей ответа:

orderList:

Пример запроса:
{
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "GET_ORDERS",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "orderList": [
  {
   "orderId": 64,
   "date": "06.08.2015 18:48",
   "datePattern": "dd.MM.yyyy HH:mm",
   "discount": 0,
   "serviceCharge": 0,
   "sum": 600,
   "quantity": 4,
    "statusExtStr": "PAID",
    "statusExtInt": 2,
    "formUrl": "https://test.paymentgate.ru/testpayment/merchants/bil24/mobile_payment_ru.html?mdOrder=2a2637b4-3d2b-44c4-b29f-4c3b39d17722&pageView=MOBILE",
  }
  ],
 "command": "GET_ORDERS",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ ЗАКАЗОВ ПОЛЬЗОВАТЕЛЯ (command = GET_ORDERS_EXT)

Поля запроса:

Состав полей ответа:

orderList:

Пример запроса:
{
 "fromDate": "01.01.2016 00:00:00",
 "userId": 1,
 "sessionId": "sessionId",
 "command": "GET_ORDERS_EXT",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "orderDatePattern": "dd.MM.yyyy HH:mm:ss",
 "ticketDatePattern": "dd.MM.yyyy HH:mm",
 "orderList": [
  {
   "orderId": 3037,
   "date": "12.12.2016 13:29:53",
   "discount": 0,
   "serviceCharge": 30.00,
   "sum": 630.00,
   "quantity": 2,
   "ticketList": [
    {
     "ticketId": 29965,
     "date": "09.01.2017 10:00",
     "actionName": "Звёздные войны: Пробуждение силы",
     "venueName": "Кинотеатр Люксор",
     "sector": "Сектор Партер",
     "row": "Ряд 2",
     "number": "Место 12",
      "categoryName": "Категория: Третья",
     "price": 300
    },
    {
     "ticketId": 29966,
     "date": "09.01.2017 10:00",
     "actionName": "Звёздные войны: Пробуждение силы",
     "venueName": "Кинотеатр Люксор",
     "sector": "Сектор Партер",
     "row": "Ряд 1",
     "number": "Место 13",
     "categoryName": "Категория: Третья",
     "price": 300
    }
   ],
   "statusExtStr": "PAID",
   "statusExtInt": 2,
  },
  {
   "orderId": 2438,
   "date": "30.08.2016 00:14:55",
   "discount": 0,
   "serviceCharge": 0.00,
   "sum": 0.00,
   "quantity": 1,
   "ticketList": [
    {
     "ticketId": 29095,
     "date": "31.07.2017 09:00",
     "actionName": "КЛУБ ЛЮБИМЫХ",
     "venueName": "территория Сочи",
     "categoryName": "Категория: Золотая",
     "price": 0
    }
   ],
   "status": 1
  }
 ],
 "command": "GET_ORDERS_EXT",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ СПИСКА СЕАНСОВ, ПО КОТОРЫМ БЫЛИ КУПЛЕНЫ БИЛЕТЫ (command = GET_ACTION_EVENTS_GROUPED_BY_TICKETS)

Поля запроса:

Состав полей ответа:

list:

Пример запроса:
{
 "userId": 11,
 "sessionId": "c6721d3c35c247da84ac460004840b68",
 "command": "GET_ACTION_EVENTS_GROUPED_BY_TICKETS",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "dayPattern": "dd.MM.yyyy",
 "timePattern": "HH:mm",
 "list": [
  {
   "actionEventId": 5,
   "actionName": "Балет Спящая красавица",
   "day": "28.09.2015",
   "time": "11:01",
   "bigPosterUrl": "https://api.bil24.pro:1240/image?type=bigPoster&actionId=2&hash=lpmbkeg1lae6najf2zd099kgs"
  },
  {
   "actionEventId": 22,
   "actionName": "Кино Эверест",
   "day": "30.09.2015",
   "time": "15:00",
   "bigPosterUrl": "https://api.bil24.pro:1240/image?type=bigPoster&actionId=11&hash=rf8qt7yz5z4s96hmko0kmkuf8"
  },
  {
   "actionEventId": 8,
   "actionName": "Концерт группы Scooter",
   "day": "12.10.2015",
   "time": "21:05",
   "bigPosterUrl": "https://api.bil24.pro:1240/image?type=bigPoster&actionId=3&hash=mtpqe8hih74wyla45p983zmt3"
  }
 ],
 "command": "GET_ACTION_EVENTS_GROUPED_BY_TICKETS",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ КУПЛЕННЫХ БИЛЕТОВ ПО ID ПРЕДСТАВЛЕНИЯ (command = GET_TICKETS_BY_ACTION_EVENT)

Поля запроса:

Состав полей ответа:

ticketList:

Пример запроса:
{
 "actionEventId": 5,
 "sizeQrCode": 500,
 "widthBarCode": 500,
 "heightBarCode": 100,
 "type": "PNG",
 "userId": 11,
 "sessionId": "c6721d3c35c247da84ac460004840b68",
 "command": "GET_TICKETS_BY_ACTION_EVENT",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "datePattern": "dd.MM.yyyy HH:mm",
 "actionEventId": 5,
 "actionName": "Кармен",
 "ticketList": [
   {
    "ticketId": 10075,
    "date": "28.09.2015 11:01",
    "venueName": "Зимний театр",
    "venueAddress": "ул. Театральная, 2",
    "actionName": "Кармен",
    "sector": "Сектор Партер",
    "row": "Ряд 1",
    "number": "Место 22",
    "categoryName": "Категория Х",
    "price": 1000,
    "totalPrice": 0,
    "serviceCharge": 0,
    "qrCodeImg": "iVBORw0KGgoAAAANSUhEUgAAAfQAAAH0AQAAAADjreInAAACwElEQVR42u3dS27jMBBFUe2A+99l7YCdjmjWq6KCbiCjJ1zDA1n2YUaEWB8y1/zVKy53H9d+fX1eV2N9/XXx9/25s34mBI939zqVEse1J9c9xH2h979nDx5v7mPNijUxRv5uz6v91R76Jnj8e/z3/FkfZebk4+S+xuPf6sfMOTPLmml/xONf5WsonaulHUvcYCT+cf2Fx7v5jJ/jf98/xN94vJuv2VCNk/dESvmP/Cse7+ajpkTHLNGyhNY57h4Uj3+F32kjTZWWKFrvy1d4vLeXqHgVyXacMCVbOmSgkWkmPN7b6zpJEqalYNZWXJETCY+39zVI0OVRqyu3MkPmj",
    "barCodeImg": "iVBORw0KGgoAAAANSUhEUgAAAfQAAABkAQAAAABYvP/QAAAAYklEQVR42u3LsQ2AIBBG4TMWVzICm+hiJDAabMIIV1KY/GpcwuI1r3n5TFGyK3atLer0njQ1dNk6o5iPJ+qpmUZYXsd323urfCgMj8fj8Xg8Ho/H4/F4PB6Px+PxeDz+Z/4GLPLRZ1RHc5UAAAAASUVORK5CYII="
    "barCodeNumber": "0123456789123",
    "smallPosterUrl": "https://..."
    "legalOwner": "Организатор...",
    "age": "18+",
    }
 ],
 "command": "GET_TICKETS_BY_ACTION_EVENT",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ ШАБЛОНА БИЛЕТА В ФОРМАТЕ SVG

ПОЛУЧЕНИЕ КУПЛЕННЫХ БИЛЕТОВ ПО ID ЗАКАЗА (command = GET_TICKETS_BY_ORDER)

Поля запроса:

Состав полей ответа:

ticketList:

Статус билета:

Пример запроса:
{
 "orderId": 5,
 "sizeQrCode": 500,
 "widthBarCode": 500,
 "heightBarCode": 100,
 "type": "PNG",
 "userId": 11,
 "sessionId": "c6721d3c35c247da84ac460004840b68",
 "command": "GET_TICKETS_BY_ACTION_EVENT",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "orderDatePattern": "dd.MM.yyyy HH:mm:ss",
 "actionEventDatePattern": "dd.MM.yyyy HH:mm",
 "orderId": 5,
 "date": "27.09.2015 10:01:01",
 "discount": 0,
 "serviceCharge": 0,
 "sum": 1000,
 "totalSum": 1000,
 "quantity": 5,
 "statusExtStr": "PAID",
 "statusExtInt": 2,
 "ticketList": [
    {
    "ticketId": 10075,
    "date": "28.09.2015 11:01",
    "venueName": "Зимний театр",
    "venueAddress": "ул. Театральная, 2",
    "actionName": "Кармен",
    "sector": "Сектор Партер",
    "row": "Ряд 1",
    "number": "Место 22",
    "categoryName": "Категория Х",
    "price": 1000,
    "totalPrice": 0,
    "serviceCharge": 0,
     "qrCodeImg": "iVBORw0KGgoAAAANSUhEUgAAAfQAAAH0AQAAAADjreInAAACwElEQVR42u3dS27jMBBFUe2A+99l7YCdjmjWq6KCbiCjJ1zDA1n2YUaEWB8y1/zVKy53H9d+fX1eV2N9/XXx9/25s34mBI939zqVEse1J9c9xH2h979nDx5v7mPNijUxRv5uz6v91R76Jnj8e/z3/FkfZebk4+S+xuPf6sfMOTPLmml/xONf5WsonaulHUvcYCT+cf2Fx7v5jJ/jf98/xN94vJuv2VCNk/dESvmP/Cse7+ajpkTHLNGyhNY57h4Uj3+F32kjTZWWKFrvy1d4vLeXqHgVyXacMCVbOmSgkWkmPN7b6zpJEqalYNZWXJETCY+39zVI0OVRqyu3MkPmj",
     "barCodeImg": "iVBORw0KGgoAAAANSUhEUgAAAfQAAABkAQAAAABYvP/QAAAAYklEQVR42u3LsQ2AIBBG4TMWVzICm+hiJDAabMIIV1KY/GpcwuI1r3n5TFGyK3atLer0njQ1dNk6o5iPJ+qpmUZYXsd323urfCgMj8fj8Xg8Ho/H4/F4PB6Px+PxeDz+Z/4GLPLRZ1RHc5UAAAAASUVORK5CYII="
    "barCodeNumber": "0123456789123",
    "smallPosterUrl": "https://..."
    "legalOwner": "Организатор...",
    "age": "18+",
    }
 ],
 "command": "GET_TICKETS_BY_ACTION_EVENT",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ ИНФОРМАЦИИ ПО ПРОДАННЫМ БИЛЕТАМ ЗА КОНКРЕТНЫЙ ДЕНЬ (command = GET_TICKETS_BY_DAY)

Поля запроса:

Состав полей ответа:

cityList:

actionList:

actionEventList:

ticketList:

Пример запроса:
{
 "date": "08.06.2017",
 "command": "GET_TICKETS_BY_DAY",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "date": "07.06.2017",
 "cityList": [
  {
   "cityId": 3,
   "actionList": [
    {
     "actionId": 323,
     "actionEventList": [
      {
       "actionEventId": 1814,
       "ticketList": [
        {
         "ticketId": 30935,
         "seatId": 2943773,
         "date": "07.06.2017 12:57:01",
         "price": 3000,
         "discount": 0,
         "serviceCharge": 0,
         "totalPrice": 3000.00,
         "refunded": false
        },
       ]
      }
     ]
    }
   ]
  }
 ],
 "command": "GET_TICKETS_BY_DAY",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ ИНФОРМАЦИИ О ПОЛЬЗОВАТЕЛЕ (command = GET_USER_INFO)

Поля запроса:

Состав полей ответа:

Пример запроса:
{
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "GET_USER_INFO",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
Пример ответа:
{
 "seatInReserve": 2,
 "orderInWait": 0,
 "command": "GET_USER_INFO",
 "resultCode": 0,
 "description": "OK"
}

ОТПРАВКА БИЛЕТОВ НА ПОЧТУ (command = SEND_TICKETS_TO_EMAIL)

Поля запроса:

Пример запроса:
{
 "email": "email@list.ru",
 "ticketIdList": [
  10261
 ],
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "command": "SEND_TICKETS_TO_EMAIL",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример ответа:
{
 "command": "SEND_TICKETS_TO_EMAIL",
 "resultCode": 0,
 "description": "OK"
}

УДАЛЕНИЕ (command = DELETE)

Описание: Метод помечает билет/заказ пользователя как удаленный, чтобы на интерфейсах в дальнейшем их не подгружать.

Поля запроса:

* destination = TICKETS_BY_ACTION_EVENT - помечаются как удаленные все билеты пользователя на конкретный сеанс.

Состав полей ответа:

Пример запроса удаления заказа:
{
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "id": 1, //id заказа
 "destination": "ORDER"
 "command": "DELETE",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример ответа успешного удаления:
{
 "command": "DELETE",
 "id": 1, //id удаленного заказа
 "destination": "ORDER"
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ ИНФОРМАЦИИ О ЗАКАЗЕ (command = GET_ORDER_INFO)

Поля запроса:

Состав полей ответа:

orderInfoList:

Пример запроса:
{
 "userId": 1,
 "sessionId": "b1581ac148e0796b176a8bc4e7b773ad",
 "orderId": 829,
 "command": "GET_ORDER_INFO",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример ответа:
{
 "orderId": 829,
 "statusExtStr": "NEW",
 "statusExtInt": 0,
 "orderInfoList": [
   {
     "actionId": 80,
     "actionName": "В сердце моря",
     "quantity": 1,
     "sum": 200,
     "smallPosterUrl": "https://api.bil24.pro:1240/image?type=smallPoster&actionId=80&hash=q823uap2k22aj0da1hbktd0ch"
   }
  ],
 "command": "GET_ORDER_INFO",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ ПОЧТЫ (command = GET_EMAIL)

Поля запроса:

Состав полей ответа:

Пример запроса:
{
"userId": 1,
"sessionId": "1e58084051c60a219d672c4b7a12d743",
"command": "GET_EMAIL",
"fid": 1,
"token": "f8fcf07a4ea5c7979780"
}

Пример ответа:
{
"email": "sinyakin89@list.ru",
"needSendTicketEmail": true,
"command": "GET_EMAIL",
"resultCode": 0,
"description": "OK"
}

ОТПРАВКА GCM ТОКЕНА НА СЕРВЕР (command = SET_PUSH_TOKEN)

Поля запроса:

Пример запроса:
{
 "userId": 1,
 "sessionId": "1e58084051c60a219d672c4b7a12d743",
 "pushToken": "ec7c5ae54051c60a219d672c4b7d743",
 "command": "SET_PUSH_TOKEN",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример ответа:
{
 "command": "SET_PUSH_TOKEN",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧИТЬ НОВОСТИ (command = GET_NEWS)

Поля запроса:

Состав полей ответа:

newsList:

Пример запроса (получить 10 новостей младше текущей даты):
{
 "time": 0,
 "count": 10,
 "cursorMode": "backward",
 "userId": 1,
 "sessionId": "1e58084051c60a219d672c4b7a12d743",
 "command": "GET_NEWS",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}
* time используется либо 0, либо unixTime пришедшей новости, либо serverUnixTime. Локальное время устройства не использовать!

Если time = 0, то на сервере используется значение текущего времени

Если cursorMode = forward, то новости приходят отсортированные по возрастанию даты
Если cursorMode = backward, то новости приходят отсортированные по убыванию даты.

Пример ответа:
{
 "datePattern": "dd.MM.yyyy HH:mm",
 "newsList": [
  {
   "id": 91,
   "unixTime": 1458571320000,
   "date": "21.03.2016 17:42",
   "header": "Заголовок 1",
   "fullDescription": "Описание 1"
  },
  {

   "id": 72,
   "unixTime": 1457989200000,
   "date": "15.03.2016 00:00",
   "header": "Заголовок 2",
   "fullDescription": "Описание 2"
  }
  ],
 "cursorMode": "backward",
 "serverUnixTime": 1459769342975,
 "last": false,
 "command": "GET_NEWS",
 "resultCode": 0,
 "description": "OK"
}

ПРОВЕРКА КДП (command = CHECK_KDP)

Поля запроса:

Пример запроса:
{
 "userId": 1,
 "sessionId": "1e58084051c60a219d672c4b7a12d743",
 "actionId": 10,
 "kdp": 12345,
 "command": "CHECK_KDP",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример положительного ответа:
{
 "command": "CHECK_KDP",
 "resultCode": 0,
 "description": "OK"
}

Пример ответа с неверным КДП:
{
 "command": "CHECK_KDP",
 "resultCode": 101,
 "description": "неверный КДП"
}

ПОЛУЧЕНИЕ ДАННЫХ ДЛЯ ФИЛЬТРА (command = GET_FILTER).

Поля запроса:

Состав полей ответа:

cityList:

venueList:

kindList:

Пример запроса:
{
 "command": "GET_FILTER",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример ответа:
{
 "cityList": [
   {
     "cityId": 1,
     "cityName": "Сочи",
     "venueList": [
       {
          "venueId": 1,
         "venueName": "Зимний театр"
       },
       {
         "venueId": 24,
         "venueName": "Зеленый театр парка \"Ривьера\""
       }
     ]
   },
   {
     "cityId": 2,
     "cityName": "Москва",
     "venueList": [
       {
         "venueId": 4,
         "venueName": "Малая Спортивная Арена Лужники"
       },
        {
         "venueId": 20,
         "venueName": "SCANDINAVIA CLUB"
       }
     ]
   },
 ],
 "kindList": [
   {
     "kindId": 0,
     "kindName": "События"
   },
    {
      "kindId": 1,
     "kindName": "Карты (МЭК)"
   },
   {
     "kindId": 2,
     "kindName": "Экскурсии"
   },
   {
     "kindId": 3,
     "kindName": "Рестораны"
   },
   {
     "kindId": 4,
     "kindName": "Отели"
   }
 ],
 "command": "GET_FILTER",
 "resultCode": 0,
 "description": "OK"
}

ПРИВЯЗКА ПОЧТЫ (command = BIND_EMAIL)

Чтобы подтвердить почту, необходимо:
1. выполнить метод BIND_EMAIL. На указанную почту придет код подтверждения.
2. выполнить CONFIRM_EMAIL с кодом, пришедшим на почту. В ответе придут данные аккаунта (userId, sessionId), к которым успешно прикреплена почта. С этими данными необходимо выполнять все последующие запросы.

Поля запроса:

Пример запроса:
{
 "userId": 1,
 "sessionId": "1e58084051c60a219d672c4b7a12d743",
 "command": "BIND_EMAIL",
 "email": "email@list.ru",
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример положительного ответа:
{
 "command": "BIND_EMAIL",
 "resultCode": 0,
 "description": "OK"
}

ПОДТВЕРЖДЕНИЕ ПОЧТЫ (command = CONFIRM_EMAIL)

Поля запроса:

Состав полей ответа:

Пример запроса:
{
 "userId": 1,
 "sessionId": "1e58084051c60a219d672c4b7a12d743",
 "command": "CONFIRM_EMAIL",
 "code": 123456,
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример положительного ответа:
{
 "command": "CONFIRM_EMAIL",
 "userId": 2,
 "sessionId": "2e4566051c60a219d672c4b7a12d129",
 "email": "email@list.ru",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ КАРТ (МЭК) (command = GET_MECS)

Поля запроса:

*mecId - Поле используется для экономии трафика в основном на мобильных фронтендах. Если передать данное поле в запросе, то в ответ вернутся карты с id большим чем переданный в запросе. Подразумевается, что карты с id <= mecId хранятся локально и не требуются в повторной загрузке.

Состав полей ответа:

list:

mecList:

Пример запроса:
{
 "mecId": 5,
 "sizeQrCode": 500,
 "widthBarCode": 500,
 "heightBarCode": 100,
 "userId": 11,
 "sessionId": "c6721d3c35c247da84ac460004840b68",
 "command": "GET_MECS",
  "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример успешного ответа:
{
 "list": [
  {
  "actionEventId": 1178,
  "actionName": "Карта Магнит",
  "fullActionName": "Товары и услуги со скидками для сотрудников сети",
  "bigPosterUrl": "https://api.bil24.pro:1240/image?type=bigPoster&actionId=156&hash=ixr9rn1fmd1hssxl6k06q3png",
  "smallPosterUrl": "https://api.bil24.pro:1240/image?type=smallPoster&actionId=156&hash=k2tlcg2xsq82jynqo9yqkmr1q",
   "cityId": 1,
  "cityName": "Краснодар",
   "venueName": "Розничная сеть Магнит",
   "venueAddress": "Краснодар, ул. Солнечная, 15/5",
  "cityPass": false,
  "quantity": 2,
  "totalSum": 4645.00,
   "mecList": [
    {
    "mecId": 29096,
    "categoryName": "Категория: Корпоративная",
    "price": 245,
    "qrCodeImg": "qrCodeImg",
    "barCodeImg": "barCodeImg",
    "barCodeNumber": "2400107290966"
    },
   {
    "mecId": 29097,
    "categoryName": "Категория: Платиновая",
    "price": 4400,
    "qrCodeImg": "qrCodeImg",
    "barCodeImg": "barCodeImg",
    "barCodeNumber": "2400107290973"
   }
  ]
   },
  {
   "actionEventId": 1380,
   "actionName": "КЛУБ ЛЮБИМЫХ",
   "fullActionName": "карта бонусной программы",
   "bigPosterUrl": "https://api.bil24.pro:1240/image?type=bigPoster&actionId=201&hash=ohvtolmud5n3eacnl1ho1ysbe",
   "smallPosterUrl": "https://api.bil24.pro:1240/image?type=smallPoster&actionId=201&hash=gnoi2lhueiyx5d555gf8ziegt",
    "cityId": 2,
    "cityName": "Сочи",
    "venueName": "территория Сочи",
    "venueAddress": "Россия, Краснодарский край, Сочи",
    "cityPass": false,
   "quantity": 1,
    "totalSum": 0.00,
    "mecList": [
    {
     "mecId": 29102,
     "categoryName": "Категория: Золотая",
     "price": 0,
     "qrCodeImg": "qrCodeImg",
     "barCodeImg": "barCodeImg",
     "barCodeNumber": "2403107291025"
    }
    ]
  }
 ],
 "command": "GET_MECS",
 "resultCode": 0,
 "description": "OK"
}

ПОЛУЧЕНИЕ ПРОМОКОДОВ (command = GET_PROMO_CODES)

Поля запроса:

Состав полей ответа:

promoPackList:

promoCodeList:

Если used или spent равен true, либо activeNow равен false, этот пользователь не может использовать данный промокод

ВОЗВРАТ БИЛЕТОВ (command = REFUND_TICKETS)*

Описание: возврат билетов.
*только для интерфейса Билетная система.

Поля запроса:

Состав полей ответа:

Статус возврата билетов:
1 - невозможно вернуть
2 - в процессе возврата
3 - билет возвращен

Примечание: повторный запрос на отмену билета не вернет ошибку, а вернет текущий статус билета.

Пример запроса:
{
 "userId": 1,
 "sessionId": "1e58084051c60a219d672c4b7a12d743",
 "command": "REFUND_TICKETS",
 "ticketIdSet": [1, 2, 3],
 "fid": 1,
 "token": "f8fcf07a4ea5c7979780"
}

Пример положительного ответа:
{
 "command": "REFUND_TICKETS",
  "statusMap": {
  "1" : 1,
  "2" : 2,
  "3" : 2
 }
 "resultCode": 0,
 "description": "OK"
}

СТАТУС ЗАКАЗА

Некоторые методы возвращают в своем составе поля статус заказа (statusExtStr и statusExtInt).

Статус заказа может меняться в следующих последовательностях:
NEW → PROCESSING → PAID
NEW → CANCELLING → CANCELLED

В исключительных случаях, из-за ошибок во внешних билетных системах, заказ может быть отменен вручную оператором системы, в этом случае статус заказа изменится так:
PROCESSING → CANCELLED

Статусы PAID и CANCELLED являются окончательными и не могут быть изменены. Получение билетов необходимо производить только после достижения заказом статуса PAID.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 09.05.2016

1. Метод GET_VENUES
- в ответе в объекте Venue добавил параметр cityId, параметр cityName теперь обязательный в ответе;
- поле fields: CITY_NAME устарело, добавил значение DESCRIPTION.

2. Метод GET_ACTIONS
- в запросе добавил поле dateFrom - необязательное (от какой даты получить представления);
- в ответе добавил поле actionEventTime - необязательное (если сеанс идет всегда в одно время, то поле будет);
- в ответе добавил поле venueName - необязательное (если место проведение всего одно, то поле будет);
- в ответе добавил поле kdp - обязательное (КДП - код доступа к представлению).
*Перед открытием схемы зала или нажатием кнопки забронировать(безместовая схема зала) пользователь должен ввести КДП (метод для проверки кдп - CHECK_KDP)

3. Метод GET_ORDERS
- в объекте paymentOrder поле type устарело и не используется, вместо него поле gateway;
- описаны все имеющиеся на данный момент paymentOrder.

4. Методе GET_TICKETS_BY_ACTION_EVENT
- в списке билетов добавил поле actionName;
- в списке билетов добавил поле smallPosterUrl.

5. Добавил GET_TICKETS_BY_ORDER
Возвращает все данные билетов по заказу.

6. Добавил метод CHECK_KDP (смотреть пункт 2)

7. Метод CREATE_ORDER
- добавил поля successUrl, failUrl - ОБЯЗАТЕЛЬНЫЕ поля, редиректы после оплаты;
- добавил поле email - необязательный параметр, указывает на то, на какой адрес отправить билеты после оплаты.

8. Добавил метод GET_FILTER

9. Метод GET_ACTION_EVENTS_GROUPED_BY_TICKETS
добавил поля:
fullActionName - полное название представления;
cityName - название города;
venueName - наименование места проведения;
quantity - количество билетов;
sum - сумма билетов.

10. Добавил метод GET_ACTION_EXT
возвращает информацию о мероприятии в конкретном городе, список мест где оно проводится, в каждом месте проведения список сеансов. Данный метод сделан для упрощения программирования. Вместо него надо было выполнить 3 запроса к серверу: GET_VENUES, GET_ACTION, GET_ACTION_EVENTS.

11. Добавил метод GET_CART
возвращает список забронированных мест. Места сгруппированы по сеансам. Метод GET_SEAT_IN_RESERVE устарел. Попрошу его больше не использовать.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 20.05.2016

1. Изменение в методе GET_ACTIONS (Метод устарел. Смотрим пункт 4)
- добавил обязательное поле kindId в ответе в списке actionList;
- добавил обязательное поле kindName в ответе в списке actionList.

2. Изменение в методе GET_ACTION_EXT
- добавил обязательное поле kindId в ответе в объекте action;
- добавил обязательное поле kindName в ответе в объекте action;
- добавил обязательное поле categoryList в ответе в объекте actionEventList.

3. Изменение в методе GET_ACTION (Метод устарел)
- добавил обязательное поле kindId в ответе в объекте action;
- добавил обязательное поле kindName в ответе в объекте action.

4. Добавил метод GET_ACTIONS_V2
новый метод вместо GET_ACTIONS. Метод позволяет запросить представления только по городу. Все остальные фильтры (места проведения, виды, дата) на клиенте.

5. Увидел в логах использование на фронтенде 1003 методов CHANGE_PRIVATE_DATA, GET_PRIVATE_DATA. Методы устарели месяца 4 назад. Попрошу перейти на метод SET_EMAIL, GET_EMAIL.

6. Метод GET_TICKETS_BY_ACTION_EVENT
15.10.2015 устарело поле seatInfo. 7. Метод GET_SEAT_IN_RESERVE устарел. Вместо него GET_CART.

8. Метод RESERVATION (бронирование мест в безместовой схеме зала)
поля quantity, categoryPriceId устарели. Вместо этих полей использовать categoryQuantityMap.

9. Метод GET_ORDERS
поле paymentOrder устарело. Добавил поле formUrl в orderList (поле перенесено из paymentOrder).

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 15.06.2016

1. Если представление требует ввода КДП, то при запросе схемы зала в url надо добавить параметр kdp=КДП.

2. В запросе "Бронирование места в безместовой схеме зала (command = RESERVATION)" добавлен необязательный параметр kdp. Передавать его, если представление требует ввод КДП.

3. Добавил в методе GET_CART в объекте actionEventList поля cityId и venueId.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 22.06.2016

1. В ответах на запросы GET_TICKETS_BY_ORDER и GET_TICKETS_BY_ACTION_EVENT в списке билетов добавлены два поля legalOwner и age.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 23.06.2016

1. Метод RESERVATION (type RESERVE, RESERVE_BY_PLACE). Добавил параметр kdp. Если представление требует ввода kdp, то параметр обязателен.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 08.07.2016

1. Добавил полу actionId в ответе на запрос GET_CART в объекте actionEventList.

2. Добавил поле phone в запросе CREATE_ORDER.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 22.07.2016

1. В ответе на запрос GET_CART добавил общий сервисный сбор, по сеансу и по месту.

2. В ответе на запрос GET_ACTION_EXT поле categoryList перенесено в categoryLimitList.

Существует 3 вида схем:
1. Безместовая. placementUrl будет отсутствовать, смотрим categoryLimitList.
2. Местовая. Смотрим placementUrl, categoryLimitList будет пустой.
3. Комбинированная. Смотрим placementUrl и categoryLimitList.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 16.08.2016

1. В ответе на запрос GET_ORDERS добавил поля discount и serviceCharge. Поля в рублях.

2. В запросе CREATE_ORDER добавил поля discount и serviceCharge. Поля в процентах.

3. В ответе на запрос AUTH добавил поле frontendType.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 02.09.2016

1. Добавил методы привязки почты BIND_EMAIL, CONFIRM_EMAIL.
Данные методы временно работают только в тестовой зоне. метод SET_EMAIL устарел и не работает теперь в тестовой зоне.

2. Добавил отдельный метод получения карт GET_MECS.
С учетом появления данного метода карты не отдаются методами GET_ACTION_EVENTS_GROUPED_BY_TICKETS, GET_TICKETS_BY_ACTION_EVENT. Ограничения по выдаче карт введены пока только в тестовой зоне. Карты не отдаются на немобильные фронтенды как в тестовой так и в реальной зоне.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 25.10.2016

1. Поля email и phone в запросе CREATE_ORDER доступны только для интерфейсов типа КАССА и ПРИГЛАСИТЕЛЬНЫЙ.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 25.11.2016

1. Добавлен метод возврата билетов REFUND_TICKETS.

2. Добавлено поле статус заказа (status) в ответах на запросы CREATE_ORDER и GET_ORDER_INFO.

3. Метод CREATE_ORDER. Поле paid устарело и будет удалено 25.12.2016.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 15.12.2016

1. Добавил метод GET_ORDERS_EXT.

2. Метод GET_TICKETS_BY_ORDER. Добавил поля: orderDatePattern, actionEventDatePattern, totalPrice, serviceCharge. Удалил поле datePattern.

3. Метод GET_TICKETS_BY_ACTION_EVENT. Добавил поля: totalPrice, serviceCharge.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 27.12.2016

1. Добавил в методе CREATE_ORDER поле fullName. Поле необязательное. Содержимое поля отобразится на билете.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 04.02.2017

1. Метод GET_ACTION_EXT. В категорию добавлен параметр availability. availability - кол-во доступных мест в категории. Если remainder отсутствует, то ориентируемся на availability. Если remainder присутствует, то нужно внимательно использовать эти параметры. К примеру общее ограничение remainder на 3 категории может быть 100, но и в каждой категории availability также может быть 100.

2. Добавлен новый статус resultCode 102, означающий, что необходимо привязать почту. Проверять данный код необходимо при ответе на запрос RESERVATION.

3. Метод GET_ACTION_EVENTS_GROUPED_BY_TICKETS. Добавлено поле ticketsUrl - ссылка на билеты в формате pdf (ссылка на вновь купленные билеты включительно с 27.02.2017. Если билет куплен ранее, то по ссылке билетов не будет).

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 05.05.2017

1. Метод GET_CITIES устарел. Вместо него использовать GET_FILTER.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 18.05.2017

1. Метод GET_ACTION_EXT. Добавлен параметр bookletUrl - ссылка на буклет на конкретное представление.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 08.06.2017

1. Добавлены поля статуса заказа (statusExtStr и statusExtInt) в ответах на запросы CREATE_ORDER, GET_ORDER_INFO, GET_ORDERS, GET_ORDERS_EXT, GET_TICKETS_BY_ORDER.

2. Поле status устарело в методах CREATE_ORDER, GET_ORDER_INFO, GET_ORDERS, GET_ORDERS_EXT, GET_TICKETS_BY_ORDER.

3. Добавлен метод CREATE_USER.

4. Добавлен метод GET_SEAT_LIST.

5. Добавлен метод CREATE_ORDER_EXT.

6. Добавлен метод CANCEL_ORDER.

7. Добавлен метод PAY_ORDER.

8. Добавлено новое поле age (возрастное ограничение) в ответ метода GET_ACTION_EXT.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 06.07.2017

1. Изменено описание метода GET_CITIES.

2. Добавлен метод GET_VENUE_TYPES.

3. Добавлен метод GET_VENUES.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 13.07.2017

1. Изменено описание методов бронирования RESERVATION.

2. Добавлено новое поле barCodeType (тип штрихкода) в ответ метода GET_TICKETS_BY_ORDER.

3. Добавлено новое необязательное поле longReservation в метод CREATE_ORDER_EXT.

4. Добавлено новое поле orderTimeout в ответ метода CREATE_ORDER_EXT.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 22.07.2017

1. Добавлены новые поля (organizerId, organizerName, legalOwner) в ответ метода GET_ACTION_EXT.

2. Добавлен метод GET_TICKETS_BY_DAY.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 09.08.2017

1. Поле userId в запросе GET_ACTION_EXT необязательное.

2. Добавлен раздел "Общая схема использования протокола": команды протокола делятся на сессионные и несессионные.
Список несессионных команд:
1. GET_ACTIONS_V2;
2. GET_ACTION_EXT;
3. GET_CITIES;
4. GET_VENUE_TYPES;
5. GET_VENUES;
6. GET_FILTER;
7. GET_SEAT_LIST;
8. GET_TICKETS_BY_DAY.

Нет необходимости выполнять команду AUTH раньше какой либо из перечисленных команд. Для их выполнения не нужен идентификатор сессии (sessionId).

Для выполнения сессионных команд нужно иметь sessionId. Получить его первоначально нужно с помощью команды AUTH (для билетных систем CREATE_USER). Полученные данные пользователя рекомендуется сохранить и использовать повторно. Сессия пользователя определяется sessionId и действует бессрочно.

В общем случае, sessionId понадобится перед командой BIND_EMAIL (RESERVATION для билетных систем).

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 23.08.2017

1. Добавлено новое поле seatId в ответ метода GET_TICKETS_BY_ORDER.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 02.10.2017

1. Добавил описание статусов билета в метод GET_TICKETS_BY_ORDER.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 18.02.2018

1. Добавлены новые поля seatList и cartTimeout в ответ метода RESERVATION.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 01.03.2018

1. Добавлены новые поля cityId и cityPass в ответ метод GET_MECS.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 12.03.2018

1. Добавлены новые поля seatingPlanId и seatingPlanName в ответ метода GET_ACTION_EXT.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 19.08.2018

1. Из всех запросов удалено обязательное поле versionCode. 2. Удален метод SEND_WI_FLY_DATA.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 16.10.2018

1. Везде изменен адрес сервера на api.bil24.pro.

2. В методе GET_TICKETS_BY_ORDER добавлено описание вариантов типов штрих-кодов.

3. В методах GET_CART, GET_MECS, GET_ORDERS_EXT, GET_TICKETS_BY_ACTION_EVENT, GET_TICKETS_BY_ORDER в параметры запроса добавлено новое необязательное поле rawCoordinates. Передача значения true исправляет несовместимости со значением координат мест (sector, row, number) и названием категории categoryName.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 06.12.2018

1. В ответ метода GET_SEAT_LIST добавлено новое поле categoryList.

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 12.12.2018

1. Добавлен новый метод для интерфейсов Билетная система GET_ALL_ACTIONS

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 23.04.2019

1. Добавлен новый метод ADD_PROMO_CODES
2. Добавлен новый метод GET_PROMO_CODES
3. Добавлены новые поля categoryPriceId, nominal, discount и discountReason в ответ метода GET_CART
4. Добавлено новое поле externalOrderId в ответ метода CREATE_ORDER_EXT

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 21.05.2019

1. Добавлен новый метод GET_SCHEMA

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 10.06.2019

1. В ответ метода GET_PROMO_CODES добавлено новое поле minPrice

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 23.07.2019

1. В ответ метода GET_SEAT_LIST добавлено новое необязательное поле categoryLimitList
2. В запрос метода CREATE_ORDER_EXT добавлены новые необязательные поля discountPercent и chargePercent

ИЗМЕНЕНИЯ ПРОТОКОЛА ОТ 13.08.2019

1. В ответ метода GET_CART добавлены новые поля fullNameRequired и phoneRequired
2. В ответ метода GET_ALL_ACTIONS добавлено новое поле phoneRequired