+7 (499) 709-84-87

TM API

В статье:
1. Запрос-пинг
2. Запрос списка групп экипажей
3. Запрос списка групп клиентов
4. Запрос списка тарифов
5. Запрос списка услуг
6. Запрос списка атрибутов
7. Запрос списка скидок
8. Создание нового заказа
9. Создание нового заказа 2
10. Расчет суммы заказа
11. Расчет суммы заказа 2
12. Изменение состояния заказа
13. Запрос информации об экипаже
14. Запрос информации об экипажах
15. Создание экипажа
16. Обновление информации об экипаже
17. Запрос информации о водителе
18. Запрос списка водителей
19. Создание водителя
20. Обновление информации о водителе
21. Запрос информации об автомобиле
22. Запрос списка автомобилей
23. Создание автомобиля
24. Обновить информацию об автомобиле
25. Запрос координат экипажей
26. Запрос адресов, содержащих нужную строку
27. Запрос адресов, содержащих нужную строку 2
28. Анализ маршрута
29. Анализ маршрута 2
30. Запрос информации о состоянии заказа
31. Создание задачи СМС серверу
32. Проверка авторизации
33. Регистрация клиента
34. Запрос информации по клиенту
35. Изменение информации по клиенту
36. Запрос текущих заказов
37. Запрос выполненных заказов
38. Проведение операции по клиенту
39. Запрос операций по клиенту
40. Проведение операции по водителю
41. Запрос операций по водителю
42. Назначение динамического приоритета водителю
43. Задание координат экипажей
44. Изменение информации по заказу
45. Анализ телефона
46. Показать сообщение в ТМ
47. Запрос списка купленных смен водителей
48. Запрос списка запланированных смен водителей
49. Продажа смены водителю
50. Сохранение отзыва клиента
51. Поиск экипажей по координатам
52. Подбор тарифа для заказа
53. Импорт марок автомобилей в БД
54. Импорт цветов автомобилей в БД
55. Запрос информации по сотруднику клиента
56. Создание сотрудника клиента
57. Обновление информации о сотруднике клиента
58. Запрос списка состояний заказа
59. Запрос списка состояний экипажа
60. Запрос информации по клиентам
61. Запрос информации о заявке спец. техники
62. Удаление заявки спец. техники
63. Запрос глобальных атрибутов
ОПИСАНИЕ ПРОТОКОЛА TMTAPI ВЕРСИЯ 1.0
1. Запрос информации по номеру телефона
2. Запрос информации по ИД заказа
3. Смена состояния заказа
4. Запись пути к файлу разговора в базу данных
5. Создать новый заказ
6. Поиск улицы в базе
7. Смена состояния заказа по результату автодозвона
8. Соединить клиента и водителя
9. Количество свободных экипажей на линии
10. Запрос пользователя по логину софтфона
11. Установить режим «Перерыв» для линий софтфона
12. Запрос телефонов водителя по позывному экипажа
13. Запрос информации о ключе защиты




TM API - специальный набор инструментов ТМ: Корпоративные поездки, который позволит объединить систему с различными полезными сервисами.

Параметры TM API

Задать настройки для корректной работы TM API вы сможете в ТМ в меню Настройки в одноименной ветке TM API.

  1. Установите флажок Использовать TM API, чтобы приступить к его использованию.
  2. В поле Локальный порт введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах ТМ Сервер. Рекомендуется оставить номер порта по умолчанию.
  3. При необходимости установите флажок Использовать автопроброс порта с помощью UPnP, также укажите Внешний порт и Локальный IP.

Ветка "Открытое API"

В данной ветке регулируется доступ к синхронизации ТМ со сторонним сервисом.

  1. Установите флажок Использовать открытое API для того, чтобы запустить работу протокола TMCommonAPI.
  2. В поле Секретный ключ укажите произвольный номер. В дальнейшем этот номер следует использовать в API-запросах на сайте.

Ветка "API для телефонии"

В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие ТМ с call-центром через программный интерфейс.

  1. Установите флажок Использовать открытое API для телефонии для того, чтобы запустить работу протокола TMTAPI.
  2. В поле Секретный ключ укажите номер секретного ключа для работы.

Ветка "TaxoPhone API"

В данной ветке находятся параметры, необходимые для взаимосвязи клиентского приложения с программным комплексом ТМ: Корпоративные поездки.

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

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

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

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

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

GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 
Signature: <...>

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

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

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

Запрос:
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

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

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

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

Существуют общие для всех запросов коды результатов:

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

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

1. Запрос-пинг

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

Метод: GET или POST

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

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

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

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

Пример:

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

2. Запрос списка групп экипажей

Метод: GET

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

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

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

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

ПараметрТипОписание
crew_groupsМассивСписок групп экипажей
• idЦелоеИД группы экипажей
• nameСтрокаНазвание группы экипажей

Пример:

Запрос:

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"
     }
    ]
  }
}

3. Запрос списка групп клиентов

Метод: GET

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

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

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

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

ПараметрТипОписание
client_groupsМассивСписок групп клиентов
• idЦелоеИД группы клиентов
• nameСтрокаНазвание группы клиентов

Пример:

Запрос:
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"
      }
    ]
  }
}

4. Запрос списка тарифов

Метод: GET

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

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

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

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

ПараметрТипОписание
tariffsМассивСписок тарифов
• idЦелоеИД тарифа
• nameСтрокаНазвание тарифа
• is_activetrue или falseАктивный тариф

Пример:

Запрос:

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
      }
    ]
  }
}

5. Запрос списка услуг

Запрос устарел. Рекомендуется использовать запрос списка параметров заказа

Метод: GET

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

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

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

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

ПараметрТипОписание
servicesМассивСписок услуг
• idЦелоеИД услуги
• nameСтрокаНазвание услуги
• sumДробноеАбсолютная сумма услуги, руб
• percentДробноеПроцент услуги от стоимости заказа, %

Пример:

Запрос:

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
      }
    ]
  }
}

6. Запрос списка атрибутов

Метод: GET

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

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

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

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

ПараметрТипОписание
order_paramsМассивСписок параметров заказа
• idЦелоеИД параметра
• nameСтрокаНазвание параметра
• sumДробноеАбсолютная сумма параметра, руб
• percentДробноеПроцент параметра от стоимости заказа, %
• order_access_controltrue или falceРегулирует доступ к заказу

Пример:

Запрос:

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
      }
    ]
  }
}

7. Запрос списка скидок

Метод: GET

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

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

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

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

ПараметрТипОписание
discountsМассивСписок скидок
• idЦелоеИД скидки
• nameСтрокаНазвание скидки
• sumДробноеАбсолютная сумма скидки, руб
• percentДробноеПроцент скидки от стоимости заказа, %

Пример:

Запрос:

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
      }
    ]
  }
}

8. Создание нового заказа

Метод: POST

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

Параметры:

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

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

КодОписание
100Заказ с такими параметрами уже создан
101Тариф не найден
102Группа экипажа не найдена
110Клиент заблокирован
111Не найден клиент, который может использовать собственный счет для оплаты заказов

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

ПараметрТипОписание
order_idЦелоеИД созданного заказа

Пример:

Запрос:

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
  }
}

