Просмотр исходного текста страницы TM API

'''TM API''' - специальный набор инструментов [[Такси-Мастер]], который позволит объединить систему с вашим сайтом и различными полезными сервисами. Он предоставляется вам на свободных условиях. 

Благодаря этому набору вы сможете: 

# Создать механизм приема заказов через интернет.  
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.  

{{Warning|Все перечисленные функции работают в Такси-Мастер не ниже [[История изменений в программе Такси-Мастер#Такси-Мастер. Версия 3.6.0 от 24.06.2019|3.6.0 от 24.06.2019г]]. В более ранних версиях программы часть функций может не поддерживаться.}}

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию. 
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# При необходимости установите флажок {{checkbox|Использовать автопроброс порта с помощью UPnP}}, также укажите {{поле|Внешний порт}} и {{поле|Локальный IP}}.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу протокола TMCommonAPI. 
# В поле {{поле|Секретный ключ}} укажите произвольный номер. В дальнейшем этот номер следует использовать в API-запросах на сайте. 

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[заказ]] или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]]. 
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу протокола TMTAPI.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]]. 
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в базе данных программы. 
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.

== Общее описание протокола ==

=== Формат запроса ===

[[TMAPI]] принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TM API, должно идти название API (common_api) и версия
API. Пример:

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list 
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в базу данных используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 
Signature: <...>
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-www-form-urlencoded. Пример:

<pre>
POST https://ip:port/common_api/1.0/create_order 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 118

phone=89123456789&source=SOURCE&source_time=20120501100000&dest=DEST&customer=CUSTOMER&
comment=COMMENT&crew_group_id=1
</pre>

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMWeb в ТМ2. Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 

Секретный ключ:
1234567890

Signature = MD5("tariff_id=1&distance_city=10" + "1234567890") = d7b8fb11b5499b64d750b8efe53e2877
</pre>

=== Формат ответа ===

TM API всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

<pre>
{
"code":<Числовой код результата>,
"descr":"<Строковое описание результата>",
"data":{<Дополнительная информация>}
}
</pre>

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках модуля TM API в ТМ2
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

== Описание запросов ==

=== Запрос-пинг ===
Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/ping 
Ответ:
{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос списка групп экипажей ===
Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|&bull; id
|Целое
|ИД группы экипажей
|-
|&bull; name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crew_groups":[
     {
       "id":1,
       "name":"CREW_GROUP1"
     },
     {
       "id":2,
       "name":"CREW_GROUP2"
     }
    ]
  }
}
</pre>

=== Запрос списка групп клиентов ===
Метод: GET

Название запроса: get_client_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_groups
|Массив
|Список групп клиентов
|-
|&bull; id
|Целое
|ИД группы клиентов
|-
|&bull; name
|Строка
|Название группы клиентов
|}

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/get_client_groups_list 
Signature: <...>
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "client_groups":[
      {
        "id":1,
        "name":"CLIENT_GROUP1"
      },
      {
        "id":2,
        "name":"CLIENT_GROUP2"
      }
    ]
  }
}
</pre>

=== Запрос списка служб ЕДС ===

Метод: GET

Название запроса: get_uds_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|&bull; id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|&bull; name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_uds_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "uds":[
      {
        "id":1,
        "name":"UDS1"
      },
      {
        "id":2,
        "name":"UDS2"
      }
    ]
  }
}
</pre>

=== Запрос списка тарифов ===

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|&bull; id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|&bull; name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|&bull; is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "tariffs":[
      {
        "id":1,
        "name":"TARIFF1"
        "is_active":true 
      },
      {
         "id":2,
         "name":"TARIFF2"
         "is_active":true
      }
    ]
  }
}
</pre>

=== Запрос списка услуг ===
'''Запрос устарел. Рекомендуется использовать [[#Запрос списка параметров заказа|Запрос списка параметров заказа]]'''

Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|&bull; id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|&bull; name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|&bull; sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|&bull; percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_services_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "services":[
      {
        "id":1,
        "name":"SERVICE1",
        "sum":100,
        "percent":0
      },
      {
        "id":2,
        "name":"SERVICE2"
        "sum":0,
        "percent":10
      }
    ]
  }
}
</pre>

=== Запрос списка параметров заказа ===
Метод: GET

Название запроса: get_order_params_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|order_params
|Массив
|Список параметров заказа
|-
|&bull; id
|Целое
|ИД параметра
|-
|&bull; name
|Строка
|Название параметра
|-
|&bull; sum
|Дробное
|Абсолютная сумма параметра, руб
|-
|&bull; percent
|Дробное
|Процент параметра от стоимости заказа, %
|-
|&bull; order_access_control
|true или falce
|Регулирует доступ к заказу
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_params_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_params":[
      {
        "id":1,
        "name":"PARAM1",
        "sum":100,
        "percent":0,
        "order_access_control":true
      },
      {
        "id":2,
        "name":"PARAM2",
        "sum":0,
        "percent":10,
        "order_access_control":false
      }
    ]
  }
}
</pre>

=== Запрос списка скидок ===
Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|&bull; id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|&bull; name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|&bull; sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|&bull; percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "discounts":[
      {
        "id":1,
        "name":"DISCOUNT1",
        "sum":100,
        "percent":0
      },
      {
        "id":2,
        "name":"DISCOUNT2"
        "sum":0,
        "percent":10
      }
    ]
  }
}
</pre>

=== Создание нового заказа ===
Метод: POST

Название запроса: create_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 30 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_lat
|Дробное
|Широта адреса назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|-
|110
|Клиент заблокирован
|-
|111
|Не найден клиент, который может использовать собственный счет для оплаты заказов
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 156

phone=89123456789&source=SOURCE&source_time=20120501100000&dest=DEST&customer=CUSTOMER&
comment=COMMENT&crew_group_id=1&uds_id=1&tariff_id=3&is_prior=false&source_lon=53.147836&source_lat
=56.896817&dest_lon=53.226775&dest_lat=56.845452

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":12345
  }
}
</pre>

=== Создание нового заказа 2 ===
Метод: POST

Название запроса: create_order2

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 30 символов
|Номер телефонам (необязателен, если client_id присутствует).
|-
|client_id
|Целое
|ИД клиента (необязателен, если phone присутствует).
|-
|addresses
|Массив
|Массив адресов. Первый элемент — адрес подачи(обязательно), последний — адрес назначения, между ними — остановки.
|-
|&bull; address
|Строка
|Адрес подачи
|-
|&bull; lat
|Дробное
|Широта адреса
|-
|&bull; lon
|Дробное
|Долгота адреса
|-
|&bull; zone_id
|Целое
|ИД района
|-
|&bull; parking_id
|Целое
|ИД стоянки
|-
|server_time_offset
|Целое
|Смещения относительно серверного времени
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|passenger
|Строка
|Пассажир
|-
|phone_to_dial
|Строка, <= 30 символов
|Телефон для отзвона
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|-
|check_duplicate
|true или false
|Проверка на дубликат
|-
|services
|Массив
|Массив услуг. Устарело. Рекомендуется использовать параметр order_params.
|-
|&bull;
|Целое
|ИД услуги
|-
|crew_props
|Массив
|Массив признаков экипажей. Устарело. Рекомендуется использовать параметр order_params.
|-
|&bull;
|Целое
|ИД признака экипажа
|-
|order_params
|Массив
|Массив параметров заказа
|-
|&bull;
|Целое
|ИД параметра заказа
|-
|total_cost
|Дробное
|Сумма заказа
|-
|use_cashless
|true или false
|Оплата по возможности всей суммы заказа с безналичного счета клиента (насколько хватает средств на счете).
|-
|use_bonus
|true или false
|Оплата по возможности всей суммы заказа с бонусного счета клиента (насколько хватает средств на бонусном счете).
|-
|cashless_sum
|Дробное
|Фиксированная сумма оплаты заказа с безналичного счета клиента (не используется, если use_cashless = true).
|-
|bonus_sum
|Дробное
|Фиксированная сумма оплаты заказа с бонусного счета клиента (не используется, если use_bonus = true).
|-
|client_employee_id
|Целое
|ИД сотрудника клиента (если задан client_id)
|-
|email
|Строка
|Email для отправки уведомлений
|-
|prior_to_current_before_minutes
|Целое
|Время перехода из предварительного в текущие заказы, мин
|-
|flight_number
|Строка
|Номер рейса
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|-
|104
|Клиент не найден
|-
|105
|Район не найден
|-
|106
|Стоянка не найдена
|-
|107
|Сотрудник клиента не найден
|-
|108
|Параметр заказа не найден
|-
|109
|Атрибут не может быть привязан к заказу
|-
|110
|Клиент заблокирован
|-
|111
|Не найден клиент, который может использовать собственный счет для оплаты заказов
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:
POST https://ip:port/common_api/1.0/create_order2 
Signature: <...>
Content-Type: application/json
Content-Length: 395
{
  "server_time_offset":2,
  "source_time":"20140415172811",
  "is_prior":false,
  "phone":"123456",
  "phone_to_dial":"654321",
  "client_id":1,
  "customer":"CUSTOMER",
  "passenger":"PASSENGER",
  "comment":"COMMENT",
  "crew_group_id":1,
  "uds_id":1,
  "tariff_id":1,
  "addresses":[
      {"address":"SOURCE","lat":56.896817,"lon":53.147830,"zone_id":1,"parking_id":1},
      {"address":"STOP1","lat":56.845452,"lon":53.226775,"zone_id":2,"parking_id":2},
      {"address":"STOP2"},
      {"address":"DESTINATION","lat":56.861230,"lon":53.241870}
  ],
  "services":[1,2],
  "crew_props":[1],
  "order_params":[3,4],
  "total_cost":370,
  "use_cashless":false,
  "use_bonus":false,
  "cashless_sum":700,
  "bonus_sum":350
  "email":"email@gmail.com"
  "prior_to_current_before_minutes":30,
  "flight_number":"130-qwe2"

}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":1672
  }
}
</pre>

=== Расчет суммы заказа ===

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_id
|Целое
|ИД клиента
|-
|client_employee_id
|Целое
|ИД сотрудника клиента
|-
|discount_id
|Целое
|ИД скидки
|-
|disc_card_id
|Целое
|ИД дисконтной карты
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|distance_city
|Дробное
|Километраж по городу
|-
|distance_country
|Дробное
|Километраж за городом
|-
|source_distance_country
|Дробное
|Километраж до подачи за городом
|-
|is_country
|true или false
|Загородный заказ
|-
|waiting_minutes
|Целое
|Время ожидания посадки клиента в минутах
|-
|is_hourly
|true или false
|Почасовой заказ
|-
|hourly_minutes
|Целое
|Длительность почасового заказа в минутах
|-
|is_prize
|true или false
|Призовой заказ
|-
|back_way
|true или false
|Обратный путь за городом
|-
|services
|Строка
|Список ИД услуг через точку с запятой, пример: «1;2;3»

Устарело. Рекомендуется использовать параметр order_params.
|-
|order_params
|Строка
|Список ИД параметров заказа через точку с запятой, пример: «1;2;3»
|-
|cashless
|true или false
|Признак безналичного заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|-
|107
|Район остановки не найден
|-
|108
|Группа экипажа не найдена
|-
|109
|Служба ЕДС не найдена
|-
|110
|Дисконтная карта не действительна
|-
|111
|Не найден сотрудник клиента
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|sum
|Дробное
|Рассчитанная общая сумма заказа
|-
|info
|Массив
|Дополнительная информация по расчету суммы заказа
|-
| &bull; comment
|Строка
|Описание позиции дополнительной информации по расчету суммы заказа
|-
| &bull; sum
|Строка
|Сумма позиции дополнительной информации по расчету суммы заказа
|}

Пример:

<pre>
Запрос: 

GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&source_time=20120501100000&is_prior=false&client_id=1&client_employee_id=11&discount_id=1&disc_card_id=1&
source_zone_id=1&dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_country=true&waiting_minutes=10&is_hourly=false&hourly_minutes=60&
is_prize=true&back_way=false&services=1;2;3&order_params=1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "sum":1000,
    "info":[
      {
         "comment":"SUM1",
         "sum":"100"
      },
      {
         "comment":"SUM2",
         "sum":"200"
      }
    ]
  }
} 
</pre>

=== Расчет суммы заказа 2 ===

Метод: POST

Название запроса: calc_order_cost2

Параметры в формате JSON:
{|
!Параметр
!Тип
!Описание
|-
|tariff_id
|Целое
|ИД тарифа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_id
|Целое
|ИД клиента
|-
|phone
|Строка
|Телефон клиента
|-
|discount_id
|Целое
|ИД скидки
|-
|disc_card_id
|Целое
|ИД дисконтной карты
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|source_lon 
|Дробное
|Долгота адреса подачи
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_lat 
|Дробное
|Широта адреса назначения
|-
|distance_city
|Дробное
|Километраж по городу
|-
|distance_country
|Дробное
|Километраж за городом
|-
|source_distance_country
|Дробное
|Километраж до подачи за городом
|-
|is_country
|true или false
|Загородный заказ
|-
|waiting_minutes
|Целое
|Время ожидания посадки клиента в минутах
|-
|is_hourly
|true или false
|Почасовой заказ
|-
|hourly_minutes
|Целое
|Длительность почасового заказа в минутах
|-
|is_prize
|true или false
|Призовой заказ
|-
|back_way
|true или false
|Обратный путь за городом
|-
|order_params
|Массив
|Массив параметров заказа
|-
|&bull;
|Целое
|ИД параметра заказа
|-
|cashless
|true или false
|Признак безналичного заказа
|-
|stops
|Массив
|Список остановок
|-
|&bull; zone_id
|Целое
|ИД района остановки
|-
|&bull; lat
|Дробное
|Широта адреса остановки
|-
|&bull; lon
|Дробное
|Долгота адреса остановки
|-
|crew_group_id
|Целое
|ИД группы экипажа
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|analyze_route
|true или false
|Нужно ли выполнять анализ адресов и маршрута. Если данный флаг установлен (analyze_route=true), то значения параметров: distance_city, distance_country, source_distance_country, переданные в данном запросе будут игнорироваться. Они автоматически будут рассчитаны в ходе выполнения запроса в результате анализа адресов и маршрута.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|-
|107
|Район остановки не найден
|-
|108
|Группа экипажа не найдена
|-
|109
|Служба ЕДС не найдена
|-
|110
|Дисконтная карта не действительна
|-
|111
|Сотрудник клиента не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|sum
|Дробное
|Рассчитанная общая сумма заказа
|-
|info
|Массив
|Дополнительная информация по расчету суммы заказа
|-
| &bull; comment
|Строка
|Описание позиции дополнительной информации по расчету суммы заказа
|-
| &bull; sum
|Строка
|Сумма позиции дополнительной информации по расчету суммы заказа
|}

Пример:

<pre>
Запрос: 

POST https://ip:port/common_api/1.0/calc_order_cost2 
Signature: <...>
Content-Type: application/json
Content-Length: <...>
{
  "tariff_id":1,
  "source_time":"20140415172811",
  "is_prior":false,
  "client_id":1,
  "discount_id":1,
  "disc_card_id":1,
  "source_zone_id":1,
  "source_lat":11.111111,
  "source_lon":22.222222,
  "dest_zone_id":2,
  "dest_lat":33.333333,
  "dest_lon":44.444444,
  "distance_city":10,
  "distance_country":20,
  "source_distance_country":5,
  "is_country":true,
  "waiting_minutes":10,
  "is_hourly":false,
  "hourly_minutes":60,
  "is_prize":true,
  "back_way":false,
  "order_params":[3,4],
  "stops": [
      {
        "zone_id": 1,
        "lat": 11.111111,
        "lon": 22.222222
      },
      {
        "zone_id": 2,
        "lat": 33.333333,
        "lon": 44.444444
      }
  ]
}
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "sum":1000,
    "info":[
      {
        "comment":"SUM1",
        "sum":"100"
      },
      {
        "comment":"SUM2",
        "sum":"200"
      }
    ]
  }
}
</pre>

