возвращает список стран для сервера server_prefix, или список серверов, доступныхтукущему аккаунту, если не задан параметр server_prefix
параметры: server_prefix - string. необязательный. задает фтр сервер, если не задано - вернет список доступных серверов для данного аккаунта. has_hotels - boolean. необязательный. default=false. если true - возвращает только те записи, которые содержат отели. has_ports - boolean. необязательный. default=false. если true - возвращает только те записи, которые содержат порты.
возвращает список регионов для сервера server_prefix и страны country_iso
параметры: server_prefix - string. обязательный. задает фтр сервер country_iso - string. необязательный. указывает на страну регионов. если не задано - все регионы фтра server_prefix. has_hotels - boolean. необязательный. default=false. если true - возвращает только те записи, которые содержат отели. has_ports - boolean. необязательный. default=false. если true - возвращает только те записи, которые содержат порты.
возвращает список городов для сервера server_prefix и региона region_uid.
параметры: server_prefix - string. обязательный. задает фтр сервер region_uid - string. необязательный. указывает на регион. если не задано - все города, которые есть в фтре. has_hotels - boolean. необязательный. default=false. если true - возвращает только те записи, которые содержат отели. has_ports - boolean. необязательный. default=false. если true - возвращает только те записи, которые содержат порты.
возвращает список арий(area) для сервера server_prefix и города city_uid.
параметры: server_prefix - string. обязательный. задает фтр сервер city_uid - string. необязательный. указывает на город. если не задано - все ареи, которые есть в фтре. has_hotels - boolean. необязательный. default=false. если true - возвращает только те записи, которые содержат отели. has_ports - boolean. необязательный. default=false. если true - возвращает только те записи, которые содержат порты. with_positions - boolean. необязательный. default=false. если true - добавляет в список арий позиции, которые есть у отелей, находящихся в этих ариях.
возвращает список Nearest Landmarks для сервера server_prefix и города city_uid.
параметры: server_prefix - string. обязательный. задает фтр сервер city_uid - string. необязательный. указывает на город. если не задано - все ландмарки, которые есть в фтре.
возвращает список позиций для сервера server_prefix
параметры: server_prefix - string. обязательный. задает фтр сервер area_uid - string или array of strings. не обязательный. задает район, в котором искать. может быть массивом строк.
возвращает список локаций по строке, входящей в название.
пример запроса:
{
'server_prefix': "ae1",
"name_like": "dar",
"type": "hotels"
}
параметры:
| Parameter | Type | Description |
|---|---|---|
| server_prefix | string | обязательный. задает фтр сервер |
| name_like | string | часть названия |
| type | string | тип возвращаемых данных. необязательное. если не задано - вернет результаты поиска по всем позициям. возможные значения: hotel, region, city, area, position, nearest_landmark, port |
возвращает список категорий отелей для сервера server_prefix
параметры: server_prefix - string. обязательный. задает фтр сервер
возвращает список типов отелей для сервера server_prefix
параметры: server_prefix - string. обязательный. задает фтр сервер
возвращает список туристических сервисов.
параметры: server_prefix - string. обязательный. задает фтр сервер city_uid - string. необязательный. указывает на город сервисов. если не задано - все сервисы. is_excursion - boolean. необязательный. default=null. если true - возвращает только те сервисы, которые являются экскурсиями. false - не являются. null - без фильтра.
возвращает список отелей сервера server_prefix по не обязательному фильтру filter.
пример запроса:
{
'server_prefix': "ae1",
"filter":{
"ftr_id": 141,
"uid": "ae1_141",
"name_like": "dar",
"city_uid": "ae1_3",
"area_uid": "ae1_55",
"position_uid": "ae1_539",
"landmark_uid": null,
"region_uid": "ae1_1"
},
'hotel_info': true
}
параметры: server_prefix - string. обязательный. задает фтр сервер hotel_info - bool. если true - возвращает информацио о отеле в поле info. default: false filter - array. необязательный. задает фильтр.параметры фильтра, каждый из параметров необязательный (также может быть равен NULL - тогда тоже не применятеся). если заданы несколько фильтров. объеденяются по логическому AND:
| Parameter | Type | Description |
|---|---|---|
| uid | string | уникальный ID отеля |
| ftr_id | integer | id отеля из ФТР-а |
| name_like | string | часть названия |
| city_uid | string | уникальный ID города, в котором отель |
| area_uid | string | уникальный ID района, в котором отель |
| position_uid | string | уникальный ID расположения отеля |
| landmark_uid | string | уникальный ID того что рядом с отелем |
| region_uid | string | уникальный ID региона, в котором отель |
возвращает список комнат всех отелей.
пример запроса:
{
"server_prefix":"ae1"
}
параметры:
server_prefix - string. обязательный. задает сервер
hotel_uid - string. необязательный. если задан, то вернет список комнат конкретного отеля.
usage example on PHP language
GetRoomInfo
возвращает информацию о комнате, включая макс оккупанси.
пример запроса:
{
"room_uid":"ae1_181",
"check_in":"2022-08-12"
}
параметры:
room_uid - string. обязательный. задает UID комнаты
check_in - string. дата заезда в номер в SQL формате.
| Parameter | Type | Description |
|---|---|---|
| room_uid | string | обязательный. задает UID комнаты |
| check_in | string | обязательный. дата заезда в номер в SQL формате. |
возвращает список валют для сервера server_prefix.
параметры: server_prefix - string. обязательный. задает фтр сервер
force - bool. не обязательный. если задан и равен true - возвращает список всех валют. иначе только USD валюту.
возвращает список аккоммодейшен тайпов для сервера server_prefix
параметры: server_prefix - string. обязательный. задает фтр сервер
возвращает список стафов, когторые яляются стафами тогоже партнера что и запрашиващий (ткущий стафф).
параметры:функция доступна стафам и партнерам.
возвращает список ордеров стафа или всех ордеров партнера текащего стафа, если разрешено правами тккущего стафа, по фильтру
пример запроса:
{
"data_serves": [ "ae1", "ru1" ],
"staff_login": "example@example.com",
"start": 0,
"limit": 10,
}
| Parameter | Type | Description |
|---|---|---|
| data_servers | array of string | required. array contained strings of server prefix. example: ["ae1"] |
| partner_account_id | integer | not required. partner account ID. used only if function called by admin user. |
| staff_login | string | not required. staff login string for return only required staff orders. |
| ignore_staff | bool | not required. default false. only for staff with group EFRITO-1 and EFRITO-4. if true - display all partner orders |
| start | integer | not required. used for pagination. return orders from "start" position |
| limit | integer | not required. used for pagination. return "limit" orders only |
| created_from | string | not required. date in format YYYY-MM-DD |
| created_to | string | not required. date in format YYYY-MM-DD |
| starting_from | string | not required. date in format YYYY-MM-DD |
| starting_to | string | not required. date in format YYYY-MM-DD |
| completion_from | string | not required. date in format YYYY-MM-DD |
| completion_to | string | not required. date in format YYYY-MM-DD |
функция доступна стафам и партнерам.
возвращает список ордеров стафа или всех ордеров партнера текащего стафа, если разрешено правами тккущего стафа, по фильтру
пример запроса:
{
"order_uid": "ae1_841"
}
| Parameter | Type | Description |
|---|---|---|
| order_uid | string | required. order uniq identifier |
возвращает массив месяцев со статусом комнатотеля hotel_uid на каждый день месяца
параметры: hotel_uid - string. UID отеля date_from - дата начала периода (первый месяц) date_to - дата окончания периода (последний месяц)
возвращает структуру специальной цены из ФТР-а. нужно для отображения информации о прайс соурсе, из которого образовалась цена.
параметры:
server_prefix - НЕ обязательный. если задан hotel_uid.
hotel_uid - string. НЕ обязательный. ели задан server_prefix и даты
price_source_id - int. ID цены. НЕ обязательный если заданы даты
date_from - string. НЕ обязательный. по умолчанию = ''. дата в MySQL формате.
date_to - string. НЕ обязательный. по умолчанию = ''. дата в MySQL формате.
даты можно задавать для отфильтровывания ненужных данных цены, например витдровы, которые уже прошли и не актуальны.
возвращает структуру промоушена (и, соответственно, аддедов, т.к. они, я вляются тоже промоушенами) из ФТР-а. используется для отображения информации о промоушене/аддеде, из которого образовалась цена.
параметры:
server_prefix - НЕ обязательный. если задан hotel_uid.
hotel_uid - string. НЕ обязательный если зада server_prefix и даты. задает отель, для которого вернуть эту информацию
promotion_id - int. НЕ обязательный если заданы даты. ID промоушена.
date_from - string. НЕ обязательный. по умолчанию = ''. дата в MySQL формате.
date_to - string. НЕ обязательный. по умолчанию = ''. дата в MySQL формате.
даты можно задавать для отфильтровывания ненужных данных цены, например витдровы, которые уже прошли и не актуальны.
меняет поля рейсов на прилет и отлет у туриста в ордере. разрешена только стафм, партнерам и админам. request example:
{
"order_uid":"ae1_400",
"port_uid":"ae2_3",
"tourist_ids":[3982,3792],
"date_time":"2021-01-01 00:01:00",
"transfer_type":2,
"is_arrival":true,
"flight_no":"su - 200"
}
параметры и их описание:
| Parameter | Type | Description |
|---|---|---|
| order_uid | string | required. UID ордера. example: "ae1_400" |
| port_uid | string | required. UID порта . example: "ae1_3" |
| tourist_ids | array of int | required. задает списко туристов в ордере. числа - поле id из order.tourists записей |
| date_time | string | required. время рейса. example: "2021-01-01 00:01:00" |
| is_arrival | boolean | required. прилет или вылет. example: true |
| flight_no | string | required. номер рейса. example: "SU201" |
| transfer_type | int | not required. тип трансфера. 0 - нет. 1 - индивидуальный, 2 - групповой |
добавляет порт трансфер в ордер. из/в порт.
request example:
{
"order_uid":"ae1_6806",
"name":"\u043c\u043e\u044f \u043d\u0430\u043c\u04351",
"place":"\u043c\u043e\u044f \u043f\u043b\u0430\u0446\u04301",
"port_uid":"ae1_17",
"area_uid":"ae1_18",
"car_uid":"ae1_11",
"tourist_ids":[26625],
"date_time":"2022-02-02 21:02:00",
"is_arrival":true,
"is_group":true
}
answer example:
{
"result":"OK",
"port_transfer_id":5357
}
параметры и их описание:
| Parameter | Type | Description |
|---|---|---|
| name | string | название для отображения |
| order_uid | string | required. UID ордера. example: "ae1_400" |
| port_uid | string | required. UID порта . example: "ae1_3". куда или откуда, в зависимости от is_arrival |
| area_uid | string | required. UID арии . example: "ae1_8". куда или откуда, в зависимости от is_arrival |
| car_group_uid | string | required. UID шруппы транспорта . example: "ae1_11". |
| car_uid | string | not required. UID транспорта. example: "ae1_11". если не задано или == NULL, то в ордер добавиться первая попавшаяся тачка из группы, если в группе есть. |
| place | string | required. куда или откуда, например название отеля из резервации в оредре. в зависимости от is_arrival. example: "аджман бич" |
| tourist_ids | array of int | required. задает списко туристов в ордере. числа - поле id из order.tourists записей |
| date_time | string | required. время рейса. example: "2021-01-01 00:01:00" |
| is_arrival | boolean | required. прилет или вылет. example: true |
| is_group | boolean | not required. default: false; групповой или нет транфер. влияет на расчет цены. example: true |
| remark | string | not required. default: ''; мысли добавляющего трансфер в свободном формате |
добавляет в ордер порт сервис.
request example:
{
"order_uid":"ae1_400",
"port_service_uid":"ae1_3",
"tourist_ids":[3982,3792],
"date_time":"2021-01-01 00:01:00",
}
answer example:
{
"result":"OK",
"service_id":5357
}
параметры и их описание:
| Parameter | Type | Description |
|---|---|---|
| order_uid | string | required. UID ордера. example: "ae1_400" |
| port_service_uid | string | required. UID сервиса. example: "ae1_3" |
| tourist_ids | array of int | required. задает список туристов в ордере. числа - поле id из order.tourists записей |
| date_time | string | required. время сервиса. example: "2021-01-01 00:01:00" |
| is_per_person | bool | not required. default: false. (ftr: per_person) |
| is_group | bool | not required. default: false. (ftr: is_group_service) |
добавляет в ордер серваис. включая экскурсии.
request example:
{
"together":true,
"is_per_person":true,
"order_uid":"ae1_400",
"service_uid":"ae1_172",
"tourist_ids":[3982,3792],
"date_time":"2021-01-01 00:01:00",
}
answer example:
{
"result":"OK",
"services_ids":[5357,5358]
}
параметры и их описание:
| Parameter | Type | Description |
|---|---|---|
| together | boolean | not required. default false - create separately service for tourists. true - one service for all tourists |
| is_per_person | boolean | not required. default: false - service price for all tourists. true - for every tourists? |
| order_uid | string | required. UID ордера. example: "ae1_400" |
| service_uid | string | required. UID сервиса. example: "ae1_172" |
| tourist_ids | array of int | required. задает список туристов в ордере. числа - поле id из order.tourists записей |
| date_time | string | required. время сервиса. example: "2021-01-01 00:01:00" |
возвращает информацию о балансе определенного партнера
параметры: server_prefix - string. обязательный. задает фтр сервер date_from - string. обязательный. дата в sql формате. date_to - string. обязательный. дата в sql формате. date_type - int. тип задаваемых дат в полях date_from, date_to. значение 0=Payment Date,1=Starting Date,2=Completion Date
функция доступна любым аккаунтам.
Помещает в кэш строку данны с ключем. можно указать время жизни кэша в секундах. возвращает строку data в случае успеха, или JSON с ошибкой.
пример запроса:
{
"key": "123",
"data": "тут всякая ерунда",
"expire_time": 300
}
| Parameter | Type | Description |
|---|---|---|
| key | string | required. ключ. максимальная длинна 32 символа. |
| data | string | required. данные |
| expire_time | int | not required. default: 300. время жизни кэша в секундах. |
функция доступна любым аккаунтам.
Возвращает сроку из кэша по ключу. или NULL если ключ не найден или JSON с ошибкой.
пример запроса:
{
"key": "123"
}
| Parameter | Type | Description |
|---|---|---|
| key | string | required. ключ. максимальная длинна 32 символа. |
функция доступна любым аккаунтам.
Генерирует и возвращает PDF файл из темплейта.
пример запроса:
{
"template_source":"<html><body><h1>{$header}</h1><ul>{foreach from=$list item=\"item\"}<li>{$item}.</li>{/foreach}</ul></body></html>",
"template_data":{
"header":"MyHeader",
"list":["aaaa","bbbb","cccc"]
},
"json_result":false
}
| Parameter | Type | Description |
|---|---|---|
| template_source | string | required. содержимое темплейта. строка в base64. в примере просто массив, что не правильно |
| template_data | string | required. переменные темплейта. json строка в base64. в примере просто массив, что не правильно |
| json_result | string | not required. если true - возвращает не содержимое файла а JSON объект, в переменной 'pdf_content' которого содержимое pdf файла в base64 строке |
возвращает список прав текущего стафа. зависят от выбранного сервера. не зависят от прав партнера. т.е. если стафу разрешено бронирование а партнеру запрещено, в конкретной функции бронировапния будет это указано а не здесь.
права стафа:agency_cart - доступ к корзине agency_cart_continue - -//- agency_cart_finish - -//- agency_request - (?) строница со списком бронирований (не используется сейчас) agency_request_confirmed - страница со списком подтвержденных бронирований (не используется сейчас) agency_request_waiting - страница со списком бронирований ожидающий подтверждения (не используется сейчас) agency_check_avail - страница поиска статических цен (не используется сейчас) agency_direct_connect - страница с поиском b2b директа. (не используется сейчас) agency_prices - страница получения файла прайслиста в екселе agency_promotions - поиск промоушенов agency_reservation - (?) - скорее всегого это было создание ордера вручную по отдельным прайссоурсам и промо на выбор, как в фтре agency_sell_periods - страница статусов румов с алотментами agency_special_rates - поиск прайс соурсов agency_check_avail_full - страница поиска статических и b2b динамических цен agency_check_avail_packages - страница с поиском пакетных цен agency_transfer_prices - страница с ценами трансферов (порт, город, даты) agency_port_services - страница с портовыми сервисами (порт) agency_services - страница с туристическими сервисами agency_excursions - страница с экскурсиями v_online_reserv - разрешено онлайн бронирование v_dc_book_b2b - разрешено бронирование директа v_book_wm - разрешено бронирование в долг agency_balance - страница баланса партнера agency_profile - строница профайла (инфа по стафу и партнеру + смена пароля своего) agency_book_one_room - страница бронирования статики agency_book_one_room_finish - страница бронирования статики agency_remember_list - страница ремембера (где можно назначать маржины и в пдфе получать это все) agency_book_one_package - страниа бронирования пакетной цены agency_book_one_package_finish - страниа бронирования пакетной цены agency_book_one_room_dc - страница бронирования директа agency_book_one_room_dc_finish - страница бронирования директа agency_orders - страница списка ордеров по фильтру (даты, ордер айди, если разрешено - список ордеров партнера, если разрешено - список ордеров конкретного стафа) agency_book_services - бронирование сервисов agency_book_services_finish - бронирование сервисов agency_book_services2 - бронирование сервисов (нужно удалить) agency_get_invoice - скрипт получения файла инвойса из фтра v_view_all_partner_orders - указывает, что в списке ордеров, стаф может запрашивать все ордера своего партнера, также при этом стафф может получить список всех стафов партнера agency_get_balance - скрипт получения файла баланса партнера из фтра