Спецификация метода AvailabilitySearch

Пример вызова


Протокол: HTTP POST
Адресная строка: api/availability/execute



Полный аналог предыдущего метода, но все данные отправляются в теле запроса, также необходимо для запроса установить Content-Type: text/xml

Информация о запросе

Ниже приведены параметры запроса и их краткое описание

Параметры запроса

НазваниеОписаниеТИП
req Объект CommonSearchRequest с параметрами запроса

GET


Описание работы сервиса

Сервис Availability (Поиск по расписанию) - поиск по наличию мест на заданное направление и даты.

Данный метод осуществляет поиск вариантов перелета по заданному маршруту по расписанию.

Возможен поиск в режиме «в одну сторону», «туда-обратно» и «сложный маршрут».

Метод возвращает множество вариантов перелета без информации об их стоимости.

Стоимость каждого варианта можно будет оценить лишь на следующем шаге бизнес-процесса: PriceExact - точный расчет стоимости перелета.

Позиция в диаграмме бизнес-процесса

Ответ на запрос AvailabilitySearch

Общая информация о структуре ответа

Ответ метода AvailabilitySearch содержит в себе 4 узла:

  • Errors - ошибки, произошедшие в процессе выполнения запроса;
  • Remarks - примечания;
  • ReferenceContainer - справочники аэропортов, городов, авиакомпаний и branded fares, присутствующих в ответе;
  • Route - контейнер сегментов;

Availability — бизнес-объект, который используется при поиске перелета по расписанию.

Поиск по расписанию возможен для маршрутов «в одну сторону», «туда и обратно» и «сложный маршрут».

Метод поиска по расписанию (Availability) возвращает множество элементов Availability, каждый из которых представляет собой контейнер данных об одном варианте перелета.

В отличии от контейнера MultiItinerary, который используется при поиске по расписанию, контейнер Availability не содержит данных по расчету тарифа, а только информацию о рейсах и доступных классах бронирования на них.

Контейнер Availability используется только для работы с методом Availability, на дальнейших этапах поиска по расписанию (точный расчет выбранного варианта PriceExact, бронирование Booking, оформление билета Ticketing) используется контейнер MultiItinerary.

Поля класса:

Тип XML-тип Название Комментарий Наличие в ответах Пример
string Attribute Origin аэропорт вылета (код аэропорта IATA - скачать список с datahub.io) всегда MOW
string Attribute Destination аэропорт прилета (код аэропорта IATA - скачать список с datahub.io) всегда MUC
datetime Attribute Date дата и время вылета всегда 12.12.2017 18:00:00
AvailabilityLeg Element AvailabilityLeg коллекция маршрутов, принадлежащих данному контейнеру всегда -

AvailabilityLeg (Element, входящий в контейнер Availability)


AvailabilityLeg - участок перелета, содержащий один или более рейсов(связанных авиакомпанией на техническом уровне участков перелета от начального до конечного пункта, включая трансферные пункты). Так как не любую пару городов связывает прямое воздушное сообщение (прямые рейсы), то не всегда один участок перелета можно преодолеть одним рейсом. Иногда требуется лететь последовательно двумя или тремя рейсами отдельными прямыми рейсами, чтобы из пункта отправления попасть в пункт назначения. Такие рейсы называют стыковочными, а те пункты (города), где осуществляются пересадки с одного рейса на другой – пунктами пересадки (стыковки), разумеется, пункт прилета первого рейса является пунктом вылета следующего. Стыковочные рейсы образуются независимыми друг от друга прямыми рейсами, в общем случае это рейсы разных авиакомпаний, каждый из них имеет свой номер, свой тип самолета и прочие характеристики. Стыковки бывают как в рамках одного аэропорта, так и с переездом в другой аэропорт того же города.

Например, из Москвы до Сиднея (Австралия) нет прямого рейса. Поэтому можно лететь, например, со стыковкой во Франкфурте:

  • SU 109 SVO D FRA 2 2125 2240 E0/319 Аэрофлот Москва - Франкфурт
  • QF 006 FRA 2 SYD 1 2350 0510+2E1/744 Qantas Франкфурт – Сидней.