9. Создание нового заказа 2

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
phoneСтрока, <= 30 символовНомер телефонам (необязателен, если client_id присутствует).
client_idЦелоеИД клиента (необязателен, если phone присутствует).
addressesМассивМассив адресов. Первый элемент — адрес подачи(обязательно), последний — адрес назначения, между ними — остановки.
• addressСтрокаАдрес подачи
• latДробноеШирота адреса
• lonДробноеДолгота адреса
• zone_idЦелоеИД района
• parking_idЦелоеИД стоянки
server_time_offsetЦелоеСмещения относительно серверного времени
source_timeГГГГММДДччммссВремя подачи
Необязательные параметры
passengerСтрокаПассажир
phone_to_dialСтрока, <= 30 символовТелефон для отзвона
customerСтрокаЗаказчик
commentСтрокаКомментарий
crew_group_idЦелоеИД группы экипажей
tariff_idЦелоеИД тарифа
is_priortrue или falseПредварительный заказ
check_duplicatetrue или falseПроверка на дубликат
servicesМассивМассив услуг. Устарело. Рекомендуется использовать параметр attribute_values.
ЦелоеИД услуги
crew_propsМассивМассив признаков экипажей. Устарело. Рекомендуется использовать параметр attribute_values.
ЦелоеИД признака экипажа
order_paramsМассивМассив параметров заказа. Устарело. Рекомендуется использовать параметр attribute_values.
ЦелоеИД параметра заказа
total_costДробноеСумма заказа
use_cashlesstrue или falseОплата по возможности всей суммы заказа с безналичного счета клиента (насколько хватает средств на счете).
use_bonustrue или 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СтрокаНомер рейса
need_custom_validate true или false Использовать специальную проверку перед созданием заказа
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

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

КодОписание
100Заказ с такими параметрами уже создан
101Тариф не найден
102Группа экипажа не найдена
104Клиент не найден
105Район не найден
106Стоянка не найдена
107Сотрудник клиента не найден
108Параметр заказа не найден
109Атрибут не может быть привязан к заказу
110Клиент заблокирован
111Не найден клиент, который может использовать собственный счет для оплаты заказов
112 Сотрудник клиента заблокирован
113 Ошибка специальной проверки заказа перед созданием.
В ответе будет возвращаться:

   "data": {
         "message":"Текст ошибки для пользователя."
    }

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

ПараметрТипОписание
order_idЦелоеИД созданного заказа

Пример:

Запрос:
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"
  "need_custom_validate":false,
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ] } Ответ: { "code":0, "descr":"OK", "data":{ "order_id":1672 } }

10. Расчет суммы заказа

Метод: GET

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

Параметры:
ПараметрТипОписание
Обязательные параметры
tariff_idЦелоеИД тарифа
Необязательные параметры
source_timeГГГГММДДччммссВремя подачи
is_priortrue или 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_countrytrue или falseЗагородный заказ
waiting_minutesЦелоеВремя ожидания посадки клиента в минутах
is_hourlytrue или falseПочасовой заказ
hourly_minutesЦелоеДлительность почасового заказа в минутах
is_prizetrue или falseПризовой заказ
back_waytrue или falseОбратный путь за городом
servicesСтрокаСписок ИД услуг через точку с запятой, пример: «1;2;3»

Устарело. Рекомендуется использовать параметр order_params.

order_paramsСтрокаСписок ИД параметров заказа через точку с запятой, пример: «1;2;3»
cashlesstrue или falseПризнак безналичного заказа

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

КодОписание
100Тариф не найден
101Ошибка при расчете по тарифу
102Скидка не найдена
103Клиент не найден
104Район подачи не найден
105Район назначения не найден
106Дисконтная карта не найдена
107Район остановки не найден
108Группа экипажа не найдена
110Дисконтная карта не действительна
111Не найден сотрудник клиента

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

ПараметрТипОписание
sumДробноеРассчитанная общая сумма заказа
infoМассивДополнительная информация по расчету суммы заказа
• commentСтрокаОписание позиции дополнительной информации по расчету суммы заказа
• sumСтрокаСумма позиции дополнительной информации по расчету суммы заказа

Пример:

Запрос: 

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"
      }
    ]
  }
} 

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

Метод: POST

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

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

ПараметрТипОписание
tariff_idЦелоеИД тарифа
source_timeГГГГММДДччммссВремя подачи
is_priortrue или 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_countrytrue или falseЗагородный заказ
waiting_minutesЦелоеВремя ожидания посадки клиента в минутах
is_hourlytrue или falseПочасовой заказ
hourly_minutesЦелоеДлительность почасового заказа в минутах
is_prizetrue или falseПризовой заказ
back_waytrue или falseОбратный путь за городом
order_paramsМассивМассив параметров заказа. Устарело. Рекомендуется использовать параметр attribute_values.
ЦелоеИД параметра заказа
cashlesstrue или falseПризнак безналичного заказа
stopsМассивСписок остановок
• zone_idЦелоеИД района остановки
• latДробноеШирота адреса остановки
• lonДробноеДолгота адреса остановки
crew_group_idЦелоеИД группы экипажа
analyze_routetrue или falseНужно ли выполнять анализ адресов и маршрута. Если данный флаг установлен (analyze_route=true), то значения параметров: distance_city, distance_country, source_distance_country, переданные в данном запросе будут игнорироваться. Они автоматически будут рассчитаны в ходе выполнения запроса в результате анализа адресов и маршрута.
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

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

КодОписание
100Тариф не найден
101Ошибка при расчете по тарифу
102Скидка не найдена
103Клиент не найден
104Район подачи не найден
105Район назначения не найден
106Дисконтная карта не найдена
107Район остановки не найден
108Группа экипажа не найдена
110Дисконтная карта не действительна
111Сотрудник клиента не найден
112 Атрибут не найден
113 Атрибут не может быть привязан к заказу

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

ПараметрТипОписание
sumДробноеРассчитанная общая сумма заказа
infoМассивДополнительная информация по расчету суммы заказа
• commentСтрокаОписание позиции дополнительной информации по расчету суммы заказа
• sumСтрокаСумма позиции дополнительной информации по расчету суммы заказа

Пример:

Запрос: 

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
      }
  ],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
} Ответ: { "code":0, "descr":"OK", "data":{ "sum":1000, "info":[ { "comment":"SUM1", "sum":"100" }, { "comment":"SUM2", "sum":"200" } ] } }

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

Метод: POST

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

Параметры:

ПараметрТипОписание
Обязательные параметры
order_id
ЦелоеИД заказа
new_state
ЦелоеНовое состояние заказа

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

КодОписание
100Не найден заказ ИД=ORDER_ID
101Не найдено состояние заказа ИД=NEW_STATE
102Изменение состояния не соответствует необходимым условиям.

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

ПараметрТипОписание
order_id
ЦелоеИД заказа
new_state
ЦелоеНовое состояние заказа

Пример:

Запрос: 

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
  }
} 

13. Запрос информации об экипаже

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
crew_idЦелоеИД экипажа

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

КодОписание
100Экипаж не найден

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

ПараметрТипОписание
crew_idЦелоеИД экипажа
codeСтрокаПозывной экипажа
nameСтрокаНаименование экипажа
driver_idЦелоеИД водителя
car_idЦелоеИД автомобиля
crew_group_idЦелоеИД группы экипажа
crew_state_idЦелоеИД состояния экипажа
onlinetrue или falseВодитель подключен к серверу «Связи с водителями»
work_shift_sumДробноеСумма, списываемая за смену
min_balanceДробноеМинимальный баланс, при котором можно выйти на смену
common_priorityЦелоеОбщий приоритет
static_priorityЦелоеСтатический приоритет
dynamic_priorityЦелоеДинамический приоритет
rating_priorityЦелоеПриоритет по рейтингу
order_change_idЦелоеИндивидуальная сдача с заказа
has_light_housetrue или falseШашка
has_labeltrue или falseНаклейка
use_plan_shiftstrue или falseЗапрет работы вне запланированных смен
order_paramsМассивМассив параметров экипажа
ЦелоеИД параметра 
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута: - «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
•  str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос: 

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,
    ]
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ] } }

14. Запрос информации об экипажах

Метод: GET

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

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

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

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

