4.3.2. Описание спецификации REST API сервиса ПСП 3.0

Спецификация API ПСП v.3 опубликована по адресу: https://api3.doc-psp.sicmt.ru/. Метод получения результатов подтверждения типов пассажира и балансов квот для заданных лет расчета (v3/select) может вызываться информационным ресурсом Участника взаимодействия при выполнении любых операций в ходе осуществления перевозок.

Полный ответ метода v3/select по одному пассажиру состоит из трех частей:

- результат подтверждения личности пассажира;

- список результатов подтверждения типов пассажира;

- список балансов квот по годам расчета по всем ДУЛ пассажира, полученным по СМЭВ.

При первом выполнении (в рамках 24 часов) запроса по пассажиру возвращаются результаты экспресс-проверки, содержащие только балансы квот пассажира (при указании в запросе списка лет расчета). При всех последующих запросах по этому пассажиру после первого запроса в пределах суток будут возвращаться полные ответы.

В ответе-результате экспресс-проверки содержатся только балансы квот, рассчитанные по указанному в запросе ДУЛ пассажира. В полном ответе балансы квот рассчитываются по всем ДУЛ пассажира, сведения о которых получены ПСП посредством СМЭВ.

При неподтверждении личности пассажира ("отрицательном ответе") возвращается пустой список результатов подтверждения типов пассажира.

Подтверждение личности пассажира включает два поля: результат подтверждения личности и код подтверждения личности. Код подтверждения личности принимает значение PIC-000000 в случае успешного подтверждения личности пассажира, и один из кодов согласно спецификации - при неуспешном.

Результат подтверждения типа пассажира содержит следующий набор полей:

- тип пассажира (type);

- статус подтверждения типа пассажира (status);

- дата начала действия успешного подтверждения типа пассажира (validity_from);

- дата окончания действия успешного подтверждения типа пассажира (validity_to);

- код подтверждения типа пассажира (code) - принимает значение PTC-000000 в случае успешного подтверждения личности гражданина и один из кодов согласно спецификации - при неуспешном;

- реестровый номер пассажира (recording_number) - состоит из 15 символов, при этом первые три цифры - код реестра многодетных (всегда 104), следующие две - код категории (всегда 00), остальные десять - сквозной номер записи (для типа пассажира "член многодетной семьи").

Статус подтверждения типа пассажира принимает одно из значений:

- confirmed - при подтверждении типа пассажира;

- conditional - при условном подтверждении типа пассажира (с условием на сопровождаемых инвалидов, выполнение которого необходимо проверить на стороне авиакомпании);

- not_confirmed - при не подтверждении типа пассажира;

- unconfirmed_type - тип пассажира является неподтверждаемым;

- no_data_to_confirmation - данных для подтверждения недостаточно.

Метод операций с билетами (v3/insert) API ПСП 3.0 вызывается для учета операций с передачей сведений о пассажире и субсидированном билете в онлайн-режиме, приближенном к реальному времени, по факту следующих событий:

- оформление билета - передается операция с типом "issued";

- возврат билета - передается операция с типом "refund";

- обмен билета - передается операция "exchange", или передаются операции двух типов: "refund" для предыдущего оформленного билета и "issued" для нового билета, выпущенного в процессе обмена;

- факт перевозки пассажира - передается операция с типом "used" (использовано);

- изменение параметров оформленного билета без изменения его номера (ревалидация) - передается операция с типом "edit".

Метод загрузки списка операций (v3/batch) API ПСП 3.0 аналогичен методу v2/balance/batch API ПСП 2.0.

Метод удаления данных (v3/delete) API ПСП 3.0 предназначен для очистки перед последующей перевыгрузкой корректных данных. Удаление данных происходит по совокупности следующих полей: тип операции, тип перевозочного документа, номер билета, дата и время операции. Не допускается удаление событий с купонами, учтенными в реестрах перевозочных документов (с типом операции used).

Метод поиска данных (v3/search) предназначен для автоматизированных рабочих мест (АРМ), разрабатываемых организацией воздушного транспорта для агентств, касс и т.п. Для работы с методом v3/search необходимо использовать специальные токены API ПСП 3.0.

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

При поиске по пассажиру возвращается полный набор сведений:

- результат подтверждения личности пассажира;

- результаты подтверждения всех типов пассажира;

- балансы квот за указанный год;

- список событий с купонами билетов, учтенных в балансах квот;

- список исправлений в билетах;

- список исправлений в купонах.

Соответствие методов API ПСП 2.0 и API ПСП 3.0 приведены в Таблице 1:

Метод API ПСП 2.0

Метод API ПСП 3.0

v2/balance

v3/select (экспресс-проверка)

v2/balance/change

v3/insert

v2/balance/batch

v3/batch