Стыковки строятся автоматически системами ГДС по специальным алгоритмам. При этом проверяется так называемое MCT (minimum connecting time, минимальное время стыковки) – время, требующееся для осуществления пересадки с рейса на рейс. В ГДС достаточно указать дату, начальный и конечный пункт участка перелета – и она подберет стыковки. Однако перелет стыковочными рейсами используется не только в том случае, если между начальным и конечным пунктом нет прямых рейсов. Довольно часто перелет стыковочными рейсами стоит дешевле прямого рейса, а иногда он получается удобнее по времени вылета/прилета и т.п. Не нужно путать стыковочные (пересадочные) пункты с пунктами отправления/назначения сегментов перелета. В терминах нашей системы участки (сегменты) задаются пользователем, и на этапе задания маршрута он не должен(кроме тех случаев, когда пассажир указывает конкретную точку пересадки по своей инициативе) задумываться о том, какие пересадки пассажиру потребуется совершить, чтобы попасть из пункта отправления каждого участка в пункт назначения. Если пассажир хочет лететь из Москвы в Сидней, значит, у него маршрут OW, состоящий из 1 участка перелета: Москва – Сидней. То, что на участке Москва – Сидней пассажир делает стыковку во Франкфурте, не значит, что у него 2 участка (сегмента) перелета. В терминах ГДС сегментом маршрута называется каждый прямой рейс маршрута. Соответственно, для ГДС в маршруте Москва – Сидней будет 2 сегмента: Москва – Франкфурт и Франкфурт – Сидней.

Поля класса:

Тип XML-тип Название Комментарий Наличие в ответах Пример
uint Attribute Key уникальный идентификатор группы участков всегда 3460159847
int Attribute id_System система бронирования - идентификатор GDS, из которой получен данный участок всегда 3
int Attribute DurationMinutes длительность полета в минутах 2 190
AvailabilityFlight Element AvailabilityFlight сегмент перелета (конкретный рейс) в данном маршруте всегда, если бронь не отменена -

AvailabilityFlight (Element, входящий в контейнер AvailabilityLeg)


AvailabilityFlight - описание сегмента перелета (конкретного рейса) в составе AvailabilityLeg с указанием авиа перевозчика, тарифа, дат и времени, а так же аэропорта вылета и прилета, класса обслуживания и статуса подтверждения с локатором авиакомпании.

Дает нам полную информацию о сегменте перелета, а так же статус его подтверждения.

Поля класса:

Тип XML-тип Название Комментарий Наличие в ответах Пример
uint Attribute Key уникальный идентификатор рейса всегда 1583579537
string Attribute Airline код авиакомпании IATA - скачать список с openflights.org
маркетинговый перевозчик
всегда SU
string Attribute OperatingAirline оперирующий перевозчик всегда SU
int Attribute Number номер рейса всегда 2320
string Attribute Origin аэропорт вылета (код аэропорта IATA - скачать список с datahub.io) всегда SVO
string Attribute OriginTerminal терминал в пункте отправления всегда, если в пункте отправления есть терминалы D
string Attribute Destination аэропорт прилета (код аэропорта IATA - скачать список с datahub.io) всегда MUC
string Attribute DestinationTerminal терминал в пункте прибытия всегда, если в пункте прибытия есть терминалы 1
datetime Attribute DepartureDate дата и время вылета всегда 18.12.2017 8:05:00
datetime Attribute ArrivalDate дата и время прилета всегда 18.12.2017 9:15:00
string Attribute AirplaneCode код самолета - Квалификатор воздушных судов всегда 320
string Attribute Status статус рейса всегда HK
int Attribute NumOfStops количество промежуточных посадок всегда 0
RBD Element RBD список кодов класса бронирования (часто бывает первой буквой FareName) и наличие всегда -

RBD (Element, входящий в контейнер AvailabilityFlight)


RBD — код класса бронирования (часто бывает первой буквой кода тарифа FareName).

По каждому рейсу маршрута метод поиска по расписанию Availability в контейнере Availability/AvailabilityLeg/Flight возвращает все классы бронирования, которые есть на рейсе с указанием количества мест, доступных для одновременного бронирования.

Если для класса бронирования, скажем, Y, кол-во доступных мест равно 7, то это не значит, что их на рейсе именно семь. Авиакомпании ограничивают показ доступных мест по классам числами от 1 до 9. Допустим, если для какого-то класса максимально возможное кол-во мест для показа 9, а реально их доступно 20, то система покажет на этот класс 9 доступных мест. А если реально доступных мест на этот класс станет 6, то система так и покажет 6.