ПараметрТипОписание
Обязательные параметры
crews_infoМассивМассив экипажей
• crew_idЦелоеИД экипажа
• codeСтрокаПозывной экипажа
• nameСтрокаНаименование экипажа
• driver_idЦелоеИД водителя
• car_idЦелоеИД автомобиля
• crew_group_idЦелоеИД группы экипажа
• crew_state_idЦелоеИД состояния экипажа
• onlinetrue или falseВодитель подключен к серверу «Связи с водителями»
• work_shift_sumДробноеСумма, списываемая за смену
• min_balanceДробноеМинимальный баланс, при котором можно выйти на смену
• common_priorityЦелоеОбщий приоритет
• static_priorityЦелоеСтатический приоритет
• dynamic_priorityЦелоеДинамический приоритет
• rating_priorityЦелоеПриоритет по рейтингу
• order_change_idЦелоеИндивидуальная сдача с заказа
• has_light_housetrue или falseШашка
• has_labeltrue или falseНаклейка
• use_plan_shiftstrue или falseЗапрет работы вне запланированных смен
• order_paramsМассивМассив параметров заказа экипажа
• •ЦелоеИД параметра заказа

Пример:

Запрос:
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":[]
      }
    ]
  }
}

15. Создание экипажа

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
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_housetrue или falseШашка
has_labeltrue или falseНаклейка
use_plan_shiftstrue или falseЗапрет работы вне запланированных смен
order_paramsМассивМассив параметров экипажа. Устарело. Рекомендуется использовать параметр attribute_values.
ЦелоеИД параметра
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

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

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

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

ПараметрТипОписание
crew_idЦелоеИД созданного экипажа

Пример:

Запрос:
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
 }
}

16. Обновление информации об экипаже

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
crew_idЦелоеИД экипажа
Необязательные параметры
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_housetrue или falseШашка
has_labeltrue или falseНаклейка
crew_gps_idЦелоеGPS идентификатор экипажа
use_plan_shiftstrue или falseЗапрет работы вне запланированных смен
order_paramsМассивМассив параметров экипажа
ЦелоеИД параметра

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

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

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

Пример:

Запрос:
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":{}
}

17. Запрос информации о водителе

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
driver_idЦелоеИД водителя
Необязательные параметры
need_phototrue или falseНужна ли фотография водителя

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

КодОписание
100Водитель не найден

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

ПараметрТипОписание
driver_idЦелоеИД водителя
nameСтрокаФИО водителя
balanceДробноеБаланс основного счета водителя
birthdayДД.ММ.ГГГГДень рождения водителя
car_idЦелоеИД основного автомобиля водителя
licenseСтрокаУдостоверение водителя
home_phoneСтрокаЛюбой неосновной телефон водителя (устаревшее поле)
mobile_phoneСтрокаОсновной телефон водителя (устаревшее поле)
is_lockedtrue или falseВодитель заблокирован
is_dismissedtrue или falseВодитель уволен
driver_photoBase64Фото водителя (только если need_photo = true)
order_paramsМассивМассив параметров водителя
ЦелоеИД параметра
phonesМассивМассив телефонов водителя
• phoneСтрокаНомер телефона
• is_defaulttrue или falseПризнак основного телефона
• use_for_calltrue или falseИспользовать для отзвона
term_accountСтрокаТерминальный аккаунт
name_for_taxophoneСтрокаИмя для TaxoPhone
accountsМассивМассив балансов счетов
•account_kindЦелоеТип счета
•balanceДробноеБаланс счета
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:

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
      }
    ]
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ] } }

18. Запрос списка водителей

Метод: GET

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

Параметры:

ПараметрТипОписание
Необязательные параметры
locked_driverstrue или falseВключить в ответ запроса заблокированных водителей (по умолчанию false)
dismissed_driverstrue или falseВключить в ответ запроса уволенных водителей (по умолчанию false)


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

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

ПараметрТипОписание
drivers_infoМассивМассив не удаленных водителей
• driver_idЦелоеИД водителя
• nameСтрокаФИО водителя
• balanceДробноеБаланс водителя
• birthdayДД.ММ.ГГГГДень рождения водителя
• car_idЦелоеИД основного автомобиля водителя
• licenseСтрокаНомер лицензии на перевозку (разрешения на перевозку)
• home_phoneСтрокаЛюбой неосновной телефон водителя (устаревшее поле)
• mobile_phoneСтрокаОсновной телефон водителя (устаревшее поле)
• is_lockedtrue или falseВодитель заблокирован
• is_dismissedtrue или falseВодитель уволен
• order_paramsМассивМассив параметров водителя
• •ЦелоеИД параметра
• phonesМассивМассив телефонов водителя
• • phoneСтрокаНомер телефона
• • is_defaulttrue или falseПризнак основного телефона
• • use_for_calltrue или falseИспользовать для отзвона
• term_accountСтрокаТерминальный аккаунт
• attribute_values Массив Массив значений атрибутов
• • id Целое Идентификатор атрибута
• • bool_value true или false Значение, если тип атрибута «Логический»
• • num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• • str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:

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"
        "attribute_values": [
            {
                 "id": 3,
                 "num_value": 10
            },
            {
                 "id": 4,
                 "str_value": "строка"
            } }, { "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"        "attribute_values": [
            {
                 "id": 3,
                 "num_value": 10
            },
            {
                 "id": 4,
                 "str_value": "строка"
            } } ] } }

19. Создание водителя

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
nameСтрокаФИО водителя
car_idЦелоеИД основного автомобиля
passwordСтрокаПароль (обязательное поле, если используется сервер связи с водителями)
Необязательные параметры
home_phoneСтрокаНеосновной телефон водителя (устаревший параметр)
mobile_phoneСтрокаОсновной телефон водителя (устаревший параметр)
passportСтрокаПаспортные данные
driver_licenseСтрокаВодительское удостоверение
employee_typeЦелоеТип работника (0 - работник компании, 1 - частник)
birthdayГГГГММДДччммссДень рождения
numberСтрокаТабельный номер
licenseСтрокаУдостоверение
start_dateГГГГММДДччммссДата приема на работу
lic_dateГГГГММДДччммссДата окончания договора
term_accountСтрокаТерминальный аккаунт (если не указан, будет сгенерирован автоматически), должен состоять из 5 цифр
commentСтрокаОписание
order_paramsМассивМассив параметров водителя
ЦелоеИД параметра
driver_photoBase64Фотография водителя
phonesМассивМассив телефонов водителя
• phoneСтрокаНомер телефона
• is_defaulttrue или falseПризнак основного телефона
• use_for_calltrue или falseИспользовать для отзвона
name_for_taxophoneСтрокаИмя для TaxoPhone
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

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

КодОписание
100Автомобиль с ИД=ID не найден
102Параметр с ИД=ID не найден или не может быть привязан к водителю
103Терминальный аккаунт не уникален
104Некорректный терминальный аккаунт
107Основной телефон может быть только один
108Водитель должен иметь основной телефон

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

ПараметрТипОписание
driver_idЦелоеИД созданного водителя

Пример:

Запрос:
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
     }
    "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      } [ } Ответ: { "code":0, "descr":"OK", "data":{ "driver_id":10 } }

20. Обновление информации о водителе

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
driver_idЦелоеИД редактируемого водителя
Необязательные параметры
nameСтрокаФИО водителя
car_idЦелоеИД основного автомобиля
passwordСтрокаПароль (обязательное поле, если используется сервер связи с водителями)
home_phoneСтрокаНеосновной телефон водителя (устаревший параметр)
mobile_phoneСтрокаОсновной телефон водителя (устаревший параметр)
passportСтрокаПаспортные данные
driver_licenseСтрокаВодительское удостоверение
employee_typeЦелоеТип работника (0 - работник компании, 1 - частник)
birthdayГГГГММДДччммссДень рождения
numberСтрокаТабельный номер
licenseСтрокаУдостоверение
start_dateГГГГММДДччммссДата приема на работу
lic_dateГГГГММДДччммссДата окончания договора
term_accountСтрокаТерминальный аккаунт
commentСтрокаОписание
time_blockГГГГММДДччммссВременная блокировка до
is_lockedtrue или falseЗаблокирован
lock_descriptionСтрокаПричина блокировки
is_dismissedtrue или falseУволен
dismiss_descriptionСтрокаПричина увольнения
order_paramsМассивМассив параметров водителя
ЦелоеИД параметра
driver_photoBase64Фотография водителя
phonesМассивМассив телефонов водителя
• phoneСтрокаНомер телефона
• is_defaulttrue или falseПризнак основного телефона
• use_for_calltrue или falseИспользовать для отзвона
name_for_taxophoneСтрокаИмя для TaxoPhone
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

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

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

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

