Список событий, имеющихся в продаже

<< Оглавление >>

Навигация:  Функциональные методы > Списки > События >

Список событий, имеющихся в продаже

ПредыдущаяВернуться на уроветь вверхСледующая

Function GetEventList(strInp: string): string;

Метод возвращает список актуальных на момент запроса событий (единиц репертуара)

 

Данный метод  возвращает список актуальных на момент запроса событий (кроме случаев, если указан параметр ShowPast).

Для сторонних сайтов метод возвращает только события, на которые выдана квота и есть свободные места.

Для "своего" сайта, если указан параметр FreeOnly = 0, то выдается список всех актуальных событий, если FreeOnly = 1, то всех актуальных событий, на которые выдана квота и есть свободные места.

Если указан параметр NomBilKn, то метод вернет информацию только по событию с указанным ID.

 

Описание входных параметров.

- [cod_t] - Идентификатор места проведения (театра)

- [cod_th] - Идентификатор зала места проведения (сцены)

- [NomBilKn] - Идентификатор события.

- [FreeOnly] - Признак показывать только свободные. По-умолчанию 1.

- [Date] - Дата, на которую вернуть список мероприятий. Время не учитывается.

- [cod_show] - Идентификатор мероприятия (спектакля).

- [DateFrom] - Дата начала вывода списка событий. Если время не указано, время начала считается с 00:00

- [DateTo] - Дата окончания вывода списка событий. Если время не указано, время окончания считается до 23:59:59

- [ShowPast] - Показывать прошедшие события. Если не указаны дата начала и окончания будут показаны все события. По-умолчанию 0.

- [SeasonTicketId] - Идентификатор абонемента.

- [FreeOnly] - Флаг только свободные. По-умолчанию - 1.

- [OffSet] - При выводе списка записей смещение от начала списка

- [Limit] - При выводе списка записей кол-во записей, которые необходимо вернуть

- [isService] - Флаг, передавать в списке события-услуги.  (1 - передавать только услуги, 0 - все, кроме услуг) По-умолчанию 0.

- [isCanceled] - Флаг, передавать отмененные события.  (0 - передавать только действующие события 1 - передвать отмененные события, 2 - все) По-умолчанию 2.

- [isSeasonTicketCompany] - Флаг, показать события, учавствующие в абонементной компании.  (0 - передавать все события, 1 - передавать только события абонементной компании). По-умолчанию 0.

- [name_show] - Наименование мероприятия (спектакля) для поиска по вхождению.

 

 

Метод принимает только одну запись входящих параметров.

(Нельзя передать, например: <InputRow NomBilKn="1" /><InputRow NomBilKn="2" />)

Метод возвращает большой массив данных (список событий с их параметрами и описаниями), поэтому не рекомендуется частый вызов данного метода.

 

В данном методе введена необязательная  "пагинация". Для ее использования необходимо указать параметры:

Offset - сдвиг от начала списка

Limit - кол-во записей для вывода.

Например: если указано Offset="0" Limit="5" будет возвращено 5 записей от начала списка.

если указано Offset="5" Limit="10" будет возвращено 10 записей начиная от шестой (1+5) от начала списка.

Также введен параметр AllRecords в XML ответа для получения общего кол-ва записей, если используется "пагинация".

Если "пагинация" не используется, AllRecords равен RecordCount

 

Если указан параметр SeasonTicketId, то остальные параметры фильтрации не учитываются!

Пагинация учитывается, но рекомендуется в этом случае ее не использовать.

 

Описание полей в выходных данных

- NomBilKn - Идентификатор события

- EventDate - Дата события (или дата окончания события, если оно с открытой датой)

- EventTime - Время события (или время окончания события, если оно с открытой датой)

- BeginDate - Дата начала события (если событие с открытой датой; если нет, то равно EventDate)

- BeginTime - Время начала события (если событие с открытой датой; если нет, то равно EventTime)

- withOpenDate - Признак событие с открытой датой

- StopOrderDate - Дата, после которой бронирование на данное событие запрещено.

- StopOrderTime - Время, после которого бронирование на данное событие запрещено.

- StopSaleDate - Дата, после которой продажа на данное событие запрещено.