=== Изменение состояния заказа ===

Метод: POST

Название запроса: change_order_state

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|ORDER_ID
|Целое
|ИД заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден заказ ИД=ORDER_ID
|-
|101
|Не найдено состояние заказа ИД=NEW_STATE
|-
|102
|Изменение состояния не соответствует необходимым условиям.
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:
<pre>
Запрос: 

POST https://ip:port/common_api/1.0/change_order_state?order_id=6&new_state=4 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":6,
    "new_state":4
  }
} 
</pre>

=== Запрос информации об экипаже ===
Метод: GET

Название запроса: get_crew_info

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|-
|crew_state_id
|Целое
|ИД состояния экипажа
|-
|online
|true или false
|Водитель подключен к серверу «Связи с водителями»
|-
|work_shift_sum
|Дробное
|Сумма, списываемая за смену
|-
|min_balance
|Дробное
|Минимальный баланс, при котором можно выйти на смену
|-
|common_priority
|Целое
|Общий приоритет
|-
|static_priority
|Целое
|Статический приоритет
|-
|dynamic_priority
|Целое
|Динамический приоритет
|-
|rating_priority
|Целое 
|Приоритет по рейтингу
|-
|order_change_id
|Целое
|Индивидуальная сдача с заказа
|-
|has_light_house
|true или false
|Шашка
|-
|has_label
|true или false
|Наклейка
|-
|use_plan_shifts
|true или false 
|Запрет работы вне запланированных смен
|-
|order_params
|Массив
|Массив параметров экипажа
|-
|&bull;
|Целое
|ИД параметра заказа
|}

Пример:

<pre>
Запрос: 

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 
Signature: <...>
Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crew_id":1,
    "code":"123",
    "name":"CREW_NAME",
    "driver_id":1,
    "car_id":1,
    "crew_group_id":1,
    "crew_state_id":3,
    "online":true
    "work_shift_sum":0,
    "min_balance":10,
    "common_priority":0,
    "static_priority":0,
    "dynamic_priority":0,
    "rating_priority":0,
    "order_change_id":218,
    "has_light_house":false,
    "has_label":false,
    "order_params":[
      1,
      2,
    ]
  }
}
</pre>

=== Запрос информации об экипажах ===
Метод: GET

Название запроса: get_crews_info

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
! colspan="3" | Обязательные параметры
|-
|crews_info
|Массив
|Массив экипажей 
|-
|&bull; crew_id
|Целое
|ИД экипажа
|-
|&bull; code
|Строка
|Позывной экипажа
|-
|&bull; name
|Строка
|Наименование экипажа
|-
|&bull; driver_id
|Целое
|ИД водителя
|-
|&bull; car_id
|Целое
|ИД автомобиля
|-
|&bull; crew_group_id
|Целое
|ИД группы экипажа
|-
|&bull; crew_state_id
|Целое
|ИД состояния экипажа
|-
|&bull; online
|true или false
|Водитель подключен к серверу «Связи с водителями»
|-
|&bull; work_shift_sum
|Дробное
|Сумма, списываемая за смену
|-
|&bull; min_balance
|Дробное
|Минимальный баланс, при котором можно выйти на смену
|-
|&bull; common_priority
|Целое
|Общий приоритет
|-
|&bull; static_priority
|Целое
|Статический приоритет
|-
|&bull; dynamic_priority
|Целое
|Динамический приоритет
|-
|&bull; rating_priority 
|Целое
|Приоритет по рейтингу
|-
|&bull; order_change_id
|Целое
|Индивидуальная сдача с заказа
|-
|&bull; has_light_house
|true или false
|Шашка
|-
|&bull; has_label
|true или false
|Наклейка
|-
|&bull; use_plan_shifts
|true или false 
|Запрет работы вне запланированных смен
|-
|&bull; order_params
|Массив
|Массив параметров заказа экипажа
|-
|&bull; &bull;
|Целое
|ИД параметра заказа
|}

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/get_crews_info 
Signature: <...>

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_info":[
      {
        "crew_id":1,
        "code":"123",
        "name":"CREW_NAME1",
        "driver_id":1,
        "car_id":1,
        "crew_group_id":1,
        "crew_state_id":3
        "online":true,
        "work_shift_sum":0,
        "min_balance":10,
        "common_priority":10,
        "static_priority":10,
        "dynamic_priority":0,
        "rating_priority":0,
        "order_change_id":0,
        "has_light_house":false,
        "has_label":false,
        "use_plan_shifts":false,
        "order_params":[
          1,
          5,
        ]
      },
      {
        "crew_id":12,
        "code":"777",
        "name":"CREW_NAME2",
        "driver_id":12,
        "car_id":12,
        "crew_group_id":2
        "crew_state_id":1,
        "online":false,
        "work_shift_sum":0,
        "min_balance":10,
        "common_priority":15,
        "static_priority":15,
        "dynamic_priority":0,
        "rating_priority":0,
        "order_change_id":0,
        "has_light_house":false,
        "has_label":true,
        "use_plan_shifts":true,
        "order_params":[]
      }
    ]
  }
}
</pre>

=== Создание экипажа ===
Метод: POST

Название запроса: create_crew

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
! colspan="3" | Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
|driver_id
|Целое
|ИД водителя
|-
|crew_group_id
|Целое
|ИД группы экипажа
|-
! colspan="3" | Необязательные параметры
|-
|code
|Строка
|Позывной экипажа
|-
|work_shift_sum
|Дробное
|Сумма, списываемая за смену
|-
|min_balance
|Дробное
|Минимальный баланс, при котором можно выйти на смену
|-
|work_time
|Строка
|Время работы, формат: “6.00-10.30, 23:00-00:48”
|-
|has_light_house
|true или false
|Шашка
|-
|has_label
|true или false
|Наклейка
|-
|use_plan_shifts
|true или false 
|Запрет работы вне запланированных смен
|-
|order_params
|Массив
|Массив параметров экипажа
|-
|&bull;
|Целое
|ИД параметра 
|}

Специальные возвращаемые коды: 
{|
!Код
!Описание
|-
|100
|Автомобиль с ИД=ID не найден
|-
|101
|Водитель с ИД=ID не найден
|-
|102
|Группа экипажа с ИД=ID не найдена
|-
|103
|Параметр с ИД=ID не найден или не может быть привязан к экипажу
|-
|104
|Экипаж с таким водителем и автомобилем уже существует
|-
|105
|Служба ЕДС автомобиля и водителя не совпадает
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД созданного экипажа
|}

Пример:

<pre>
Запрос:
POST https://ip:port/common_api/1.0/create_crew 
Signature: <...>
Content-Type: application/json
Content-Length: 104

{
  "car_id":1,
  "driver_id":2,
  "crew_group_id":3,
  "code":"CODE",
  "use_shift":true,
  "order_params":[3,4]
}
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "crew_id":1
 }
}
</pre>

=== Обновление информации об экипаже ===
Метод: POST

Название запроса: update_crew_info

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
! colspan="3" | Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|-
! colspan="3" | Необязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
|driver_id
|Целое
|ИД водителя
|-
|crew_group_id
|Целое
|ИД группы экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|work_shift_sum
|Дробное
|Сумма, списываемая за смену
|-
|min_balance
|Дробное
|Минимальный баланс, при котором можно выйти на смену
|-
|work_time
|Строка
|Время работы, формат: “6.00-10.30, 23:00-00:48”
|-
|has_light_house
|true или false
|Шашка
|-
|has_label
|true или false
|Наклейка
|-
|crew_gps_id
|Целое
|GPS идентификатор экипажа
|-
|use_plan_shifts
|true или false
|Запрет работы вне запланированных смен
|-
|order_params
|Массив
|Массив параметров экипажа
|-
|&bull;
|Целое
|ИД параметра 
|}

Специальные возвращаемые коды: 
{|
!Код
!Описание
|-
|100
|Автомобиль с ИД=ID не найден
|-
|101
|Водитель с ИД=ID не найден
|-
|102
|Группа экипажа с ИД=ID не найдена
|-
|103
|Параметр с ИД=ID не найден или не может быть привязан к экипажу
|-
|104
|Экипаж с таким водителем и автомобилем уже существует
|-
|105
|Служба ЕДС автомобиля и водителя не совпадает
|-
|106
|Экипаж с ИД=ID не найден
|-
|107
|Экипаж на линии, запрещено редактирование полей: водитель, автомобиль, позывной, группа экипажа, сумма за смену, минимальный баланс, запрет выхода вне запланированной смены.
|}

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:
<pre>
Запрос:
POST https://ip:port/common_api/1.0/update_crew_info 
Signature: <...>
Content-Type: application/json
Content-Length: 104

{
  "crew_id":1,
  "car_id":1,
  "driver_id":3,
  "crew_group_id":3,
  "code":"CODE",
  "use_plan_shifts":true,
  "order_params":[3,4]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}
</pre>

=== Запрос информации о водителе ===
Метод: GET

Название запроса: get_driver_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|balance
|Дробное
|Баланс основного счета водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Любой неосновной телефон водителя (устаревшее поле) 
|-
|mobile_phone
|Строка
|Основной телефон водителя (устаревшее поле) 
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|-
|order_params
|Массив 
|Массив параметров водителя
|-
|&bull;
|Целое
|ИД параметра 
|-
|phones
|Массив
|Массив телефонов водителя
|-
|&bull; phone
|Строка
|Номер телефона
|-
|&bull; is_default
|true или false
|Признак основного телефона
|-
|&bull; use_for_call
|true или false 
|Использовать для отзвона
|-
|term_account
|Строка
|Терминальный аккаунт
|-
|name_for_taxophone
|Строка
|Имя для TaxoPhone
|-
|accounts
|Массив
|Массив балансов счетов
|-
|&bull;account_kind
|Целое
|Тип счета
|-
|&bull;balance
|Дробное
|Баланс счета
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_driver_info?driver_id=1&need_photo=false 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "driver_id":1,
    "name":"DRIVER_NAME",
    "balance":100,
    "birthday":"01.01.1980",
    "car_id":1,
    "license":"1234567890",
    "home_phone":"123456",
    "mobile_phone":"+79123456789",
    "is_locked":false,
    "is_dismissed":false,
    "order_params":[3,4]
    "phones":[
      {
       "phone":"79999999999",
       "is_default":true
       "use_for_call": true
      },
      {
       "phone":"79999999999",
       "is_default":false
       "use_for_call": false
      }
    ]
    "term_account":"00008"
    "name_for_taxophone":"NameForTaxoPhone"
    "accounts":
    [
      {
        "account_kind":0,
        "balance":1000993.00
      },
      {
        "account_kind":1000,
        "balance":600.00
      }
    ]
  }
}
</pre>

=== Запрос списка водителей ===
Метод: GET

Название запроса: get_drivers_info

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Небязательные параметры
|-
|locked_drivers
|true или false
|Включить в ответ запроса заблокированных водителей (по умолчанию false)
|-
|dismissed_drivers
|true или false
|Включить в ответ запроса уволенных водителей (по умолчанию false)
|}


Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|drivers_info
|Массив
|Массив не удаленных водителей
|-
|&bull; driver_id
|Целое
|ИД водителя
|-
|&bull; name
|Строка
|ФИО водителя
|-
|&bull; balance
|Дробное
|Баланс водителя
|-
|&bull; birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|&bull; car_id
|Целое
|ИД основного автомобиля водителя
|-
|&bull; license
|Строка
|Номер лицензии на перевозку (разрешения на перевозку)
|-
|&bull; home_phone
|Строка
|Любой неосновной телефон водителя (устаревшее поле) 
|-
|&bull; mobile_phone
|Строка
|Основной телефон водителя (устаревшее поле) 
|-
|&bull; is_locked
|true или false
|Водитель заблокирован
|-
|&bull; is_dismissed
|true или false
|Водитель уволен
|-
|&bull; order_params
|Массив
|Массив параметров водителя
|-
|&bull; &bull;
|Целое
|ИД параметра
|-
|&bull; phones
|Массив
|Массив телефонов водителя
|-
|&bull; &bull; phone
|Строка
|Номер телефона
|-
|&bull; &bull; is_default
|true или false
|Признак основного телефона
|-
|&bull; &bull; use_for_call
|true или false 
|Использовать для отзвона
|-
|&bull; term_account
|Строка 
|Терминальный аккаунт
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_drivers_info 
Signature: <...>
locked_drivers=true&dismissed_drivers=true


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "drivers_info":[
      {
        "driver_id":1,
        "name":"DRIVER_NAME1",
        "balance":100.00,
        "birthday":"01.01.1980",
        "car_id":1,
        "license":"1234567890",
        "home_phone":"123456",
        "mobile_phone":"+79123456788",
        "is_locked":false,
        "is_dismissed":false,
        "order_params":[3,4]
        "phones":[
          {
           "phone":"79999999999",
           "is_default":true
           "use_for_call": true
          },
          {
           "phone":"79999999999",
           "is_default":false
           "use_for_call": true
          }
        ]
        "term_account":"00008"
      },
      {
        "driver_id":2,
        "name":"DRIVER_NAME2",
        "balance":-50.00,
        "birthday":"01.01.1980",
        "car_id":2,
        "license":"1234567899",
        "home_phone":"123457",
        "mobile_phone":"+79123456789",
        "is_locked":true,
        "is_dismissed":true,
        "order_params":[5,6]
        "phones":[
          {
           "phone":"79999999999",
           "is_default":true
           "use_for_call": true
          },
          {
           "phone":"79999999999",
           "is_default":false
           "use_for_call": false
          }
        ]
        "term_account":"00009"
      }
    ]
  }
}

</pre>

=== Создание водителя ===
Метод: POST

Название запроса: create_driver

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|name
|Строка
|ФИО водителя
|-
|car_id
|Целое
|ИД основного автомобиля
|-
|password
|Строка
|Пароль (обязательное поле, если используется сервер связи с водителями)
|-
|uds_id
|Целое
|ИД службы ЕДС (обязательное поле, если используется ЕДС, иначе можно не указывать)
|-
!colspan="3"|Необязательные параметры
|-
|home_phone
|Строка
|Неосновной телефон водителя (устаревший параметр)
|-
|mobile_phone
|Строка
|Основной телефон водителя (устаревший параметр)
|-
|passport
|Строка
|Паспортные данные
|-
|driver_license
|Строка
|Водительское удостоверение
|-
|employee_type
|Целое
|Тип работника (0 - работник компании, 1 - частник)
|-
|birthday
|ГГГГММДДччммсс
|День рождения
|-
|number
|Строка
|Табельный номер
|-
|license
|Строка
|Удостоверение
|-
|start_date
|ГГГГММДДччммсс
|Дата приема на работу
|-
|lic_date
|ГГГГММДДччммсс
|Дата окончания договора
|-
|term_account
|Строка
|Терминальный аккаунт (если не указан, будет сгенерирован автоматически), должен состоять из 5 цифр
|-
|comment
|Строка
|Описание
|-
|order_params
|Массив
|Массив параметров водителя
|-
|&bull;
|Целое
|ИД параметра 
|-
|driver_photo
|Base64
|Фотография водителя
|-
|phones
|Массив
|Массив телефонов водителя
|-
|&bull; phone
|Строка
|Номер телефона
|-
|&bull; is_default
|true или false
|Признак основного телефона
|-
|&bull; use_for_call
|true или false 
|Использовать для отзвона
|-
|name_for_taxophone
|Строка
|Имя для TaxoPhone
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль с ИД=ID не найден
|-
|101
|Служба ЕДС с ИД=ID не найдена
|-
|102
|Параметр с ИД=ID не найден или не может быть привязан к водителю
|-
|103
|Терминальный аккаунт не уникален
|-
|104
|Некорректный терминальный аккаунт
|-
|107
|Основной телефон может быть только один
|-
|108
|Водитель должен иметь основной телефон
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД созданного водителя
|}