Пример:

Запрос:
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
    }
    "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      } ] } Ответ: { "code":0, "descr":"OK", "data":{} }

21. Запрос информации об автомобиле

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
car_idЦелоеИД автомобиля
Необязательные параметры
need_phototrue или falseНужна ли фотография автомобиля

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

КодОписание
100Автомобиль не найден

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

ПараметрТипОписание
car_idЦелоеИД автомобиля
codeСтрокаПозывной автомобиля
nameСтрокаНаименование автомобиля
gos_numberСтрокаГосударственный номер автомобиля
colorСтрокаЦвет автомобиля
markСтрокаМарка автомобиля
modelСтрокаМодель автомобиля
short_nameСтрокаКраткое название автомобиля
production_yearЦелоеГод выпуска автомобиля
is_lockedtrue или falseАвтомобиль заблокирован
order_paramsМассивМассив параметров автомобиля
ЦелоеИД параметра
car_photoBase64Фото автомобиля (только если need_photo = true)
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:

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]
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ] } }

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

Метод: GET

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

Параметры:

ПараметрыТипОписание
Необязательные параметры
locked_carstrue или falseВключить в ответ заблокированных автомобилей (по умолчанию false)


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

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

ПараметрыТипОписание
cars_infoМассивМассив автомобилей
• car_idЦелоеИД автомобиля
• codeСтрокаПозывной автомобиля
• nameСтрокаНаименование автомобиля
• gos_numberСтрокаГос. номер автомобиля
• colorСтрокаЦвет автомобиля
• markСтрокаМарка автомобиля
• modelСтрокаМодель автомобиля
• short_nameСтрокаКраткое название автомобиля
• production_yearЦелоеГод выпуска автомобиля
• is_lockedtrue или falseАвтомобиль заблокирован
• order_paramsМассивМассив параметров автомобиля
• •ЦелоеИД параметра
• attribute_values Массив Массив значений атрибутов
• • id Целое Идентификатор атрибута
• • bool_value true или false Значение, если тип атрибута «Логический»
• • num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• • str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:

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]
      "attribute_values": [
            {
                  "id": 1,
                  "bool_value": true
            },
            {
                  "id": 2,
                  "num_value": 1
            }
        ] }, { "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]       "attribute_values": [
            {
                  "id": 3,
                  "num_value": 10
            },
            {
                  "id": 4,
                  "str_value": "строка"
            }
        ] } ] } }

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

Метод: POST

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

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

ПараметрыТип Описание
Обязательные параметры
codeСтрокаПозывной
markСтрокаМарка
colorСтрокаЦвет
gos_numberСтрокаГосударственный номер
Необязательные параметры
modelСтрокаМодель
short_nameСтрокаКраткое название
production_yearЦелоеГод выпуска
car_classСтрокаКласс автомобиля (A, B, C, ...)
vinСтрокаVIN
body_numberСтрокаНомер кузова
engine_numberСтрокаНомер двигателя
permitСтрокаРазрешение на перевозку
commentСтрокаОписание
order_paramsМассивМассив параметров автомобиля. Устарело. Рекомендуется использовать параметр attribute_values.
ЦелоеИД параметра
car_photoBase64Фотография автомобиля
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

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

КодОписание
100Автомобиль с ИД=ID имеет такой же позывной=CODE
0Параметр с ИД=ID не найден или не может быть привязан к автомобилю

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

ПараметрТипОписание
car_idЦелоеИД созданного автомобиля

Пример:

Запрос:
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":[1,2,3,4],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ] } Ответ: { "code":0, "descr":"OK", "data":{ "car_id":140 } }

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

Метод: POST

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

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

ПараметрыТипОписание
Обязательные параметры
car_idЦелоеИД автомобиля
Необязательные параметры
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_lockedtrue или falseАвтомобиль заблокирован
lock_descriptionСтрокаПричина блокировки
car_photoBase64Фотография автомобиля

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

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

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

Пример:

Запрос:
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":{}
}

25. Запрос координат экипажей

Метод: GET

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

Параметры:

ПараметрыТипОписание
Необязательные параметры
crew_idЦелоеИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.

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

КодОписание
100Координаты не найдены

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

ПараметрТипОписание
crews_coordsМассивСписок координат экипажей
• crew_idЦелоеИД экипажа
• crew_codeСтрокаПозывной экипажа
• coords_timeГГГГММДДччммссВремя получения координат
• latДробноеДолгота
• lonДробноеШирота
• state_kindСтрокаТип состояния экипажа. Может принимать значения:

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

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

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

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

Пример:

Запрос:
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"
      }
    ]
  }
}

26. Запрос адресов, содержащих нужную строку

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
get_streetstrue или falseИскать улицы
get_pointstrue или falseИскать пункты
get_housestrue или falseИскать дома. Не может быть равно true, если get_streets = true или get_points = true.
streetСтрокаЧасть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
Необязательные параметры
houseСтрокаЧасть номера дома. Нужно только если get_houses = true.
cityСтрокаГород, в котором искать адреса
max_addresses_countЦелоеМаксимальное количество адресов в ответе
search_in_tmtrue или falseИскать адреса в ТМ (по умолчанию = true)
search_in_yandextrue или falseИскать адреса в Яндекс (по умолчанию = false)
search_in_googletrue или falseИскать адреса в Google (по умолчанию = false)
search_in_2gistrue или falseИскать адреса в 2GIS (по умолчанию = false)
search_in_tmgeoservicetrue или falseИскать адреса в TMGeoService (по умолчанию = false)

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

КодОписание
100Подходящие адреса не найдены
101Не указано место для поиска адресов

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

ПараметрТипОписание
addressesМассивСписок подходящих адресов
• address_sourceСтрокаИсточник адреса. Может принимать значения:

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

•"yandex" — Яндекс

•"google" — Google

•"2gis" — 2GIS

•"tmgeoservice" — TMGeoService

• streetСтрокаНазвание улицы или пункта
• houseСтрокаНомер дома
• kindСтрокаТип адреса. Может принимать значения:

• "street" — улица

• "house" — дом

• "point" — пункт

• commentСтрокаКомментарий
• coordsМассивКоординаты дома или пункта
• • latДробноеШирота
• • lonДробноеДолгота

Пример:

Запрос:

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":""
      }
    ]
  }
}

27. Запрос адресов, содержащих нужную строку 2

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
get_streetstrue или falseИскать улицы
get_pointstrue или falseИскать пункты
get_housestrue или falseИскать дома
addressСтрокаСтрока для поиска адреса
Необязательные параметры
cityСтрокаГорода, разделенные запятой, в которых искать адреса
max_addresses_countЦелоеМаксимальное количество адресов в ответе
search_in_tmtrue или falseИскать адреса в ТМ (по умолчанию = true)
search_in_yandextrue или falseИскать адреса в Яндекс (по умолчанию = false)
search_in_googletrue или falseИскать адреса в Google (по умолчанию = false)
search_in_2gistrue или falseИскать адреса в 2GIS (по умолчанию = false)
search_in_tmgeoservicetrue или falseИскать адреса в TMGeoService (по умолчанию = false)

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

КодОписание
100Подходящие адреса не найдены
101Не указано место для поиска адресов

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

ПараметрТипОписание
addressesМассивСписок подходящих адресов
• address_sourceСтрокаИсточник адреса. Может принимать значения:

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

•"yandex" — Яндекс

•"google" — Google