Поля класса:

Тип XML-тип Название Комментарий Наличие в ответах Пример
string Attribute например, Y буква кода семейства тарифа (Branded Fare) всегда Y="7"
string Attribute например, 7 количество мест по данному тарифу всегда Y="7"

ReferenceContainer - справочники авиакомпаний, городов, аэропортов и семейств тарифов.

Структура ответа

  • Airlines(ReferenceAirline) - список авиакомпаний, каждая из которых присутствует хотя бы в одном из рейсов в ответе;
    • Rus - название авиакомпании на русском языке (некоторые названия не переводятся и совпадают с английским)
    • En - название авиакомпании на английском языке
    • Code - код авиакомпании IATA - скачать список с openflights.org
  • Airports(ReferenceAirport) - список аэропортов, каждый из которых является пунктом вылета или прилета хотя бы в одном из рейсов в ответе;
    • Rus - название аэропорта на русском языке (некоторые названия не переводятся и совпадают с английским)
    • En - название аэропорта на английском языке
    • Code - код аэропорта IATA - скачать список с datahub.io
    • id_City - идентификатор города, в котором расположен аэропорт, см. ReferenceCity
    • Longitude - долгота аэропорта
    • Latitude - широта аэропорта
  • Cities(ReferenceCity) - список городов, в которых находятся аэропорты из пункта выше.
    • Rus - название города на русском (некоторые названия не переводятся и совпадают с английским)
    • En - название города на английском
    • Code - код города IATA - скачать список с openflights.org
    • Country - код страны ISO 3166-2 - скачать список с openflights.org
    • id_City - идентификатор города
    • CountryName - сведения о стране, в которой находится город
      • Rus - название страны на русском
      • En - название страны на английском
  • FamiliesV2(FamilyV2) - список семейств тарифов, которые представлены в ответе;
    • AirlineCode - код авиакомпании IATA - скачать список с openflights.org
    • Name - название семейства
    • id_Family - id семейства
    • id_Airline - id авиакомпании
    • FareNameRegex - REGEX для проверки условий тарифа
    • NameEnglish - название семейства на английском
    • Services(ServiceV2) - перечень услуг, которые могут быть доступны или недоступны при выполнении перелета по тарифу из семейства;
      • ServiceCode - код услуги
      • IsFree - включена услуга в тариф или нет
      • id_Service - id услуги
      • id_Family - id семейства
      • Description - описание услуги
      • DescriptionEnglish - описание услуги на английском
  • Airplanes(ReferenceAirplane) - список воздушных суден, которые представлены в ответе.
    • Code - код воздушного судна
    • Name - название воздушного судна

Пример ответа

<?xml version="1.0" encoding="utf-8" ?>
<ReferenceContainer>
  <Airlines>
    <ReferenceAirline Rus="Уральские Авиалинии" En="Ural Airlines" Code="U6" />
  </Airlines>
  <Airports>
    <ReferenceAirport Rus="Домодедово" En="Domodedovo" Code="DME" id_City="660" Longitude="37,906111" Latitude="55,408611" />
    <ReferenceAirport Rus="Екатеринбург" En="Ekaterinburg" Code="SVX" id_City="708" Longitude="60,802700042725" Latitude="56,743099212646" />
  </Airports>
  <Cities>
    <ReferenceCity Rus="Москва" En="Moscow" Code="MOW" Country="RU" id_City="660">
      <CountryName Rus="Россия" En="Russia" />
    </ReferenceCity>
    <ReferenceCity Rus="Екатеринбург" En="Ekaterinburg" Code="SVX" Country="RU" id_City="708">
      <CountryName Rus="Россия" En="Russia" />
    </ReferenceCity>
  </Cities>
  <FamiliesV2>
    <FamilyV2 AirlineCode="U6" Name="Промо" id_Family="175" id_Airline="1001" FareNameRegex="^(.*\d*(PR)).*\d*$" NameEnglish="Promo">
      <Services>
        <ServiceV2 ServiceCode="exchangeable" IsFree="false" id_Service="853" id_Family="175">
          <Description>Изменения в билете до вылета (за 40 мин. до окончания регистрации) разрешены со сбором за каждый сегмент</Description>
          <DescriptionEnglish>Changes to the ticket before departure (40 minutes before the end of registration) are allowed with an additional charge for each segment</DescriptionEnglish>
        </ServiceV2>
        <ServiceV2 ServiceCode="carryOn" IsFree="true" id_Service="851" id_Family="175">
          <Description>5 кг</Description>
          <DescriptionEnglish>Up to 5 kg</DescriptionEnglish>
        </ServiceV2>
        <ServiceV2 ServiceCode="baggage" IsFree="true" id_Service="852" id_Family="175">
          <Description>Один чемодан 10 кг</Description>
          <DescriptionEnglish>1 item up to 10 kg</DescriptionEnglish>
        </ServiceV2>
      </Services>
    </FamilyV2>
  </FamiliesV2>
  <Airplanes>
    <ReferenceAirplane Code="320">
      <Name>AIRBUS INDUSTRIE A320-100/200</Name>
    </ReferenceAirplane>
    <ReferenceAirplane Code="319">
      <Name>AIRBUS INDUSTRIE A319</Name>
    </ReferenceAirplane>
  </Airplanes>
  <Systems />