Пример:
<pre>
Запрос:
POST https://ip:port/common_api/1.0/create_driver 
Signature: <...>
Content-Type: application/json
Content-Length: 104

{
  "name":"NAME",
  "car_id":140,
  "password":"PASSWORD",
  "birthday":"19930218000000",
  "comment":"COMMENT",
  "order_params":[3,4]
  "name_for_taxophone":"NameForTaxoPhone",
  "phones":[
     {
      "phone":"79999999999",
      "is_default":true
      "use_for_call": true
     },
     {
      "phone":"79999999999",
      "is_default":false
      "use_for_call": true
     }
  [
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "driver_id":10
 }
}
</pre>

=== Обновление информации о водителе ===
Метод: POST

Название запроса: update_driver_info

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД редактируемого водителя
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка
|ФИО водителя
|-
|car_id
|Целое
|ИД основного автомобиля
|-
|password
|Строка
|Пароль (обязательное поле, если используется сервер связи с водителями)
|-
|uds_id
|Целое
|ИД службы ЕДС (обязательное поле, если используется ЕДС, иначе можно не указывать)
|-
|home_phone
|Строка
|Неосновной телефон водителя (устаревший параметр)
|-
|mobile_phone
|Строка
|Основной телефон водителя (устаревший параметр)
|-
|passport
|Строка
|Паспортные данные
|-
|driver_license
|Строка
|Водительское удостоверение
|-
|employee_type
|Целое
|Тип работника (0 - работник компании, 1 - частник)
|-
|birthday
|ГГГГММДДччммсс
|День рождения
|-
|number
|Строка
|Табельный номер
|-
|license
|Строка
|Удостоверение
|-
|start_date
|ГГГГММДДччммсс
|Дата приема на работу
|-
|lic_date
|ГГГГММДДччммсс
|Дата окончания договора
|-
|term_account
|Строка
|Терминальный аккаунт
|-
|comment
|Строка
|Описание
|-
|time_block
|ГГГГММДДччммсс
|Временная блокировка до
|-
|is_locked 
|true или false
|Заблокирован
|-
|lock_description
|Строка
|Причина блокировки
|-
|is_dismissed
|true или false
|Уволен
|-
|dismiss_description
|Строка
|Причина увольнения
|-
|order_params
|Массив
|Массив параметров водителя
|-
|&bull;
|Целое
|ИД параметра 
|-
|driver_photo
|Base64
|Фотография водителя
|-
|phones
|Массив
|Массив телефонов водителя
|-
|&bull; phone
|Строка
|Номер телефона
|-
|&bull; is_default
|true или false
|Признак основного телефона
|-
|&bull; use_for_call
|true или false 
|Использовать для отзвона
|-
|name_for_taxophone
|Строка
|Имя для TaxoPhone
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль с ИД=ID не найден
|-
|101
|Служба ЕДС с ИД=ID не найдена
|-
|102
|Параметр с ИД=ID не найден или не может быть привязан к водителю
|-
|103
|Терминальный аккаунт не уникален
|-
|104
|Некорректный терминальный аккаунт
|-
|105
|Водитель с ИД=ID не найден
|-
|106
|Экипаж на линии, запрещено редактирование полей: основной автомобиль, тип работника, служба ЕДС.
|-
|107
|Основной телефон может быть только один
|-
|108
|Водитель должен иметь основной телефон
|}

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:
<pre>
Запрос:
POST https://ip:port/common_api/1.0/update_driver_info 
Signature: <...>
Content-Type: application/json
Content-Length: 104

{
  "driver_id":10
  "name":"NAME",
  "car_id":140,
  "password":"PASSWORD",
  "home_phone":"79999999999",
  "moblie_phone":"79999999999",
  "birthday":"19930218000000",
  "comment":"COMMENT",
  "order_params":[3,4]
  "name_for_taxophone":"NameForTaxoPhone",
  "phones":[
    {
     "phone":"79999999999",
     "is_default":true
      "use_for_call": true
    },
    {
     "phone":"79999999999",
     "is_default":false
      "use_for_call": false
    }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

Название запроса: get_car_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|gos_number  
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|model
|Строка
|Модель автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|is_locked
|true или false
|Автомобиль заблокирован
|-
|order_params
|Массив
|Массив параметров автомобиля
|-
|&bull;
|Целое
|ИД параметра 
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "car_id":1,
    "code":"123",
    "name":"CAR_NAME",
    "gos_number":"a123bc",
    "color":"COLOR",
    "mark":"MARK",
    "model":"MODEL",
    "short_name":"SHORT_NAME",
    "production_year":2000,
    "is_locked":false,
    "order_params":[1,2]
  }
}
</pre>

=== Запрос списка автомобилей ===

Метод: GET

Название запроса: get_cars_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|locked_cars
|true или false
|Включить в ответ заблокированных автомобилей (по умолчанию false)
|}


Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметры
!Тип
!Описание
|-
|cars_info
|Массив
|Массив автомобилей
|-
|&bull; car_id
|Целое
|ИД автомобиля
|-
|&bull; code
|Строка
|Позывной автомобиля
|-
|&bull; name
|Строка
|Наименование автомобиля
|-
|&bull; gos_number
|Строка
|Гос. номер автомобиля
|-
|&bull; color
|Строка
|Цвет автомобиля
|-
|&bull; mark
|Строка
|Марка автомобиля
|-
|&bull; model
|Строка
|Модель автомобиля
|-
|&bull; short_name
|Строка
|Краткое название автомобиля
|-
|&bull; production_year
|Целое
|Год выпуска автомобиля
|-
|&bull; is_locked
|true или false
|Автомобиль заблокирован
|-
|&bull; order_params
|Массив
|Массив параметров автомобиля
|-
|&bull; &bull; 
|Целое
|ИД параметра 
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_cars_info 
Signature: <...>
locked_cars=true


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
  "cars_info":[
    {
      "car_id":1,
      "code":"111",
      "name":"CAR_1",
      "gos_number":"111111",
      "color":"COLOR_1",
      "mark":"MARK_1",
      "model":"MODEL_1",
      "short_name":"SHORT_NAME_1",
      "production_year":2000,
      "is_locked":false,
      "order_params":[1,2]
    },
    {
      "car_id":2,
      "code":"222",
      "name":"CAR_2",
      "gos_number":"222222",
      "color":"COLOR_2",
      "mark":"MARK_2",
      "model":"MODEL_2",
      "short_name":"SHORT_NAME_2",
      "production_year":2000,
      "is_locked":false,
      "order_params":[3,4]
    }
   ]
  }
}

</pre>

=== Создание автомобиля ===

Метод: POST

Название запроса: create_car

Параметры в формате JSON:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|code
|Строка
|Позывной
|-
|mark
|Строка
|Марка
|-
|color
|Строка
|Цвет
|-
|gos_number
|Строка
|Государственный номер
|-
|uds_id
|Целое
|ИД службы ЕДС (обязательное поле, если используется ЕДС, иначе можно не указывать)
|-
!colspan="3"|Необязательные параметры
|-
|model
|Строка
|Модель
|-
|short_name
|Строка
|Краткое название
|-
|production_year
|Целое
|Год выпуска
|-
|car_class
|Строка
|Класс автомобиля (A, B, C, ...)
|-
|vin
|Строка
|VIN
|-
|body_number
|Строка
|Номер кузова
|-
|engine_number
|Строка
|Номер двигателя
|-
|permit
|Строка
|Разрешение на перевозку
|-
|comment
|Строка
|Описание
|-
|order_params
|Массив
|Массив параметров автомобиля
|-
|&bull;
|Целое
|ИД параметра 
|-
|car_photo
|Base64
|Фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль с ИД=ID имеет такой же позывной=CODE
|-
|101
|Служба ЕДС не найдена
|-
|0
|Параметр с ИД=ID не найден или не может быть привязан к автомобилю
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД созданного автомобиля
|}

Пример:

<pre>
Запрос:
POST https://ip:port/common_api/1.0/create_car 
Signature: <...>
Content-Type: application/json
Content-Length: 104

{
  "code":"CODE",
  "mark":"MARK",
  "model":"MODEL",
  "color":"BLACK",
  "gos_number":"NUMBER",
  "production_year":2000,
  "comment":"COMMENT",
  "order_params":[3,4]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "car_id":140
 }
}
</pre>

=== Обновить информацию об автомобиле ===

Метод: POST

Название запроса: update_car_info

Параметры в формате JSON:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|mark
|Строка
|Марка
|-
|color
|Строка
|Цвет
|-
|gos_number
|Строка
|Государственный номер
|-
|model
|Строка
|Модель
|-
|short_name
|Строка
|Краткое название
|-
|production_year
|Целое
|Год выпуска
|-
|car_class
|Строка
|Класс автомобиля (A, B, C, ...)
|-
|vin
|Строка
|VIN
|-
|body_number
|Строка
|Номер кузова
|-
|engine_number
|Строка
|Номер двигателя
|-
|permit
|Строка
|Разрешение на перевозку
|-
|comment
|Строка
|Описание
|-
|order_params
|Массив
|Массив параметров автомобиля
|-
|
|Целое
|ИД параметра 
|-
|is_locked
|true или false
|Автомобиль заблокирован
|-
|lock_description
|Строка
|Причина блокировки
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|car_photo
|Base64
|Фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|101
|Служба ЕДС не найдена
|-
|102
|Автомобиль с ИД=ID не найден
|-
|103
|Экипаж на линии, запрещено редактирование полей: марка, модель, краткое наименование, цвет, гос. номер, служба ЕДС.
|-
|104
|Параметр с ИД=ID не найден или не может быть привязан к автомобилю
|}

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:
<pre>
Запрос:
POST https://ip:port/common_api/1.0/update_car_info 
Signature: <...>
Content-Type: application/json
Content-Length: 104

{
  "car_id":1,
  "code":"CODE",
  "mark":"MARK",
  "model":"MODEL",
  "color":"BLACK",
  "gos_number":"NUMBER",
  "production_year":2000,
  "comment":"COMMENT",
  "order_params":[3,4]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

Название запроса: get_crews_coords

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|&bull; crew_id
|Целое
|ИД экипажа
|-
|&bull; crew_code
|Строка
|Позывной экипажа
|-
|&bull; coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|&bull; lat
|Дробное
|Долгота
|-
|&bull; lon
|Дробное
|Широта
|-
|&bull; state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

• "waiting" — экипаж свободен, ожидает заказы

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве
|}

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_coords":[
      {
        "crew_id":1,
        "crew_code":"111",
        "coords_time":"20120101101010",
        "lat":11.111111,
        "lon":22.222222,
        "state_kind":"waiting"
     },
     {
        "crew_id":2,
        "crew_code":"222",
        "coords_time":"20120101101010",
        "lat":33.333333,
        "lon":44.444444,
        "state_kind":"on_order"
      }
    ]
  }
}

Запрос:

GET https://ip:port/common_api/1.0/get_crews_coords?crew_id=1 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_coords":[
      {
        "crew_id":1,
        "crew_code":"111",
        "coords_time":"20120101101010",
        "lat":11.111111,
        "lon":22.222222,
        "state_kind":"waiting"
      }
    ]
  }
}
</pre>

=== Запрос адресов, содержащих нужную строку ===
Метод: GET

Название запроса: get_addresses_like

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_points
|true или false
|Искать пункты
|-
|get_houses
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|city
|Строка
|Город, в котором искать адреса
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|-
|search_in_tm
|true или false
|Искать адреса в ТМ (по умолчанию = true)
|-
|search_in_yandex
|true или false
|Искать адреса в Яндекс (по умолчанию = false)
|-
|search_in_google
|true или false
|Искать адреса в Google (по умолчанию = false)
|-
|search_in_2gis
|true или false
|Искать адреса в 2GIS (по умолчанию = false)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|-
|101
|Не указано место для поиска адресов
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|&bull;address_source
|Строка
|Источник адреса. Может принимать значения:

•"tm" — Такси Мастер (адрес из базы данных или из карты)

•"yandex" — Яндекс

•"google" — Google

•"2gis" — 2GIS
|-
|&bull; street
|Строка
|Название улицы или пункта
|-
|&bull; house
|Строка
|Номер дома
|-
|&bull; kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|&bull; comment
|Строка
|Комментарий
|-
|&bull; coords
|Массив
|Координаты дома или пункта
|-
|&bull; &bull;  lat
|Дробное
|Широта
|-
|&bull;  &bull; lon
|Дробное
|Долгота
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&
get_houses=false&street=STREE 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
        "street":"STREET1",
        "house":"",
        "kind":"street",
        "comment":""
        "coords":{
        "lat":0,
        "lon":0
        }
      },
      {
        "street":"STREET2",
        "house":"",
        "kind":"street",
        "comment":""
        "coords":{
        "lat":0,
        "lon":0
        }
      },
      {
        "street":"POINT_STREET1",
        "house":"",
        "kind":"point",
        "comment":"Point at street STREET1"
        "coords":{
        "lat":53.224656,
        "lon":56.842521
        }
      }
    ]
  }
}

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=false&get_points=false&
get_houses=true&street=STREET1&house=1&max_addresses_count=10 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
        "street":"STREET1",
        "house":"1",
        "kind":"house",
        "comment":""
      },
      {
        "street":"STREET1",
        "house":"10",
        "kind":"house",
        "comment":""
      },
      {
        "street":"STREET1",
        "house":"11",
        "kind":"house",
        "comment":""
      }
    ]
  }
}
</pre>

=== Запрос адресов, содержащих нужную строку 2 ===
Метод: GET

Название запроса: get_addresses_like2 

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_points
|true или false
|Искать пункты
|-
|get_houses
|true или false
|Искать дома
|-
|address
|Строка
|Строка для поиска адреса 
|-
!colspan="3"|Необязательные параметры
|-
|city
|Строка
|Города, разделенные запятой, в которых искать адреса
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|-
|search_in_tm
|true или false
|Искать адреса в ТМ (по умолчанию = true)
|-
|search_in_yandex
|true или false
|Искать адреса в Яндекс (по умолчанию = false)
|-
|search_in_google
|true или false
|Искать адреса в Google (по умолчанию = false)
|-
|search_in_2gis
|true или false
|Искать адреса в 2GIS (по умолчанию = false)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|-
|101
|Не указано место для поиска адресов
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|&bull; address_source
|Строка
|Источник адреса. Может принимать значения:

•"tm" — Такси Мастер (адрес из базы данных или из карты)

•"yandex" — Яндекс

•"google" — Google

•"2gis" — 2GIS
|-
|&bull; city
|Строка
|Название города 
|-
|&bull; point
|Строка
|Название пункта
|-
|&bull; street
|Строка
|Название улицы 
|-
|&bull; house
|Строка
|Номер дома
|-
|&bull; kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|&bull; comment
|Строка
|Комментарий
|-
|&bull; coords
|Массив
|Координаты дома или пункта
|-
|&bull; &bull;  lat
|Дробное
|Широта
|-
|&bull;  &bull; lon
|Дробное
|Долгота
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like2?get_streets=true&get_points=true& get_houses=true&address=STR12 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
        "address_source":"tm",
        "kind":"street",
        "city":"CITY ",
        "point":"",
        "street":"STREET",
        "house":"12",
        "comment":"",
        "coords":{
             "lat":11.11111,
             "lon":22.222222 
        }
      },
      {
         "address_source":"tm",
         "kind":"street",
         "city":"CITY ",
         "point":"",
         "street":"STREET",
         "house":"120",
         "comment":"",
         "coords":{
             "lat":11.11111,
             "lon":22.222222 
        }
      }
    ]
  }
}


</pre>

=== Анализ маршрута ===
Метод: GET

Название запроса: analyze_route

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|-
!colspan="3"|Необязательные параметры
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_lat
|Дробное
|Широта адреса назначения
|}