- StopSaleTime - Время, после которого продажа на данное событие запрещено.

- StopReturnDate - Дата, после которой возврат билетов на данное событие запрещен.

- cod_show  - Идентификатор мероприятия

- cod_t - Идентификатор места проведения (театра)

- cod_h - Идентификатор зала места проведения (сцены)

- EventDuration Продолжительность события (может отличаться от продолжительности мероприятия)

- is_Primera - Флаг, премьера или нет (может отличаться от флага, установленного для мероприятия)

- WithIntermission - Флаг "с антрактом" (может отличаться от флага, установленного для мероприятия)

- EventNote - Примечания к событию,

- name_show - Наименование мероприятия,

- author - Автор мероприятия,

- Note1 - Строка примечаний к мероприятию 1,

- Note2 - Строка примечаний к мероприятию 2,

- Note3  - Строка примечаний к мероприятию 3,

- Note4  - Строка примечаний к мероприятию 4,

- Tag - Тег(и).

- Age - Возрастное ограничение,  -1 - не определен. (если передается, например, 16, это означает 16+)

- Producer - Продюссер,

- Actors - Актеры,

- Annotation - Анотация,

- OrganizerID - Идентификатор организатора мероприятия,

- OrganizerName - Наименование организатора мероприятия,

- OrganizerTin - ИНН организатора мероприятия,

- OrganizerPhone - Телефон организатора мероприятия,

- OrganizerEmail - Email организатора мероприятия,

- OrganizerAddress - Адрес организатора мероприятия,

- OrganizationProCultureID - Идентификатор организации в ПроКультура,

- MinPrice - Цена номинал минимальная (только на места, доступные для текущего шлюза)

- MinPriceSell - Цена продажи минимальная (только на места, доступные для текущего шлюза)

- MaxPrice - Цена номинал максимальная (только на места, доступные для текущего шлюза)

- MaxPriceSell - Цена продажи максимальная (только на места, доступные для текущего шлюза)

 

- FreePlacesQty - Кол-во доступных для шлюза мест обычной (не эксклюзивной) квоты.

- FreePlacesQtyExclusive - Кол-во доступных для шлюза мест эксклюзивной квоты.

- FreePlacesTicketOffice - Кол-во свободных мест в кассе театра. (Для стороннего сайта всегда равно -1)

- ETicketPermitted - Разрешен проход по электронному билету. (1 - разрешено, 0 - нет).

 

- SeasonTicket - Признак абонемента (0 - обычное событие, 1 - событие-абонемент, 2 - событие относится к абонементу)

- SeasonTicketID - Идентификатор абонемента (0 - если событие - не абонемент)

- SeasonTicketEvents - Кол-во событий, относящихся к абонементу (0 - если событие - не абонемент).

 

- EventsSetID - Идентификатор комплекта (0, если не комплект)

- EventsSetEvents - Кол-во событий, относящихся к комплекту (0 - если событие - не комплект).

- EventsSetName - Наименование комплекта.

 

- MultiSelectAllowed - Разрешен множественный выбор мест. (Если параметр равен 1, места события могут быть объеденены с местами других событий в одном заказе)

- MaxPlacesQty - Кол-во мест в одном заказе на событие. (0 - нет ограничений, любое число - кол-во мест в одном заказе на это событие)

- DeleteReservPlacesPermitted - Разрешено частичное удаление мест из заказа. (1 - разрешено, 0 - запрещено)

- isService - Признак, является ли событие услугой

- isCanceled - Признак отмены мероприятия

- LinkedServicesExists - Существуют ли привязанные к мероприятию услуги (услуги могут быть связаны только с событиями, у которых нет признака "услуга")

- PromoExists - Существуют ли промокоды на событие (0- не существуют, 1 существует хотя бы один не требующий ввода email, 2 - существует хотя бы один, требующий ввода Email),

- SalesByQty - Продажа мест по кол-ву,

- isShowBySectors - Признак отображения схемы зала по секторам или полностью (0 - полностью, 1 - по секторам)

- isRevaluation - Признак динамической переоценки мест.

- isReservPermitted - Разрешена бронь на событие.

- isSalesPermitted - Разрешена продажа на событие.