</ReferenceContainer>

Errors

Контейнер ошибок, каждый элемент которого выглядит следующим образом:
Module: MASTERPRICERPARSER Method: TRYEXECUTE Error: TRANSACTION UNABLE TO PROCESS : CB (711 / 301)
В данном ответе сожержится следующая информация:

  • Module - название модуля, в котором произошла ошибка
  • Method - имя процедуры, в которой возникла ошибка
  • Error - описание ошибки
В данном примере приведена системная ошибка на стороне поставщика система бронирования Amadeus.




Структура запроса при отправке запроса в теле сообщения

  • id_Profile - int, число, идентификатор финансового профиля(финансовый профиль) для применения 3D и финусловий;
  • SecurityKey - ключ для работы с API;
  • IsMock - bool - используется только для разработки, для моментального получения прегенеренного ответа;
  • MaximizeSpeed - bool, максимизация выполения запроса;
  • Fare - int, код класса обслуживания;
  • FareName - Fare;
  • Adults - int - число, количество взрослых, 1-4;
  • Children - int - число, количество детей, 0-4;
  • Infants - int - число, количество младенцев, 0-4;
  • InfantsWithSeat - int, число, количество младенцев с местом, 0-4;
  • Youths - int, число, количество молодёжи, от 12 до 23 лет;
  • Elderlies - int, число, количество женщин свыше 55 лет, мужчин свыше 60 лет;
  • OnlyDirect - bool - возвращать только прямые рейсы в ответе;
  • ConnectionPoint - string - необязательное поле, код пункта пересадки, город или аэропорт, код аэропорта IATA - скачать список с datahub.io;
  • Airlines - string - необязательное поле, предпочтительные перевозчики - не более 3-х кодов авиакомпаний через запятую(например, "SU,AF,KL"), код авиакомпании IATA - скачать список с openflights.org;
  • Route - маршрут перелета, состоит из участков Segment

    • Origin - string - пункт вылета(код города или аэропорта) - код аэропорта IATA - скачать список с datahub.io;
    • Destination - string - пункт прибытия(код города или аэропорта) - код аэропорта IATA - скачать список с datahub.io ;
    • Date - datetime - дата вылета, формат dd.MM.yyyy - время игнорируется и не обязательно для заполнения;
    • StartHour - string - необязательное поле, минимальный час вылета, 2 символа с ведущим 0, например, 01;
    • EndHour - string - необязательное поле, максимальный час вылета, 2 символа с ведущим 0, например, 09;

Пример для отправки запроса в теле сообщения

<?xml version="1.0" encoding="utf-8" ?>
<CommonSearchRequest SecurityKey="XXXXXXXXX" id_Profile="XXX" Fare="0" FareName="Economy" Adults="0" Children="0" Infants="0" InfantsWithSeat="0" Youths="0" Elderlies="0" OnlyDirect="false">
  <ConnectionPoint/>
  <Route>
    <Segment Origin="MOW" Destination="LED" Date="01.10.2024 0:00:00">
      <StartHour>00</StartHour>
      <EndHour>24</EndHour>
    </Segment>
  </Route>
</CommonSearchRequest>