Параметр source не является обязательным к заполнению, если заданы source_lon и source_lat.

Параметр dest не является обязательным к заполнению, если заданы dest_lon и dest_lat.


Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat  
|Дробное
|Широта адреса подачи
|-
|source_lon  
|Дробное
|Долгота адреса подачи
|-
|source_zone_id  
|Целое 
|ИД района подачи
|-
|dest_lat
|Дробное 
|Широта адреса назначения
|-
|dest_lon  
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id  
|Целое 
|ИД района назначения
|-
|city_dist  
|Дробное
|Километраж по городу
|-
|country_dist  
|Дробное
|Километраж за городом
|-
|source_country_dist  
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2&source_lon=
53.153044&source_lat=56.893301&dest_lon=53.218103&dest_lat=56.869759 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "source_lat":11.111111,
    "source_lon":22.222222,
    "source_zone_id":1,
    "dest_lat":33.333333,
    "dest_lon":44.444444,
    "dest_zone_id":2,
    "city_dist":1.1,
    "country_dist":2.2,
    "source_country_dist":3.3
  }
}
</pre>

=== Анализ маршрута 2 ===

Метод: POST

Название запроса: analyze_route2

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|get_full_route_coords
|true или false
|Возвращать координаты точек полного маршрута.
|-
|addresses
|Массив
|Массив адресов. Первый элемент — адрес подачи, последний — адрес назначения, между ними — остановки.
|-
|&bull; address
|Строка
|Адрес подачи
|-
|&bull; lat
|Дробное
|Широта адреса
|-
|&bull; lon
|Дробное
|Долгота адреса
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметры
!Тип
!Описание
|-
|Addresses
|Массив
|Массив адресов. Первый элемент — адрес подачи, последний — адрес назначения, между ними — остановки.
|-
|&bull; lat
|Дробное
|Широта адреса
|-
|&bull; lon
|Дробное
|Долгота адреса
|-
|&bull; zone_id
|Целое
|Район адреса
|-
|&bull; parking_id
|Целое
|Стоянка адреса
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом.
|-
|full_route_coords
|Массив
|Массив координат точек маршрута.
|-
|&bull; lat
|Дробное
|Широта точки
|-
|&bull; lon
|Дробное
|Долгота точки
|}

Пример:

<pre>

Запрос:

POST /common_api/1.0/analyze_route2 
Host: ip:port
Keep-Alive: 300
Connection: keep-alive
Content-Type: application/json
Content-Length: 243
Signature: <...>

{"get_full_route_coords":true,"addresses":[{"address":"STREET1, 1","lat":11.111111,
"lon":22.222222},{"address":"STREET2, 2","lat":33.333333,"lon":44.444444},
{"address":"STREET3, 3","lat":55.555555,"lon":55.555555},{"address":"STREET4,
4","lat":77.777777,"lon":88.888888}]}



Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
     "addresses":[
       {
        "lat":11.111111,
        "lon":22.222222,
        "zone_id":1,
        "parking_id":1
       },
       {
        "lat":33.333333,
        "lon":44.444444,
        "zone_id":2,
        "parking_id":2
       }
     ],
     "city_dist":0,
     "country_dist":2.647,
     "source_country_dist":3.412,
     "full_route_coords":[
       {
        "lat":55.833603,
        "lon":37.515537
       },
       {
        "lat":55.832855,
        "lon":37.516315
       },
       {
        "lat":55.833405,
        "lon":37.51799
       },
       ...
    ]
  }
}
</pre>

=== Запрос информации о состоянии заказа ===

Метод: GET

Название запроса: get_order_state

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id  
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id  
|Целое
|ИД заказа
|-
|state_id  
|Целое 
|ИД состояния заказа
|-
|state_kind 
|Строка 
|Тип состояния заказа. Может принимать значения:

• "new_order" — новый заказ

• "driver_assigned" — водитель назначен

• "car_at_place" — машина подъехала на место

• "client_inside" — клиент в машине

• "finished" — заказ успешно завершен

• "aborted" — заказ прекращен
|-
|crew_id  
|Целое 
|ИД экипажа
|-
|prior_crew_id 
|Целое 
|ИД предварительного экипажа
|-
|driver_id  
|Целое
|ИД водителя
|-
|car_id  
|Целое
|ИД автомобиля 
|-
|server_time_offset
|Целое
|Смещение относительно серверного времени
|-
|start_time 
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time 
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source  
|Строка
|Адрес подачи
|-
|source_lat 
|Строка 
|Широта адреса подачи
|-
|source_lon
|Строка 
|Долгота адреса подачи
|-
|destination
|Строка
|Адрес назначения
|-
|destination_lat
|Строка 
|Широта адреса назначения 
|-
|destination_lon
|Строка 
|Долгота адреса назначения 
|-
|stops
|Массив 
|Информация по остановкам заказа 
|-
|&bull; address
|Строка 
|Адрес остановки 
|-
|&bull; lat
|Дробное 
|Широта адреса остановки 
|-
|&bull; lon
|Дробное 
|Долгота адреса остановки 
|-
|customer
|Строка
|Заказчик
|-
|passenger 
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|-
|client_id
|Целое
|ИД клиента
|-
|client_employee_id
|Целое
|ИД сотрудника клиента 
|-
|order_crew_group_id
|Целое
|ИД группы экипажей, которая указана в заказе
|-
|tariff_id
|Целое
|ИД тарифа
|-
|car_mark
|Строка
|Марка автомобиля
|-
|car_model
|Строка
|Модель автомобиля
|-
|car_color
|Строка
|Цвет автомобиля
|-
|car_number
|Строка
|Государственный номер автомобиля
|-
|confirmed
|Строка
|Состояние подтвержденности заказа водителем или оператором.

Может принимать значения:

• "not_confirmed" — не подтверждено

• "confirmed_by_driver" — заказ принят водителем

• "confirmed_by_oper" — заказ подтвержден оператором
|-
|crew_coords
|Массив
|Координаты экипажа
|-
|&bull; lat
|Дробное
|Широта
|-
|&bull; lon
|Дробное
|Долгота
|-
|order_params
|Массив
|Массив параметров заказа экипажа
|-
|&bull; 
|Целое
|ИД параметра заказа
|-
|creation_way
|Строка
|Способ создания заказа. Может принимать значения:

• "operator" — заказ создан оператором

• "sms" — заказ создан через смс

• "market" — заказ из биржи

• "common_api" — заказ создан через api

• "t_api" — заказ создан через api

• "taxophone" — заказ создан через таксофон с телефона

• "driver" — заказ создан водителем

• "daily_order" — ежедневный заказ

• "taxophone_web" — заказ создан через таксофон с сайта

• "unknown" — неизвестный
|-
|is_prior
|true или false
|Предварительный заказ 
|-
|is_really_prior
|true или false
|Предварительный заказ на вкладке "Предварительные"
|-
|email
|Строка
|Email для уведомлений
|-
|prior_to_current_before_minutes
|Целое
|Время перехода из предварительного в текущие заказы, мин
|-
|flight_number
|Строка
|Номер рейса
|}

Пример:

<pre>
Запрос: 

GET https://ip:port/common_api/1.0/get_order_state?order_id=1  
Signature: <...> 
Ответ: 

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":1,
    "state_id":12,
    "state_kind":"car_at_place",
    "crew_id":1,
    "prior_crew_id":0,
    "driver_id":2,
    "car_id":3,
    "server_time_offset:0,
    "start_time":"20130117125641",
    "source_time":"20130117132617",
    "finish_time":"20130117130343",
    "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
    "source_lat":56.863613,
    "source_lon":53.186539,
    "destination":"Кирова ул. \/Ижевск\/, 56",
    "destination_lat":56.862202,
    "destination_lon":53.187485,
    "stops":[
      {
        "address":"30 Лет Победы ул. \/Ижевск\/, 8",
        "lat":56.863388,
        "lon":53.184269
      }
    ],
    "cuctomer":"Слепаков",
    "passenger":"Слепаков",
    "phone":"8800",
    "client_id":1,
    "client_employee_id":1,
    "order_crew_group_id":1,
    "tariff_id":1,
    "car_mark":"Ауди",
    "car_model":"Q7",
    "car_color":"черный",
    "car_number":"А777АА",
    "confirmed":"confirmed_by_oper",
    "crew_coords": {
        "lat": 56.833981,
        "lon": 53.220249
    },
    "order_params":[
      1,
      2,
      5
    ],
    "creation_way":"operator",
    "is_prior":true,
    "is_really_prior":false,
    "email":"mail@mail.ru"
    "prior_to_current_before_minutes":30,
    "flight_number":"A-0501/123"
 
  }
}
</pre>

=== Создание задачи СМС серверу ===

Метод: POST

Название запроса: send_sms

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 30 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST /common_api/1.0/send_sms 
Content-Type: application/x-www-form-urlencoded
Content-Length: 33

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}
</pre>

=== Проверка авторизации ===

Метод: GET

Название запроса: check_authorization

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login 
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id 
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD 

Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "client_id":131
 }
}
</pre>

=== Регистрация клиента ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
!colspan="4"|Необязательные параметры
|-
|client_group
|Целое
|ИД группы клиента
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|ГГГГММДДччммсс
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения: 
• "male" -  мужской

• "female" - женский
|-
|email
|Строка
|E-mail
|-
|use_email_informing
|true или false
|Использовать E-mail для отправки уведомлений по заказу
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
|-
|101
|Клиент с логином=LOGIN уже существует
|-
|102
|Группа клиента с ИД=CLIENT_GROUP не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id 
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/register_client 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 104
name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS&client_group=1&email=mail%40ya.ru&use_email_informing=true

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "client_id":140
  }
}
</pre>

=== Запрос информации по клиенту ===

Метод: GET

Название запроса: get_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id 
|Целое
|ИД клиента
|-
|name
|Строка
|ФИО
|-
|number
|Строка
|Номер договора
|-
|address 
|Строка
|Домашний адрес
|-
|gender 
|Строка 
|Пол. Может принимать значения:

• "male" -  мужской

• "female" - женский
|-
|birthday 
|ДД.ММ.ГГГГ 
|Дата рождения
|-
|phones  
|Строка
|Номера телефонов (через запятую), не привязанных к сотруднику
|-
|balance 
|Дробное
|Баланс
|-
|bonus_balance 
|Дробное
|Бонусный баланс
|-
|login  
|Строка
|Логин
|-
|password 
|Строка
|Пароль
|-
|client_group_id
|Целое
|ИД группы клиента
|-
|tariff_id
|Целое
|ИД тарифа клиента или группы клиентов
|-
|prize_tariff_id
|Целое
|ИД призового тарифа клиента или группы клиентов
|-
|tariff_shift_id
|Целое
|ИД смены тарифов клиента или группы клиентов
|-
|discount_id
|Целое
|ИД скидки клиента или группы клиентов
|-
|prize_discount_id
|Целое
|ИД призовой скидки клиента или группы клиентов
|-
|min_balance
|Дробное
|Порог, ниже которого не может опускаться баланс
|-
|min_balance_for_use_cashless
|Дробное
|Минимальный баланс для использования безналичного счета
|-
|min_bonus_balance_for_use_bonus
|Дробное
|Минимальный баланс для использования бонусного счета
|-
|is_locked
|true или false
|Клиент заблокирован
|-
|lock_description
|Строка
|Причина блокировки
|-
|use_cashless
|true или false
|Признак использования безналичного расчета по умолчанию
|-
|remain_prize
|Целое
|Сколько заказов осталось до призового
|-
|email
|Строка
|E-mail
|-
|use_email_informing
|true или false
|Использовать E-mail для отправки уведомлений по заказу
|-
|default_crew_group
|Целое
|Группа экипажей по умолчанию
|-
|employees
|Массив
|Массив сотрудников клиента
|-
|&bull; id
|Целое
|ИД сотрудника
|-
|&bull; name
|Строка
|ФИО сотрудника
|-
|&bull; phones
|Массив
|Массив телефонов сотрудника клиента 
|-
|&bull;&bull; phone
|Строка
|Номер телефона сотрудника
|-
|&bull; email
|Строка
|E-mail
|-
|&bull; use_email_informing
|true или false
|Использовать E-mail для отправки уведомлений по заказу
|-
|&bull; default_crew_group
|Целое
|Группа экипажей по умолчанию
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 

Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "client_id":140,
    "name":"Васильев Артём",
    "number":"000140",
    "address":"Бутово,45",
    "gender":"male",
    "birthday":"18.02.1993",
    "phones":"[
      "88",
      "99"
    ]",
    "balance":2985,
    "bonus_balance":85,
    "login":"artem",
    "password":"vasilev",
    "client_group_id":1 
    "tariff_id":1,
    "prize_tariff_id":2,
    "tariff_shift_id":0,
    "discount_id":3,
    "prize_discount_id":4,
    "min_balance":100,
    "min_balance_for_use_cashless":null,
    "min_balance_for_use_bonus":50,
    "is_locked":false,
    "lock_description":null,
    "use_cashless":true,
    "remain_prize":5
    "email":"test@ya.ru",
    "use_email_informing":true,
    "default_crew_group":1,
    "employees":[
      {
        "id":5,
        "name":"Иванов Иван",
        "phones":[
          {
        "phone":"88"
          },
          {
        "phone":"99"
          }, 
        ],
        "email":"newEmail@mail.ru",
        "use_email_informing":true
        "default_crew_group":1

      }
    ]
  }
}
</pre>

=== Изменение информации по клиенту ===

Метод: POST

Название запроса: update_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|ГГГГММДДччммсс
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения: 
• "male" -  мужской

• "female" - женский
|-
|client_group_id
|Целое
|ИД группы клиента
|-
|email
|Строка
|E-mail
|-
|use_email_informing
|true или false
|Использовать E-mail для отправки уведомлений по заказу
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
|-
|102
|Клиент с логином=LOGIN уже существует
|-
|103
|Группа клиента с ИД=CLIENT_GROUP_ID не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/update_client_info 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 118

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=20140901000000&gender=m
ale&address=ADDRESS&client_group_id=3&email=mail%40ya.ru&use_email_informing=true

Ответ:

{
 "code":0,
  "descr":"OK",
  "data":{}
}
</pre>

=== Запрос текущих заказов ===

Метод: GET

Название запроса: get_current_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|client_employee_id
|Целое
|ИД сотрудника (только если указан ИД клиента)
|-
|phone
|Строка, <= 30 символов
|Телефон клиента 
|-
|crew_id
|Целое
|ИД экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|-
|101
|Не найден сотрудник клиента ИД=CLIENT_EMPLOYEE_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|state_kind
|Строка
|Тип состояния заказа. Может принимать значения:

• "new_order" — новый заказ

• "driver_assigned" — водитель назначен

• "car_at_place" — машина подъехала на место

• "client_inside" — клиент в машине
|-
|server_time_offset
|Целое
|Смещение относительно серверного времени
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source  
|Строка
|Адрес подачи
|-
|source_lat
|Строка 
|Широта адреса подачи 
|-
|source_lon
|Строка 
|Долгота адреса подачи 
|-
|destination  
|Строка
|Адрес назначения
|-
|destination_lat
|Строка
|Широта адреса назначения 
|-
|destination_lon
|Строка
|Долгота адреса назначения
|-
|stops
|Массив 
|Информация по остановкам заказа 
|-
|• address
|Строка
|Адрес остановки 
|-
|• lat
|Дробное 
|Широта адреса остановки 
|-
|• lon
|Дробное 
|Долгота адреса остановки 
|-
|customer
|Строка
|Заказчик
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|phone
|Строка
|Номер телефона
|-
|client_id
|Целое
|ИД клиента
|-
|tariff_id
|Целое
|ИД тарифа
|-
|order_crew_group_id
|Целое
|ИД группы экипажей, которая указана в заказе
|-
|creation_way
|Строка
|Способ создания заказа. Может принимать значения:

• "operator" — заказ создан оператором