•"2gis" — 2GIS

•"tmgeoservice" — TMGeoService

• cityСтрокаНазвание города
• pointСтрокаНазвание пункта
• streetСтрокаНазвание улицы
• houseСтрокаНомер дома
• kindСтрокаТип адреса. Может принимать значения:

• "street" — улица

• "house" — дом

• "point" — пункт

• commentСтрокаКомментарий
• coordsМассивКоординаты дома или пункта
• • latДробноеШирота
• • lonДробноеДолгота

Пример:

Запрос:

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 
        }
      }
    ]
  }
}


28. Анализ маршрута

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
sourceСтрокаАдрес подачи
destСтрокаАдрес назначения
Необязательные параметры
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ДробноеКилометраж до адреса подачи, если адрес подачи за городом

Пример:

Запрос:

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
  }
}

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

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
get_full_route_coordstrue или falseВозвращать координаты точек полного маршрута.
addressesМассивМассив адресов. Первый элемент — адрес подачи, последний — адрес назначения, между ними — остановки.
• addressСтрокаАдрес подачи
• latДробноеШирота адреса
• lonДробноеДолгота адреса

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

КодОписание
100Маршрут не распознан

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

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

Пример:

Запрос:

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
       },
       ...
    ]
  }
}

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

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
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МассивИнформация по остановкам заказа
• addressСтрокаАдрес остановки
• latДробноеШирота адреса остановки
• 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МассивКоординаты экипажа
• latДробноеШирота
• lonДробноеДолгота
order_paramsМассивМассив параметров заказа экипажа
ЦелоеИД параметра заказа
creation_wayСтрокаСпособ создания заказа. Может принимать значения:

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

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

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

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

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

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

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

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

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

• "unknown" — неизвестный

is_priortrue или falseПредварительный заказ
is_really_priortrue или falseПредварительный заказ на вкладке "Предварительные"
emailСтрокаEmail для уведомлений
prior_to_current_before_minutesЦелоеВремя перехода из предварительного в текущие заказы, мин
flight_numberСтрокаНомер рейса
order_bundle_id Целое ИД заявки спец. техники
sum Дробное Сумма без скидки
total_sum Дробное Итоговая сумма заказа
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос: 

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
      }
    ],
    "customer":"Слепаков",
    "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",
    "sum":50.5,
    "total_sum":80,
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ]
  }
}

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

Метод: POST

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
phoneСтрока, <= 30 символовНомер телефона
messageСтрокаТекст СМС

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

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

Пример:

Запрос:

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":{}
}

32. Проверка авторизации

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
loginСтрока, <= 60 символовЛогин
passwordСтрока, <= 60 символовПароль

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

КодОписание
100Не найден клиент с логином LOGIN и/или неверный пароль

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

ПараметрТипОписание
client_idЦелоеИД клиента

Пример:

Запрос:

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

Signature: <...>

Ответ:

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

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

Метод: POST

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

Параметры:

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

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

• "female" - женский

emailСтрокаE-mail
use_email_informingtrue или falseИспользовать E-mail для отправки уведомлений по заказу
comment Строка Комментарий

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

КодОписание
100Клиент с ИД=ID имеет такой же номер телефона=PHONE
101Клиент с логином=LOGIN уже существует
102Группа клиента с ИД=CLIENT_GROUP не найдена
103Клиент указанный в качестве родителя с ИД=PARENT_ID не найден

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

ПараметрТипОписание
client_idЦелоеИД созданного клиента

Пример:

Запрос:

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&parent_id=10&email=mail%40ya.ru&use_email_informing=true
Ответ:

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

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

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
client_idЦелоеИД клиента

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

КодОписание
100Не найден клиент ИД=CLIENT_ID

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

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

• "" - не указан

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

• "female" - женский

birthdayДД.ММ.ГГГГДата рождения
phonesМассивМассив телефонов клиента
• phoneСтрокаНомер телефона клиента
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_lockedtrue или falseКлиент заблокирован
lock_descriptionСтрокаПричина блокировки
use_cashlesstrue или falseПризнак использования безналичного расчета по умолчанию
remain_prizeЦелоеСколько заказов осталось до призового
emailСтрокаE-mail
use_email_informingtrue или falseИспользовать E-mail для отправки уведомлений по заказу
default_crew_groupЦелоеГруппа экипажей по умолчанию
employeesМассивМассив сотрудников клиента
• client_idЦелоеИД клиента-сотрудника
• parent_idЦелоеИД родителя клиента-сотрудника
• nameСтрокаФИО клиента-сотрудника
• numberСтрокаНомер договора клиента-сотрудника
• addressСтрокаДомашний адрес клиента-сотрудника
• genderСтрокаПол клиента-сотрудника. Может принимать значения:

• "" - не указан

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

• "female" - женский

• birthdayДД.ММ.ГГГГДата рождения клиента-сотрудника
• phonesМассивМассив телефонов клиента-сотрудника
•• phoneСтрокаНомер телефона клиента-сотрудника
• 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_lockedtrue или falseКлиент-сотрудник заблокирован
• lock_descriptionСтрокаПричина блокировка клиента-сотрудника
• use_cashlesstrue или falseПризнак использования безналичного расчета по умолчанию для клиента-сотрудника
• remain_prizeЦелоеСколько заказов осталось до призового
• emailСтрокаE-mail клиента-сотрудника
• use_email_informingtrue или falseИспользовать E-mail для отправки уведомлений по заказу
• default_crew_groupЦелоеГруппа экипажей по умолчанию

Пример:

Запрос:

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

Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":
  {
    "client_id":20,
    "parent_id":0,
    "name":"Юр. лицо1",
    "number":"111",
    "address":"Адрес Юр. лицо1",
    "gender":"",
    "birthday":"22.01.2016",
    "phones":
    [
      "105",
      "123456789",
      "100"
    ],
    "balance":10,
    "bonus_balance":333,
    "login":"111",
    "password":"111",
    "client_group_id":1,
    "tariff_id":39,
    "prize_tariff_id":0,
    "tariff_shift_id":0,
    "discount_id":2,
    "prize_discount_id":0,
    "min_balance":0,
    "min_balance_for_use_cashless":null,
    "min_bonus_balance_for_use_bonus":null,
    "is_locked":false,
    "lock_description":"",
    "use_cashless":true,
    "remain_prize":0,
    "email":"Юр. лицо1@ss.ru",
    "use_email_informing":true,
    "default_crew_group":6,
    "employees":
    [
      {
        "client_id":323,
        "parent_id":20,
        "name":"Сотрудник1",
        "number":"111",
        "address":"Адрес Сотрудник1",
        "gender":"",
        "birthday":null,
        "phones":
        [
          "11221122112211"
        ],
        "balance":0,
        "bonus_balance":0,
        "login":"",
        "password":"",
        "client_group_id":1,
        "tariff_id":17,
        "prize_tariff_id":0,
        "tariff_shift_id":0,
        "discount_id":2,
        "prize_discount_id":0,
        "min_balance":0,
        "min_balance_for_use_cashless":null,
        "min_bonus_balance_for_use_bonus":null,
        "is_locked":false,
        "lock_description":"",
        "use_cashless":true,
        "remain_prize":0,
        "email":"Сотрудник1@ss.ru",
        "use_email_informing":true,
        "default_crew_group":6
      },
      {
        "client_id":322,
        "parent_id":323,
        "name":"Сотрудник2",
        "number":"111",
        "address":"Адрес Сотрудник1",
        "gender":"",
        "birthday":null,
        "phones":
        [],
        "balance":0,
        "bonus_balance":0,
        "login":"",
        "password":"",
        "client_group_id":1,
        "tariff_id":17,
        "prize_tariff_id":0,
        "tariff_shift_id":0,
        "discount_id":2,
        "prize_discount_id":0,
        "min_balance":0,
        "min_balance_for_use_cashless":null,
        "min_bonus_balance_for_use_bonus":null,
        "is_locked":false,
        "lock_description":"",
        "use_cashless":true,
        "remain_prize":1,
        "email":"Сотрудник2@ss.ru",
        "use_email_informing":true,
        "default_crew_group":6
      },
      {
        "client_id":321,
        "parent_id":322,
        "name":"Сотрудник3",
        "number":"111",
        "address":"Адрес Сотрудник1",
        "gender":"",
        "birthday":null,
        "phones":
        [],
        "balance":0,
        "bonus_balance":0,
        "login":"",
        "password":"",
        "client_group_id":1,
        "tariff_id":17,
        "prize_tariff_id":0,
        "tariff_shift_id":0,
        "discount_id":2,
        "prize_discount_id":0,
        "min_balance":0,
        "min_balance_for_use_cashless":null,
        "min_bonus_balance_for_use_bonus":null,
        "is_locked":false,
        "lock_description":"",
        "use_cashless":true,
        "remain_prize":1,
        "email":"Сотрудник3@ss.ru",
        "use_email_informing":true,
        "default_crew_group":4
      },
      {
        "client_id":326,
        "parent_id":20,
        "name":"aaaaaaaasssssssssssssss",
        "number":"111",
        "address":"Адрес Юр. лицо1",
        "gender":"",
        "birthday":null,
        "phones":
        [],
        "balance":0,
        "bonus_balance":0,
        "login":"",
        "password":"",
        "client_group_id":1,
        "tariff_id":39,
        "prize_tariff_id":0,
        "tariff_shift_id":0,
        "discount_id":2,
        "prize_discount_id":0,
        "min_balance":0,
        "min_balance_for_use_cashless":null,
        "min_bonus_balance_for_use_bonus":null,
        "is_locked":false,
        "lock_description":"",
        "use_cashless":true,
        "remain_prize":0,
        "email":"",
        "use_email_informing":false,
        "default_crew_group":6
      },
      {
        "client_id":379,
        "parent_id":20,
        "name":"Алексей",
        "number":"000379",
        "address":"Адрес Юр. лицо1",
        "gender":"",
        "birthday":"24.02.2020",
        "phones":
        [],
        "balance":0,
        "bonus_balance":0,
        "login":"aaaabbbbbb",
        "password":"111",
        "client_group_id":1,
        "tariff_id":39,
        "prize_tariff_id":0,
        "tariff_shift_id":0,
        "discount_id":2,
        "prize_discount_id":0,
        "min_balance":0,
        "min_balance_for_use_cashless":null,
        "min_bonus_balance_for_use_bonus":null,
        "is_locked":false,
        "lock_description":"",
        "use_cashless":true,
        "remain_prize":1,
        "email":"",
        "use_email_informing":false,
        "default_crew_group":6
      }
    ]
  }
}

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

Метод: POST

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

Параметры:

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

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

• "female" - женский

parent_idЦелоеИД клиента-родителя
client_group_idЦелоеИД группы клиента
emailСтрокаE-mail
use_email_informingtrue или falseИспользовать E-mail для отправки уведомлений по заказу
comment Строка Комментарий

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

КодОписание
100Клиент с номером телефона=PHONE уже существует
101Клиент с ИД=ID имеет такой же номер телефона=PHONE
102Клиент с логином=LOGIN уже существует
103Группа клиента с ИД=CLIENT_GROUP_ID не найдена
104Клиент указанный в качестве родителя с ИД=PARENT_ID не найден

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

Пример:

Запрос:

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=male&
address=ADDRESS&parent_id=10&client_group_id=3&email=mail%40ya.ru&use_email_informing=true

Ответ:

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

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

Метод: GET

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

Параметры:

ПараметрыТипОписание
Необязательные параметры
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_priortrue или falseПредварительный заказ
is_really_priortrue или falseПредварительный заказ на вкладке "Предварительные"
emailСтрокаEmail для уведомлений
prior_to_current_before_minutesЦелоеВремя перехода из предварительного в текущие заказы, мин
flight_numberСтрокаНомер рейса

Пример:

Запрос:
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"

      }
    ]
  }
}

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

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
start_timeГГГГММДДччммссНачало периода
finish_timeГГГГММДДччммссКонец периода
Примечание: должен присутствовать хотя бы один параметр из client_id, phone, crew_id, driver_id.
Необязательные параметры
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МассивМассив адресов остановок
• addressСтрокаАдрес остановки
• latДробноеШирота адреса остановки
• 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СтрокаНомер рейса

Пример:

Запрос:
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"

      }
    ]
  }
}

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

Метод: POST

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
client_idЦелоеИД клиента
sumДробноеСумма
oper_typeЦелоеТип операции:

• "receipt" - приход

• "expense" - расход

Необязательные параметры
oper_timeГГГГММДДччммссВремя создания операции (если не указано, текущее)
commentСтрокаКомментарий
pay_typeЦелоеТип оплаты:

• "cash" - наличный

• "nocash" - безналичный

bonus_opertrue или falseОперация по бонусному счёту

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

КодОписание
100Не найден клиент ИД=CLIENT_ID

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

ПараметрТипОписание
oper_idЦелоеИД операции

Пример:

Запрос:

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

  }
}

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

Метод: GET

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

Параметры:

ПараметрыТипОписание
Обязательные параметры
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ЦелоеИД отмененной операции (для операции отмены)

Пример:

Запрос:

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
      }
    ]
  }
}

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

Метод: POST

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

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

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

• receipt - приход

• expense - расход

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

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

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

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

ПараметрТипОписание
oper_idЦелоеИД операции


Пример:

Запрос:

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
   }
}

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

Метод: GET

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

Параметры:

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


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

КодОписание
100Не найден водитель ИД=DRIVER_ID


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

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

•"receipt" - приход

•"expense" - расход

nameСтрокаНаименование
commentСтрокаКомментарий
account_kindЦелоеИД типа счета
cancelled_by_oper_idЦелоеИД операции отмены (для отмененной операции)
cancelled_oper_idЦелоеИД отмененной операции (для операции отмены)

Пример:

Запрос:

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":111,
        "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
      }
    ]
  }
}

42. Назначение динамического приоритета водителю

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
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ЦелоеИД созданного динамического приоритета

Пример:

Запрос:
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
   }
}

43. Задание координат экипажей

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
crew_coordsМассивМассив координат экипажей
• crew_idЦелоеИД экипажа
• gps_idЦелоеGPS идентификатор (если не задан ИД экипажа)
• latДробноеШирота
• lonДробноеДолгота
Необязательные параметры
speedДробноеСкорость


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

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


Пример:

Запрос:

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":{}
}

44. Изменение информации по заказу

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
order_idЦелоеИД заказа
Необязательные параметры
phoneСтрока, <= 30 символовНомер телефона
source_timeГГГГММДДччммссВремя подачи
is_priortrue или falseПредварительный заказ
customerСтрокаЗаказчик
passengerСтрокаПассажир
commentСтрокаКомментарий
crew_group_idЦелоеИД группы экипажей
client_idЦелоеИД клиента
tariff_idЦелоеИД тариф
addressesМассивМассив адресов. Первый элемент — адрес

подачи(обязательно), последний — адрес назначения, между ними — остановки.

• addressСтрокаАдрес подачи
• latДробноеШирота адреса
• lonДробноеДолгота адреса
order_paramsМассивМассив параметров заказа. Устарело. Рекомендуется использовать параметр attribute_values
ЦелоеИД параметра заказа
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»
cost_orderДробноеСумма заказа
state_idЦелоеИД состояния заказа
discount_idЦелоеИД скидки
auto_select_discounttrue или falseАвтоматически подобрать скидку, если не указана явно
auto_select_tarifftrue или falseАвтоматически подобрать тариф, если не указан явно
auto_recalc_costtrue или falseАвтоматически пересчитать сумму заказа
auto_update_order_paramstrue или falseАвтоматически обновить параметры заказа по клиенту и группе клиента
emailСтрокаEmail для уведомлений
prior_to_current_before_minutesЦелоеВремя перехода из предварительного в текущие заказы, мин
flight_numberСтрокаНомер рейса
need_custom_validate true или false Использовать специальную проверку перед изменением заказа

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

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

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