- isSeasonTicketCompany - Признак принадлежности к абонементной кампании.

- SeasonTicketCompanyMin - Минимальное кол-во билетов для получения скидки по абонементной кампании.

- VatId - Идентификатор НДС

- Status - Статус события.

- isSoldCertificates - Разрешена оплата сертификатами.

- BlockPlacesAround - Признак блокировки мест (социальная рассадка).

- CheckPersonalData - Признак - при бронировании на событие запрашивать данные, передаваемые в ДИТ.

- ProCultureID - ID мероприятия в ПроКультура

- PushkinCardPermitted - Разрешение продажи по программе "Пушкинская карта". (0 - не разрешено, 1 - разрешено, 2 - только по "Пушкинской карте")

- QRCodeOnly - Признак - доступ на событие разрешен только при предъявлении QR кода о вакцинации.

- GroupOrderPermitted - Признак - На событие разрешено (не разрешено) создавать групповые заказы,

- DiscountProgram - Событие участвует в дисконтной программе (только для собственного сайта),

- LoyaltyProgram - Событие участвует в программе лояльности (только для собственного сайта).

- LoyaltyPoints - Кол-во баллов по программе лояльности, начисляемых зрителю при покупке билетов на данное событие (только для собственного сайта).

- ReturnDiscountPermit - Разрешение возврата билетов, купленных по промокоду.

- RequestVisitorData - Запрашивать данные зрителя (0 - не запрашивать, 1 - запрашивать только ФИО, 2 - запрашивать ФИО + тип, серию и номер документа).

- OfficialPlacesPermit - Разрешение на выдачу служебных мест через шлюз на данном событии (только для собственного сайта)

- UseBenefits - Флаг - на событие разрешено применять скидки (см. метод GetBenefitsList)

- HaveHallViewPics - Признак на событие есть фотографии, как с места видна сцена

- result_code - Код ошибки

- result_message - Описание ошибки

 

Обратите внимание!

Поле FreePlacesTicketOffice возвращает реальное значение только для "своего" сайта. Для стороннего сайта значение этого поля равно -1.

Обратите внимание!

Дата и время, указанные в StopOrderDate и StopOrderTime это дата и время, после которых не разрешена бронь, но может разрешена продажа (если поля StopSaleDate и StopSaleTime имеют соответствующие значения).

 

Заказ на событие, где разрешена только продажа, заказ будет снят автоматически сразу после разблокировки.

Реализация алгоритма запрета брони, но возможности продажи лежит на стороне подключающегося сайта.

Обратите внимание!

Если параметр isReservPermitted = 1 и isSalesPermitted = 0, на событие разрешена только бронь,

 

Если параметр isReservPermitted = 0 и isSalesPermitted = 1, на событие разрешена только продажа.

 

Если разрешена только продажа, порядок вызовов методов резерва и продажи остается неизменным.

 

Контроль за обязательным вызовом метода продажи лежит на стороне сайта.

 

Входной XML.

<GateReq>

<ReqLogin>

        <!--  Имя пользователя и пароль для авторизации -->

       <UserName>User</UserName>

       <UserPass>Password</UserPass>

</ReqLogin>

<ReqBody>

       <InputRow [cod_t="Код театра"] [cod_th="Код сцены"] [DateFrom="20.03.2019"] [DateTo="20.04.2019"]/>

</ReqBody>

</GateReq>

 

Выходной XML.

<GateAnswer>

<AnswerResult>

  <ResultCode>0</ResultCode><!--  Код ответа шлюза, общий для всего запроса-->

  <RecordCount>2</RecordCount><!--  Количество записей в возвращаемом "RecordSet-е" -->

  <AllRecords>2</AllRecords>

</AnswerResult>

<AnswerBody>

  <Row NomBilKn="2"  EventDate="20.03.2026" EventTime="19:00" cod_show="12" cod_t="1" cod_h="3" ... result_code="0" result_message="OK"/>

  <Row NomBilKn="3"  EventDate="21.03.2026" EventTime="19:00" cod_show="15" cod_t="1" cod_h="4" ... result_code="0" result_message="OK"/>

</AnswerBody>

</GateAnswer>