• "sms" — заказ создан через смс

• "market" — заказ из биржи

• "common_api" — заказ создан через api

• "t_api" — заказ создан через api

• "taxophone" —  заказ создан через таксофон с телефона

• "driver" — заказ создан водителем

• "daily_order" — ежедневный заказ

• "taxophone_web" — заказ создан через таксофон с сайта

• "unknown" — неизвестный
|-
|client_employee_id
|Целое
|ИД сотрудника клиента
|-
|is_prior
|true или false
|Предварительный заказ
|-
|is_really_prior
|true или false
|Предварительный заказ на вкладке "Предварительные"
|-
|email
|Строка
|Email для уведомлений
|-
|prior_to_current_before_minutes
|Целое
|Время перехода из предварительного в текущие заказы, мин
|-
|flight_number
|Строка
|Номер рейса
|}

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 
Signature: <...>

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "orders":[
      {
        "id":20648,
        "state_id":44,
        "state_kind":"new_order",
        "server_time_offset:0,
        "start_time":"20130204181111",
        "source_time":"20130204181111",
        "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
        "source_lat":56.863613,
        "source_lon":53.186539,
        "destination":"Кирова ул. \/Ижевск\/, 56",
        "destination_lat":56.862202,
        "destination_lon":53.187485,
        "stops":[
          {
            "address":"30 Лет Победы ул. \/Ижевск\/, 8",
            "lat":56.863388,
            "lon":53.184269
          }
        ],
        "customer":"Маша",
        "passenger":"Маша",
        "crew_id":0,
        "prior_crew_id":0,
        "driver_id":0,
        "car_id":0,
        "phone":"18",
        "client_id":140,
        "tariff_id":1,
        "order_crew_group_id":1,
        "creation_way":"operator",
        "client_employee_id":1,
        "is_prior":false,
        "is_really_prior":false
        "email":"mail@mail.ru",
        "prior_to_current_before_minutes":30,
        "flight_number":"123/123123-0"
      },
      {
        "id":20670,
        "state_id":45,
        "state_kind":"car_at_place",
        "start_time":"20130207153022",
        "source_time":"20130207153022",
        "source":"11-й мкр,",
        "destination":"1-й пр-т \/Москва\/,",
        "customer":"Саша",
        "passenger":"Саша",
        "crew_id":1,
        "prior_crew_id":1,
        "driver_id":1,
        "car_id":1,
        "phone":"18",
        "client_id":140,
        "tariff_id":2,
        "order_crew_group_id":2,
        "creation_way":"operator",
        "client_employee_id":4,
        "is_prior":false,
        "is_really_prior":false 
        "email":"mail@mail.ru"
        "prior_to_current_before_minutes":30,
        "flight_number":"123/123123"

      }
    ]
  }
}
</pre>

=== Запрос выполненных заказов ===

Метод: GET

Название запроса: get_finished_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|-
!colspan="3"|Необязательные параметры
|-
|client_id
|Целое
|ИД клиента 
|-
|client_employee_id
|Целое
|ИД сотрудника (только если указан ИД клиента)
|-
|phone
|Строка, <= 30 символов
|Телефон клиента 
|-
|crew_id
|Целое
|ИД экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|state_type 
|Строка
|Тип состояния заказа. Может принимать значения:

• "all" — все

• "finished" — выполненные

• "aborted" — прекращенные
|-
|state_ids 
|Строка
|Список состояний заказа через точку с запятой, пример: «1;2;3»
|}
'''Примечание''': должен присутствовать хотя бы один параметр из client_id, phone, crew_id, driver_id.

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|server_time_offset
|Целое
|Смещение относительно серверного времени
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source  
|Строка
|Адрес подачи
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon  
|Дробное
|Долгота адреса подачи
|-
|destination  
|Строка
|Адрес назначения
|-
|destination_lat
|Дробное
|Широта адреса назначения
|-
|destination_lon  
|Дробное
|Долгота адреса назначения
|-
|stops
|Массив
|Массив адресов остановок
|-
|&bull; address
|Строка
|Адрес остановки
|-
|&bull; lat
|Дробное
|Широта адреса остановки
|-
|&bull; lon
|Дробное
|Долгота адреса остановки
|-
|trip_distance 
|Дробное 
|Фактический километраж
|-
|trip_time
|Целое
|Фактическое время в пути
|-
|customer
|Строка
|Заказчик
|-
|passenger
|Строка
|Пассажир
|-
|sum 
|Дробное
|Стоимость заказа без учета скидок (наценок)
|-
|total_sum 
|Дробное
|Итоговая стоимость заказа
|-
|cash_sum 
|Дробное
|Заплачено наличными
|-
|cashless_sum 
|Дробное
|Заплачено с безналичного счета клиента
|-
|bonus_sum 
|Дробное
|Заплачено с бонусного счета клиента
|-
|bank_card_sum 
|Дробное
|Заплачено банковской картой
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|phone
|Строка
|Номер телефона
|-
|client_id
|Целое
|ИД клиента
|-
|tariff_id
|Целое
|ИД тарифа
|-
|order_crew_group_id
|Целое
|ИД группы экипажей, которая указана в заказе
|-
|creation_way
|Строка
|Способ создания заказа. Может принимать значения:

• "operator" — заказ создан оператором

• "sms" — заказ создан через смс

• "market" — заказ из биржи

• "common_api" — заказ создан через api

• "t_api" — заказ создан через api

• "taxophone" —  заказ создан через таксофон с телефона

• "driver" — заказ создан водителем

• "daily_order" — ежедневный заказ

• "taxophone_web" — заказ создан через таксофон с сайта

• "unknown" — неизвестный
|-
|client_employee_id
|Целое
|ИД сотрудника клиента
|-
|email
|Строка
|Email для уведомлений
|-
|flight_number
|Строка
|Номер рейса
|}

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/get_finished_orders?driver_id=1&start_time=20170314122041&finish_time=20170314122641 
Signature: <...>
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "orders":[
      {
        "id":20651,
        "state_id":34,
        "server_time_offset:1,
        "start_time":"20130205110812",
        "source_time":"20130205110812",
        "finish_time":"20130205115618",
        "source":"прпроп",
        "source_lat":42.9806060791016,
        "source_lon":47.4614906311035,
        "destination":"рррррр",
        "destination_lat":55.6898765563965,
        "destination_lon":37.6890335083008,
        "stops":[
           {
             "address":"ввввв",
             "lat":55.6792640686035,
             "lon":37.5807800292969
           },
           {
             "address":"ааааа",
             "lat":55.6731262207031,
             "lon":37.6959686279297
           },
           {
             "address":"ппппп",
             "lat":55.678165435791,
             "lon":37.6913642883301
           }
         ],
        "trip_distance":20,
        "trip_time":100,
        "customer":"Вера",
        "passenger":"Вера",
        "sum":908,
        "total_sum":1000,
        "cash_sum":700,
        "cashless_sum":100,
        "bonus_sum":150,
        "bank_card_sum":50,
        "crew_id":6,
        "prior_crew_id":0,
        "driver_id":4,
        "car_id":6,
        "phone":"111111",
        "client_id":140,
        "tariff_id":1,
        "order_crew_group_id":1
        "email":"mail@mail.ru"
        "flight_number":"fln-122"

      },
      {
        "id":20669,
        "state_id":34,
        "source_time":"20130205130500",
        "start_time":"20130205130500",
        "finish_time":"20130205134511",
        "source":"1",
        "destination":"2",
        "customer":"Маша",
        "passenger":"Маша",
        "sum":454,
        "total_sum":500,
        "cash_sum":0,
        "cashless_sum":500,
        "bonus_sum":0,
        "bank_card_sum":0,
        "crew_id":6,
        "prior_crew_id":0,
        "driver_id":4,
        "car_id":6,
        "phone":"222222",
        "client_id":140,
        "tariff_id":2,
        "order_crew_group_id":2
        "creation_way":"operator"
        "client_employee_id":7
        "email":"mail@mail.ru"
        "flight_number":"fln-123"

      }
    ]
  }
}
</pre>

=== Проведение операции по клиенту ===

Метод: POST

Название запроса: create_client_operation

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции: 
• "receipt" - приход

• "expense" - расход
|-
!colspan="3"|Необязательные параметры
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции (если не указано, текущее)
|-
|comment
|Строка
|Комментарий
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
|bonus_oper
|true или false
|Операция по бонусному счёту
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 99

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT&bonus_oper=true

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "oper_id":31

  }
}
</pre>

=== Запрос операций по клиенту ===

Метод: GET

Название запроса: get_client_operations

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента 
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое 
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
|name
|Строка
|Наименование
|-
|comment
|Строка
|Комментарий
|-
|cancelled_by_oper_id
|Целое
|ИД операции отмены (для отмененной операции)
|-
|cancelled_oper_id
|Целое
|ИД отмененной операции (для операции отмены)
|}

Пример:

<pre>
Запрос:

GET 

GET https://ip:port/common_api/1.0/get_client_operations?
client_id=112&start_time=20130201092112&finish_time=20130221092112 

Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "operations":[
      {
        "oper_id":112,
        "oper_time":"20130219091328",
        "sum":"21,8",
        "order_id":11800,
        "oper_type":"receipt",
        "pay_type":"cash",
        "name":"Пополнение счета",
        "comment":"Комментарий"
        "cancelled_by_oper_id":0,
        "cancelled_oper_id":112
      },
      {
        "oper_id":112,
        "oper_time":"20130220112245",
        "sum":"4500",
        "order_id":11801,
        "oper_type":"receipt",
        "pay_type":"cash",
        "name":"Пополнение счета",
        "comment":"Комментарий"
        "cancelled_by_oper_id":111,
        "cancelled_oper_id":0
      }
    ]
  }
}
</pre>

=== Проведение операции по водителю ===

Метод: POST

Название запроса: create_driver_operation

Параметры  в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
|oper_sum
|Дробное
|Сумма
|-
|oper_type
|Строка
|Тип операции: 

• receipt - приход

• expense - расход
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка
|Наименование операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции (если не задано, текущее)  !! Не используется с ТМ 3.7
|-
|comment
|Строка
|Комментарий
|-
|account_kind
|Целое
|ИД типа счета (0 - основной счет), по умолчанию 0
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Водитель не найден ИД=DRIVER_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}


Пример:

<pre>

Запрос:

POST https://ip:port/common_api/1.0/create_driver_operation 
Signature: <...>
Content-Type: application/json
Content-Length: 99

{
   "driver_id": 1,
   "oper_sum": 10.00,
   "oper_type": "receipt",
   "name": "Пополнение счета",
   "oper_time": "20141210100719",
   "comment": "Комментарий к операции"
    "account_kind": 1
}

Ответ:

{
   "code":0,
   "descr":"OK",
   "data":{
   "oper_id":31
   }
}

</pre>

=== Запрос операций по водителю ===

Метод: GET

Название запроса: get_driver_operations

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|-
!colspan="3"|Необязательные параметры
|-
|account_kind
|Целое
|ИД типа счета (0 - основной счет), по умолчанию 0
|}


Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден водитель ИД=DRIVER_ID
|}


Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:

•"receipt" - приход

•"expense" - расход
|-
|name
|Строка
|Наименование
|-
|comment
|Строка
|Комментарий
|-
|cancelled_by_oper_id
|Целое
|ИД операции отмены (для отмененной операции)
|-
|cancelled_oper_id
|Целое
|ИД отмененной операции (для операции отмены)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_driver_operations?
driver_id=112&start_time=20130201092112&finish_time=20130221092112 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "operations":[
      {
        "oper_id":112,
        "oper_time":"20130219091328",
        "sum":"21,8",
        "order_id":11800,
        "oper_type":"receipt",
        "name":"DRIVER_OPERATION_1",
        "comment":"DRIVER_OPERATION_COMMENT_1"
        "account_kind":0,
        "cancelled_by_oper_id":0,
        "cancelled_oper_id":112
      },
      {
        "oper_id":112,
        "oper_time":"20130220112245",
        "sum":"4500",
        "order_id":11801,
        "oper_type":"receipt",
        "name":"DRIVER_OPERATION_2",
        "comment":"DRIVER_OPERATION_COMMENT_2"
        "account_kind":0,
        "cancelled_by_oper_id":111,
        "cancelled_oper_id":0
      }
    ]
  }
}
</pre>

=== Назначение динамического приоритета водителю ===
Метод: POST

Название запроса: create_driver_dyn_priority

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя (должно быть что-то одно: либо driver_id, либо crew_id)
|-
|crew_id
|Целое
|ИД экипажа (должно быть что-то одно: либо driver_id, либо crew_id)
|-
|priority
|Целое
|Приоритет
|-
|start_time
|ГГГГММДДччммсс
|Время начала действия приоритета
|-
|finish_time
|ГГГГММДДччммсс
|Время окончания действия приоритета
|-
|name
|Строка
|Наименование приоритета
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден ИД=DRIVER_ID
|-
|101
|Экипаж не найден ИД=CREW_ID
|-
|102
|Время начала действия приоритета должно быть меньше времени окончания
|-
|103
|Время действия приоритета уже истекло
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|dyn_priority_id
|Целое
|ИД созданного динамического приоритета
|}

Пример:

<pre>
Запрос:
POST https://ip:port/common_api/1.0/create_driver_dyn_priority 
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
   "driver_id": 1,
   "priority": 10,
   "start_time": "20150101100000",
   "finish_time": "20150101200000",
   "name": "За выполнение заказа в отдаленный район"
}

Ответ:

{
   "code":0,
   "descr":"OK",
   "data":{
   "dyn_priority_id":123
   }
}
</pre>

=== Задание координат экипажей ===
Метод: POST

Название запроса: set_crews_coords

Параметры в формате JSON:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_coords
|Массив
|Массив координат экипажей
|-
|&bull; crew_id
|Целое
|ИД экипажа
|-
|&bull; gps_id
|Целое
|GPS идентификатор (если не задан ИД экипажа)
|-
|&bull; lat
|Дробное
|Широта
|-
|&bull; lon
|Дробное
|Долгота
|-
!colspan="3"|Необязательные параметры
|-
|speed
|Дробное
|Скорость
|}


Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет


Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/set_crews_coords 
Signature: <...>
Content-Type: application/json
Content-Length: 109

{"crews_coords":[{"crew_id":1,"lat":11.111111,"lon":22.222222},
{"gps_id":2,"lat":33.333333,"lon":44.444444}]}

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}
</pre>

=== Изменение информации по заказу ===
Метод: POST

Название запроса: update_order

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
!colspan="3"|Необязательные параметры
|-
|phone
|Строка, <= 30 символов
|Номер телефона
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|customer
|Строка
|Заказчик
|-
|passenger
|Строка
|Пассажир
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|client_id
|Целое
|ИД клиента
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тариф
|-
|addresses
|Массив
|Массив адресов. Первый элемент — адрес
подачи(обязательно), последний — адрес назначения, 
между ними — остановки.
|-
|&bull; address
|Строка
|Адрес подачи
|-
|&bull; lat
|Дробное
|Широта адреса
|-
|&bull; lon
|Дробное
|Долгота адреса
|-
|order_params
|Массив
|Массив параметров заказа
|-
|&bull;
|Целое
|ИД параметра заказа
|-
|cost_order
|Дробное
|Сумма заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|discount_id
|Целое
|ИД скидки
|-
|auto_select_discount
|true или false
|Автоматически подобрать скидку, если не указана явно
|-
|auto_select_tariff
|true или false
|Автоматически подобрать тариф, если не указан явно
|-
|auto_recalc_cost
|true или false
|Автоматически пересчитать сумму заказа
|-
|auto_update_order_params
|true или false
|Автоматически обновить параметры заказа по клиенту и группе клиента
|-
|email
|Строка
|Email для уведомлений
|-
|prior_to_current_before_minutes
|Целое
|Время перехода из предварительного в текущие заказы, мин
|-
|flight_number
|Строка
|Номер рейса
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ не найден
|-
|101
|Состояние заказа не найдено
|-
|102
|Тариф не найден
|-
|103
|Скидка не найдена
|-
|104
|Группа экипажа не найдена
|-
|105
|Служба не найдена
|-
|106
|Клиент не найден
|-
|107
|Изменение состояния не соответствует необходимым условиям
|-
|108
|Параметр заказа не найден
|-
|109
|Атрибут не может быть привязан к заказу
|}

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