Пример:

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",
    "need_custom_validate":false,
    "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
} Ответ: { "code":0, "descr":"OK", "data":{} }

45. Анализ телефона

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
phoneСтрокаНомер телефона
Необязательные параметры
search_in_drivers_mobiletrue или falseИскать среди телефонов водителей
search_in_clientstrue или falseИскать среди телефонов клиентов
search_in_phonestrue или falseИскать в справочнике телефонов


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

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

КодОписание
100Телефон не найден

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

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


Пример:

Запрос:

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
   }
}

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

Метод: POST

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

Параметры:

ПараметрТипОписание
Обязательные параметры
textСтрокаТекст сообщения
Необязательные параметры
headerСтрокаЗаголовок сообщения
timeoutЦелоеСкрывать сообщение через, сек. (0 — не скрывать)
usersМассивМассив пользователей (если не указаны — отправлять всем)
ЦелоеИД пользователя


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

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


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

Пример:

Запрос:
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":{}
}

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

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
start_timeГГГГММДДччммссНачало периода
finish_timeГГГГММДДччммссКонец периода
Необязательные параметры
driver_idЦелоеИД водителя
new_shiftstrue или falseВключить в ответ новые смены (по умолчанию true)
in_work_shiftstrue или falseВключить в ответ смены в работе (по умолчанию true)
finished_shiftstrue или falseВключить в ответ выполненные смены (по умолчанию true)
failed_shiftstrue или falseВключить в ответ неуспешно завершенные смены (по умолчанию true)
returned_shiftstrue или falseВключить в ответ возвращенные смены (по умолчанию false)

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

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

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

Пример:

Запрос:

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
      }
    ]
  }
}

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

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
start_timeГГГГММДДччммссНачало периода (если включаем в ответ срочные смены)
finish_timeГГГГММДДччммссКонец периода (если включаем в ответ срочные смены)
Необязательные параметры
limited_shiftstrue или falseВключить в ответ срочные смены (по умолчанию true)
unlimited_shiftstrue или falseВключить в ответ бессрочные смены (по умолчанию true)

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

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

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

Пример:

Запрос:

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
      }
    ]
  }
}

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

Метод: POST

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

Параметры:

ПараметрТипОписание
Обязательные параметры
crew_idЦелоеИД экипажа
plan_shift_idЦелоеИД запланированной смены

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

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


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

Пример:

Запрос:

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":{}
}

50. Сохранение отзыва клиента

Метод: POST

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

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

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

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

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

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

Пример:

Запрос:
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":{}
}

51. Поиск экипажей по координатам

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
latДробноеШирота точки центра поиска
lonДробноеДолгота точки центра поиска
radiusДробноеРадиус поиска, км или мили
Необязательные параметры
crews_without_coordstrue или falseИскать экипажи без реальных координат по координатам стоянок
crews_release_inЦелоеДопустимое время до освобождения в зоне поиска, если надо возвращать занятые экипажи (если 0, то искать только свободные экипажи), мин
crew_group_idЦелоеИД группы экипажей, заказы из которой должны видеть подходящие экипажи
attributesСтрокаСписок ИД атрибутов заказа, которыми должны обладать подходящие экипажи (через точку с запятой, пример: «1;2;3»). Устарело. Рекомендуется использовать параметр attribute_values
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

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

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

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

Пример:

Запрос:
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
  }
}

52. Подбор тарифа для заказа

Метод: POST

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

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

ПараметрТипОписание
Необязательные параметры
client_idЦелоеИД клиента
crew_group_idЦелоеИД группы экипажей
source_timeГГГГММДДччммссВремя подачи
is_prizetrue или falseПризовой заказ
addressesМассивМассив координат адресов. Первый элемент — адрес подачи,

последний — адрес назначения, между ними — остановки. Заполняется если определены координаты всех адресов.

• lonДробноеДолгота адреса
• latДробноеШирота адреса

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

КодОписание
100Клиент не найден

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

ПараметрТипОписание
tariff_idЦелоеТариф

Пример:

Запрос:
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
 }
}

53. Импорт марок автомобилей в БД

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
marksМассив строкИмпортируемые марки автомобилей

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

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

Пример:

Запрос: 

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":{}
 }

54. Импорт цветов автомобилей в БД

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
colorsМассив строкИмпортируемые цвета автомобилей

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

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

Пример:

Запрос: 

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

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

 Ответ:

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

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

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
client_employee_idЦелоеИД сотрудника клиента

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

КодОписание
100Не найден сотрудник клиента ИД=CLIENT_EMPLOYEE_ID

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

ПараметрТипОписание
client_employee_idЦелоеИД сотрудника
client_idЦелоеИД клиента
nameСтрокаФИО сотрудника
is_deletedtrue или falseПризнак удаленного сотрудника
emailСтрокаE-mail
use_email_informingtrue или falseИспользовать E-mail для отправки уведомлений по заказу
default_crew_groupЦелоеГруппа экипажей по умолчанию
phonesМассивМассив телефонов сотрудника клиента
• phoneСтрокаНомер телефона сотрудника

Пример:

Запрос:

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"
      }
    ]
  }
 }

56. Создание сотрудника клиента

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
client_idЦелоеИД клиента
nameСтрокаФИО сотрудника
Необязательные параметры
emailСтрокаE-mail
use_email_informingtrue или falseИспользовать E-mail для отправки уведомлений по заказу
phonesМассивМассив телефонов сотрудника
• phoneСтрокаНомер телефона

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

КодОписание
100Клиент с ИД=CLIENT_ID не найден
101Клиент с ИД=ID имеет такой же номер телефона=PHONE

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

Пример:

Запрос: 

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":{}
 }

57. Обновление информации о сотруднике клиента

Метод: POST

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

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

ПараметрТипОписание
Обязательные параметры
client_employee_idЦелоеИД редактируемого сотрудника клиента
Необязательные параметры
nameСтрокаФИО сотрудника
is_deletedtrue или falseПризнак удаленного сотрудника
emailСтрокаE-mail
use_email_informingtrue или falseИспользовать E-mail для отправки уведомлений по заказу
phonesМассивМассив телефонов сотрудника
• phoneСтрокаНомер телефона

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


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

КодОписание
100Сотрудник с ИД=CLIENT_EMPLOYEE_ID не найден
101Клиент с ИД=ID имеет такой же номер телефона=PHONE
102Запрещено редактирование телефонов удаленного сотрудника

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

Пример:

Запрос: 

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":{}
 }

58. Запрос списка состояний заказа

Метод: GET

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

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

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

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

ПараметрТипОписание
order_paramsМассивСписок параметров заказа
• idЦелоеИД параметра
• nameСтрокаНазвание параметра
• state_typeСтрокаТип состояния. Может принимать значения:

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

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

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

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

Пример:

Запрос:


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"
      },
     ...
                ]
        }
}

59. Запрос списка состояний экипажа

Метод: GET

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

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

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

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

ПараметрТипОписание
order_paramsМассивСписок параметров заказа
• idЦелоеИД параметра
• nameСтрокаНазвание параметра
• state_typeСтрокаТип состояния. Может принимать значения:

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

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

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

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

Пример:

Запрос:
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"
         },
         ...
               ]
        }
}


60. Запрос информации по клиентам

Метод: GET

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

Параметры:

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

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

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

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

Пример:

Запрос:
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"
      }
    ]
  }
}

61. Запрос информации о заявке спец. техники

Метод: GET

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

Параметры:

Параметр Тип Описание
Обязательные параметры
order_bundle_id Целое ИД заявки спец. техники

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