<pre>
POST https://ip:port/common_api/1.0/update_order 
Signature: <...>
Content-Type: application/json
Content-Length: 208

{
  "order_id": 12105,
  "phone": "555",
  "source_time": "20141216095044",
  "is_prior": true,
  "auto_select_discount": true,
  "auto_select_tariff": true,
  "auto_recalc_cost": true,
  "auto_update_order_params": true,
  "customer": "Заказчик",
  "passenger": "Пассажир",
  "comment": "Комментарий",
  "crew_group_id": 8,
  "client_id": 30,
  "tariff_id": 33,
  "addresses":[
      {"address":"SOURCE","lat":56.896817,"lon":53.147830},
      {"address":"STOP1","lat":56.845452,"lon":53.226775},
      {"address":"STOP2"},
      {"address":"DESTINATION","lat":56.861230,"lon":53.241870}
  ],
  "cost_order": 200,
  "state_id": 55,
  "discount_id": 1
  "email" : "mail@mail.ru"
  "prior_to_current_before_minutes":30,
  "flight_number":"Number"

}
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}
</pre>

=== Анализ телефона ===

Метод: GET

Название запроса: analyze_phone

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка
|Номер телефона
|-
!colspan="3"|Необязательные параметры
|-
|search_in_drivers_mobile
|true или false
|Искать среди телефонов водителей
|-
|search_in_clients
|true или false
|Искать среди телефонов клиентов
|-
|search_in_phones
|true или false
|Искать в справочнике телефонов
|}


Если параметры search_in_drivers_mobile, search_in_clients, search_in_phones не заданы, то поиск телефона будет происходить во всех справочниках.

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Телефон не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|phone_type
|Строка
|Может принимать значения: «driver_mobile», «client», «phone».
|-
|id
|Целое
|ИД водителя, клиента, телефона из справочника.
|-
|client_employee_id
|Целое
|ИД сотрудника клиента (если телефон найден среди телефонов клиента)
|}


Пример:

<pre>
Запрос:

GET /common_api/1.0/analyze_phone?
phone=89501234567&search_in_drivers_mobile=true&search_in_drivers_home=true&search_in_clients=true&
search_in_phones=true 

Host: 127.0.0.1:8089
Keep-Alive: 300
Connection: keep-alive
Signature: 4285286a446064353f4a951b721c54f7

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
  "phone_type":"client",
  "id":1
  "client_employee_id":2
   }
}

</pre>

=== Показать сообщение в ТМ ===

Метод: POST

Название запроса: show_tm_message

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|text
|Строка
|Текст сообщения
|-
!colspan="3"|Необязательные параметры
|-
|header
|Строка
|Заголовок сообщения
|-
|timeout
|Целое
|Скрывать сообщение через, сек. (0 — не скрывать)
|-
|users
|Массив
|Массив пользователей (если не указаны — отправлять всем)
|-
|&bull; 
|Целое
|ИД пользователя
|}


Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Пользователи для отправки сообщения не найдены
|}


Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:
<pre>

Запрос:
POST /common_api/1.0/show_tm_message 
Host: 127.0.0.1:8089
Keep-Alive: 300
Connection: keep-alive
Signature: 4285286a446064353f4a951b721c54f7

{
   "text": "Текст сообщения",
   "users": [
       1,
       2,
       3
   ],
   "header": "Заголовок",
   "timeout": 12
}


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

</pre>

=== Запрос списка купленных смен водителей ===

Метод: GET

Название запроса: get_driver_shifts

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|-
!colspan="3"|Необязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
|new_shifts
|true или false
|Включить в ответ новые смены (по умолчанию true)
|-
|in_work_shifts
|true или false
|Включить в ответ смены в работе (по умолчанию true)
|-
|finished_shifts
|true или false
|Включить в ответ выполненные смены (по умолчанию true)
|-
|failed_shifts
|true или false
|Включить в ответ неуспешно завершенные смены (по умолчанию true)
|-
|returned_shifts
|true или false
|Включить в ответ возвращенные смены (по умолчанию false)
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|shifts
|Массив
|Массив купленных смен
|-
|&bull; shift_id
|Целое 
|ИД купленной смены
|-
|&bull; driver_id 
|Целое 
|ИД водителя
|-
|&bull;driver_name 
|Строка 
|ФИО водителя
|-
|&bull; plan_shift_id 
|Строка
|ИД запланированной смены
|-
|&bull; plan_shift_name 
|Строка 
|Наименование запланированной смены
|-
|&bull; plan_shift_cost 
|Дробное 
|Цена смены
|-
|&bull; plan_shift_type 
|Строка 
|Тип смены («limited» - срочная, «unlimited» - бессрочная)
|-
|&bull; plan_shift_start_time
|ГГГГММДДччммсс 
|План-начало смены (для срочных)
|-
|&bull; plan_shift_finish_time
|ГГГГММДДччммсс 
|План-конец смены (для срочных)
|-
|&bull; plan_shift_length 
|Целое 
|План продолжительность смены, ч. (для бессрочных)
|-
|&bull; plan_shift_crew_group_id
|Целое 
|ИД первой группы экипажей, которая может купить смену
|-
|&bull; plan_shift_crew_groups
|Массив
|ИД групп экипажей, которые могут купить смену
|-
|&bull; shift_state 
|Строка 
|Состояние смены («new» - новая, «in_work» - в работе, «finished» - завершена успешно, «failed» - завершена неуспешно)
|-
|&bull; buy_time 
|ГГГГММДДччммсс 
|Время продажи смены водителю
|-
|&bull; is_returned 
|true или false 
|Признак возвращенной смены
|-
|&bull; return_time 
|ГГГГММДДччммсс 
|Время возврата смены
|-
|&bull; orders_count 
|Целое 
|Количество заказов, выполненных водителем за смену
|-
|&bull; orders_sum 
|Дробное 
|Сумма заказов, выполненных водителем за смену
|-
|&bull; fact_length 
|Дробное 
|Фактическая продолжительность смены, ч.
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_driver_shifts?start_time=20140101101010&finish_time=20140101202020 
Signature: <...>


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "shifts":[
      {
        "shift_id":1,
        "driver_id":1,
        "driver_name":"DRIVER_1",
        "plan_shift_id":1,
        "plan_shift_name":"PLAN_SHIFT_1",
        "plan_shift_cost":100,
        "plan_shift_type":"limited",
        "plan_shift_start_time":"20140101101010",
        "plan_shift_finish_time":"20140101101010",
        "plan_shift_length":null,
        "plan_shift_crew_group_id":1,
        "shift_state":new,
        "buy_time":"20140101101010",
        "is_returned":false,
        "return_time":null,
        "orders_count":10,
        "orders_sum":1000,
        "fact_length":1.2
      },
      {
        "shift_id":2,
        "driver_id":2,
        "driver_name":"DRIVER_2",
        "plan_shift_id":2,
        "plan_shift_name":"PLAN_SHIFT_2",
        "plan_shift_cost":200,
        "plan_shift_type":"unlimited",
        "plan_shift_start_time":null,
        "plan_shift_finish_time":null,
        "plan_shift_length":8,
        "plan_shift_crew_group_id":null,
        "shift_state":new,
        "buy_time":"20140101101010",
        "is_returned":true,
        "return_time":"20140101101010",
        "orders_count":0,
        "orders_sum":0,
        "fact_length":0
      }
    ]
  }
}
</pre>

=== Запрос списка запланированных смен водителей ===

Метод: GET

Название запроса: get_driver_plan_shifts

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|start_time 
|ГГГГММДДччммсс 
|Начало периода (если включаем в ответ срочные смены)
|-
|finish_time 
|ГГГГММДДччммсс 
|Конец периода (если включаем в ответ срочные смены)
|-
!colspan="3"|Необязательные параметры
|-
|limited_shifts 
|true или false 
|Включить в ответ срочные смены (по умолчанию true)
|-
|unlimited_shifts 
|true или false 
|Включить в ответ бессрочные смены (по умолчанию true)
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|plan_shifts 
|Массив 
|Массив запланированных смен
|-
|&bull; plan_shift_id 
|Целое 
|ИД запланированной смены
|-
|&bull; plan_shift_name 
|Строка 
|Наименование запланированной смены
|-
|&bull; plan_shift_comment
|Строка 
|Комментарий запланированной смены
|-
|&bull; plan_shift_cost 
|Дробное 
|Цена смены
|-
|&bull; plan_shift_type 
|Строка 
|Тип смены («limited» - срочная, «unlimited» - бессрочная)
|-
|&bull; plan_shift_start_time
|ГГГГММДДччммсс 
|План-начало смены (для срочных)
|-
|&bull; plan_shift_finish_time
|ГГГГММДДччммсс 
|План-конец смены (для срочных)
|-
|&bull; plan_shift_length 
|Целое 
|План продолжительность смены, ч. (для бессрочных)
|-
|&bull; plan_shift_crew_group_id
|Целое 
|ИД первой группы экипажей, которая может купить смену
|-
|&bull; plan_shift_crew_groups
|Массив
|ИД групп экипажей, которые могут купить смену
|-
|&bull; max_sell_count 
|Целое 
|Максимальное количество продаж смены
|-
|&bull; sold_count 
|Целое 
|Количество продаж смены
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_driver_plan_shifts?start_time=20140101101010&finish_time=20140101202020 
Signature: <...>


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "plan_shifts":[
      {
        "plan_shift_id":1,
        "plan_shift_name":"PLAN_SHIFT_1",
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_1",
        "plan_shift_cost":100,
        "plan_shift_type":"limited",
        "plan_shift_start_time":"20140101101010",
        "plan_shift_finish_time":"20140101101010",
        "plan_shift_length":null,
        "plan_shift_crew_group_id":1,
        "max_sell_count":100,
        "sold_count":10
      },
      {
        "plan_shift_id":2,
        "plan_shift_name":"PLAN_SHIFT_2",
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_2",
        "plan_shift_cost":200,
        "plan_shift_type":"unlimited",
        "plan_shift_start_time":null,
        "plan_shift_finish_time":null,
        "plan_shift_length":8,
        "plan_shift_crew_group_id":2,
        "max_sell_count":200,
        "sold_count":20
      }
    ]
  }
}
</pre>

=== Продажа смены водителю ===

Метод: POST

Название запроса: driver_buy_shift

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id 
|Целое 
|ИД экипажа
|-
|plan_shift_id 
|Целое 
|ИД запланированной смены
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100 
|Запланированная смена не найдена
|-
|101 
|Экипаж не найден
|-
|102 
|Водитель не найден
|-
|103 
|Недостаточно денег на счете водителя
|-
|104 
|Водитель уволен либо заблокирован
|-
|105 
|Запланированная смена устарела
|-
|106 
|Не подходит группа экипажа
|-
|107 
|Превышено максимальное число покупок смены
|-
|108 
|Повторная покупка смены
|-
|109
|Экипажу не назначен атрибут для доступа к смене
|}


Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/driver_buy_shift 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 25
crew_id=1&plan_shift_id=1


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}
</pre>

=== Сохранение отзыва клиента ===
Метод: POST

Название запроса: save_client_feed_back

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка
|Телефон
|-
|rating
|Целое
|Рейтинг (от 1 до 5)
|-
|text
|Строка
|Текстовый отзыв
|-
!colspan="3"|Необязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Допускается указывать либо параметр rating либо text, либо оба параметра.

Специальные возвращаемые коды: нет.

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:
<pre>
Запрос:
POST /common_api/1.0/save_client_feed_back 
Host: 127.0.0.1:8090
Keep-Alive: 300
Connection: keep-alive
Content-Type: application/json
Content-Length: 72
Signature: <...>

{
  "phone":"89123456789",
  "rating":4,
  "text":"test feedback",
  "order_id":100
}
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}
</pre>

=== Поиск экипажей по координатам ===
Метод: GET

Название запроса: find_crews_by_coords

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|lat
|Дробное
|Широта точки центра поиска
|-
|lon
|Дробное
|Долгота точки центра поиска
|-
|radius
|Дробное
|Радиус поиска, км или мили
|-
!colspan="3"|Необязательные параметры
|-
|crews_without_coords
|true или false
|Искать экипажи без реальных координат по координатам стоянок
|-
|crews_release_in
|Целое
|Допустимое время до освобождения в зоне поиска, если надо возвращать занятые экипажи (если 0, то искать только свободные экипажи), мин
|-
|crew_group_id
|Целое
|ИД группы экипажей, заказы из которой должны видеть подходящие экипажи
|-
|uds_id
|Целое
|ИД службы ЕДС, к которой должны принадлежать подходящие экипажи
|-
|attributes
|Строка
|Список ИД атрибутов заказа, которыми должны обладать подходящие экипажи (через точку с запятой, пример: «1;2;3»)
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|waiting_count
|Целое
|Количество свободных экипажей в зоне поиска
|-
|on_order_count
|Целое
|Количество занятых экипажей, освобождающихся в зоне поиска
|}

Пример:
<pre>
Запрос:
GET https://ip:port/common_api/1.0/find_crews_by_coords?
lat=11.111111&lon=22.222222&radius=2&crews_release_in=5 
Signature: <...>
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "waiting_count":5,
  "on_order_count":2
  }
}
</pre>

=== Подбор тарифа для заказа ===
Метод: POST

Название запроса: select_tariff_for_order

Параметры в формате JSON:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prize
|true или false
|Призовой заказ
|-
|addresses
|Массив
|Массив координат адресов. Первый элемент — адрес подачи,
последний — адрес назначения, между ними — остановки.
Заполняется если определены координаты всех адресов.
|-
|* lon
|Дробное 
|Долгота адреса
|-
|* lat
|Дробное 
|Широта адреса
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|tariff_id
|Целое
|Тариф
|}

Пример:

<pre>
Запрос:
POST https://ip:port/common_api/1.0/select_tariff_for_order 
Signature: <...>
Content-Type: application/json
Content-Length: <...>
{
  "client_id":1,
  "crew_group_id":2,
  "source_time":"20160101100000",
  "is_prize":true
 "addresses": [
      {
            "lat": 11.111111,
            "lon": 22.222222
      },
      {
            "lat": 33.333333,
            "lon": 44.444444
 }
}
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "tariff_id":2
 }
}
</pre>

=== Импорт марок автомобилей в БД  ===
Метод: POST 

Название запроса:  import_car_marks 

Параметры в формате JSON: 

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|marks
|Массив строк
|Импортируемые марки автомобилей
|}

Специальные возвращаемые коды: нет 

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример: 

<pre>
Запрос: 

POST https://ip:port/common_api/1.0/import_car_marks 
Signature: <...> 
Content-Type: application/json 
Content-Length: <...> 
{
  "marks": [
    "Mercedes",
    "BMW"
  ]
 } 

Ответ:

 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

</pre>

=== Импорт цветов автомобилей в БД  ===
Метод: POST 

Название запроса:  import_car_colors 

Параметры в формате JSON: 

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|colors
|Массив строк
|Импортируемые цвета автомобилей
|}

Специальные возвращаемые коды: нет 

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример: 

<pre>
Запрос: 

POST https://ip:port/common_api/1.0/import_car_colors 
Signature: <...> 
Content-Type: application/json 
Content-Length: <...>

 {
  "colors": [
    "красный",
    "синий"
  ]
 }

 Ответ:

 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

</pre>

=== Запрос информации по сотруднику клиента  ===
Метод: GET 

Название запроса: get_client_employee_info 

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_employee_id
|Целое
|ИД сотрудника клиента
|}

Специальные возвращаемые коды: 
{|
!Код
!Описание
|-
|100
|Не найден сотрудник клиента ИД=CLIENT_EMPLOYEE_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|client_employee_id
|Целое
|ИД сотрудника
|-
|client_id
|Целое
|ИД клиента
|-
|name
|Строка
|ФИО сотрудника
|-
|is_deleted
|true или false
|Признак удаленного сотрудника
|-
|email
|Строка
|E-mail
|-
|use_email_informing
|true или false
|Использовать E-mail для отправки уведомлений по заказу
|-
|default_crew_group
|Целое
|Группа экипажей по умолчанию
|-
|phones
|Массив
|Массив телефонов сотрудника клиента
|-
|&bull; phone
|Строка
|Номер телефона сотрудника
|}

Пример: 

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_client_employee_info?client_employee_id=10 
Signature: <...> 

Ответ:

 {
  "code":0,
  "descr":"OK",
  "data":{
     "client_employee_id":5,
    "client_id":1,
    "name":"Иванов Иван",
    "is_deleted":false,
    "email":"mail@mail.ru",
    "use_email_informing":true,
    "default_crew_group":1,
    "phones":[
      {
        "phone":"88"
      },
      {
        "phone":"99"
      }
    ]
  }
 }

</pre>

=== Создание сотрудника клиента ===
Метод: POST 

Название запроса: create_client_employee 

Параметры в формате JSON: 

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента 
|-
|name
|Строка
|ФИО сотрудника 
|-
!colspan="3"|Необязательные параметры
|-
|email
|Строка
|E-mail
|-
|use_email_informing
|true или false
|Использовать E-mail для отправки уведомлений по заказу
|-
|phones
|Массив
|Массив телефонов сотрудника
|-
|&bull; phone
|Строка
|Номер телефона
|}

Специальные возвращаемые коды: 
{|
!Код
!Описание
|-
|100
|Клиент с ИД=CLIENT_ID не найден
|-
|101
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
|}

Возвращаемые данные в случае успешного выполнения запроса: нет. 

Пример:

<pre>
Запрос: 

POST https://ip:port/common_api/1.0/create_client_employee 
Signature: <...> 
Content-Type: application/json 
Content-Length: 104

{
  "client_id":10
  "name":"Иванов Иван",
  "email":"mail@mail.ru",
  "use_email_informing":true,
  "phones":[
    {
      "phone":"79999999999",
    },
    {
      "phone":"79999999999",
    }
  ]
 }

 Ответ:
 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

</pre>

=== Обновление информации о сотруднике клиента ===
Метод: POST 

Название запроса: update_client_employee_info 

Параметры в формате JSON: 

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_employee_id
|Целое
|ИД редактируемого сотрудника клиента  
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка
|ФИО сотрудника 
|-
|is_deleted
|true или false
|Признак удаленного сотрудника
|-
|email
|Строка
|E-mail
|-
|use_email_informing
|true или false
|Использовать E-mail для отправки уведомлений по заказу
|-
|phones
|Массив
|Массив телефонов сотрудника
|-
|&bull; phone
|Строка
|Номер телефона
|}

Примечание: запрещено редактировать телефоны удаленного сотрудника.


Специальные возвращаемые коды: 
{|
!Код
!Описание
|-
|100
|Сотрудник с ИД=CLIENT_EMPLOYEE_ID не найден
|-
|101
|Клиент с ИД=ID имеет такой же номер телефона=PHONE 
|-
|102
|Запрещено редактирование телефонов удаленного сотрудника
|}

Возвращаемые данные в случае успешного выполнения запроса: нет. 

Пример:

<pre>
Запрос: 

POST https://ip:port/common_api/1.0/update_client_employee_info 
Signature: <...> 
Content-Type: application/json
Content-Length: 104

{
  "client_employee_id":10
  "name":"Иванов Иван",
  "is_deleted":false,
  "email":"mail@mail.ru",
  "use_email_informing":true,
  "phones":[
    {
      "phone":"79999999999",
    },
    {
      "phone":"79999999999",
    }
  ]
 } 

Ответ:
 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

</pre>

=== Запрос списка состояний заказа ===
Метод: GET 

Название запроса: get_order_states_list

Параметры: нет 

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_params
|Массив 
|Список параметров заказа
|-
|&bull; id 
|Целое 
|ИД параметра
|-
|&bull; name
|Строка
|Название параметра
|-
|&bull; state_type 
|Строка
|Тип состояния. Может принимать значения:

• "accepted" — заказ принят

• "in_work" — заказ в работе

• "finished" — заказ выполнен

• "aborted" — заказ прекращен
|}

Пример:

<pre>
Запрос:


GET https://ip:port/common_api/1.0/get_order_states_list 

Signature: <...>

Ответ:


{
 "code":0,
 "descr":"OK",
 "data":{
 "order_params":[
     {
      "id":1,
      "name":"Принят",
      "state_type":"accepted"
     },
     {
      "id":2,
      "name":"В работе",
      "state_type":"in_work"
      },
     ...
                ]
        }
}

</pre>

===  Запрос списка состояний экипажа ===
Метод: GET 

Название запроса: get_crew_states_list

Параметры: нет 

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_params
|Массив 
|Список параметров заказа
|-
|&bull; id 
|Целое 
|ИД параметра
|-
|&bull; name
|Строка
|Название параметра
|-
|&bull; state_type 
|Строка
|Тип состояния. Может принимать значения:

• "waiting" — экипаж свободен

• "not_available" — экипаж не на линии

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве
|}

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/get_crew_states_list 
Signature: <...>

Ответ:
{
 "code":0,
 "descr":"OK",
 "data":{
 "order_params":[
         {
          "id":1,
          "name":"Свободен",
          "state_type":"waiting"
         },
         {
          "id":2,
          "name":"Не работает",
          "state_type":"not_available"
         },
         ...
               ]
        }
}

</pre>


=== Запрос информации по клиентам ===
Метод: GET

Название запроса: get_clients_info

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|text
|Строка
|Текст для поиска по названию или по номеру договора клиента
|-
|max_clients_count 
|Целое
|Максимальное количество клиентов, которое надо вернуть. Если не указано, то 10.
|}

Специальные возвращаемые коды: Нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|-
|name
|Строка
|Наименование
|-
|number
|Строка
|Номер договора
|}

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/get_clients_info?text=test&max_clients_count=10 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "clients_info":[
      {
        "client_id":390,
        "name":"tester1",
        "number":"001"
      },
      {
        "client_id":394,
        "name":"tester2",
        "number":"002"
      }
    ]
  }
}

</pre>

== Описание протокола TMTAPI Версия 1.0 ==

=== Общее описание протокола ===

==== Формат запроса ==== 

TM API принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TM API, должно идти название API (tm_tapi) и версия API.

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone 
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPE-PHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b 
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-www-form-
urlencoded. 

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state 
Content-Type: application/x-www-form-urlencoded
Content-Length: 71

order_id=98798&need_state=12&signature=a204c50c7e48f0c6849a87485fe5e171
</pre>

В любом запросе обязательно с другими полями должно передаваться поле signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMAPI в Такси-Мастер. 

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPE
&signature=ef17ea682d09e452af544a5758dba396 

Секретный ключ:
321

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396

</pre>

==== Формат ответа ====
TM API всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате XML. Общий вид возвращаемого результата:

<pre>
<response>
<code>Числовой код результата</code>
<descr>Строковое описание результата</descr>
<data>Дополнительная информация</data>
</response>
</pre>

Существуют общие для всех запросов коды результатов:
{|
! Код 
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3 
|API отключено в настройках модуля TM API в Такси-Мастер
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10 
|Внутренняя ошибка обработки запроса
|}

=== Описание запросов ===

==== Запрос информации по номеру телефона ====
Метод: GET

Название запроса: get_info_by_phone

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов 
|Номер телефона
|-
|FIELDS
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через символ ''"-"''
|-
|signature 
|Строка 
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

{|
!Параметр 
!Тип 
!Описание
|-
|PHONE_TYPE 
|Целое 
|Тип телефона звонящего:
1 - если звонит водитель с основного телефона; 

2 - если звонит физическое лицо; 

3 - если звонит юридическое лицо; 

4 - если звонит номер из справочника Телефоны; 

5 - если звонит водитель с неосновного телефона;

6 - если звонит ЦОЗ водитель;

0 - неизвестный номер.
|-
|PHONE_TO_DIAL 
|Строка, <= 16 символов 
|Номер телефона для отзвона по заказу
|-
|CREW_ID 
|Целое 
|ИД экипажа
|-
|IS_PRIOR 
|0 или 1 (false или true)
|Признак предварительного заказа
|-
|IS_PRIZE
|0 или 1 (false или true)
|Признак призового заказа
|-
|ORDER_CLIENT_ID 
|Целое
|ИД клиента из заказа
|-
|DRIVER_PHONE 
|Строка, <= 16 символов 
|Номер телефона водителя
|-
|CREW_SYSTEMSTATE 
|Целое 
|Состояние экипажа
|-
|CLIENT_ID 
|Целое 
|ИД клиента
|-
|CLIENT_TYPE 
|Целое 
|Тип клиента
|-
|CATEGORYID
|Целое 
|ИД категории телефона
|-
|PHONE_SYSTEM_CATEGORY
|Целое 
|Системное значение категории телефона (0 - обычный, 1 - черный, 2 - белый, 3 - серый)
|-
|ORDER_ID 
|Целое 
|ИД заказа
|-
|DRIVER_ID 
|Целое 
|ИД водителя
|-
|ORDER_STATE 
|Целое 
|Состояние заказа
|-
|DRIVER_REMAINDER 
|Дробное 
|Баланс счета водителя
|-
|DISCOUNTEDSUMM 
|Строка 
|Сумма заказа с учетом всех скидок
|-
|CREW_GROUP_ID 
|Целое 
|ИД группы экипажа (если в заказе указан экипаж, то берется ИД группы экипажа, если нет — из карты заказа) 
|-
|FIRST_CREW_GROUP_ID
|Целое
|ИД первой группы экипажа
|-
|CLIENT_BALANCE 
|Дробное 
|Баланс клиента
|-
|DRIVER_TIMECOUNT 
|Целое 
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT 
|Целое 
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR 
|Строка 
|Запись с информацией о цвете
|-
|SOUND_MARK 
|Строка 
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER 
|Строка 
|Государственный номер автомобиля
|-
|CAR_COLOR 
|Строка 
|Цвет автомобиля
|-
|CAR_MARK 
|Строка 
|Марка автомобиля
|-
|ORDER_COORDS
|Строка 
|Координаты места подачи. Порядок координат: долгота адреса, широта адреса.
|-
|CREW_COORDS
|Строка 
|Координаты назначенного экипажа. Порядок координат: долгота адреса, широта адреса.
|-
|MARKET_TYPE
|Целое
|Тип биржи заказов (2 — Яндекс, 3 — ЦОЗ).
|-
|ORDERS_COUNT
|Целое
|Для телефона клиента — количество текущих и предварительных заказов по телефону; для телефона водителя — количество текущих заказов, на которые назначен данный водитель
|-
|CLIENT_GROUP_ID
|Целое
|ИД группы клиента
|-
|CLIENT_BONUS_BALANCE
|Дробное
|Бонусный баланс клиента
|-
|AD_LIGHTHOUSE
|Строка
|Признак наличия шашек. Пустая строка – номер клиента или водителя без экипажа. 1 – есть шашки, 0 – нет шашек.
|-
|CREW_STATE
|Целое
|Состояние экипажа.
|-
|SOURCE_TIME
|ГГГГММДДччммсс
|Дата и время подачи
|-
|DRV_SHIFT_START_TIME
|ГГГГММДДччммсс
|Начало фактической смены водителя
|-
|START_USER_SIP_ACCOUNTS
|Строка
|Список логинов SIP–аккаунтов пользователя, принявшего заказ
|-
|CREATION_WAY
|Строка
|Способ создания заказа (operator, sms, market, common_api, t_api, taxophone, driver, daily_order, taxophone_web, unknown)
|-
|CREATOR_TAXI_PHONE
|Строка
|Телефон службы-создателя для заказов, принятых из ЦОЗ
|-
|PERFORMER_TAXI_PHONE
|Строка
|Телефон службы-исполнителя для заказов, отданных в ЦОЗ
|-
|CLIENT_IS_LOCKED
|0 или 1 (false или true)
|Признак блокировки клиента
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPE-PHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <PHONE_TYPE>0</PHONE_TYPE>
    <PHONE_TO_DIAL></PHONE_TO_DIAL>
    <CREW_ID>3</CREW_ID>
    <ORDER_ID>6</ORDER_ID>
    <SOURCE_TIME>20140929134911</SOURCE_TIME>
    <DRV_SHIFT_START_TIME>20141007105050</DRV_SHIFT_START_TIME>
  </data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET

Название запроса: get_info_by_order_id

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|ORDER_ID 
|Целое 
|ИД заказа
|-
|FIELDS 
|Строка 
|Список полей, которые необходимо вернуть. Поля перечисляются через символ ''"-"''
|-
|signature 
|Строка 
|Поле для проверки секретного ключа
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

{|
!Параметр 
!Тип 
!Описание
|-
|DRIVER_TIMECOUNT 
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR 
|Строка 
|Запись с информацией о цвете
|-
|CAR_MARK
|Строка 
|Марка автомобиля
|-
|CAR_COLOR
|Строка 
|Цвет автомобиля
|-
|GOSNUMBER 
|Строка 
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка 
|Запись с информацией о марке автомобиля
|-
|CREW_GROUP_ID
|Целое 
|ИД группы экипажа (значение из карты заказа) 
|-
|FIRST_CREW_GROUP_ID
|Целое
|ИД первой группы экипажа
|-
|IS_PRIOR 
|0 или 1 (false или true)
|Признак предварительного заказа
|-
|IS_PRIZE
|0 или 1 (false или true)
|Признак призового заказа
|-
|DISCOUNTEDSUMM 
|Строка 
|Сумма заказа с учетом всех скидок
|-
|DRIVER_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID 
|Целое 
|ИД категории телефона
|-
|SOURCE_TIMECOUNT
|Целое 
|Время до подачи в минутах
|-
|ORDER_COORDS
|Строка
|Координаты места подачи. Порядок координат: долгота адреса, широта адреса.
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа. Порядок координат: долгота адреса, широта адреса.
|-
|ORDER_STATE
|Целое 
|ИД состояния заказа
|-
|MARKET_TYPE
|Целое 
|Тип биржи заказов (2 — Яндекс, 3 — ЦОЗ).
|-
|AD_LIGHTHOUSE
|Строка
|Признак наличия шашек (1 – шашки есть, 0 – шашек нет).
|-
|CREW_STATE
|Целое
|Состояние экипажа
|-
|SOURCE_TIME
|ГГГГММДДччммсс
|Дата и время подачи
|-
|START_USER_SIP_ACCOUNTS
|Строка
|Список логинов SIP–аккаунтов пользователя, принявшего заказ
|-
|ORDER_PARAMS
|Целое
|Список ИД параметров заказа
|-
|CREATION_WAY
|Строка
|Способ создания заказа (operator, sms, market, common_api, t_api, taxophone, driver, daily_order, taxophone_web, unknown)
|-
|CREATOR_TAXI_PHONE
|Строка
|Телефон службы-создателя для заказов, принятых из ЦОЗ
|-
|PERFORMER_TAXI_PHONE
|Строка
|Телефон службы-исполнителя для заказов, отданных в ЦОЗ
|}

Пример:

<pre>
Запрос:

GET https://ip:port/tm_tapi/1.0/get_info_by_order_id?order_id=60&fields=DRIVER_SOURCETIME-MARKCOLOR-
GOSNUMBER-IS_PRIOR-MOBILE_PHONE-SOURCE_TIME&signature=fdcd04e570443b56176b83f44748dc23


Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <DRIVER_SOURCETIME></DRIVER_SOURCETIME>
    <MARK></MARK>
    <COLOR></COLOR>
    <GOSNUMBER></GOSNUMBER>
    <IS_PRIOR></IS_PRIOR>
    <MOBILE_PHONE></MOBILE_PHONE>
    <SOURCE_TIME>20140929134911</SOURCE_TIME>
  </data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

Название запроса: change_order_state

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|ORDER_ID 
|Целое 
|ИД заказа
|-
|NEED_STATE 
|Целое 
|Новое состояние заказа
|-
|signature 
|Строка 
|Поле для проверки секретного ключа
|}