Код Описание
100 Заявка спец. техники не найдена

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

Параметр Тип Описание
order_bundle_id Целое ИД заявки спец. техники
start_time ГГГГММДДччммсс Время начала
addresses Массив Массив адресов заявки
• address Строка Адрес подачи
• lat Дробное Широта
• lon Дробное Долгота
client_id Целое ИД клиента
phone Строка Телефон
orders Массив Массив заказов заявки спец. техники
• order_id Целое ИД заказа
duration Целое Длительность заявки спец. техники, в часах

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_order_bundle_info?order_bundle_id=1 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data": {
    "order_bundle_id":1,
    "start_time":"20190101100000",
    "addresses": [
      {
        "address":"АДРЕС",
        "lat":11.111111,
        "lon":22.222222
      }
    ],
    "client_id":1,
    "phone":"123",
    "orders": [
      {
        "order_id":111
      },
      {
        "order_id":222
      }
    ],
    "duration":1
  }
}

62. Удаление заявки спец. техники

Метод: POST

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

Параметры:

Параметр Тип Описание
Обязательные параметры
order_bundle_id Целое ИД заявки спец. техники

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

Код Описание
100 Заявка спец. техники не найдена

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

Пример:

Запрос:
POST https://ip:port/common_api/1.0/delete_order_bundle HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

order_bundle_id=1

Ответ:

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

63. Запрос глобальных атрибутов

Метод: GET

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

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

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

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

Параметр Тип Описание
global_attributes Массив Массив значений глобальных атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
- «Число» (непосредственное значение)
- «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
- «Перечисляемый» (значение выбранного элемента перечисления)
• str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_global_attributes

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "global_attributes":[
      {
        "id":123,
        "bool_value":true
      },
      {
        "id":124,
        "num_value":314
      },
      {
        "id":125,
        "str_value": "AAA"
      }
    ]
  }
}


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

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

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

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

Пример:

GET https://ip:port/tm_tapi/1.0/get_info_by_phone 

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

Пример:

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

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

Пример:

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

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

Пример:

Запрос:
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

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

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

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

Существуют общие для всех запросов коды результатов:

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

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

1. Запрос информации по номеру телефона

Метод: GET

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

Параметры:

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

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

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

ПараметрТипОписание
PHONE_TYPEЦелоеТип телефона звонящего:

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

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

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

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

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

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

0 - неизвестный номер.

PHONE_TO_DIALСтрока, <= 16 символовНомер телефона для отзвона по заказу
CREW_IDЦелоеИД экипажа
IS_PRIOR0 или 1 (false или true)Признак предварительного заказа
IS_PRIZE0 или 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_LOCKED0 или 1 (false или true)Признак блокировки клиента

Пример:

Запрос:
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>

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

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
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_PRIOR0 или 1 (false или true)Признак предварительного заказа
IS_PRIZE0 или 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СтрокаТелефон службы-исполнителя для заказов, отданных в ЦОЗ

Пример:

Запрос:

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>

3. Смена состояния заказа

Метод: POST

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

Параметры:

ПараметрТипОписание
Обязательные параметры
ORDER_IDЦелоеИД заказа
NEED_STATEЦелоеНовое состояние заказа
signatureСтрокаПоле для проверки секретного ключа

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

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

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

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

Пример:

Запрос:

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>

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

Метод: POST

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

Параметры:

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

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

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

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

Пример:

Запрос:

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>

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

Метод: POST

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

Параметры:

ПараметрТипОписание
Обязательные параметры
PHONEСтрока, <= 16 символовНомер телефона
ORDER_STATE_IDЦелоеИД состояния заказа
signatureСтрокаПоле для проверки секретного ключа
Необязательные параметры
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_COUNTRY0 или 1 (false или true)Признак междугороднего заказа
IS_PRIOR0 или 1 (false или true)Признак предварительного заказа
PRIZE0 или 1 (false или true)Признак призового заказа
NOTEСтрока, <=80 символовПримечание
BONUSPOINTДробноеБонусные баллы, начисленные водителю за заказ
DISTANCEДробноеКилометраж по городу (в километрах)
HOURLY_LENЦелоеДлительность исполнения почасового заказа (в минутах)
HOURLY_STARTГГГГММДДччммссДата начала отсчета при почасовом заказе
HOURLY_PAY0 или 1 (false или true)Признак почасового заказа
PHONE_TO_DIALСтрока, <=16 символовНомер телефона для отзвона по заказу
FROMBORDER0 или 1 (false или true)Признак заказа "с бордюра"
WAITING_STARTГГГГММДДччммссДата начала ожидания заказчика водителем
WAITING_LENGTHЦелоеОбщая длина периода ожидания заказчика водителем (в минутах)
BACKFREEЦелоеПризнак применения скидки в 50% на обратный путь
INPUTTIMEГГГГММДДччммссДата принятия заказа (от даты создания заказа отличается тем, что может быть задана пользователем)
MONEY_RECEIVE0 или 1 (false или true)Подтверждение принятия денег наличными
NOTIFY_BEFOREЦелоеПериод времени, за который пользователь оповещается о наступлении даты подачи
WANTCREWIDЦелоеИД желаемого экипажа
DISTANCE_COUNTRYДробноеКилометраж за границами города (в километрах)
DISTANCE_CHECK0 или 1 (false или true)Разрешение ручного ввода километража
CLIENTIDЦелоеИД постоянного клиента
INFRA_STATEЦелоеСостояние заявки в исходящей компании колцентра INFRA (1 - заявка передана в исходящую компанию, 2 - отзвон успешно произведен, 3 - занято, 4 - не берут трубку)
INFRA_ORDERЦелоеINFRA-заказ (спец. поле для работы с колцентром компании Инфрател)

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

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

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

Пример:

Запрос:

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>

6. Поиск улицы в базе

Метод: POST

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

Параметры:

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

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

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

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


Пример:

Запрос:
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>

7. Смена состояния заказа по результату автодозвона

Метод: POST

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

Параметры:

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

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

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

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

Пример:

Запрос:
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>

8. Соединить клиента и водителя

Метод: POST

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

Параметры:

ПараметрТипОписание
Обязательные параметры
order_idЦелоеИД заказа
signatureСтрокаПоле для проверки секретного ключа

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

КодОписание
100Не найден заказ с таким ИД
103В заказе нет водителя
104У водителя не определен телефон

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

Пример:

Запрос:

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>

9. Количество свободных экипажей на линии

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
signatureСтрокаПоле для проверки секретного ключа
Необязательные параметры
crew_group_idЦелоеИД группы экипажа предполагаемого заказа

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

ПараметрТипОписание
COUNTЦелоеКоличество свободных экипажей на линии

Пример:

Запрос:
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>

10. Запрос пользователя по логину софтфона

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
signatureСтрокаПоле для проверки секретного ключа
loginСтрокаЛогин SIP-аккаунта

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

ПараметрТипОписание
IDЦелоеИД пользователя, который использует указанный логин SIP-аккаунта софтфона в данный момент
NAMEСтрокаИмя пользователя, который использует указанный логин SIP-аккаунта софтфона в данный момент

Пример:

Запрос:
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>

11. Установить режим «Перерыв» для линий софтфона

Метод: POST

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

Параметры:

ПараметрТипОписание
Обязательные параметры
dndСтрока0 или 1
user_loginСтрокаЛогин пользователя ТМ
linesСтрокаСписок линий, разделенных символом «|»
signatureСтрокаПоле для проверки секретного ключа

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

КодОписание
100Пользователь с таким логином или линиями не найден.

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

Пример:

Запрос:

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>

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

Метод: GET

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

Параметры:

ПараметрТипОписание
Обязательные параметры
crew_codeСтрокаПозывной экипажа


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

КодОписание
100Водитель не найден

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

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

Пример:

Запрос:

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>

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

Метод: 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

Пример:

Запрос:
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>

Все настройки в разделе "Настройки и руководство"