Специальные возвращаемые коды:

{|
!Код 
!Описание
|-
|100 
|Заказ с таким ИД не найден
|-
|101 
|Изменение состояния не соответствует необходимым условиям
|}

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр 
!Тип 
!Описание
|-
|ORDER_ID 
|Целое 
|ИД заказа
|-
|NEED_STATE 
|Целое 
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state 
Content-Type: application/x-www-form-urlencoded
Content-Length: 71

order_id=18561&need_state=14&signature=3e8107e0c044e55d983db1fbed82fd8c

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <ORDER_ID>18561</ORDER_ID>
    <NEW_STATE>14</NEW_STATE>
  </data>
</response>
</pre>

==== Запись пути к файлу разговора в базу данных ====

Метод: POST

Название запроса: create_record_link

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|RECORD_DATE 
|ДДММГГГГччммсс 
|Дата записи
|-
|RECORD_LENGTH 
|Целое 
|Продолжительность записи (в секундах)
|-
|CALL_ID
|Строка, <= 60 символов 
|ИД звонка (необязателен, если указан PHONE)
|-
|PHONE 
|Строка, <= 16 символов 
|Номер телефона (необязателен, если указан CALL_ID)
|-
|FILE_PATH 
|Строка, <=255 символов 
|Путь к файлу записи
|-
|CALL_TYPE
|0 или 1
|0 — Исходящий, 1 — Входящий
|-
|signature 
|Строка 
|Поле для проверки секретного ключа
|}

Специальные возвращаемые коды: нет.

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр 
!Тип 
!Описание
|-
|RECORD_ID 
|Целое 
|ИД созданной записи
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/create_record_link 
Content-Type: application/x-www-form-urlencoded
Content-Length: 185

RECORD_DATE=20130122180949&RECORD_LENGTH=215&CALL_ID=12345&PHONE=8987564&FILE_PATH=d%3A%5Ctemp%5CTM
%5Ctrunk%5CSource%5CDevUtils%5CTMAPITest%5C&CALL_TYPE=1&signature=56851c4e8d2d4bb9ba615615f76ad7f7

Ответ:
<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <RECORD_ID>25</RECORD_ID>
  </data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

Название запроса: make_new_order

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|PHONE 
|Строка, <= 16 символов 
|Номер телефона
|-
|ORDER_STATE_ID 
|Целое 
|ИД состояния заказа
|-
|signature 
|Строка 
|Поле для проверки секретного ключа
|-
!colspan="3"|Необязательные параметры
|-
|CREWGROUPID
|Целое 
|ИД группы экипажа
|-
|TARIF_ID
|Целое 
|ИД тарифа
|-
|DISCOUNTEDSUMM
|Дробное
|Фиксированная сумма за заказ
|-
|CUSTOMER
|Строка, <=80 символов
|Заказчик
|-
|SOURCE
|Строка, <=80 символов
|Адрес подачи
|-
|SOURCE_STREET
|Целое
|ИД улицы подачи
|-
|SOURCE_HOUSE
|Строка, <=10 символов
|Дом подачи
|-
|SOURCE_FLAT
|Строка, <=10 символов
|Квартира подачи
|-
|SOURCE_POINT
|Целое
|ИД пункта подачи
|-
|DESTINATION
|Строка, <=80 символов
|Адрес назначения
|-
|DESTINATION_STREET
|Целое
|ИД улицы назначения
|-
|DESTINATION_HOUSE
|Строка, <=10 символов
|Дом назначения
|-
|DESTINATION_FLAT
|Строка, <=10 символов
|Квартира назначения
|-
|DESTINATION_POINT
|Целое
|ИД пункта назначения
|-
|CREWID
|Целое
|ИД экипажа
|-
|SUMM
|Дробное
|Стоимость заказа без учета скидок (наценок)
|-
|STARTUSER
|Целое
|Пользователь, создавший заказ
|-
|STARTTIME
|ГГГГММДДччммсс
|Дата создания заказа
|-
|FINISHUSER
|Целое
|Пользователь, завершивший заказ
|-
|FINISHTIME
|ГГГГММДДччммсс
|Дата завершения заказа
|-
|SOURCE_ZONE
|Целое
|Район подачи
|-
|DESTINATION_ZONE
|Целое
|Район назначения
|-
|SOURCE_PARKING
|Целое
|Стоянка подачи
|-
|DESTINATION_PARKING
|Целое
|Стоянка назначения
|-
|SOURCE_TIME
|ГГГГММДДччммсс
|Дата подачи
|-
|SOURCE_COUNTRY
|0 или 1 (false или true)
|Признак междугороднего заказа
|-
|IS_PRIOR
|0 или 1 (false или true)
|Признак предварительного заказа
|-
|PRIZE
|0 или 1 (false или true)
|Признак призового заказа
|-
|NOTE
|Строка, <=80 символов
|Примечание
|-
|BONUSPOINT
|Дробное
|Бонусные баллы, начисленные водителю за заказ
|-
|DISTANCE
|Дробное
|Километраж по городу (в километрах)
|-
|HOURLY_LEN
|Целое
|Длительность исполнения почасового заказа (в минутах)
|-
|HOURLY_START
|ГГГГММДДччммсс
|Дата начала отсчета при почасовом заказе
|-
|HOURLY_PAY
|0 или 1 (false или true)
|Признак почасового заказа
|-
|PHONE_TO_DIAL
|Строка, <=16 символов
|Номер телефона для отзвона по заказу
|-
|FROMBORDER
|0 или 1 (false или true)
|Признак заказа "с бордюра"
|-
|WAITING_START
|ГГГГММДДччммсс
|Дата начала ожидания заказчика водителем
|-
|WAITING_LENGTH
|Целое
|Общая длина периода ожидания заказчика водителем (в минутах)
|-
|BACKFREE
|Целое
|Признак применения скидки в 50% на обратный путь
|-
|INPUTTIME
|ГГГГММДДччммсс
|Дата принятия заказа (от даты создания заказа отличается тем, что может быть задана пользователем)
|-
|MONEY_RECEIVE
|0 или 1 (false или true)
|Подтверждение принятия денег наличными
|-
|NOTIFY_BEFORE
|Целое
|Период времени, за который пользователь оповещается о наступлении даты подачи
|-
|WANTCREWID
|Целое
|ИД желаемого экипажа
|-
|DISTANCE_COUNTRY
|Дробное
|Километраж за границами города (в километрах)
|-
|DISTANCE_CHECK
|0 или 1 (false или true)
|Разрешение ручного ввода километража
|-
|CLIENTID
|Целое
|ИД постоянного клиента
|-
|INFRA_STATE
|Целое
|Состояние заявки в исходящей компании колцентра INFRA (1 - заявка передана в исходящую компанию, 2 - отзвон успешно произведен, 3 - занято, 4 - не берут трубку)
|-
|INFRA_ORDER
|Целое
|INFRA-заказ (спец. поле для работы с колцентром компании Инфрател)
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр 
!Тип 
!Описание
|-
|ORDER_ID 
|Целое 
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order 
Content-Type: application/x-www-form-urlencoded
Content-Length: 206

PHONE=89058770593&ORDER_STATE_ID=10&DISCOUNTED_SUMM=100&signature=afc947f610eba380df6d0e441b03ddad

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <order_id>27</order_id>
  </data>
</response>
</pre>

==== Поиск улицы в базе ====
Метод: POST

Название запроса: street_search

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|PHONE 
|Строка, <= 16 символов 
|Номер телефона
|-
|CALL_ID
|Целое 
|ИД звонка
|-
|VOICE_STREET
|Строка, <= 60 символов
|Название улицы или пункта, полученное через преобразование голоса в текст
|-
|signature
|Строка
|Поле для проверки секретного ключа
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр 
!Тип 
!Описание
|-
|CALL_ID 
|Целое 
|ИД звонка
|-
|PHONE 
|Строка, <= 16 символов
|Номер телефона
|-
|STREET_FOUND
|0 или 1 (false или true)
|Признак того, что улица найдена
|-
|STREET_NAME
|Строка, <= 60 символов
|Наименование улицы или пункта, найденное в базе данных
|}


Пример:

<pre>
Запрос:
POST https://ip:port/tm_tapi/1.0/street_search 
Content-Type: application/x-www-form-urlencoded
Content-Length: 175

PHONE=89058770593&CALL_ID=56&VOICE_STREET=пушкинск&FIND_STREET=0&API_FIND_STREET=&NUM_HOUSE=&signat
ure=9204a53e0f4842bb623c3a5f7683520a

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <CALL_ID>56</CALL_ID>
    <PHONE>89058770593</PHONE>
    <FIND_STREET>1</FIND_STREET>
    <API_FIND_STREET>Пушкинская</API_FIND_STREET>
  </data>
</response>
</pre>

==== Смена состояния заказа по результату автодозвона ====
Метод: POST

Название запроса: set_request_state

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|STATE_ID
|Целое
|Cостояние заказа до отзвона
|-
|PHONE_TYPE
|0 или 1
|Признак, что звонили клиенту (если 0 - водителю) 
|-
|ORDER_ID
|Целое
|ИД заказа
|-
|STATE
|Целое (0, 1, 2, 3, 4, 5)
|Состояние отзвона (0 – начальное, 1 — в процессе, 2 — успешно, 3 — занято, 4 — нет ответа, 5 — ошибка) 
|-
|signature
|Строка
|Поле для проверки секретного ключа
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Настройки смены состояний заказа с использованием автодозвона задаются в карточке
состояний заказа.

Пример:

<pre>
Запрос:
POST https://ip:port/tm_tapi/1.0/set_request_state 
Content-Type: application/x-www-form-urlencoded
Content-Length: 71

state_id=7&phone_type=1&order_id=50&state=4&signature=0eb50db401d3540e038fde68eb260333

Ответ:

<response>
   <code>0</code>
   <descr>OK</descr>
</response>
</pre>

==== Соединить клиента и водителя ====
Метод: POST

Название запроса: connect_client_and_driver

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа
|}

Специальные возвращаемые коды:
{|
!Код 
!Описание
|-
|100
|Не найден заказ с таким ИД
|-
|103
|В заказе нет водителя
|-
|104
|У водителя не определен телефон
|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/connect_client_and_driver 
Content-Type: application/x-www-form-urlencoded
Content-Length: 53

order_id=13&signature=6a4b16da44a495b67eb7af11d51954d4

Ответ:

<response>
   <code>0</code>
   <descr>OK</descr>
</response>

</pre>

==== Количество свободных экипажей на линии ====
Метод: GET

Название запроса: get_free_crews_count

Параметры:
{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|signature
|Строка
|Поле для проверки секретного ключа
|-
!colspan="3"|Необязательные параметры
|-
|crew_group_id
|Целое
|ИД группы экипажа предполагаемого заказа
|-
|uds_id
|Целое
|ИД службы ЕДС предполагаемого заказа
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр 
!Тип 
!Описание
|-
|COUNT
|Целое
|Количество свободных экипажей на линии
|}

Пример:
<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_free_crews_count?
crew_group_id=1&uds_id=1&signature=88ca2091061c3e90123275f2c5df55a6 
Content-Type: application/x-www-form-urlencoded
Ответ:
<response>
<code>0</code>
<descr>OK</descr>
<data>
<COUNT>5</COUNT>
</data>
</response>
</pre>

==== Запрос пользователя по логину софтфона ====
Метод: GET

Название запроса: get_user_by_sip_login

Параметры:
{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|signature
|Строка
|Поле для проверки секретного ключа
|-
|login
|Строка
|Логин SIP-аккаунта
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр 
!Тип 
!Описание
|-
|ID
|Целое
|ИД пользователя, который использует указанный логин SIP-аккаунта софтфона в данный момент
|-
|NAME
|Строка
|Имя пользователя, который использует указанный логин SIP-аккаунта софтфона в данный момент
|}

Пример:
<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_user_by_sip_login?
login=LOGIN&signature=9b06455cdfe933e7af12a35a70e9b1c6 
Content-Type: application/x-www-form-urlencoded
Ответ:
<response>
<code>0</code>
<descr>OK</descr>
<data>
<ID>1</ID>
<NAME>ADMINISTRATOR</NAME>
</data>
</response>
</pre>

==== Установить режим «Перерыв» для линий софтфона ====
Метод: POST

Название запроса: set_sip_account_dnd_mode

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|dnd
|Строка
|0 или 1
|-
|user_login
|Строка
|Логин пользователя ТМ
|-
|lines
|Строка
|<nowiki>Список линий, разделенных символом «|»</nowiki>
|-
|signature
|Строка
|Поле для проверки секретного ключа
|}

Специальные возвращаемые коды:
{|
!Код 
!Описание
|-
|100
|Пользователь с таким логином или линиями не найден.
|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/set_sip_account_dnd_mode 
Content-Type: application/x-www-form-urlencoded
Content-Length: 66

dnd=1&user_login=USER&lines=101%7C102&signature=3e8107e0c044e55d983db1fbed82fd8c

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
</response>
</pre>

==== Запрос телефонов водителя по позывному экипажа ====

Метод: GET

Название запроса: get_driver_phones_by_crew_code

Параметры:

{|
!Параметр 
!Тип 
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_code 
|Строка 
|Позывной экипажа
|}


Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100 
|Водитель не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр 
!Тип 
!Описание
|-
|mobile_phone 
|Строка 
|Основной телефон водителя 
|-
|home_phone 
|Строка 
|Неосновной телефон водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/tm_tapi/1.0/get_driver_phones_by_crew_code?
crew_code=CODE&signature=6f03bc45d3aa17f7738672180a3ee5de 
Content-Type: application/x-www-form-urlencoded

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<mobile_phone>123456789</mobile_phone>
<home_phone>987654321</home_phone>
</data>
</response>

</pre>

==== Запрос информации о ключе защиты ====

Метод: GET

Название запроса: get_key_info

Параметры: нет.

Специальные возвращаемые коды: нет.

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр 
!Тип 
!Описание
|-
|company_name
|Строка
|Наименование организации
|-
|company_id
|Целое
|ИД организации
|-
|tm_server_license_count
|Целое
|Количество лицензий для TMServer
|-
|tm_license_count
|Целое
|Количество лицензий для TM2
|-
|tm_terminal_license_count
|Целое
|Количество лицензий для терминала
|-
|tm_driver_server_license_count
|Целое
|Количество лицензий для TMDriverServer
|-
|tm_driver_license_count
|Целое
|Количество лицензий для водителей
|-
|tm_sms_server_license_count
|Целое
|Количество лицензий для TMSMSServer
|}

Пример:
<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_key_info 
Content-Type: application/x-www-form-urlencoded

signature=6f03bc45d3aa17f7738672180a3ee5de

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
company_name>ООО БИТ-Мастер</company_name>
<company_id>000</company_id>
<tm_server_license_count>1</tm_server_license_count>
<tm_license_count>10</tm_license_count>
<tm_terminal_license_count>1</tm_terminal_license_count>
<tm_driver_server_license_count>1</tm_driver_server_license_count>
<tm_driver_license_count>30</tm_driver_license_count>
<tm_sms_server_license_count>1</tm_sms_server_license_count>
</data>
</response>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Приведенная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Форма, представленная в примере, будет выглядеть следующим образом:
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]