Описание методов API сервера Такси Онлайн

Метод tt.taxi.driver.FindAddress — Поиск адреса

Поиск подходящего адреса.

Входные данные

ПараметрТипПримечание
*textstringШаблон поиска (улица и номер дома через запятую)
*limitint32Ограничение на кол-во результатов.

Выходные данные

ПараметрТипПримечание
*dataAddressProto[]Результаты

Метод tt.taxi.driver.GetAddress — Получить адрес

Получение адреса по id.

Входные данные

ПараметрТипПримечание
*idint32

Выходные данные

ПараметрТипПримечание
*dataAddressProto

Метод tt.taxi.driver.Login — Вход в систему

Создается сессия для водителя, водитель переводится в состояние онлайн, у водителя обновляется дата последнего события.
Возобновляется процедура распределения заказов.

Входные данные

ПараметрТипПримечание
*loginstringЛогин
*emailstringEmail водителя. Устарело. Используется, если не заполнено поле логин.
*passwordHashstringSHA256 пароля.
*deviceIdstringUdid устройства.
*fcmIdstringFCM instance ID.
*mpVersionint32Версия клиента (необязательное)

Выходные данные

ПараметрТипПримечание
*sidstringИдентификатор сессии.
*accountIdint64Ид водителя.

Метод tt.taxi.driver.Logout — Выход из системы

Запрос завершает сессию.

Входные данные

ПараметрТипПримечание
*emptyint32Неиспользуемая переменная.

Выходные данные

ПараметрТипПримечание
*emptyint32

Метод tt.taxi.driver.OrderAccept — Взять заказ

• Получаем водителя с правом первоочередного выбора для заказа, и время ожидания для других водителей.
• Если это текущий водитель, то время ожидания - 0, и проверять резервирование не нужно.
• Если нужно проверять резервирование, то если какой-то другой водитель уже отправил запрос на взятие заказа, то метод завершается с ошибкой.
• Если время ожидания больше 0, то резервируем заказ за текущим водителем, и отправляем ему в ответ время ожидания. Когда время ожидания истечет, автоматически берем заказ.
• Иначе сразу же берем заказ. Отправляем водителям, которым был доступен этот заказ, оповещение. Отправляем всем водителям службы оповещение об изменении числа доступных заказов на стоянке.

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа.
*arriveTimeint32Время подачи автомобиля (мин)

Выходные данные

ПараметрТипПримечание
*waitSecondsint32Подождите X секунд.
*serviceTariffsClientTariffProto[]Тарифы службы. В случае автоматического переключения тарифов возвращаем 1 тариф с разными сегментами, в случае ручного переключения - 2 тарифа, городской и загородный.
*orderTariffsClientTariffProto[]Тарифы для текущего заказа, если есть.

Метод tt.taxi.driver.OrderDone — Выполнить заказ

Запрос устанавливает окончание поездки
Заказ переводится в состояние "выполнен". Водитель переводится в состояние "готов".

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа, если не указан - заказ с бордюра.
*doneDateint64Дата выполнения заказа (unix time * 1000)
*pricedoubleСтоимость поездки.
*timeint64Время выполнения заказа (мсек)
*distancedoubleРасстояние поездки (метры)
*tariffIdint64Ид клиентского тарифа поездки.
*internalOrderIdstringВнутренний идентификатор заказа (для заказов с бордюра). Должен был уникальным для всей истории работы водителя. Костыль, нужен чтобы МП не присылал несколько одинаковых запросов о выполнении заказа.

Выходные данные

ПараметрТипПримечание
*emptyint32

Метод tt.taxi.driver.OrderAddTime — Дополнительное время

Запрос увеличивает время прибытия автомобиля к месту заказа на указанное количество минут.

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа.
*timeIncint32Добавочное время (мин.)

Выходные данные

ПараметрТипПримечание
*timeint32Итоговое время прибытия (то что было установлено + указанное в запросе)

Метод tt.taxi.driver.OrderAcceptAdvance — Забронировать предзаказ

Запрос ставит предзаказ в резерв водителю.

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа.

Выходные данные

ПараметрТипПримечание
*emptyint32

Метод tt.taxi.driver.OrderWaitForClient — На месте

Запрос устанавливает начало ожидания клиента
Заказ переводится в состояние "ожидание клиента".

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа.

Выходные данные

ПараметрТипПримечание
*emptyint32

Метод tt.taxi.driver.OrderInProgress — Начать поездку

Заказ переводится в состояние "выполняется" (момент начала поездки)

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа.

Выходные данные

ПараметрТипПримечание
*emptyint32

Метод tt.taxi.driver.OrderFail — Отказ (при выполнении)

Заказ снимается, если указан параметр needCancel, иначе переводится в состояние "новый". Водитель переводится в состояние "готов".

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа.
*needCancelboolTrue - снимать заказ в системе после отказа, false - перевести заказ в состояние "новый"
*refusalCausestringПричина отказа (BROKE_CAR - Сломалась машина, CLIENT_REFUSED - Клиент отказался, DANGEROUS_CLIENT - Опасный клиент)

Выходные данные

ПараметрТипПримечание
*emptyint32

Метод tt.taxi.driver.OrderRejectAdvance — Отказаться от брони

Запрос снимает бронь с предзаказа.

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа.

Выходные данные

ПараметрТипПримечание
*emptyint32

Метод tt.taxi.driver.OrderReject — Отклонить предложенный заказ

Запрос отклоняет заказ (пока заказ еще не взят)
Отказ от доступного заказа. Возобновляется процедура распределения заказов.

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа.
*isForcedOrderboolОтказ от автоназначения.

Выходные данные

ПараметрТипПримечание
*emptyint32

Метод tt.taxi.driver.OrderConfirmAdvance — Подтвердить предзаказ

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

Входные данные

ПараметрТипПримечание
*orderIDint64ID заказа.

tt.taxi.driver.ConfirmPreorder — Подтверждение предзаказа (PUSH)

PUSH-запрос для подтверждения предзаказа.

Структура ConfirmPreorderProto
ПараметрТипПримечание
*orderOrderProtoПредзаказ для подтверждения.
*startDateint64Дата начала выполнения заказа (в случае подтверждения)

Метод tt.taxi.driver.GetOrderOfferStatus — Получить доступность заказа

Определить, что должен сделать клиент с данным заказом
Т.к. используем концепцию "тонкого клиента" - то в идеале вся логика клиента должна быть на сервере.

Входные данные

ПараметрТипПримечание
*orderIdint64Ид заказа.

Выходные данные

ПараметрТипПримечание
*statusOrderOfferStatusКоманда на клиент.
*reasonstringСообщение

Описание типов данных

Перечисление OrderOfferStatus
НазваниеЗначениеПримечание
*SHOW_OFFER1Показать форму заказа.
*WAIT_FOR_OFFER2Подождать, пока придет предложение заказа.
*SHOW_CUSTOM_MESSAGE3Показать сообщение.
*SHOW_MESSAGE_WAIT4Показать сообщение "подождите вашей очереди"

Метод tt.taxi.driver.GetDistanceToOrders — Растояние до заказа

Расчитать растояние до заказов.

Входные данные

ПараметрТипПримечание
*orderIdint64ИД заказа.

Выходные данные

ПараметрТипПримечание
*distancedoubleРастояние в метрах.

Метод tt.taxi.driver.GetAllOrders — Список доступных заказов

Получить список всех доступных заказов.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*ordersOrderProto[]Список заказов.
*isOnlineOnlyboolПоказывать заказы только на линии.

Метод tt.taxi.driver.GetOrdersOnParkingPoint — Список заказов на стоянке

Получить список заказов на стоянке, где нет водителей.

Входные данные

ПараметрТипПримечание
*parkingPointIdint64

Выходные данные

ПараметрТипПримечание
*ordersOrderProto[]Список заказов.
*successboolУдалось ли получить список заказов.
*isOnlineOnlyboolПоказывать заказы только на линии.

Метод tt.taxi.driver.GetAdvanceOrders — Список предварительных заказов

Возвращает информацию по предварительным заказам.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*orderInfoOrderInfoProtoИнформация о предварительных заказах.
*advanceOrdersInfoAdvanceOrdersInfoProtoДоп. информация о предварительных заказах.

Метод tt.taxi.driver.GetIsOrderAccept — Статус взятия заказа

Входные данные

ПараметрТипПримечание
*orderIdint64ID заказа.

Выходные данные

ПараметрТипПримечание
*isAcceptboolСтатус взятия заказа.
*serviceTariffsClientTariffProto[]Тарифы службы. В случае автоматического переключения тарифов возвращаем 1 тариф с разными сегментами, в случае ручного переключения - 2 тарифа, городской и загородный.
*orderTariffsClientTariffProto[]Тарифы для текущего заказа, если есть.

Метод tt.core.messages.Send — Отправить сообщение

tt.core.messages.Send
Отправить сообщение одному или нескольким получателям.

Входные данные

ПараметрТипПримечание
*messageMessageDescProtoСообщение

Выходные данные

ПараметрТипПримечание
*idint64

Метод tt.core.messages.GetHistory — Получить историю сообщений

tt.core.messages.GetHistory
Получение истории сообщений.

Входные данные

ПараметрТипПримечание
*contactIDint64ID контакта.
*fromDateint64Дата начиная с которой вернуть историю (UNIX TIMESTAMP сек.)
*toDateint64Дата до которой вернуть историю (UINIX TIMESTAMP сек.)
*limitint32Максимальное число сообщений (не более 100)

Выходные данные

ПараметрТипПримечание
*messagesMessageDescProto[]Список сообщений.

Метод tt.core.messages.GetContacts — Список контактов

tt.core.messages.GetContacts
Получение списка контактов и групп.

Входные данные

ПараметрТипПримечание
*pageint32Номер страницы (начиная с 0)
*itemsPerPageint32Количество элементов на странице.
*filterstringФильтрация контактов по строке.

Выходные данные

ПараметрТипПримечание
*groupsGroupDescProto[]Список групп.
*contactsContactDescProto[]Список контактов.

Метод tt.core.messages.GetContactsByIdList — Список контактов по id

Получение списка контактов по id контактов.

Входные данные

ПараметрТипПримечание
*contactIdsint64[]Список ид контактов.

Выходные данные

ПараметрТипПримечание
*contactsContactDescProto[]Список контактов.

Метод tt.core.messages.GetMessages — Список новых сообщений

tt.core.messages.GetMessages
Получение списка новых сообщений. Это же сообщение приходит в PUSH;

Входные данные

ПараметрТипПримечание
*unusedbool

Выходные данные

ПараметрТипПримечание
*messagesMessageDescProto[]Список сообщений.

Метод tt.core.messages.List — Список сообщений

Данный прото файл используется в следующих функциях:
tt.core.messages.Delete
Удаление сообщения. Можно удалять только свои сообщения, при этом сообщения у получателя/отправителя остаются;

Входные данные

ПараметрТипПримечание
*messagesint64[]Список ID сообщений. Удаляются индивидуальные сообщения.

Выходные данные

ПараметрТипПримечание
*unusedbool

tt.core.messages.SetReaded
Отметить соощение как прочитанное. Эту функцию надо вызывать только тогда когда установлен флаг confirmation. Вызывать только после того как пользователь каким либо образом подтвердил прочтение (например кнопку нажал).

tt.core.messages.SetReceived
Отметить сообщение как полученное. Эту функуию надо вызывать каждый раз при получении нового сообщения.


Метод tt.taxi.driver.AlarmCancel — Отмена тревоги

Отменить тревогу.

Входные данные

ПараметрТипПримечание
*emptyint32Ничего не нужно.

Описание типов данных

Структура AlarmCancelPushProto — Push-уведомление об отмене тревоги
ПараметрТипПримечание
*idint64Ид тревоги.

Метод tt.taxi.driver.AlarmRaise — Поднять тревогу

Поднять тревогу.

Входные данные

ПараметрТипПримечание
*coordsGeoPointProtoТекущие координаты водителя.

Описание типов данных

Структура AlarmProto — Информация о тревоге
ПараметрТипПримечание
*idint64Ид тревоги.
*driverIdint64Ид водителя, поднявшего тревогу.
*driverLastNamestringФамилия водителя, поднявшего тревогу.
*driverFirstNamestringИмя водителя, поднявшего тревогу.
*driverMiddleNamestringОтчество водителя, поднявшего тревогу.
*coordsGeoPointProtoКоординаты водителя.
*streetstringУлица
*houseNumstringНомер дома.
*beginDateint64Дата поднятия тревоги.
*callsignstringПозывной водителя.
*carModelstringМарка машины.
*carColorstringЦвет машины.
*carNumberstringНомер машины.
*endDateint64Дата окончания тревоги.
*isActiveboolАктивна ли тревога.
*relevantToint64Актуальна до.
Структура AlarmRaisePushProto — Уведомление о поднятии тревоги
ПараметрТипПримечание
*dataAlarmProtoИнформация о тревоге.

Метод tt.taxi.driver.RespondToPhoto — Ответ на фото

Утверждение или отказ в выходе на смену водителю по фото автомобиля.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.
*approvedboolУтверждено или отказ.
*messagestringСообщение для водителя.

Описание типов данных

Структура RespondToPhotoPushProto — Push-уведомление об утверждении или отказе в выходе на смену
ПараметрТипПримечание
*approvedboolУтверждено или отказ.
*messagestringСообщение для водителя.

Метод tt.taxi.driver.UpdateProfile — Изменить профиль водителя

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

Входные данные

ПараметрТипПримечание
*phonestringТелефон
*emailstringЭл. почта.

Метод tt.taxi.driver.SetState — Изменить состояние

Запрос изменяет состояние водителя (в том числе выход на смену, уход со смены)

Входные данные

ПараметрТипПримечание
*stateDriverInfoProto.StateНовое состояние.

Выходные данные

ПараметрТипПримечание
*stateDriverInfoProto.StateТекущее(установленное) состояние.

Метод tt.taxi.driver.IsPhotoRequired — Необходимость проверки фото

Возвращает необходимость проверки фото автомобиля оператором для выхода на смену.

Входные данные

ПараметрТипПримечание
*emptyint32Параметров нет.

Выходные данные

ПараметрТипПримечание
*isRequiredboolНеобходимость проверки фото.

Метод tt.taxi.driver.AdvancePayment — Обещанный платеж

Запрос выполняет обещанный платеж.

Входные данные

ПараметрТипПримечание
*emptyint32

Выходные данные

ПараметрТипПримечание
*successboolУспех платежа.
*allowAdvancePaymentboolДоступность обещанного платежа в будущем.
*messageTextstringТекст сообщения для пользователя.

Метод tt.taxi.driver.SetLastCoords — Отправить текущие координаты

Запрос устанавливает последние координаты (gps) водителя.

Входные данные

ПараметрТипПримечание
*coordsGeoPointProto
*providerstringИсточник
*accuracydoubleТочность
*speeddoubleСкорость

Выходные данные

ПараметрТипПримечание
*valbool

Метод tt.taxi.driver.SendPhoto — Отправить фотографию автомобиля

Послать фотографию автомобиля для выхода на смену.

Входные данные

ПараметрТипПримечание
*photoDriverPhotoProtoФото

Выходные данные

ПараметрТипПримечание
*idint64Ид фотографии на сервере.

Метод tt.taxi.driver.CallClient — Позвонить клиенту

Позвонить клиенту (заглушка)

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Метод tt.taxi.driver.CallOperator — Позвонить оператору

Позвонить оператору (заглушка)

Входные данные

ПараметрТипПримечание
*reasonstringПричина звонка.

Метод tt.taxi.driver.GetVersion — Получить версию протокола

Запрос возвращает текущую версию протокола.

Входные данные

ПараметрТипПримечание
*clientAppVersionstringВерсия клиентского приложения.
*clientProtoVersionstringВерсия протокола клиентского приложения.

Выходные данные

ПараметрТипПримечание
*serverProtoVersionstringВерсия протокола сервера.
*lastClientAppVersionCodeint32Код (целое число) последней доступной версии клиента, соответствующий android:versionCode в манифесте приложения.
*lastClientAppUrlstringАдрес для загрузки последней версии клиента.

Метод tt.taxi.driver.GetTimeOnShift — Получить время на смене

Запрос возвращает время, прошедшее с последнего выхода на смену водителя.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*timeElapsedint64Время (в мс), прошедшее с момента выхода водителя на смену.

Метод tt.taxi.common.GetCityBounds — Получить границы города

Возвращает границы города.

Входные данные

ПараметрТипПримечание
*cityIdint32

Выходные данные

ПараметрТипПримечание
*boundsGeoPolygonProto

Метод tt.taxi.driver.GetAddressCoords — Получить координаты адреса

Возвращает координаты адреса.

Входные данные

ПараметрТипПримечание
*idint64Id адреса.

Выходные данные

ПараметрТипПримечание
*coordsGeoPointProtoКоординаты

Метод tt.taxi.driver.GetProfile — Получить профиль водителя

Запрос возвращает профиль водителя.

Входные данные

ПараметрТипПримечание
*emptyint32

Выходные данные

ПараметрТипПримечание
*driverDriverProfileProtoИнформация о водителе.
*carCarProfileProtoИнформация об автомобиле.
*ratingParamsRatingParamProto[]Параметры, влияющие на рейтинг.

Описание типов данных

Структура DriverProfileProto
ПараметрТипПримечание
*phonestringТелефон
*emailstringЭл. почта.
*driverPhotobytesФотография водителя.
*firstNamestringИмя
*lastNamestringФамилия
*middleNamestringОтчество
*callsignstringПозывной
*licensestringНомер лицензии.
*ratingint32Рейтинг
Структура CarProfileProto
ПараметрТипПримечание
*modelstringМодель машины.
*colorstringЦвет машины.
*numberstringНомер машины.
*carPhotobytesФотография машины.
Структура RatingParamProto
ПараметрТипПримечание
*namestringНазвание параметра.
*typestringТип параметра (driver - параметр водителя, car - параметр машины)
*weightint32Вес параметра (максимально допустимое значение)
*valuedoubleЗначение параметра (текущее значение параметра для водителя или null если у водителя нет такого параметра)

Метод tt.taxi.driver.GetCurrentAddress — Получить регистрацию по адресу

Возвращает адрес, зарегистрированный при регистрации по адресу, или null.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*addressOrderProto.PointАдрес
*wantHomeboolВключен ли режим "Хочу домой"

Метод tt.taxi.driver.GetTime — Получить текущее время

Запрос возвращает текущее время сервера.

Входные данные

ПараметрТипПримечание
*timeint64Unix time (msec.) время на клиенте.

Выходные данные

ПараметрТипПримечание
*timeint64Unix time (msec.) время на сервере.

Метод tt.taxi.driver.GetAccount — Получить текущий баланс

Запрос возвращает текущий баланс водителя и историю операций.

Входные данные

ПараметрТипПримечание
*beginDateint64Начало периода.
*endDateint64Конец периода.

Выходные данные

ПараметрТипПримечание
*balancedoubleТекущий баланс.
*daysLeftint32Кол-во дней, на которое хватит суммы на балансе.
*allowAdvancePaymentboolДоступность обещанного платежа.
*historyAccOperationProto[]История операций за период.

Описание типов данных

Структура AccOperationProto
ПараметрТипПримечание
*timestampint64Дата проведения операции.
*amountdoubleСумма
*commentarystringКомментарий

Метод tt.taxi.driver.GetInfo — Получить текущую информацию

Запрос возвращает текущую информацию по водителю (еслть ли назначенные заказы, сообщения, новости и т.д.)
Возвращается информация: личные данные водителя, алгоритм распределения, текущий заказ, доступные заказы, предварительные заказы.

Входные данные

ПараметрТипПримечание
*driverInfoboolВозвращать ли информацию о водителе.
*ordersInfoboolВозвращать ли информацию о заказах.

Выходные данные

ПараметрТипПримечание
*driverInfoDriverInfoProtoИнформация о водителе.
*orderInfoOrderInfoProtoИнформация о заказах.
*advanceOrdersInfoAdvanceOrdersInfoProtoДоп. информация о предварительных заказах.

Описание типов данных

Структура OrderInfoProto — Информация о заказах
ПараметрТипПримечание
*ordersOrderProto[]Список заказов (доступные, назначенные, текущий, предзаказы)
*orderCountint32Кол-во заказов.
*advanceCountint64Кол-во предзаказов.
Структура AdvanceOrderInfoProto — Дополнительная информация о предварительных заказах
ПараметрТипПримечание
*orderIdint64Id заказа.
*driversCountint64Кол-во водителей, забронировавших этот заказ.
*driverPosint64Позиция водителя в очереди на этот заказ.
Структура AdvanceOrdersInfoProto — Дополнительная информация о предварительных заказах
ПараметрТипПримечание
*ordersAdvanceOrderInfoProto[]Список доступных предварительных заказов.

Метод tt.taxi.driver.HurryClient — Поторопить клиента

Поторопить клиента (заглушка)

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Метод tt.taxi.driver.SetParkingPoint — Регистрация на стоянке

Запрос устанавливает текущую стоянку для водителя
Водитель регистрируется на стоянке. Возобновляется процедура распределения заказов. Всем водителям службы отправляются оповещения о появлении нового водителя на стоянке.

Входные данные

ПараметрТипПримечание
*idint64ID стоянки. Если не указан, то разрегистрирует водителя с текущей стоянки.

Выходные данные

ПараметрТипПримечание
*emptyint32

Метод tt.taxi.driver.SetCurrentAddress — Регистрация по адресу

Регистрация по адресу.

Входные данные

ПараметрТипПримечание
*addressIdint64ID адреса.
*wantHomeboolХочу домой. Если установлено, то водителю включается режим "хочу домой".

Метод tt.taxi.driver.ChangeDriverTariff — Смена тарифа водителя

Входные данные

ПараметрТипПримечание
*tariffIdint64Ид тарифа.

Метод tt.taxi.driver.CreateDemoDriver — Создать демо аккаунт

Входные данные

ПараметрТипПримечание
*deviceIdstringУникальный идентификатор устройства.
*passwordHashstringХеш

Выходные данные

ПараметрТипПримечание
*loginstringЛогин нового водителя.
*passwordstringПароль нового водителя (4 цифры)

Метод tt.taxi.driver.GetDriverTariffs — Список водительских тарифов

Возвращается список тарифов водителя.

Входные данные

ПараметрТипПримечание
*emptyint32Неиспользуемая переменная.

Выходные данные

ПараметрТипПримечание
*activeTariffDriverTariffInfoProtoАктивный тариф водителя.
*tariffsToChangeDriverTariffInfoProto[]Тарифы, на которые возможен переход.
*embargoTimeint64Время запрета на смену тарифа.

Описание типов данных

Структура DriverTariffInfoProto — Информация о тарифе
ПараметрТипПримечание
*tariffIdint64ИД тарифы.
*titlestringНаименование тарифа.
*pricedoubleЦена перехода.
*descDriverTariffInfoDescProto[]Описание тарифа.
Структура DriverTariffInfoDescProto — Описание тарифа
ПараметрТипПримечание
*titlestringНазвание поля.
*descriptionstringОписание
*isForListboolОписание тарифа только для отображения в списке.

Метод tt.taxi.driver.GetDoneOrders — Список выполненных заказов

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

Входные данные

ПараметрТипПримечание
*beginDateint64Дата, начиная с которой возвращать заказы.
*endDateint64Дата, до которой возвращать заказы.

Выходные данные

ПараметрТипПримечание
*dataDoneOrderProto[]

Описание типов данных

Структура DoneOrderProto
ПараметрТипПримечание
*dateint64Дата завершения заказа.
*isBorderboolЗаказ с бордюра?
*pricedoubleСтоимость поездки.

Метод tt.taxi.driver.GetClientTariffs — Список клиентских тарифов

Возвращается список клиентских тарифов для данной службы.

Входные данные

ПараметрТипПримечание
*emptyint32Неиспользуемая переменная.

Выходные данные

ПараметрТипПримечание
*tariffsClientTariffProto[]Тарифы службы. В случае автоматического переключения тарифов возвращаем 1 тариф с разными сегментами, в случае ручного переключения - 2 тарифа, городской и загородный.
*orderTariffsClientTariffProto[]Тарифы для текущего заказа, если есть.

Метод tt.taxi.driver.GetShifts — Список смен

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

Входные данные

ПараметрТипПримечание
*beginDateint64Дата, начиная с которой возвращать смены.
*endDateint64Дата, до которой возвращать смены.

Выходные данные

ПараметрТипПримечание
*dataDriverShiftProto[]

Описание типов данных

Структура DriverShiftProto
ПараметрТипПримечание
*beginDateint64Дата начала интервала.
*endDateint64Дата конца интервала.

Метод tt.taxi.driver.GetParkingPoints — Список стоянок

Возвращается список стоянок, число заказов и водителей на стоянках.

Входные данные

ПараметрТипПримечание
*getBordersboolЕсли true - возвращаем границы стоянок.

Выходные данные

ПараметрТипПримечание
*pointsParkingPointProto[]Список стоянок.

Метод tt.taxi.demo.CreateUserAccount — Добавить пользователя

Добавить нового демо пользователя.

Входные данные

ПараметрТипПримечание
*emailstringПочта пользователя.
*phonestringТелефон пользователя.

Выходные данные

ПараметрТипПримечание
*dataDemoUserAccountInfoИнформация о новом пользователе.

Описание типов данных

Структура DemoUserAccountInfo
ПараметрТипПримечание
*idint64Ид нового пользователя.
*passstringПароль нового пользователя.
*hashPassstringХэш пароля нового пользователя.
*loginstringЛогин нового пользователя.
*isNewboolСоздан новый аккаунт или востановлен старый.

Метод tt.taxi.demo.GetApp — Получить клиентское приложение

Запрос возвращает ссылку на новый билд клиентского приложения
Если указан телефон, отправляет на него ссылку.

Входные данные

ПараметрТипПримечание
*phonestringНомер телефона.

Выходные данные

ПараметрТипПримечание
*lastClientAppUrlstringАдрес для загрузки клиентского приложения.

Метод tt.taxi.integration.GetNewDrivers — Получить новых водителей из Таксы

Получить список водителей, которые брали заказы при включенной интеграции, но не были заведены в Такси Онлайн.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*driversGetNewDriversDriver[]Список водителей.

Описание типов данных

Структура GetNewDriversDriver — Список водителей - позывной и ФИО
ПараметрТипПримечание
*driverIdint32
*callsignint32Позывной
*fiostringФИО

Метод tt.taxi.integration.SyncBalance — Синхронизация баланса

Синхронизация баланса из Таксы в ТО.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Метод tt.taxi.client.SetFeedback — Обратная связь

Входные данные

ПараметрТипПримечание
*phonestringТелефон клиента.
*textstringТекст сообщения.
*clientIdint64Ид клиента.

Метод tt.taxi.client.AddOrderRating — Оставить отзыв

Входные данные

ПараметрТипПримечание
*ratingOrderRatingProtoОтзыв

Выходные данные

ПараметрТипПримечание
*idint64ИД новой записи.

Метод tt.taxi.client.ClientDriverReject — Отказаться от текущего водителя

Отказаться от текущего водителя.

Входные данные

ПараметрТипПримечание
*clientIdint64ИД клиента.
*orderIdint64ИД заказа.

Метод tt.taxi.client.SendSms — Отправить смс

Входные данные

ПараметрТипПримечание
*phonestringТелефон получателя.
*textstringТекст смс.

Метод tt.taxi.client.GetDriverRating — Получить оценку водителя

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.

Выходные данные

ПараметрТипПримечание
*likeCountint64Количество положительных отзывов.
*sagCountint64Количество отрицательных отзывов.

Метод tt.taxi.client.GetOrderCostDetails — Получить подробуую информацию по стоимости заказа

получить подробуую информацию по стоимости заказа.

Входные данные

ПараметрТипПримечание
*orderIdint64ИД заказа.

Выходные данные

ПараметрТипПримечание
*costdoubleСтоимость заказа.
*costDetailsCostDetails[]Подробная информация по стоимости заказа.

Описание типов данных

Структура CostDetails
ПараметрТипПримечание
*namestringПараметр
*valuestringЗначение

Метод tt.taxi.client.GetActiveOrders — Получить список Ид заказов

получить список Ид активных заказов.

Входные данные

ПараметрТипПримечание
*clientIdint64ИД клиента.
*serviceIdint64ИД службы.
*stageIdint32ИД стадии заказа (если пусто - активные)

Выходные данные

ПараметрТипПримечание
*ordersIdsint64[]Список ИД активных заказов.

Метод tt.taxi.client.DriverOrderRequest — Предложение заказа водителю

предложение заказа водителю.

Входные данные

ПараметрТипПримечание
*driverIdint64ИД водителя.
*orderIdint64ИД заказа.

Выходные данные

ПараметрТипПримечание
*statusint64Статус запрос (1 - запрос отправлен, 2 - водитель взял заказ, 3 - отказался)

Метод tt.taxi.operator.RestoreAddress — Восстановить адреса

Восстановить адрес или несколько по id.

Входные данные

ПараметрТипПримечание
*idint32[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultRestoreValidationResultРезультат валидации.

Метод tt.taxi.operator.CreateAddress — Добавить адрес

Сохранение в базу нового адреса.

Входные данные

ПараметрТипПримечание
*dataAddressProto

Выходные данные

ПараметрТипПримечание
*idint32Id нового адреса.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.operator.CreateAddressIfNotExists — Добавить или получить адрес

Сохранение в базу нового адреса. Если такой адрес уже существует (проверяется по ид города, номеру дома и ид/названию улицы), то выдать ид существующего адреса.

Входные данные

ПараметрТипПримечание
*dataAddressProto

Выходные данные

ПараметрТипПримечание
*idint32Id нового или существующего адреса.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.operator.FindAddress — Поиск адреса

Поиск подходящего адреса.

Входные данные

ПараметрТипПримечание
*textstringШаблон поиска (улица и номер дома через запятую)
*limitint32Ограничение на кол-во результатов.

Выходные данные

ПараметрТипПримечание
*dataAddressProto[]Результаты

Метод tt.taxi.operator.FindHouseOnStreet — Поиск дома

Поиск дома на улице.

Входные данные

ПараметрТипПримечание
*textstringЧасть номера дома.
*limitint32Ограничение на кол-во результатов.
*streetIdint32Ид улицы.
*clientIdint64Клиент

Выходные данные

ПараметрТипПримечание
*dataAddressProto[]Список адресов.

Метод tt.taxi.operator.GetAddress — Получить адрес

Получение адреса по id.

Входные данные

ПараметрТипПримечание
*idint32

Выходные данные

ПараметрТипПримечание
*dataAddressProto

Метод tt.taxi.operator.GetParkingPointFromAddress — Получить стоянку по адресу

Получает ид стоянки по адресу.

Входные данные

ПараметрТипПримечание
*addressIdint64Ид адреса.

Выходные данные

ПараметрТипПримечание
*ppIdint64Ид стоянки.

Метод tt.taxi.operator.UpdateAddress — Редактировать адрес

Редактировать адрес.

Входные данные

ПараметрТипПримечание
*idint32Ид объекта.
*dataAddressProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.operator.GetAddresses — Список адресов

Получение списка адресов.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataAddressListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.operator.GetAddressList — Список адресов по id

Получение адресов по списку id.

Входные данные

ПараметрТипПримечание
*idint32[]

Выходные данные

ПараметрТипПримечание
*dataAddressProto[]

Метод tt.taxi.operator.DeleteAddress — Удалить адреса

Удалить адрес или несколько по id.

Входные данные

ПараметрТипПримечание
*idint32[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateCity — Добавить город

Добавить новый город.

Входные данные

ПараметрТипПримечание
*dataCityProto

Выходные данные

ПараметрТипПримечание
*idint32Ид нового города.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetCity — Получить город

Получить город по id.

Входные данные

ПараметрТипПримечание
*idint32Id города.

Выходные данные

ПараметрТипПримечание
*dataCityProtoГород

Метод tt.taxi.manager.UpdateCity — Редактировать город

Редактировать город.

Входные данные

ПараметрТипПримечание
*idint32Ид объекта.
*dataCityProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetCities — Список городов

Получить список городов.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataCityProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.DeleteCity — Удалить города

Удалить города по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.operator.CreatePlace — Добавить объект (место)

Сохранение в базу нового объекта (места)

Входные данные

ПараметрТипПримечание
*dataPlaceUpdateProto

Выходные данные

ПараметрТипПримечание
*idint32Id нового объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.operator.GetPlace — Получить объект (место)

Получение объекта (места) по id.

Входные данные

ПараметрТипПримечание
*idint32

Выходные данные

ПараметрТипПримечание
*dataPlaceProto

Метод tt.taxi.operator.GetPlaces — Получить список объектов (мест)

Получение списка мест.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataPlaceProto[]Список мест.
*countint64Общее количество строк.

Метод tt.taxi.operator.UpdatePlace — Редактировать объект (место)

Редактировать объект (место)

Входные данные

ПараметрТипПримечание
*idint32Ид объекта.
*dataPlaceUpdateProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.operator.DeletePlace — Удалить объекты (места)

Удалить объект(место) или несколько по id.

Входные данные

ПараметрТипПримечание
*idint32[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.operator.GetStreet — Получить улицу

Получить улицу по id.

Входные данные

ПараметрТипПримечание
*idint32Id улицы.

Выходные данные

ПараметрТипПримечание
*dataStreetProtoУлица

Метод tt.taxi.operator.GetNearestAddress — Поиск ближайшего адреса

Поиск ближайшего адреса по координатам.

Входные данные

ПараметрТипПримечание
*latitudedoubleШирота
*longitudedoubleДолгота

Выходные данные

ПараметрТипПримечание
*dataAddressProtoБлижайший адрес.

Метод tt.taxi.operator.FindStreetOrPlace — Поиск улицы или места (объекта)

Поиск улицы или места (объекта)

Входные данные

ПараметрТипПримечание
*cityIdint32Ид города.
*textstringШаблон
*limitint32Ограничение на кол-во результатов.

Выходные данные

ПараметрТипПримечание
*streetsStreetProto[]Список улиц.
*placesPlaceProto[]Список мест (объектов)

Метод tt.core.user.Login — Вход в систему

Запрос создает новую сессию.

Входные данные

ПараметрТипПримечание
*emailstringEmail. Устарело. Используется, если не заполнено поле login.
*passwordHashstringSHA256 пароля.
*loginstringЛогин.

Выходные данные

ПараметрТипПримечание
*sidstringИдентификатор сессии.
*accountIdint64Ид пользователя.
*permissionsUserPermissionsProtoСписок разрешений для пользователя.

Метод tt.taxi.operator.Login — Вход оператора в систему

Входные данные

ПараметрТипПримечание
*accessTokenstringТокен авторизации.
*signstringСигнатура
*loginstringЛогин оператора.
*fiostringФио оператора.

Выходные данные

ПараметрТипПримечание
*idint64Id пользователя.
*loginstringЛогин пользователя.
*sidstringИдентификатор сессии.
*fiostringФИО пользователя.

Метод tt.core.user.Logout — Выход из системы

Запрос завершает сессию.

Входные данные

ПараметрТипПримечание
*emptyint32Неиспользуемая переменная.

Выходные данные

ПараметрТипПримечание
*emptyint32Неиспользуемая переменная.

Метод tt.taxi.manager.GetDoneOrdersTotal — Заработок водителя

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

Входные данные

ПараметрТипПримечание
*filterFilterAndProtoФильтр

Выходные данные

ПараметрТипПримечание
*borderTotaldoubleЗаработок с бордюра.
*serviceTotaldoubleЗаработок в службе.
*fail_countint64Количество отказов во время выполнения.

Метод tt.taxi.manager.AdvancePayment — Обещанный платеж

Запрос выполняет обещанный платеж.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.

Выходные данные

ПараметрТипПримечание
*successboolУспех платежа.
*allowAdvancePaymentboolДоступность обещанного платежа в будущем.
*messageTextstringТекст сообщения для пользователя.

Метод tt.taxi.manager.GetAccountBalance — Получить баланс водителя

Получить остаток на балансе водителя.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.

Выходные данные

ПараметрТипПримечание
*balancedoubleОстаток на балансе.

Метод tt.taxi.manager.CreateAccountCorrection — Провести корректировку

Провести корректировку баланса водителя.

Входные данные

ПараметрТипПримечание
*dataAccountCorrectionProto

Выходные данные

ПараметрТипПримечание
*idint64Ид новой операции.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetDoneOrders — Список выполненных заказов

Получить список выполненных заказов водителя.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataDoneOrderListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.GetAccountOperations — Список операций с балансом

Получить список операций с балансом водителя.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataAccountOperationListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.CreateDriver — Добавить водителя

Добавление нового водителя (создание нового аккаунта). Установка статических параметров водителя.

Входные данные

ПараметрТипПримечание
*dataDriverUpdateProtoДанные водителя.
*staticParamsint64[]Статические параметры водителя.
*loginstringЛогин водителя.
*emailstringЕмейл водителя (можно не указывать). Если будет не указан логин, то он будет установлен в email.
*passwordHashstringХэш пароля.
*lastNamestringФамилия
*firstNamestringИмя
*middleNamestringОтчество
*passwordStringstringПароль
*shiftsint64[]Список смен.

Выходные данные

ПараметрТипПримечание
*idint64Ид нового водителя.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateDriverNote — Добавить заметку

Добавить заметку для водителя.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.
*textstringТекст заметки.

Метод tt.taxi.manager.SendMessageToDriver — Отправить сообщение водителю

Отправить сообщение водителю.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.
*messagestringТекст сообщения.

Метод tt.taxi.manager.GetDriver — Получить водителя

Получить водителя по id.

Входные данные

ПараметрТипПримечание
*idint64

Выходные данные

ПараметрТипПримечание
*dataDriverProto

Метод tt.taxi.manager.GetLastCoordsOnline — Получить координаты водителя

Запрос получает последние координаты (gps) водителя.

Входные данные

ПараметрТипПримечание
*statusIdint64Статус водителя, если пусто, то всех онлайн.
*serviceIdint64ИД службы.

Выходные данные

ПараметрТипПримечание
*coordsGeoPointDriverProto[]Последние координаты водителя.
*countint64Общее количество отметок.

Метод tt.taxi.manager.GetDriverAutoCallsignSettings — Получить настройки счетчика позывных

Получить настройки счетчика позывных.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*dataDriverAutoCallsignProtoНастройки счетчика позывных.

Метод tt.taxi.manager.GetDriverAutoCallsignCurrent — Получить текущий счетчик позывных

Получить текущий счетчик позывных.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*isAutoCallsignboolИспользовать счетчик позывных.
*callsignstringТекущий позывной.

Метод tt.taxi.manager.GetHistoryCoords — Получить трек водителя

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.
*dateFromint64
*dateToint64

Выходные данные

ПараметрТипПримечание
*coordsGeoPointHistoryProto[]Координаты водителя.
*countint64Общее количество отметок.

Метод tt.taxi.manager.GetOrderCoords — Получить трек водителя по заказу

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.
*orderIdint64Ид заказа.

Выходные данные

ПараметрТипПримечание
*coordsGeoPointHistoryProto[]Координаты водителя.
*countint64Общее количество отметок.

Метод tt.taxi.manager.UpdateDriver — Редактировать водителя

Изменение данных о водителе. У водителя обновляется дата последнего события. Возобновляется процедура распределения заказов.

Входные данные

ПараметрТипПримечание
*idint64
*dataDriverUpdateProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResult

Метод tt.taxi.manager.GetDriverSummary — Сводка по водителю

Возвращает сводку по водителю.

Входные данные

ПараметрТипПримечание
*idint64Ид водителя.

Выходные данные

ПараметрТипПримечание
*balancedoubleБаланс
*earningsdoubleЗаработок (руб/мес)
*complaintsint32Количество жалоб.
*shiftIdint64Работа в смене (ид смены)
*shiftstringРабота в смене.
*ordersint64Количество заказов за 30 дней.
*failsTotalint64Количество отказов за 30 дней (всего)
*failsBrokeCarint64Количество отказов за 30 дней (Сломалась машина)
*failsClientRefusedint64Количество отказов за 30 дней (Клиент отказался)
*failsDangerousClientint64Количество отказов за 30 дней (Опасный клиент)
*rejectsTotalint64Количество отказов от предложений за 30 дней.
*failsOperatorRefusedint64Количество отказов за 30 дней (Снят оператором)
*cancelledIvrint64Количество отказов за 30 дней (Автодозвон)

Метод tt.taxi.manager.GetDriverWorkList — Смены водителя

Получить информацию о сменах и рабочем времени водителя.

Входные данные

ПараметрТипПримечание
*driverIdint64Id водителя.
*beginint64Начало интервала.
*endint64Конец интервала.
*pagingPagingProtoРазбиение на страницы.

Выходные данные

ПараметрТипПримечание
*timesWorkTimeProto[]Список интервалов рабочего времени водителя.
*shiftsWorkShiftProto[]Список описаний смен.
*infoWorkInfoProto[]Информация для каждой даты.
*summaryWorkSummaryProtoОбщая информация.

Описание типов данных

Структура WorkTimeProto — Интервал рабочего времени водителя
ПараметрТипПримечание
*beginint64Начало интервала.
*endint64Конец интервала.
*shiftIdint64Ид смены, если водитель работал в смене.
Структура WorkShiftTimeProto — Интервал смены
ПараметрТипПримечание
*beginint64Начало интервала (дата и время)
*endint64Конец интервала (дата и время)
Структура WorkShiftProto — Информация о смене
ПараметрТипПримечание
*idint64Ид смены.
*namestringНазвание смены.
*timesWorkShiftTimeProto[]Список временных интервалов смены.
Структура WorkInfoProto — Информация по дате
ПараметрТипПримечание
*dateint64Дата
*ordersint32Количество заказов за дату.
*failsint32Количество отказов за дату.
*workTimeint64Отработанное время (миллисекунды)
Структура WorkSummaryProto — Общая информация об отработанном времени
ПараметрТипПримечание
*workTimeOnShiftint64Отработанное время в сменах за весь период (миллисекунды)
*workTimeOffShiftint64Отработанное время вне смен за весь период (миллисекунды)

Метод tt.taxi.manager.SetDriverBan — Снять водителя со смены

Снять водителя со смены (наложить бан) либо отменить бан.

Входные данные

ПараметрТипПримечание
*driverIdint64Id водителя.
*banboolЗабанить или разбанить.
*banDateBeginint64Опционально - дата начала бана.
*banDateEndint64Опционально - дата окончания бана.
*banReasonstringОпционально - причина бана.

Метод tt.taxi.manager.GetDriversList — Список водителей

Получить список водителей (новая версия)

Входные данные

ПараметрТипПримечание
*paramsGetProto
*isWorkingbool

Выходные данные

ПараметрТипПримечание
*dataDriverListViewProto[]
*countint64
*extFieldsNamesDriverExtFieldsNamesProto[]Информация о полях с динамическими именами.

Метод tt.taxi.manager.GetDriversByTariffExtId — Список водителей по дополнению к тарифу

Получить список водителей, отфильтрованный по ид дополнения к тарифу.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры запроса.
*extIdint64Ид дополнения.

Выходные данные

ПараметрТипПримечание
*dataDriverListViewProto[]Список водителей.
*countint64Общее количество строк.

Метод tt.taxi.manager.GetReservingDrivers — Список водителей, забронировавших заказ

Получить список ид водителей, забронировавших заказ.

Входные данные

ПараметрТипПримечание
*orderIdint64Ид заказа.

Выходные данные

ПараметрТипПримечание
*driverIdsint64[]Список ид водителей.

Метод tt.taxi.manager.GetDriverCars — Список машин водителя

Получить машины, приписанные к водителю.

Входные данные

ПараметрТипПримечание
*idint64Id водителя.

Выходные данные

ПараметрТипПримечание
*dataCarListProto[]Список его машин.

Метод tt.taxi.manager.SetDriverTariffExtensions — Установить дополнения к тарифу водителя

Установить дополнения для тарифа водителю.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя, которому нужно установить дополнения.
*tariffIdsint64[]Список ид дополнений.

Метод tt.taxi.manager.SetDriverCars — Установить машины водителя

Установить машины, приписанные к водителю.

Входные данные

ПараметрТипПримечание
*idint64Id водителя.
*carIdint64[]Список id машин.

Метод tt.taxi.manager.SetDriverAutoCallsignSettings — Установить настройки счетчика позывных

Установка настроек счетчика позывных.

Входные данные

ПараметрТипПримечание
*dataDriverAutoCallsignProtoНастройки

Метод tt.taxi.manager.SetDriverTariff — Установить тариф водителя

Установить базовый тариф водителю.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя, которому нужно установить тариф.
*tariffIdint64Ид базового тарифа.

Метод tt.taxi.manager.CreateCsvRequest — Создать заявку

Входные данные

ПараметрТипПримечание
*dataCsvRequestProtoДанные

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetCsvRequestsList — Список заявок

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataCsvRequestViewProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.GetCsvReportsList — Список отчетов

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataCsvReportProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.FrontGetDriversAndOrders — Водители и заказы

Блок "Водители и заказы" на главной странице.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*dataFrontDriversAndOrdersDataProto[]Список результатов.

Описание типов данных

Структура FrontDriversAndOrdersDataProto — Элемент блока "Водители и заказы"
ПараметрТипПримечание
*driversOnlineint64Водителей онлайн.
*driversOnPpint64Водителей на стоянках.
*driversFreeint64Свободных водителей.
*driversInProgressint64Водителей выполняющие заказ.
*driversNotOnShiftint64Водителей не на смене.
*ordersInProgressint64Заказов выполняется.
*ordersDistribint64Заказов на распределении.
*ordersDone24int64Выполненных заказов за 24 часа.
*serviceIdint64Ид службы.
*serviceNamestringНазвание службы.
*ordersProblemint64Проблемных заказов.
*ordersActiveint64Активных заказов.
*ordersAdvanceint64Предварительных заказов.

Метод tt.taxi.manager.FrontGetDriversAndOrdersByServiceId — Водители и заказы по службе

Блок "Водители и заказы" на главной странице.

Входные данные

ПараметрТипПримечание
*serviceIdint64ИД службы.

Выходные данные

ПараметрТипПримечание
*driversOnlineint64Водителей онлайн.
*driversOnPpint64Водителей на стоянках.
*driversFreeint64Свободных водителей.
*driversInProgressint64Водителей выполняющие заказ.
*driversNotOnShiftint64Водителей не на смене.
*ordersInProgressint64Заказов выполняется.
*ordersDistribint64Заказов на распределении.
*ordersDone24int64Выполненных заказов за 24 часа.
*serviceIdint64Ид службы.
*serviceNamestringНазвание службы.
*ordersProblemint64Проблемных заказов.
*ordersActiveint64Активных заказов.
*ordersAdvanceint64Предварительных заказов.

Метод tt.taxi.manager.FrontGetServicesWork — Работа служб

Блок "Работа служб" на главной странице.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*currentDataFrontServicesWorkResultProtoТекущие данные.
*lastHourDataFrontServicesWorkResultProtoДанные час назад (для отображения динамики)

Описание типов данных

Структура FrontServicesWorkResultProto — Данные блока "Работа служб"
ПараметрТипПримечание
*dataFrontServicesWorkDataProto[]Список результатов по службам.
Структура FrontServicesWorkDataProto — Элемент блока "Работа служб"
ПараметрТипПримечание
*donePercentdoubleИсполняемость (%)
*arriveTimeAvgint64Среднее время подачи (мсек)
*executeTimeAvgint64Среднее время выполнения заказа (мсек)
*distribTimeAvgint64Среднее время распределения (мсек)
*serviceIdint64Ид службы.
*serviceNamestringНазвание службы.

Метод tt.taxi.manager.FrontGetParkingPoints — Стоянки

Блок "Стоянки" на главной странице.

Входные данные

ПараметрТипПримечание
*cityIdint32Город, если не задан то выдается информация по всем городам.

Выходные данные

ПараметрТипПримечание
*dataFrontPPDataProto[]Список результатов по стоянкам.

Описание типов данных

Структура FrontPPDataProto — Элемент блока "Стоянки"
ПараметрТипПримечание
*ppIdint64Ид стоянки.
*ppNamestringНазвание стоянки.
*ordersTotalint64Поступило заказов.
*ordersDoneint64Выполнено заказов.
*ordersDistribint64Свободные заказы.
*preordersint64Предзаказы
*ordersActiveint64Активные заказы.
*driversFrontPPDriverDataProto[]Очередь водителей на стоянке.
Структура FrontPPDriverDataProto — Информация о водителе на стоянке
ПараметрТипПримечание
*driverIdint64Ид водителя.
*callsignstringПозывной
*regDateint64Дата и время регистрации на стоянке.

Метод tt.taxi.manager.ArchiveDiscount — Архивировать дисконтные карты

Архивировать дисконтную карту.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для архивации.

Метод tt.taxi.manager.CreateDiscount — Добавить дисконтную карту

Добавить новую дисконтную карту.

Входные данные

ПараметрТипПримечание
*dataDiscountProto
*numberTostringПри создании серии: до какого номера создавать.

Выходные данные

ПараметрТипПримечание
*idint64Ид новой карты.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetDiscount — Получить дисконтную карту

Получить дисконтную карту по id.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.

Выходные данные

ПараметрТипПримечание
*dataDiscountProtoДанные

Метод tt.taxi.manager.GetDiscountByCode — Получить дисконтную карту по коду

Получить дисконтную карту по коду.

Входные данные

ПараметрТипПримечание
*serviceIdint64Ид службы.
*codestringКодовое слово или номер карты.
*clientIdint64ИД клиента.

Выходные данные

ПараметрТипПримечание
*dataDiscountProtoДанные

Метод tt.taxi.manager.GetDiscountHistoryByPhone — Получить историю дисконтных карт

Получить историю использования дисконтных карт по номеру телефона.

Входные данные

ПараметрТипПримечание
*phonestringТелефон
*serviceIdint64ИД службы.

Выходные данные

ПараметрТипПримечание
*dataDiscountListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.UpdateDiscount — Редактировать дисконтные карты

Редактировать дисконтные карты.

Входные данные

ПараметрТипПримечание
*numberFromstringНомер карты (от, включительно)
*numberTostringНомер карты (до, включительно)
*clientIdint64Ид клиента.
*phonestringТелефон
*serviceIdsint64[]Ид служб.
*fieldsstring[]Список полей для редактирования (может включать clientId, phone и serviceIds)
*isActualboolАктивная

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetDiscounts — Список дисконтных карт

Получить список дисконтных карт.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataDiscountListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.common.GetLogSpecial — Получить отладочный лог

Отправляется текст специального лога (журнала событий). Пока поддерживается только лог distrib - распределение заказов.

Входные данные

ПараметрТипПримечание
*logNamestringИд лога.

Выходные данные

ПараметрТипПримечание
*contentsstringТекст лога.

Метод tt.taxi.common.GetCurrentDate — Получить текущую дату

Получить текущую дату на сервере.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*dateint64Текущая дата сервера.

Метод tt.taxi.operator.CreateComplaint — Добавить жалобу

Создание новой жалобы. Отсутствующие в запросе поля будут проинициализированы значениями по умолчанию.

Входные данные

ПараметрТипПримечание
*dataComplaintProto

Метод tt.taxi.operator.UpdateComplaint — Редактировать жалобу

Редактирование жалобы.

Входные данные

ПараметрТипПримечание
*idint64Идентификатор редактируемой жалобы.
*dataComplaintProtoНовые данные.
*fieldsstring[]Список полей, которые необходимо поменять (поля из data)

Метод tt.taxi.operator.GetComplaints — Список жалоб

Получает список жалоб.

Входные данные

ПараметрТипПримечание
*idint64
*limitint32
*filterstring
*typestringТип жалоб. Возможные значения: client - жалоба клиента, driver - жалоба водителя, operator - жалоба оператора.

Выходные данные

ПараметрТипПримечание
*dataComplaintProto[]Список жалоб.

Метод tt.taxi.manager.AssignDriverToOrder — Назначить заказ водителю

Назначить заказ водителю.

Входные данные

ПараметрТипПримечание
*orderIdint64Ид заказа.
*driverIdint64Ид водителя.
*arriveTimeint32Время подачи машины (мин.), по умолчанию будет 10 минут.

Выходные данные

ПараметрТипПримечание
*successboolФлаг успешного завершения.

Метод tt.taxi.manager.CancelOrder — Отмена заказа

Отмена заказа (перевод его в завершенные).

Входные данные

ПараметрТипПримечание
*idint64Ид заказа.
*incomingPhonestringВходящий номер.

Метод tt.taxi.manager.GetOrderCars — Получить все машины на заказе

Получить все машины на заказе по ид заказа.

Входные данные

ПараметрТипПримечание
*idint64Ид заказа.

Выходные данные

ПараметрТипПримечание
*dataOrderCarProto[]

Метод tt.taxi.manager.GetOrder — Получить карточку заказа

Получить заказ по ид.

Входные данные

ПараметрТипПримечание
*idint64

Выходные данные

ПараметрТипПримечание
*dataOrderProto
*stateTimerint64Таймер с начала этапа заказа.
*isProblemboolЯвляется ли заказ проблемным.
*timeLimitint64Ограничение времени на текущий этап (мсек)

Метод tt.taxi.manager.GetOrderExt — Получить карточку заказа (Ext)

Получить заказ по ид.

Входные данные

ПараметрТипПримечание
*idint64

Выходные данные

ПараметрТипПримечание
*dataOrderExtProto
*stateTimerint64Таймер с начала этапа заказа.
*isProblemboolЯвляется ли заказ проблемным.
*timeLimitint64Ограничение времени на текущий этап (мсек)

Метод tt.taxi.manager.GetOrderLog — Получить лог заказа

Получение истории заказа.

Входные данные

ПараметрТипПримечание
*orderIdint64Ид заказа.

Выходные данные

ПараметрТипПримечание
*dataOrderLogProto[]Список событий.

Метод tt.taxi.manager.GetOrderRoute — Получить маршрут заказа

Получить маршрут (планируемый) для заказа.

Входные данные

ПараметрТипПримечание
*idint64Ид заказа.

Выходные данные

ПараметрТипПримечание
*pointsRoutePoint[]Промежуточные точки маршрута.

Метод tt.taxi.manager.GetOrderCar — Получить машину на заказе

Получить описание борта, выполняющего заказ, по ид заказа.

Входные данные

ПараметрТипПримечание
*idint64Ид заказа.

Выходные данные

ПараметрТипПримечание
*dataOrderCarProto

Метод tt.taxi.manager.GetForcedOrdersSettings — Получить настройки автоназначения

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*dataForcedOrdersSettingsНастройки

Метод tt.taxi.manager.GetOrderFormSettings — Получить настройки формы заказа

Получить настройки формы заказа.

Входные данные

ПараметрТипПримечание
*serviceIdint64Ид службы.

Выходные данные

ПараметрТипПримечание
*dataOrderFormSettingsProtoДанные

Метод tt.taxi.manager.GetOrderCost — Предварительная стоимость заказа

Получить предварительную стоимость заказа.

Входные данные

ПараметрТипПримечание
*tariffIdint64Клиентский тариф для расчета стоимости.
*serviceIdint64Ид службы.
*routeint64[]Полный маршрут поездки (начальная точка, промежуточные точки, конечная точка)
*discountIdint64Ид дисконтной карты.
*clientIdint64Ид клиента.
*isPreorderboolПредзаказ
*isMpboolЗаказ из МП клиента.
*tariffAdditionsint64[]Список дополнений к тарифу.

Выходные данные

ПараметрТипПримечание
*costdoubleПредварительная стоимость заказа (руб.)
*numCarsint32Приблизительное количество машин, которым уйдет заказ.
*distancedoubleРасстояние до клиента от ближайшей машины (ближайшая машина определяется по прямой) (метры)
*timedoubleПриблизительное время подачи машины (считается по ближайшей машине, ближайшая машина определяется по прямой) (секунды)
*routeDistancedoubleСуммарная длина маршрута поездки (метры)
*costStringstringОтформатированная предварительная стоимость заказа.
*discountValuedoubleПроцент скидки по дисконтной карте.
*discountMoneydoubleФиксированная скидка (руб.)
*bonusValuedoubleПроцентный бонус.
*bonusMoneydoubleФиксированный бонус (руб.)
*leftBeforeFreeRideint64Поездок осталось до бесплатной.
*isCardActivatedboolКарта активирована (безналичный расчет)
*isMayContractboolКлиент может ехать по безналичному расчету.
*routeLengthStringstringРастояние строкой в км.
*clientBalancedoubleБаланс клиента.
*isManualForcedOrderEnabledboolВключена галочка "Автоназначение"

Метод tt.taxi.manager.TestOrderCostCalculations — Проверка расчета стоимости

Входные данные

ПараметрТипПримечание
*orderIdint64Ид заказа.

Выходные данные

ПараметрТипПримечание
*serverResultTestOrderCostCalculationsResultProtoРезультат расчета сервера.
*mpResultTestOrderCostCalculationsResultProtoРезультат расчета мобильного приложения.

Описание типов данных

Структура TestOrderCostCalculationsResultProto
ПараметрТипПримечание
*calcStatusstringСтатус расчета.
*totalDistancedoubleРасстояние (м)
*totalCostdoubleРасчитанная стоимость (руб)
*calculateLogTextstringДополнительная информация.

Метод tt.taxi.manager.UpdateOrder — Редактировать заказ

Изменение заказа. Перерасчет его рейтинга и стоянки. Возобновляется процедура распределения заказов. Завершение заказа.

Входные данные

ПараметрТипПримечание
*idint64
*dataOrderProto
*fieldsstring[]
*isCancelboolЗавершить заказ.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResult

Метод tt.taxi.manager.CancelReservation — Снять бронь с водителя

Снять бронь на предварительный заказ с водителя.

Входные данные

ПараметрТипПримечание
*orderIdint64Ид заказа.
*driverIdint64Ид водителя.

Метод tt.taxi.manager.CreateSubOrder — Создать дочерний заказ

Создает новый заказ, копирует данные из родительского и устанавливает parentId.

Входные данные

ПараметрТипПримечание
*parentIdint64Ид родительского заказа.

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного заказа.

Метод tt.taxi.manager.CreateOrder — Создать заказ

Создать новый заказ
Создание нового заказа. Расчет его рейтинга и стоянки. Отправка оповещения о новом предварительном заказе (если тип заказа - предварительный). Возобновляется процедура распределения заказов.

Входные данные

ПараметрТипПримечание
*dataOrderProtoИнформация о заказе.
*assignOrderAssignProto[]Список назначений.

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного заказа.
*validationResultValidationResultРезультат валидации.

Описание типов данных

Структура OrderAssignProto — Назначение на заказ
ПараметрТипПримечание
*driverIdint64Ид водителя которого нужно назначить.
*automobileClassint64Ид класса машины.

Метод tt.taxi.manager.CreateOrUpdateOrderExt — Создать заказ (Ext)

Входные данные

ПараметрТипПримечание
*dataOrderSaveExtProtoИнформация о заказе.

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного заказа.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetOrders — Список заказов

Получить список заказов.

Входные данные

ПараметрТипПримечание
*paramsGetProto

Выходные данные

ПараметрТипПримечание
*dataOrderListProto[]
*countint64

Метод tt.taxi.manager.SetOrderRoute — Установить маршрут заказа

Установить маршрут (планируемый) для заказа.

Входные данные

ПараметрТипПримечание
*idint64Ид заказа.
*pointsRoutePoint[]Промежуточные точки маршрута.

Метод tt.taxi.manager.SetForcedOrdersSettings — Установить настройки автоназначения

Входные данные

ПараметрТипПримечание
*dataForcedOrdersSettingsНастройки

Метод tt.taxi.manager.UpdateOrderFormSettings — Установить настройки формы заказа

Установить настройки формы заказа.

Входные данные

ПараметрТипПримечание
*serviceIdint64Ид службы.
*dataOrderFormSettingsProtoДанные

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetCallLog — Журнал звонка

Получить журнал событий для звонка.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataCallLogProto[]Журнал событий.
*countint64Общее количество строк.

Метод tt.taxi.manager.GetSmsList — Список СМС

Получить список СМС.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataSmsListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.GetCallList — Список звонков

Получить список звонков.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataCallListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.GetCallAndSmsList — Список звонков и смс одним списком

Получить список звонков и смс.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataCallAndSmsListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.CreateSound — Добавить звук

Добавить новый звук в справочник звуков.

Входные данные

ПараметрТипПримечание
*dataSoundProto

Выходные данные

ПараметрТипПримечание
*idint64Ид новой записи.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetSound — Получить звук

Получить информацию о Звуке из справочника звуков по ID.

Входные данные

ПараметрТипПримечание
*idint64Ид звука.

Выходные данные

ПараметрТипПримечание
*dataSoundProto

Метод tt.taxi.manager.UpdateSound — Редактировать звук

Редактировать справочник звуков.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*dataSoundProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetSounds — Список звуков

Получить список звуков из справочника звуков.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataSoundListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.GetSoundSections — Список разделов звуков

Получить список разделов звуков из справочника.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataSoundSectionProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.DeleteSound — Удалить звуки

Удалить звуки по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateKarmaManual — Добавить параметр кармы назначаемый вручную

Входные данные

ПараметрТипПримечание
*dataKarmaProto

Выходные данные

ПараметрТипПримечание
*idint64Ид нового объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateStaticParam — Добавить статический параметр

Создать новый статический параметр.

Входные данные

ПараметрТипПримечание
*dataStaticParamДанные

Выходные данные

ПараметрТипПримечание
*idint64Ид параметра.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateKarmaDriversCorrection — Корректировка кармы водителя

Добавить нового клиента.

Входные данные

ПараметрТипПримечание
*dataKarmaDriversUpdateProto

Выходные данные

ПараметрТипПримечание
*idint64Ид корректировки.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.CancelActiveKarmaRule — Отменить правило кармы

Входные данные

ПараметрТипПримечание
*driverKarmaIdint64Ид правила кармы водителя.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.ApplyManualKarmaRule — Применить правило кармы вручную

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.
*karmaIdint64Ид правила кармы.
*commentstringКомментарий

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.
*idint64ИД новой записи.

Метод tt.taxi.manager.UpdateKarmaException — Редактировать исключение правил кармы

Входные данные

ПараметрТипПримечание
*idint64Ид
*dataKarmaExceptionBlockProtoДанные

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateKarma — Редактировать параметр кармы водителей

Редактировать параметр кармы водителей.

Входные данные

ПараметрТипПримечание
*idint64Ид дополнения.
*dataKarmaUpdateProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateStaticParam — Редактировать статический параметр

Изменить статический параметр.

Входные данные

ПараметрТипПримечание
*idint64Ид параметра.
*dataStaticParamДанные
*fieldsstring[]Список полей для изменения.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateKarmaException — Создать исключение для правил кармы

Входные данные

ПараметрТипПримечание
*dataKarmaExceptionBlockProto

Выходные данные

ПараметрТипПримечание
*idint64Ид нового объекта.

Метод tt.taxi.manager.CreateKarmaExt — Создать правило кармы

Входные данные

ПараметрТипПримечание
*dataKarmaUpdateProto

Выходные данные

ПараметрТипПримечание
*idint64Ид нового объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetKarmaDriverLog — Список всех правил кармы для водителей

Возвращает список штрафов и бонусов водителей.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.
*driverIdint64Ид водителя.

Выходные данные

ПараметрТипПримечание
*dataKarmaDriversListProto[]Список результатов.
*countint64Общее количество строк для запроса.

Метод tt.taxi.manager.GetKarmaExceptions — Список исключений правил кармы

Входные данные

ПараметрТипПримечание
*tariffIdint64Ид тарифа.

Выходные данные

ПараметрТипПримечание
*dataKarmaExceptionBlockProto[]Список результатов.

Метод tt.taxi.manager.GetKarma — Список параметров кармы водителей

Возвращает список параметров кармы водителей.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataKarmaProto[]Список результатов.
*countint64Общее количество строк для запроса.

Метод tt.taxi.manager.GetKarmaManual — Список параметров кармы водителей назначаемых вручную

Возвращает список параметров кармы водителей.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataKarmaProto[]Список результатов.
*countint64Общее количество строк для запроса.

Метод tt.taxi.manager.GetStaticParams — Список статических параметров

Получение списка существующих статических параметров.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*dataStaticParam[]

Метод tt.taxi.manager.GetKarmaTemplates — Список шаблонов правил кармы

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataKarmaTemplateProto[]Список результатов.
*countint64Общее количество строк для запроса.

Метод tt.taxi.manager.GetKarmaDrivers — Список штрафов и бонусов водителей

Возвращает список штрафов и бонусов водителей.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataKarmaDriversListProto[]Список результатов.
*countint64Общее количество строк для запроса.

Метод tt.taxi.manager.GetKarmaDriverActive — Список штрафов и бонусов водителя

Возвращает список штрафов и бонусов водителей.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.

Выходные данные

ПараметрТипПримечание
*dataKarmaDriversListProto[]Список результатов.
*countint64Общее количество строк для запроса.

Метод tt.taxi.manager.GetStaticParamsForCar — Статические параметры автомобиля

Получение статических параметров для автомобиля.

Входные данные

ПараметрТипПримечание
*idint64Ид автомобиля.

Выходные данные

ПараметрТипПримечание
*paramsStaticParam[]Список параметров.

Метод tt.taxi.manager.GetStaticParamsForDriver — Статические параметры водителя

Получение статических параметров для водителя.

Входные данные

ПараметрТипПримечание
*idint64Ид водителя.

Выходные данные

ПараметрТипПримечание
*paramsStaticParam[]Список параметров.

Метод tt.taxi.manager.DeleteKarmaException — Удалить исключение правил кармы

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.DeleteKarma — Удалить правило кармы

Удалить правило кармы по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.DeleteStaticParam — Удалить статические параметры

Удалить статические параметры по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.SetStaticParamsForCar — Установить статические параметры автомобиля

Установка статических параметров для автомобиля.

Входные данные

ПараметрТипПримечание
*carIdint64Ид автомобиля.
*paramsint64[]Список ид параметров.

Метод tt.taxi.manager.SetStaticParamsForDriver — Установить статические параметры водителя

Установка статических параметров для водителя.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.
*paramsStaticParam[]Список параметров.

Метод tt.taxi.manager.CreateOrUpdateClient — Добавить или изменить клиента

Добавить или изменить клиента.

Входные данные

ПараметрТипПримечание
*idint64Ид клиента для обновления.
*dataClientUpdateProto

Выходные данные

ПараметрТипПримечание
*idint64Ид новой записи, если клиент создан.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateClientBalanceAdjust — Корректировка баланса клиента

Корректировка баланса клиента.

Входные данные

ПараметрТипПримечание
*dataClientBalanceAdjustProtoИнформация о корректировке.

Выходные данные

ПараметрТипПримечание
*idint64Ид новой записи, если корректировка создана.

Метод tt.taxi.manager.GetClientBalance — Получить баланс клиента

Получить баланс клиента по id.

Входные данные

ПараметрТипПримечание
*idint64Ид клиента.
*dateFromint64Дата От.
*dateToint64Дата До.

Выходные данные

ПараметрТипПримечание
*dataClientBalanceProtoИнформация о балансе.

Метод tt.taxi.manager.GetClientBalanceHistory — Получить историю баланса клиента

Получить историю баланса клиента по id.

Входные данные

ПараметрТипПримечание
*idint64ИД клиента.
*paramsGetProtoПараметры запроса.

Выходные данные

ПараметрТипПримечание
*dataClientBalanceHistoryProto[]История баланса.
*countint64Общее количество строк.

Метод tt.taxi.manager.GetClientTripHistory — Получить историю поездок клиента

Получить историю поездок клиента по id.

Входные данные

ПараметрТипПримечание
*idint64ИД клиента.
*paramsGetProtoПараметры запроса.

Выходные данные

ПараметрТипПримечание
*dataClientTripHistory[]Информация о поездках.
*countint64Количество записей.

Описание типов данных

Структура ClientTripHistory — Элемент списка
ПараметрТипПримечание
*orderIdint64ИД заказа.
*statusstringСтатус поездки.
*serviceIdint64ИД службы.
*serviceNamestringИмя службы.
*dateint64Дата
*phonestringТелефон
*fromstringОткуда
*tostringКуда
*discountIdint64ИД дисконтной карты.
*discountNumberstringНомер дисконтной карты.
*costdoubleСтоимость поездки.
*stageIdint64ИД стадии заказа.
*fromIdint64Откуда (Ид адреса)
*toIdint64Куда (Ид адреса)

Метод tt.taxi.manager.GetClient — Получить клиента

Получить клиента по id.

Входные данные

ПараметрТипПримечание
*idint64

Выходные данные

ПараметрТипПримечание
*dataClientCardProto

Метод tt.taxi.manager.GetClientByPhone — Получить клиента по номеру телефона

Получить клиента по номеру телефона.

Входные данные

ПараметрТипПримечание
*phonestringНомер телефона клиента.
*serviceIdint64Ид службы для поиска (пусто - выдаем первого попавшегося)

Выходные данные

ПараметрТипПримечание
*dataClientCardProtoИнформация о клиенте.

Метод tt.taxi.manager.GetClientTotal — Получить сводку по клиенту

Получить сводку клиента по id.

Входные данные

ПараметрТипПримечание
*idint64ИД клиента.

Выходные данные

ПараметрТипПримечание
*dataClientTotalsProtoСводка по клиенту.

Метод tt.taxi.manager.GetClientBalanceOpTypes — Получить типы операций над балансом

получить типы операций над балансом.

Входные данные

ПараметрТипПримечание
*idint64Пустой аргумент.

Выходные данные

ПараметрТипПримечание
*dataClientOpTypeProto[]Типы операций.

Метод tt.taxi.manager.ClientContractStopWork — Прекрартить работу договорного клиента

прекрартить работу договорного клиента по id.

Входные данные

ПараметрТипПримечание
*idint64

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateClient — Редактировать клиента

Редактировать данные клиента.

Входные данные

ПараметрТипПримечание
*idint64Ид клиента.
*dataClientUpdateProtoДанные
*fieldsstring[]Список полей для изменения.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetClientList — Список клиентов

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataClientCardProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.GetClientLastOrders — Список последних заказов

Получить список последних адресов заказов клиента.

Входные данные

ПараметрТипПримечание
*clientIdint64
*limitint32

Выходные данные

ПараметрТипПримечание
*dataPlaceProto[]

Метод tt.taxi.manager.GetClientPopularOrders — Список частых заказов

Получить список наиболее частых адресов заказов клиента.

Входные данные

ПараметрТипПримечание
*clientIdint64
*limitint32

Выходные данные

ПараметрТипПримечание
*dataPlaceProto[]

Метод tt.taxi.manager.DeleteClient — Удалить клиента

Удалить клиента по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateCarClass — Добавить класс машины

Добавить новый класс машины.

Входные данные

ПараметрТипПримечание
*dataCarClassProto

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateCarClass — Редактировать класс машины

Редактировать класс автомобиля.

Входные данные

ПараметрТипПримечание
*idint64
*dataCarClassProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResult

Метод tt.taxi.manager.GetCarClasses — Список классов машин

Получить возможные классы автомобилей.

Входные данные

ПараметрТипПримечание
*paramsGetProto

Выходные данные

ПараметрТипПримечание
*dataCarClassProto[]
*countint64

Метод tt.taxi.manager.DeleteCarClass — Удалить классы машин

Удалить классы машин по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateCarModel — Добавить марку машины

Добавить новую марку машины.

Входные данные

ПараметрТипПримечание
*dataCarModelProto

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateCarModel — Редактировать марку машины

Редактировать марку автомобиля.

Входные данные

ПараметрТипПримечание
*idint64
*dataCarModelProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResult

Метод tt.taxi.manager.GetCarModels — Список марок машин

Получить возможные марки автомобилей.

Входные данные

ПараметрТипПримечание
*paramsGetProto

Выходные данные

ПараметрТипПримечание
*dataCarModelProto[]
*countint64

Метод tt.taxi.manager.DeleteCarModel — Удалить марки машин

Удалить модели машин по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateCarColor — Добавить цвет машины

Добавить новый цвет машины.

Входные данные

ПараметрТипПримечание
*dataCarColorProto

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateCarColor — Редактировать цвет машины

Редактировать цвет автомобиля.

Входные данные

ПараметрТипПримечание
*idint64
*dataCarColorProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResult

Метод tt.taxi.manager.GetCarColors — Список цветов машин

Получить возможные цвета автомобиля.

Входные данные

ПараметрТипПримечание
*paramsGetProto

Выходные данные

ПараметрТипПримечание
*dataCarColorProto[]
*countint64

Метод tt.taxi.manager.DeleteCarColor — Удалить цвета машин

Удалить цвета машин по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateCar — Добавить машину

Создать новый автомобиль.

Входные данные

ПараметрТипПримечание
*dataCarProtoДанные о машине.
*staticParamsint64[]Статические параметры (оснащение)

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateCar — Редактировать машину

Обновить данные автомобиля.

Входные данные

ПараметрТипПримечание
*idint64
*dataCarProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetCars — Список машин

Получить список автомобилей.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataCarListProto[]Список объектов.
*countint64Количество объектов.

Метод tt.taxi.manager.CreateMedia — Добавить медиа ресурс

Создать медиа-ресурс.

Входные данные

ПараметрТипПримечание
*dataMediaProto

Выходные данные

ПараметрТипПримечание
*idint64Ид нового объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetMedia — Получить медиа ресурс

Получить карточку медиа-ресурса по id.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.

Выходные данные

ПараметрТипПримечание
*dataMediaProtoДанные

Метод tt.taxi.manager.UpdateMedia — Редактировать медиа ресурс

Редактировать медиа-ресурс.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*dataMediaProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetMediaList — Список медиа ресурсов

Получить список медиа-ресурсов.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataMediaProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.DeleteMedia — Удалить медиа ресурсы

Удалить медиа-ресурсы по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.SetClientAppVersion — Установить версию МП

Установить версию мобильного приложения.

Входные данные

ПараметрТипПримечание
*lastClientAppVersionCodeint32Код (целое число) последней доступной версии клиента, соответствующий android:versionCode в манифесте приложения.
*lastClientAppUrlstringАдрес для загрузки последней версии клиента.

Метод tt.taxi.manager.CorrectStats

Входные данные

ПараметрТипПримечание
*startDatestringНачало интервала.
*endDatestringКонец интервала.
*addOrdersCountPerDayint64Сколько заказов добавить в каждый день.
*successPercentdoubleНужная исполняемость.
*timeZoneOffsetint64Смещение часоого пояса.
*tariffIdint64Тариф
*orderCostMinint64Примерная стоимость заказа (min)
*orderCostMaxint64Примерная стоимость заказа (max)
*doChangesbool
*driverIdint64
*addOrdersCoefdoubleСколько заказов добавить в каждый день (коэффициент)

Метод tt.taxi.manager.GetServiceOrdersExchange — Получить настройки обмена заказами

Получить настройки обмена заказами для службы.

Входные данные

ПараметрТипПримечание
*serviceIdint64Ид службы.

Выходные данные

ПараметрТипПримечание
*toAllboolЕсли true, то отдавать всем службам.
*toint64[]Ид служб, которым нужно отдавать заказы.
*fromAllboolЕсли true, то принимать у всех служб.
*fromint64[]Ид служб, у которых нужно брать заказы.
*changeDriverTariffboolЕсли true, заменять тариф водителя.
*tariffPerOrderIdint64Ид тарифа при оплате за заказ.
*tariffUnlimitedIdint64Ид тарифа при периодическом списании.

Метод tt.taxi.manager.GetServiceOrdersExchangeList — Список

Получить список настроек обмена заказами.

Входные данные

ПараметрТипПримечание
*paramsGetProto

Выходные данные

ПараметрТипПримечание
*dataServiceExchangeListProto[]
*countint64

Описание типов данных

Структура ServiceExchangeListProto — Настройки обмена заказами - список
ПараметрТипПримечание
*idint64Ид службы.
*namestringНазвание службы.
*fromServicesstringСписок служб "брать заказы"
*toServicesstringСписок служб "отдавать заказы"

Метод tt.taxi.manager.SetServiceOrdersExchange — Установить настройки обмена заказами

Установить настройки обмена заказами для службы.

Входные данные

ПараметрТипПримечание
*serviceIdint64Ид службы.
*toAllboolЕсли true, то отдавать всем службам.
*toint64[]Ид служб, которым нужно отдавать заказы.
*fromAllboolЕсли true, то принимать у всех служб.
*fromint64[]Ид служб, у которых нужно брать заказы.
*changeDriverTariffboolЕсли true, заменять тариф водителя.
*tariffPerOrderIdint64Ид тарифа при оплате за заказ.
*tariffUnlimitedIdint64Ид тарифа при периодическом списании.

tt.taxi.manager.CreateOrganization — Добавить организацию

Добавить новую организацию.

Структура CreateCustomerOrganizationRqProto
ПараметрТипПримечание
*dataCustomerOrganizationUpdateProto
Структура CreateCustomerOrganizationRsProto
ПараметрТипПримечание
*idint64Ид нового клиента.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetOrganization — Получить органзацию по ID

Получить органзацию по ID.

Входные данные

ПараметрТипПримечание
*idint64Ид организации.

Выходные данные

ПараметрТипПримечание
*dataCustomerOrganizationViewProto

tt.taxi.manager.GetOrganizations — Получить список организаций

Возвращает список всех организаций.

Структура GetCustomerOrganizationRqProto
ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.
Структура GetCustomerOrganizationRsProto
ПараметрТипПримечание
*dataCustomerOrganizationViewProto[]Список результатов.
*countint64Общее количество строк для запроса.

tt.taxi.manager.UpdateOrganization — Редактирование организации

Редактировать данные организации.

Структура UpdateCustomerOrganizationRqProto
ПараметрТипПримечание
*idint64Ид организации.
*dataCustomerOrganizationUpdateProtoДанные
*fieldsstring[]Список полей для изменения.
Структура UpdateCustomerOrganizationRsProto
ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

tt.taxi.manager.DeleteOrganization — Удалить организацию

Удалить организацию по id.

Структура DeleteCustomerOrganizationRqProto
ПараметрТипПримечание
*idint64[]Список id для удаления.
Структура DeleteCustomerOrganizationRsProto
ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.CreatePlat — Добавить платежную систему

import "tt.taxi.common.desc.Validation.proto";

Входные данные

ПараметрТипПримечание
*dataPlatProto

Выходные данные

ПараметрТипПримечание
*idint64Ид новой записи.

Добавить новую платежную систему.


Метод tt.taxi.manager.GetPlat — Получить платежную систему

Получить карточку платежной системы.

Входные данные

ПараметрТипПримечание
*idint64Ид платежной системы.

Выходные данные

ПараметрТипПримечание
*dataPlatProto

Метод tt.taxi.manager.UpdatePlat — Редактировать платежную систему

Изменить платежную систему.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*dataPlatProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetPlats — Список платежных систем

Получить список платежных систем.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataPlatListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.DeletePlat — Удалить платежные системы

Удалить настройки платежных систем по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateGroup — Добавить группу

Добавить группу пользователей.

Входные данные

ПараметрТипПримечание
*dataGroupProto

Выходные данные

ПараметрТипПримечание
*idint64Ид нового объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetGroup — Получить группу

Получить группу пользователей.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.

Выходные данные

ПараметрТипПримечание
*dataGroupProtoДанные

Метод tt.taxi.manager.UpdateGroup — Редактировать группу

Редактировать группу пользователей.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*dataGroupProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetGroups — Список групп

Получить список групп пользователей.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataGroupListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.DeleteGroup — Удалить группу

Удалить группу пользователей.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.GetServiceConnectionsList — Список подключений

Получить список подключений пользователей к службам.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataServiceConnectionsListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.SetServiceConnections — Установить подключения

Установить подключения пользователей к службе.

Входные данные

ПараметрТипПримечание
*serviceIdint64Ид службы.
*userIdsint64[]Ид пользователей.

Метод tt.core.user.GetRole — Получить роль

Получить роль по ид.

Входные данные

ПараметрТипПримечание
*idint64Ид роли.

Выходные данные

ПараметрТипПримечание
*dataRoleProtoРоль

Метод tt.core.user.UpdateRole — Редактировать роль

Редактировать роль в системе.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*dataRoleProtoДанные
*fieldsstring[]Список полей для изменения.

Метод tt.core.user.CreateRole — Создать роль

Добавить новую роль в систему.

Входные данные

ПараметрТипПримечание
*dataRoleProtoРоль

Выходные данные

ПараметрТипПримечание
*idint64Ид новой роли.
*validationResultValidationResultРезультат валидации.

Метод tt.core.user.GetRoles — Список ролей

Получить список ролей.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataRoleListProto[]Список
*countint64Общее количество строк.

Метод tt.core.user.DeleteRole — Удалить роль

Удалить роль.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateUserAccount — Добавить пользователя

Добавить нового пользователя.

Входные данные

ПараметрТипПримечание
*dataAccountProto
*sendEmailboolОтправлять ли данные на почту.

Выходные данные

ПараметрТипПримечание
*idint64Ид нового пользователя.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetUserSettings — Получить настройки пользователя

Получить пользовательские настройки в виде JSON.

Входные данные

ПараметрТипПримечание
*keystringНазвание группы настроек.

Выходные данные

ПараметрТипПримечание
*datastringНастройки в виде JSON.

Метод tt.taxi.manager.GetUserAccount — Получить пользовательский аккаунт

Получить аккаунт пользователя по id.

Входные данные

ПараметрТипПримечание
*idint64

Выходные данные

ПараметрТипПримечание
*dataAccountProto

Метод tt.taxi.manager.UpdateUserAccount — Редактировать пользовательский аккаунт

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

Входные данные

ПараметрТипПримечание
*idint64
*dataAccountProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.SetUserSettings — Сохранить настройки пользователя

Сохранить пользовательские настройки в виде JSON.

Входные данные

ПараметрТипПримечание
*keystringНазвание группы настроек.
*datastringНастройки в виде JSON.

Метод tt.taxi.manager.GetUserAccounts — Список аккаунтов

Получить список аккаунтов в системе.

Входные данные

ПараметрТипПримечание
*paramsGetProto

Выходные данные

ПараметрТипПримечание
*dataAccountListProto[]
*countint64

Метод tt.taxi.manager.GetServiceConnections — Список подключений

Получить список подключенных пользователей по Ид службы.

Входные данные

ПараметрТипПримечание
*idint64Id службы.

Выходные данные

ПараметрТипПримечание
*dataConnectionsListProtoСписок ИД пользователей.

Метод tt.taxi.manager.GetUsersWithPermissions — Список пользователей с привилегиями

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

Входные данные

ПараметрТипПримечание
*permissionCodesstring[]Коды привилегий.

Выходные данные

ПараметрТипПримечание
*usersAccountProto[]Список пользователей.

Метод tt.core.user.GetResources — Список ресурсов

Получить список ресурсов в системе (на которые можно назначить права)

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*resourcesResourceProto[]Список ресурсов.

Описание типов данных

Структура ResourceProto — Описание ресурса
ПараметрТипПримечание
*idint64Id ресурса.
*namestringНазвание ресурса.
*categorystringКатегория ресурса.
*permissionsPermissionProto[]Действия с ресурсом.
Структура PermissionProto — Описание разрешения
ПараметрТипПримечание
*idint64Id разрешения.
*namestringНазвание разрешения.
*codestringКод разрешения.

Метод tt.taxi.manager.CreateRuleset — Добавить распределение

Добавить новые настройки распределения.

Входные данные

ПараметрТипПримечание
*dataRulesetProto

Выходные данные

ПараметрТипПримечание
*idint64Ид нового распределения.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetRuleDescriptions — Описание правил

Получение описания правил для распределения.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*dataRuleDescriptionProto[]Список правил.

Описание типов данных

Структура RuleDescriptionProto
ПараметрТипПримечание
*namestringКод параметра.
*titlestringНазвание параметра.
*notestringОписание параметра.
*canChangeWeightboolМожно или нет поменять вес.

Метод tt.taxi.manager.GetRulesetById — Получить распределение

Получить настройки распределения заказов по id.

Входные данные

ПараметрТипПримечание
*idint64

Выходные данные

ПараметрТипПримечание
*dataRulesetProto

Метод tt.taxi.manager.UpdateRuleset — Редактировать распределение

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

Входные данные

ПараметрТипПримечание
*idint64
*dataRulesetProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetRulesets — Список настроек распределения

Получить список настроек распределения.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataRulesetListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.GetRules — Список правил

Получение правил для распределения.

Входные данные

ПараметрТипПримечание
*rulesetIdint64Ид распределения. Если не передан, то возвращается только правило со статическим рейтингом.

Выходные данные

ПараметрТипПримечание
*dataRuleProto[]Список правил.

Метод tt.taxi.manager.DeleteRuleset — Удалить настройки распределения

Удалить настройки распределения по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.SetRules — Установить список правил

Установка правил для распределения.

Входные данные

ПараметрТипПримечание
*rulesetIdint64Ид распределения.
*dataRuleProto[]Список правил.

Метод tt.taxi.manager.ArchiveWorkMode — Архивировать режимы работы

Архивировать режимы работы по списку id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для архивирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateWorkMode — Изменить режим работы

Изменение режима работы.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*dataWorkModeProtoДанные

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetWorkMode — Получить режим работы

Получить режим работы по ID.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.

Выходные данные

ПараметрТипПримечание
*dataWorkModeProtoДанные

Метод tt.taxi.manager.GetWorkModeList — Получить список режимов работы

Получить список режимов работы.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataWorkModeListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.CreateWorkMode — Создать режим работы

Создание режима работы.

Входные данные

ПараметрТипПримечание
*dataWorkModeProto

Выходные данные

ПараметрТипПримечание
*idint64Ид нового объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.DeleteWorkMode — Удалить режим работы

Удалить режим работы по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.ArchiveService — Архивировать службы

Архивировать службы по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для архивации.

Метод tt.taxi.manager.CreateService — Добавить службу

Добавить новую службу.

Входные данные

ПараметрТипПримечание
*dataServiceProto

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetService — Получить службу

Получить службу по id.

Входные данные

ПараметрТипПримечание
*idint64

Выходные данные

ПараметрТипПримечание
*dataServiceProto

Метод tt.taxi.manager.GetServiceWM — Получить службу с учетом режима работы

Получить службу по id.

Входные данные

ПараметрТипПримечание
*idint64

Выходные данные

ПараметрТипПримечание
*dataServiceProto

Метод tt.taxi.manager.UpdateService — Редактировать службу

Редактировать службу.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*dataServiceProtoДанные
*fieldsstring[]Список полей для изменения.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetServicesList — Список служб

Получить список служб.

Входные данные

ПараметрТипПримечание
*paramsGetProto

Выходные данные

ПараметрТипПримечание
*dataServiceListProto[]
*countint64

Метод tt.taxi.manager.DeleteService — Удалить службы

Удалить службы по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.ArchiveShift — Архивировать смены

Архивировать смены по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для архивации.

Метод tt.taxi.manager.GetShiftsChart — График смен

Получить график смен.

Входные данные

ПараметрТипПримечание
*dayOfWeekint32День недели (0 - воскресенье, 1 - пн, 6 - сб)
*serviceIdint64Опциональный фильтр по службе.

Выходные данные

ПараметрТипПримечание
*dataShiftChartProto[]Данные по службам.

Описание типов данных

Структура ShiftChartProto — Данные о смене для построения графика
ПараметрТипПримечание
*idint64Id
*namestringНазвание смены.
*timesShiftTimeProto[]Расписание смены.
*driversint32Количество водителей на смене.

Метод tt.taxi.manager.CreateShift — Добавить смену

Создать новую смену.

Входные данные

ПараметрТипПримечание
*dataShiftProto

Метод tt.taxi.manager.SetShiftDrivers — Назначить смену водителям

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

Входные данные

ПараметрТипПримечание
*shiftIdint64Id смены.
*driverIdint64[]Список id водителей.

Метод tt.taxi.manager.DriverIdsByCallsigns — Получить водителей по позывным

Входные данные

ПараметрТипПримечание
*callsignsstring[]Список позывных.

Выходные данные

ПараметрТипПримечание
*idsint64[]Список ИД водителей.

Метод tt.taxi.manager.GetShift — Получить смену

Получить смену по id.

Входные данные

ПараметрТипПримечание
*idint64Ид смены.

Выходные данные

ПараметрТипПримечание
*dataShiftProtoСмена

Метод tt.taxi.manager.UpdateShift — Редактировать смену

Редактировать смену.

Входные данные

ПараметрТипПримечание
*idint64
*dataShiftProto
*fieldsstring[]

Метод tt.taxi.manager.GetShiftDrivers — Список водителей на смене

Получить список водителей, которым назначена смена.

Входные данные

ПараметрТипПримечание
*shiftIdint64Id смены.
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*countint64Количество результатов.
*dataDriverListViewProto[]Список водителей.

Метод tt.taxi.manager.GetShifts — Список смен

Получить список смен.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры запроса.

Выходные данные

ПараметрТипПримечание
*dataShiftListProto[]Данные
*countint64Количество найденных объектов.

Метод tt.taxi.manager.DeleteShift — Удалить смены

Удалить смены по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.GetSystemEventTypes — Получить список типов событий системы

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataSystemEventTypeProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.CreateParkingPoint — Добавить стоянку

Добавление новой стоянки.

Входные данные

ПараметрТипПримечание
*dataParkingPointProtoСтоянка

Выходные данные

ПараметрТипПримечание
*idint64Id новой стоянки.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetParkingPoint — Получить стоянку

Получить стоянку по id.

Входные данные

ПараметрТипПримечание
*idint64Id стоянки.

Выходные данные

ПараметрТипПримечание
*dataParkingPointProtoРезультат

Метод tt.taxi.manager.UpdateParkingPoint — Редактировать стоянку

Изменение данных о стоянке.

Входные данные

ПараметрТипПримечание
*idint64
*dataParkingPointProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResult

Метод tt.taxi.manager.GetAdjacentParkingPoints — Список смежных стоянок

Получить список ид стоянок, смежных с новой стоянкой.

Входные данные

ПараметрТипПримечание
*cityIdint64Ид города.
*borderGeoPolygonProtoГраницы стоянки.

Выходные данные

ПараметрТипПримечание
*idint64[]Список ид стоянок, смежных с заданной.

Метод tt.taxi.manager.GetParkingPoints — Список стоянок

Получить список стоянок.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataParkingPointListProto[]Список стоянок.
*countint64Общее кол-во строк.

Метод tt.taxi.manager.DeleteParkingPoint — Удалить стоянки

Удалить стоянки по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.ArchiveDriverTariff — Архивировать тарифы водителя

Архивировать тарифы водителя по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для архивации.

Метод tt.taxi.manager.CreateTariffChange — Добавить задачу по смене тарифа

Добавить новую задачу по смене тарифа.

Входные данные

ПараметрТипПримечание
*dataTariffChangeProto

Выходные данные

ПараметрТипПримечание
*idint64Ид новой задачи.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateDriverTariff — Добавить тариф водителя

Создать новый тариф водителя.

Входные данные

ПараметрТипПримечание
*dataDriverTariffProtoОписание тарифа.

Выходные данные

ПараметрТипПримечание
*idint64Ид созданного тарифа.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetDriverTariff — Получить тариф водителя

Получить тариф водителя.

Входные данные

ПараметрТипПримечание
*idint64Ид тарифа.

Выходные данные

ПараметрТипПримечание
*dataDriverTariffProtoИнформация о тарифе.
*isUsedboolНазначался ли тариф водителям.

Метод tt.taxi.manager.GetTariffChanges — Расписание задач на смену тарифов

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

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataTariffChangeListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.UpdateTariffChange — Редактировать задачу по смене тарифа

Редактировать задачу по смене тарифа.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*dataTariffChangeProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateDriverTariff — Редактировать тариф водителя

Редактировать тариф водителя.

Входные данные

ПараметрТипПримечание
*idint64
*dataDriverTariffProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResult

Метод tt.taxi.manager.GetDriverTariffsList — Список тарифов водителя

Получить список тарифов водителей.

Входные данные

ПараметрТипПримечание
*paramsGetProto

Выходные данные

ПараметрТипПримечание
*dataDriverTariffListViewProto[]
*countint64

Метод tt.taxi.manager.DeleteTariffChange — Удалить задачу по смене тарифов

Удалить задачи по смене тарифов по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.ArchiveExtraPayment — Архивировать дополнения

Архивировать дополнения к клиентским тарифам по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для архивации.

Метод tt.taxi.manager.ArchiveClientTariff — Архивировать тарифы клиента

Архивировать клиентские тарифы по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для архивации.

Метод tt.taxi.manager.CreateExtraPayment — Добавить дополнение

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

Входные данные

ПараметрТипПримечание
*dataExtraPaymentProtoДополнение

Выходные данные

ПараметрТипПримечание
*idint64Id созданного объекта.

Метод tt.taxi.manager.CreateClientTariff — Добавить тариф клиента

Создание нового тарифа.

Входные данные

ПараметрТипПримечание
*dataClientTariffExtProtoДескриптор тарифа.

Выходные данные

ПараметрТипПримечание
*idint64Id созданного объекта.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetExtraPayment — Получить дополнение

Получить дополнение к тарифу клиента по ид.

Входные данные

ПараметрТипПримечание
*idint64Ид дополнения.

Выходные данные

ПараметрТипПримечание
*dataExtraPaymentProto

Метод tt.taxi.manager.GetClientTariff — Получить тариф клиента

Получить тариф клиента по ид.

Входные данные

ПараметрТипПримечание
*idint64Ид тарифа.

Выходные данные

ПараметрТипПримечание
*dataClientTariffExtProto
*isUsedboolИспользовался ли тариф.

Метод tt.taxi.manager.UpdateExtraPayment — Редактировать дополнение

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

Входные данные

ПараметрТипПримечание
*idint64Ид дополнения.
*dataExtraPaymentProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateClientTariff — Редактировать тариф клиента

Редактировать клиентский тариф.

Входные данные

ПараметрТипПримечание
*idint64Ид тарифа.
*dataClientTariffExtProtoДанные
*fieldsstring[]Список полей для изменения.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetExtraPayments — Список дополнений

Возвращает список дополнений к клиентским тарифам
Для получения актуального списка дополнений по службе, необходимо добавить в фильтр GetProto: serviceIds any (?), isActual=true.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataExtraPaymentListProto[]Список результатов.
*countint64Общее количество строк для запроса.

Метод tt.taxi.manager.GetClientTariffs — Список тарифов клиента

Возвращает список клиентских тарифов.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataClientTariffListProto[]Список результатов.
*countint64Общее количество строк для запроса.

Метод tt.taxi.manager.AlarmCancel — Отмена тревоги

Отменить тревогу по ИД.

Входные данные

ПараметрТипПримечание
*idint64ИД тревоги.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.CreateNotification — Добавить уведомление

Добавить новое уведомление.

Входные данные

ПараметрТипПримечание
*dataNotificationProto

Выходные данные

ПараметрТипПримечание
*idint64Ид нового уведомления.
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.SendTestSMS — Отправить тестовое SMS

Отправить тестовое SMS.

Входные данные

ПараметрТипПримечание
*numberstringНомер телефона для отправки SMS.
*textstringТекст SMS.

Метод tt.taxi.manager.GetNotificationSettings — Получить настройки уведомлений

Получить настройки уведомлений.

Входные данные

ПараметрТипПримечание
*serviceIdint64Ид службы.

Выходные данные

ПараметрТипПримечание
*dataNotificationSettingsProtoДанные

Метод tt.taxi.manager.GetNotification — Получить уведомление

Получить уведомление по ид.

Входные данные

ПараметрТипПримечание
*idint64Ид уведомления.

Выходные данные

ПараметрТипПримечание
*dataNotificationProtoРезультат

Метод tt.taxi.manager.UpdateNotification — Редактировать уведомление

Редактировать уведомление.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*dataNotificationProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.manager.GetNotificationSettingsList — Список настроек уведомлений

Получить список настроек уведомлений.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataNotificationSettingsListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.GetNotificationEvents — Список событий

Получить список событий для уведомлений.

Входные данные

ПараметрТипПримечание
*emptyint32Нет параметров.

Выходные данные

ПараметрТипПримечание
*dataNotificationEventProto[]Список событий.

Метод tt.taxi.manager.GetNotifications — Список уведомлений

Получить список уведомлений.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataNotificationListProto[]Список
*countint64Общее количество строк.

Метод tt.taxi.manager.GetSmsTemplates — Список шаблонов

Получить список шаблонов в SMS.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataSmsTemplateProto[]Список объектов.
*countint64Количество объектов.

Метод tt.taxi.manager.DeleteNotification — Удалить уведомления

Удалить уведомления по id.

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.manager.UpdateNotificationSettings — Установить настройки уведомлений

Установить настройки уведомлений.

Входные данные

ПараметрТипПримечание
*serviceIdint64Ид службы.
*dataNotificationSettingsProtoДанные
*fieldsstring[]Список полей для редактирования.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.taxi.operator.RespondToPhoto — Ответ на фото

Утверждение или отказ в выходе на смену водителю по фото автомобиля.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.
*approvedboolУтверждено или отказ.
*messagestringСообщение для водителя.

Описание типов данных

Структура RespondToPhotoPushProto — Push-уведомление об утверждении или отказе в выходе на смену
ПараметрТипПримечание
*approvedboolУтверждено или отказ.
*messagestringСообщение для водителя.

Метод tt.taxi.operator.GetDriverPhoto — Получить фото машины

Получение фото машины водителя по ид водителя.

Входные данные

ПараметрТипПримечание
*driverIdint64Ид водителя.

Выходные данные

ПараметрТипПримечание
*photoDriverPhotoProtoПоследнее фото машины водителя.
*dateint64Дата, когда было сделано фото.

Метод tt.taxi.manager.LoadCorrectionFile — Загрузить реестр корректировок

Получить список городов.

Входные данные

ПараметрТипПримечание
*idint32ID
*saveboolЕсли true, корректировки записываются в БД, иначе просто выводятся.

Выходные данные

ПараметрТипПримечание
*dataCorrectionFile[]Список
*countint64Общее количество строк.
*goodCountint64Количество строк, готовых к загрузке.
*badCountint64Количество строк, не прошедших проверку.

Метод tt.taxi.manager.GetAlarm — Получить информацию о тревоге

Получить информацию о тревоге по ИД.

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.

Выходные данные

ПараметрТипПримечание
*dataAlarmProtoДанные

Метод tt.core.user.Unsubscribe — Отписаться от уведомлений

Отписаться от уведомлений.

Входные данные

ПараметрТипПримечание
*eventstringТип уведомлений.

Метод tt.core.user.Subscribe — Подписаться на уведомления

Подписаться на уведомления.

Входные данные

ПараметрТипПримечание
*eventstringТип уведомлений.

Метод tt.core.user.CheckIsActionAllowed — Проверить доступность операции

Проверить доступность операции.

Входные данные

ПараметрТипПримечание
*actionCodestringКод операции.

Выходные данные

ПараметрТипПримечание
*isAllowedboolДоступность операции.
*reasonstringПричина отказа.

tt.taxi.reports.Drivers — Водители

Отчет по водителям.

Структура DriversReportRqProto
ПараметрТипПримечание
*dateFromint64С
*dateToint64По
*serviceIdint64Служба в которой ищем, если не указана то во всех.
*pagingPagingProtoПагинация
*orderingOrderingProtoСортировка
*filterFilterAndProtoФильтр
*isWorkingbool
Структура DriversReportRsProto
ПараметрТипПримечание
*dataReportDriversProto[]Таблица отчета.
*countint64Количество записей (всего)
Структура ReportDriversProto
ПараметрТипПримечание
*idint64Ид водителя.
*namestringФИО водителя.
*callsignstringПозывной
*serviceNamestringНазвание службы.
*ridesCountint64Поездок за период.
*financePlusdoubleНачислено за период (руб)
*financeMinusdoubleСписано за период (руб)
*carmaChangedoubleИзменение кармы за период.
*rejectsCountint64Предложений за период.
*offersCountint64Отказов от предложений за период.
*failsCountint64Отказов от заказов за период.
*failsPercentdoubleПроцент отказов за период.
*successPercentdoubleПроцент успешных заказов.
*carstringАвтомобиль

tt.taxi.reports.Discounts — Дисконтные карты

Отчет по дискотным картам.

Структура DiscountReportRqProto
ПараметрТипПримечание
*dateFromint64С
*dateToint64По
*searchStringstringСтрока поиска.
*serviceIdint64Служба в которой ищем, если не указана то во всех.
*pagingPagingProtoПагинация
*orderingOrderingProtoСортировка
Структура DiscountReportRsProto
ПараметрТипПримечание
*dataReportDiscountProto[]Таблица отчета.
*countint64Количество записей (всего)
Структура ReportDiscountProto
ПараметрТипПримечание
*cardIdint64Ид карты.
*namestringНазвание карты/акции.
*cardNumstringНомер карты.
*serviceNamestring[]Название службы.
*tripCountint64Поездок по карте.
*clientCountint64Клиентов проехало по карте.
*servicesStringstringСписок служб одной строкой.

tt.taxi.reports.DiscountsDetails — Дисконтные карты (Детализация)

Отчет по дискотным картам (Детализация)

Структура DiscountDetailReportRqProto
ПараметрТипПримечание
*dateFromint64С
*dateToint64По
*discountIdint64ИД дискотной карты.
*serviceIdint64Служба в которой ищем, если не указана то во всех.
*pagingPagingProtoПагинация
Структура DiscountDetailReportRsProto
ПараметрТипПримечание
*dataReportDiscountDetailОтчет
*countint64Количество записей (всего)
Структура ReportDiscountDetail
ПараметрТипПримечание
*cardIdint64Ид карты.
*namestringНазвание карты/акции.
*cardNumstringНомер карты.
*clientsReportDiscountClients[]Клиенты
*servicesstring[]Имена служб.
Структура ReportDiscountClients
ПараметрТипПримечание
*clientsIdsint64[]Ид клиентов.
*clientsNamesstring[]ФИО клиентов или названия организаций.
*phonestringТелефон с которого ездил клиент по этой карте.
*clientTripsint64Поездок по телефону.

Метод tt.taxi.reports.OrdersByTime — Заказы по времени

Отчет "Заказы по времени"

Входные данные

ПараметрТипПримечание
*beginstringВременной период - дата "от"
*endstringВременной период - дата "до"
*serviceIdint64Ид службы (если не передано, то все службы)
*timePeriodTimePeriodПериод, по которому идет группировка (по умолчанию - день)

Выходные данные

ПараметрТипПримечание
*dataOrdersByTimeDataProto[]Список результатов.

Описание типов данных

Перечисление TimePeriod — Период, по которому идет группировка
НазваниеЗначениеПримечание
*DAY1День
*WEEK2Неделя
*MONTH3Месяц
*HOUR4Час
Структура OrdersByTimeDataProto — Элемент отчета "Заказы по времени"
ПараметрТипПримечание
*dateint64Дата
*allOrdersint64Всего заказов.
*successOrdersint64Успешных заказов.
*driversOnlineint64Водителей онлайн.
*tzstringВременная зона отчета.

tt.taxi.reports.Clients — Клиенты

Отчет по клиентам.

Структура ClientReportRqProto
ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.
*dateFromint64С
*dateToint64По
*serviceIdint64Служба
Структура ClientReportRsProto
ПараметрТипПримечание
*dataClientReportProto[]Список клиентов.
*countint64Количество записей.
Структура ClientReportProto — Элемент таблицы отчета по клиентам
ПараметрТипПримечание
*idint64Ид клиента.
*fiostringФИО клиента / имя юр. лица.
*phonesstringТелефоны клиента.
*contractIdint64Номер договора.
*balancedoubleБаланс клиента.
*isLegalboolЮр. лицо.
*isContractboolПо контракту.
*ordersCountint64Количество поездок.
*ordersAvgCostdoubleСредняя стоимость поездки.
*summdoubleСумма
*servicesIdsint64[]ИД служб.
*servicesNamesstringИмена служб.
*balanceOnStartdoubleБаланс клиента на начало периода.
*balanceOnEnddoubleБаланс клиента на конец периода.

Метод tt.taxi.reports.Media — Медиа ресурсы

Отчет "Медиа-ресурсы"

Входные данные

ПараметрТипПримечание
*beginint64Начало отчетного периода.
*endint64Конец отчетного периода.
*mediaIdint64Ид ресурса.
*zeroesboolПоказать нулевых.

Выходные данные

ПараметрТипПримечание
*dataMediaDataProto[]Таблица

Описание типов данных

Структура MediaDataProto — Элемент таблицы отчета "Медиа-ресурсы"
ПараметрТипПримечание
*mediaIdint64Ид ресурса.
*mediaNamestringНазвание ресурса.
*monthint64Месяц
*hiredDriversint64Привлеченные водители.
*payingDriversint64Платящие водители.
*workingDriversint64Выполнившие больше 10 заказов.

Метод tt.taxi.reports.MediaDrivers — Водители

Отчет "Медиа-ресурсы" - получить информацию по водителям.

Входные данные

ПараметрТипПримечание
*beginint64Начало отчетного периода.
*endint64Конец отчетного периода.
*mediaIdint64Ид ресурса.

Выходные данные

ПараметрТипПримечание
*dataMediaDriversDataProto[]Таблица

Описание типов данных

Структура MediaDriversDataProto — Элемент отчета "Медиа-ресурсы" - данные по водителям
ПараметрТипПримечание
*driverIdint64Ид водителя.
*callsignstringПозывной водителя.
*driverLastNamestringФамилия водителя.
*driverFirstNamestringИмя водителя.
*driverMiddleNamestringОтчество водителя.
*managerIdint64Ид менеджера.
*managerLastNamestringФамилия менеджера.
*managerFirstNamestringИмя менеджера.
*managerMiddleNamestringОтчество менеджера.
*monthint64Дата (округлена до месяца)
*incomedoubleНачисления (руб)
*ordersint64Выполнено заказов.

Метод tt.taxi.reports.ManagerReport — Менеджеры

Отчет "Менеджеры"

Входные данные

ПараметрТипПримечание
*beginint64Начало отчетного периода.
*endint64Конец отчетного периода.
*managerIdint64Ид менеджера.
*zeroesboolПоказать нулевых.

Выходные данные

ПараметрТипПримечание
*dataManagerReportDataProto[]Таблица

Описание типов данных

Структура ManagerReportDataProto — Элемент таблицы отчета "Менеджеры"
ПараметрТипПримечание
*managerIdint64Ид менеджера.
*managerLastNamestringФамилия менеджера.
*managerFirstNamestringИмя менеджера.
*managerMiddleNamestringОтчество менеджера.
*monthint64Дата (округлена до месяца)
*incomedoubleНачисления (руб)
*driversint64Водителей

Метод tt.taxi.reports.ManagerReportDrivers — Водители

Отчет "Менеджеры" - получить информацию по водителям.

Входные данные

ПараметрТипПримечание
*beginint64Начало отчетного периода.
*endint64Конец отчетного периода.
*managerIdint64Ид менеджера.

Выходные данные

ПараметрТипПримечание
*dataManagerReportDriversDataProto[]Таблица

Описание типов данных

Структура ManagerReportDriversDataProto — Элемент отчета "Менеджеры" - данные по водителям
ПараметрТипПримечание
*driverIdint64Ид водителя.
*callsignstringПозывной водителя.
*driverLastNamestringФамилия водителя.
*driverFirstNamestringИмя водителя.
*driverMiddleNamestringОтчество водителя.
*managerIdint64Ид менеджера.
*managerLastNamestringФамилия менеджера.
*managerFirstNamestringИмя менеджера.
*managerMiddleNamestringОтчество менеджера.
*monthint64Дата (округлена до месяца)
*incomedoubleНачисления (руб)
*ordersint64Выполнено заказов.

Метод tt.taxi.reports.Equipment — Оснащение

Отчет "Оснащение"

Входные данные

ПараметрТипПримечание
*beginint64Временной период - дата "от"
*endint64Временной период - дата "до"
*serviceIdint64Ид службы (если не передано, то все службы)
*equipmentIdsint64[]Список ид оснащения (статических параметров)

Выходные данные

ПараметрТипПримечание
*driversTotalint64Всего водителей.
*driversWithEquipmentint64Водителей с оснащением.
*driversRichButLazyint64Водителей с оснащением, выполнивших <5 заказов за день.
*driversPoorButHardWorkingint64Водителей без оснащения, выполнивших >20 заказов за день.

Метод tt.taxi.reports.EquipmentDrivers — Оснащение (список водителей)

Входные данные

ПараметрТипПримечание
*beginint64Временной период - дата "от"
*endint64Временной период - дата "до"
*serviceIdint64Ид службы (если не передано, то все службы)
*equipmentIdsint64[]Список ид оснащения (статических параметров)

Выходные данные

ПараметрТипПримечание
*dataEquipmentReportDriversDataProto[]Список водителей.

Описание типов данных

Структура EquipmentReportDriversDataProto — Элемент отчета "Менеджеры" - данные по водителям
ПараметрТипПримечание
*driverIdint64Ид водителя.
*callsignstringПозывной водителя.
*driverLastNamestringФамилия водителя.
*driverFirstNamestringИмя водителя.
*driverMiddleNamestringОтчество водителя.
*managerIdint64Ид менеджера.
*managerLastNamestringФамилия менеджера.
*managerFirstNamestringИмя менеджера.
*managerMiddleNamestringОтчество менеджера.
*commentstring

Метод tt.taxi.reports.DriversDecrease — Отток водителей

Отчет "Отток водителей"

Входные данные

ПараметрТипПримечание
*beginint64Начало отчетного периода.
*endint64Конец отчетного периода.
*managerIdint64Ид менеджера.
*zeroesboolПоказать нулевых.
*percentdoubleПоказать водителей с процентом падения больше заданного.

Выходные данные

ПараметрТипПримечание
*driversHiredint64Водителей пришло.
*driversFiredint64Водителей ушло.
*dataDriversDecreaseDataProto[]Таблица

Описание типов данных

Структура DriversDecreaseDataProto — Элемент таблицы отчета "Отток водителей"
ПараметрТипПримечание
*driverIdint64Ид водителя.
*driverLastNamestringФамилия водителя.
*driverFirstNamestringИмя водителя.
*driverMiddleNamestringОтчество водителя.
*driverCallsignstringПозывной
*driverPhonestringТелефон водителя.
*ordersLastMonthint64Заказы за прошлый период.
*ordersThisMonthint64Заказы за текущий период.
*ordersDecreasedoubleПадение, %
*managerIdint64Ид менеджера.
*managerLastNamestringФамилия менеджера.
*managerFirstNamestringИмя менеджера.
*managerMiddleNamestringОтчество менеджера.
*commentDateint64Дата комментария.
*commentTextstringТекст комментария.

Метод tt.taxi.reports.AccountCorrections — Отчет по корректировкам

Отчет по корректировкам.

Входные данные

ПараметрТипПримечание
*beginint64Начало временного периода.
*endint64Конец временного периода.
*serviceIdint64Ид службы (не указано - отчет по всем службам)
*corrTypeint64Тип корректировки (не указано - все корректировки). См. AccountCorrectionTypeProto
*paramsGetProtoДоп. параметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataAccountCorrectionListProto[]Список
*countint64Общее количество строк.
*totalPlusdoubleВсего поступило, руб.
*totalMinusdoubleВсего списано, руб.

Метод tt.taxi.reports.TariffsReport — Отчет по тарифам

Отчет по тарифам.

Входные данные

ПараметрТипПримечание
*beginstringВременной период - дата "от"
*endstringВременной период - дата "до"
*serviceIdint64Ид службы (если не передано, то все службы)
*textstringТекст для поиска.
*paramsGetProtoДополнительные параметры.

Выходные данные

ПараметрТипПримечание
*dataTariffsReportDataProto[]Список результатов.
*countint64Количество записей.

Описание типов данных

Структура TariffsReportDataProto — Элемент отчета по тарифам
ПараметрТипПримечание
*tariffIdint64ИД тарифа.
*tariffNamestringНазвание тарифа.
*servicesNamesstringНазвания служб.
*driversCountint64Водителей
*activeDriversCountint64Активных водителей.
*ordersCountint64Заказов
*incomedoubleПоступлений
*driversAvgdoubleСр.водитель
*orderAvgdoubleСр.заказ

Метод tt.taxi.reports.SummaryReport — Сводный отчет

Отчет "Сводный отчет"

Входные данные

ПараметрТипПримечание
*beginint64Временной период - дата "от"
*endint64Временной период - дата "до"
*serviceIdint64Ид службы (если не передано, то все службы)
*byDaysboolЕсли true, то группировка по дням, иначе группировка по службам.

Выходные данные

ПараметрТипПримечание
*dataSummaryReportDataProto[]Список результатов.

Описание типов данных

Структура SummaryReportDataProto — Элемент отчета "Сводный отчет"
ПараметрТипПримечание
*ordersReceivedint64Полученные заказы.
*ordersDoneint64Выполненные заказы.
*ordersFromClientsApiint64Заказы из клиентского апи.
*preordersAllint64Предзаказы
*preordersDoneint64Успешные предзаказы.
*ordersDistribTimeAvgint64Среднее время распределения заказов (мсек)
*ordersArriveTimeAvgint64Среднее время подачи АМ (мсек)
*ordersBorderint64Заказы с бордюра.
*driversTotalint64Всего водителей.
*driversNewint64Новые водители.
*driversDecreaseint64Отток водителей.
*driversActiveint64Активные водители.
*driversProfitint64Доходные водители.
*driversLoyalint64Постоянных водителей.
*financeBankRegistrydoubleПолучено по реестрам банка (руб)
*financeBankWithCommissiondoubleПолучено по банку с учетом комиссий ПС (руб)
*financeDriverCommissiondoubleУдержано с водителей комиссий ПС (руб)
*financeContractsdoubleПолучено по договору (руб)
*financeDriversdoubleНачислено (руб)
*financeCorrectionsPlusdoubleКорректировки в плюс (руб)
*financeCorrectionsMinusdoubleКорректировки в минус (руб)
*financeOrderCostAvgdoubleСредняя стоимость за заказ (руб)
*policeClientCancelsint64Отказы клиентов от заказов.
*policeDriverFailsint64Отказы водителей от заказов.
*serviceIdint64Ид службы (при группировке по службам)
*dateint64Дата (при группировке по дням)
*driverOrderCostAvgdoubleСредняя стоимость заказа для водителя (руб)

Метод tt.policy.log.GetClientsBalanceOperations — Лог баланса пользователей

Получение лога баланса пользователей.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataClientBalanceHistoryProto[]Список
*countint64Общее количество строк.

Метод tt.policy.log.GetUsersOperations — Лог действий пользователей

Получение лога действий пользователей.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataUsersOperationsListProto[]Список
*countint64Общее количество строк.

Метод tt.policy.log.GetOrderEvents — Лог заказов

Получение лога по заказам.

Входные данные

ПараметрТипПримечание
*paramsGetOrderEventsGetProtoПараметры запроса.

Выходные данные

ПараметрТипПримечание
*dataOrderEventsListProto[]Список
*countint64Общее количество строк.

Описание типов данных

Структура GetOrderEventsGetProto — Описание запроса на список элементов.
ПараметрТипПримечание
*pagingPagingProtoПагинация
*orderingOrderingProtoСортировка
*filterGetOrderEventsFilterProtoФильтр
Структура GetOrderEventsFilterProto
ПараметрТипПримечание
*fromstringДата от.
*tostringДата до.
*textstringТекст для поиска.
*eventTypestringТип события.
*conditionsFilterProto[]Заглушка

Метод tt.policy.log.GetKarmaEvents — Лог кармы

Получение лога кармы.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataKarmaEventsListProto[]Список
*countint64Общее количество строк.

Метод tt.policy.log.GetPPLog — Лог по стоянкам

Получение лога по стоянкам.

Входные данные

ПараметрТипПримечание
*paramsPPLogGetProtoПараметры запроса.

Выходные данные

ПараметрТипПримечание
*dataPPLogListProto[]Список
*countint64Общее количество строк.

Описание типов данных

Структура PPLogGetProto — Описание запроса на список элементов.
ПараметрТипПримечание
*pagingPagingProtoПагинация
*orderingOrderingProtoСортировка
*filterPPLogFilterProtoФильтр
Структура PPLogFilterProto
ПараметрТипПримечание
*fromstringДата от.
*tostringДата до.
*textstringТекст для поиска.
*conditionsFilterProto[]Заглушка
Структура PPLogListProto — Элемент списка лога по стоянкам
ПараметрТипПримечание
*idint64Номер (идентификатор записи события)
*driverIdint64ИД водителя.
*callsignstringПозывной водителя.
*firstNamestringИмя водителя.
*lastNamestringФамилия водителя.
*middleNamestringОтчество водителя.
*dateint64Дата и время.
*textstringКомментарий
*ppIdint64Ид стоянки.
*ppNamestringИмя стоянки.

Метод tt.policy.log.GetCallAndSmsLog — Лог смс и звонков

Получение лога по смс и звонкам.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataCallAndSmsLogListProto[]Список
*countint64Общее количество строк.

Метод tt.policy.log.GetAccOperations — Лог тарификатора

Получение лога тарификатора.

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataAccOperationsListProto[]Список
*countint64Общее количество строк.

tt.messaging.system.UpdateMessage — Изменение сообщения системы

Структура UpdateMessagesRqProto
ПараметрТипПримечание
*idint64Ид объекта.
*dataMessageUpdateProtoДанные
*fieldsstring[]Список полей для редактирования.
Структура UpdateMessagesRsProto
ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.messaging.system.UpdateSystemEventsNotify — Изменить настройки оповещания по системному событию

Входные данные

ПараметрТипПримечание
*eventIdint64Ид типа системного события.
*dataSystemEventsNotifyUpdateProto[]Новые настройки оповещания.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.messaging.system.GetMessagesCount — Получить количество сообщений

Входные данные

ПараметрТипПримечание
*emptyint32Неиспользуемая переменная.

Выходные данные

ПараметрТипПримечание
*allint64Количество всех сообщений.
*internalint64Количество простых сообщений.
*alarmint64Количество сообщений о тревогах.
*warningint64Количество предупреждений.
*errorint64Количество сообщений об ошибках.

Метод tt.messaging.system.GetSystemEventsNotify — Получить настройки оповещания по системному событию

Входные данные

ПараметрТипПримечание
*eventIdint64Ид типа системного события.

Выходные данные

ПараметрТипПримечание
*dataSystemEventsNotifyListProto[]Данные
*countint64Количество записей в ответе.

Метод tt.messaging.system.GetMessage — Получить сообщение системы по ID

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.
*markAsReadedboolПометить сообение как "прочитано"

Выходные данные

ПараметрТипПримечание
*dataMessageListProtoДанные

Метод tt.messaging.system.GetMessages — Получить список сообщений системы

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataMessageListProto[]Список
*countint64Общее количество строк.

tt.messaging.system.CreateMessage — Создание сообщения системы

Структура CreateMessagesRqProto
ПараметрТипПримечание
*dataMessageUpdateProtoДанные
Структура CreateMessagesRsProto
ПараметрТипПримечание
*idint32Ид нового сообщения.
*validationResultValidationResultРезультат валидации.

Метод tt.messaging.system.DeleteMessage — Удаление сообщения системы

Входные данные

ПараметрТипПримечание
*idint64Ид объекта.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.messaging.api.UpdateDistribution — Изменить рассылку

Входные данные

ПараметрТипПримечание
*idint64Ид рассылки.
*dataDistributionProto
*fieldsstring[]

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат валидации.

Метод tt.messaging.api.CancelAllUndeliveredRecipients — Отменить рассылку для всех реципиентов рассылки которым не было доставлено сообщение

Входные данные

ПараметрТипПримечание
*distributionIdint64Ид рассылки.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат операции.

Метод tt.messaging.api.CancelRecipientDistribution — Отменить рассылку для реципиента

Входные данные

ПараметрТипПримечание
*recipientIdint64Ид реципиента.

Выходные данные

ПараметрТипПримечание
*validationResultValidationResultРезультат операции.

Метод tt.messaging.api.GetDistribution — Получить детальную информацию по рассылке

Входные данные

ПараметрТипПримечание
*idint64Ид рассылки.

Выходные данные

ПараметрТипПримечание
*dataDistributionProto

Метод tt.messaging.api.GetRecipientFilters — Получить список доступных фильтров реципиентов

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataRecipientFilterProto[]Список фильтров реципиентов.
*countint64Общее количество строк.

Метод tt.messaging.api.GetDistributionTemplates — Получить список доступных шаблонов сообщений

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataDistributionTemplateProto[]Список шаблонов сообщений.
*countint64Общее количество строк.

Метод tt.messaging.api.GetDistributionPolicies — Получить список ограничений по рассылке

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataDistributionPolicyProto[]Список ограничений рассылки.
*countint64Общее количество строк.

Метод tt.messaging.api.GetDistributions — Получить список рассылок

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataDistributionProto[]
*countint64Общее количество строк.

Метод tt.messaging.api.GetRecipientsByFilter — Получить список реципиентов по выбранному фильтру

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.
*filterIdstringИД фильтра.

Выходные данные

ПараметрТипПримечание
*dataDistributionRecipientListСписок реципиентов.
*countint64Общее количество строк.

Метод tt.messaging.api.GetRecipientsByStatus — Получить список реципиентов по статусу

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.
*distributionIdint64Ид рассылки.
*statusstringСтатус реципиентов.

Выходные данные

ПараметрТипПримечание
*dataDistributionRecipientListСписок реципиентов.
*countint64Общее количество строк.

Метод tt.messaging.api.GetRecipientTypes — Получить список типов реципиентов

Входные данные

ПараметрТипПримечание
*paramsGetProtoПараметры фильтрации.

Выходные данные

ПараметрТипПримечание
*dataRecipientTypeProto[]Список типов реципиентов.
*countint64Общее количество строк.

Метод tt.messaging.api.CreateDistribution — Создать рассылку

Входные данные

ПараметрТипПримечание
*dataDistributionProtoОбъект рассылки.

Выходные данные

ПараметрТипПримечание
*idint64Ид рассылки.
*validationResultValidationResultРезультат валидации.

tt.messaging.model.Distribution — Структуры

Структура RecipientProto — реципиент
ПараметрТипПримечание
*genericIdint64Типизированный ИД сущности типа (см.поле type)
*namestringВидимое имя реципиента.
*phonestringТелефон
*emailstringПочта
*typestringТип рецпипента (DRIVER)
*lastTryDateint64Дата последней попытки.
*tryCountint64Количество попыток.
*statustextstringСтатус (Доставленые, Не доставленые, В процессе)
*typeDeliverystringСпособ доставки.
Структура RecipientFilterProto — фильтр реципиентов
ПараметрТипПримечание
*idstringИд фильтра.
*typestringANY, DRIVER, OPERATOR.
*titlestringНазвание фильтра.
Структура RecipientTypeProto — тип реципиента
ПараметрТипПримечание
*idstringИд (ANY, DRIVER, OPERATOR...)
*titlestringНазвание
*allowedPolicyIdsstring[]Допустимые типы рассылок.
Структура DistributionRecipientList — Список получателей
ПараметрТипПримечание
*idint64Ид списка.
*typeRecipientTypeProtoТипы получателей.
*filterIdstringФильтр реципиентов.
*recipientsRecipientProto[]Список получателей.
Структура DistributionPolicyProto — Ограничения рассылок
ПараметрТипПримечание
*idstringИд (EMAIL, SMS, MOBILE)
*titlestringНазвание
*maxTextLengthint32Максимальная длина текста рассылки.
*showSenderboolПоказывать отправителя.
*repeatTimeMinint32Время между повторными отправками.
Структура DistributionTemplateProto — Шаблон сообщения рассылки
ПараметрТипПримечание
*idint64Ид шаблона.
*titlestringШаблон заголовка.
*textstringШаблон тела сообщения.
Структура DistributionProto — Сообщение
ПараметрТипПримечание
*idint64Ид рассылки.
*policyDistributionPolicyProtoПравила обработки и проверки сообщения.
*dateCreatedint64Дата создания рассылки.
*actualDateFromint64Начало периода актуальности рассылки.
*actualDateToint64Конец периода актуальности рассылки.
*senderNamestringОтправитель
*textstringШаблон текста рассылки.
*lastTryDateint64Дата последней попытки отправки.
*tryCountint32Количество попыток отправки.
*statusint64Статус отправки.
*statusTextstringДетализация статуса.
*distributionRecipientsDistributionRecipientListСписок получателей.
*recipientCountint64Количество получателей.
*recipientDeliveryint64Количество доставленых.
*recipientNotDeliveryint64Количество не доставленых.
*authorint64ИД Инициатора.
*authorFiostringФИО Инициатора.
*isPersonalizedboolПерсонифицированная рассылка.
*policyIdint64ИД типа рассылки.
*policyNamestringИмя типа рассылки.

Метод tt.messaging.api.DeleteDistribution — Удалить рассылку(и)

Входные данные

ПараметрТипПримечание
*idint64[]Список id для удаления.

Выходные данные

ПараметрТипПримечание
*validationResultDeleteValidationResultРезультат валидации.

Метод tt.taxi.yandex.GetBlackListPhone — Черный список телефонов

Выдать черный список телефонов.

Входные данные

ПараметрТипПримечание
*idint32

Выходные данные

ПараметрТипПримечание
*phonestring[]Список телефонов.

tt.core.messages.desc.Group — Группа

Структура GroupDescProto — Дескриптор группы
ПараметрТипПримечание
*idint64ID группы.
*namestringНазвание

tt.core.messages.desc.Contact — Контакт

Структура ContactDescProto — Дескриптор контакта
ПараметрТипПримечание
*idint64ID контакта.
*groupIDint64ID группы.
*namestringИмя (ник)
*isOnlineboolСтатус

tt.core.messages.desc.Message — Сообщение

Структура MessageDescProto — Дескриптор сообщения
ПараметрТипПримечание
*messagestringТело сообщения. Устанавливается при отправке.
*confirmationboolТребуется ли подтверждение о прочтении.
*receiversint64[]Список ID получателей (заполняется только при отправке, при получении всегда пустой)
*senderIDint64ID отправителя.
*messageIDint64ID сообщения.
*dateSendint64Дата создания сообщения (unix time (мс))
*dateReceivedint64Дата получения сообщения (unix time (мс))
*dateReadedint64Дата прочтения сообщения (unix time (мс)). Если дата установлена, то значит есть подтверждение о прочтении.

tt.taxi.driver.desc.Order — Заказ

Структура OrderProto — Дескриптор данных заказа
ПараметрТипПримечание
*stateStateСтатус заказа.
*typeTypeТип заявки.
*functionsFunctions[]Список доступных действий для заявки.
*dateNewstringДата поступления заявки.
*datePlannedStartstringДата подачи автомобиля (запланированная, используется для предзаказов)
*dateDriverFoundstringДата назначения заказа на водителя.
*dateDriverAcceptstringДата согласия водителя выполнить заказ.
*dateWaitForClientstringДата начала ожидания клиента.
*dateInProgressstringДата назала выполнения заказа.
*fromPointPointТочка "откуда"
*toPointPointТочка "куда"
*notestringПримечание
*clientNamestringИмя/фамилия клиента.
*arriveTimeint32Время подачи автомобиля (в минутах)
*orderIDint64ID заказа.
*acceptTimeoutint32Тaймаут в секундах, в течение которого водитель должен принять решение по предложенному заказу.
*arriveIntervalsint32[]Список интервалов (в минутах) подачи авто для выбора водителем.
*recommendedTimeint32Рекомендуемое время подачи авто, которое будет установлено как время подачи авто сразу же при открытии формы приема заказа.
*offerDateint64Дата, когда заказ был предложен водителю.
*waitForClientTimeint32Время (сек), через которое будет доступна кнопка "Поторопить клиента"
*tariffIdint64Ид клиентского тарифа, установленного оператором.
*clientPhonestringТелефон для связи с клиентом.
*fixedPriceboolЗаказ с фиксированной стоимостью.
*costdoubleРассчитанная стоимость заказа (руб)
*distancedoubleРассчитанная длина поездки (метры)
*costDetailsOrderCostDetailProto[]Информация о маршруте поездки.
*serviceNamestringСлужба, из которой пришел заказ.
*isCashboolПлатит ли клиент (false для корпоративных клиентов)
*isContractboolЗаказ по договору.
*clientBonusesAvaildoubleКоличество бонусов у клиента.
*distanceTodoubleРастояние до заказа (метры)
*intermediatePointsPoint[]Промежуточные точки маршрута.
*isForcedboolЗаказ с автоназначением.
*isEnabledCounterOrderboolВключен режим встречного заказа.
Перечисление State — Статус заявки
НазваниеЗначениеПримечание
*UNKNOWN0
*PREORDER1Предварительный заказ.
*ASSIGNED2Едет к клиенту.
*DONE3Выполнен
*CANCELLED_OP4Отменен (звонок оператору)
*FAILED_NO_CARS_SYS5Отменен (нет машин, система)
*DISTRIB_WAIT6Поиск машины (пауза)
*DISTRIB7Поиск машины.
*WAIT_FOR_CLIENT8Ждет клиента.
*IN_PROGRESS9Везет клиента.
*PREORDER_CONFIRM_WAIT10Ожидание подтверждения брони.
*PREORDER_CONFIRMED11Бронь подтверждена.
*INCOMPLETE12В процессе создания.
*CLIENT_NOTIFIED13Ждет клиента, клиент уведомлен.
*CLIENT_NOTIFY_FAIL14Уведомить клиента не удалось.
*CLIENT_CONFIRMED15Едет к клиенту, заказ подтвержден.
*FAILED_NO_CARS_OP16Отменен (нет машин, оператор)
*CANCELLED_NA17Отменен (клиент не отвечает)
*CANCELLED_IVR18Отменен (автодозвон)
*FAILED_DRIVER19Отменен (отказ водителя)
*FAILED_CHANGE_DRIVER20Отменен (замена водителя)
*CANCELLED_2421Снят системой.
Перечисление Functions — Доступные действия
НазваниеЗначениеПримечание
*ACCEPT_ADVANCE1Зарезервировать предварительный заказ.
*REJECT_ADVANCE2Снять резерв с предварительного заказа.
*ACCEPT3Взять заказ.
*REJECT4Отказаться от заказа (до того как заказ взят)
*FAIL5Заказ невозможно выполнить.
*WAIT_FOR_CLIENT6Переход в состояние ожидания клиента.
*IN_PROGRESS7Переход в состояние выполнения заказа (клиент сел в машину)
*DONE8Заказ выполнен.
Перечисление Type — Тип заявки
НазваниеЗначениеПримечание
*NOW1Заказ
*ADVANCE2Предзаказ
Структура Point
ПараметрТипПримечание
*citystringГород
*streetstringУлица
*buildingstringНомер здания.
*porchstringНомер подъезда.
*placestringНазвание объекта (если есть)
*coordsGeoPointProtoКоординаты
Структура OrderCostDetailProto — Точка маршрута поездки
ПараметрТипПримечание
*titlestringТекст
*streetstringУлица
*buildingstringНомер дома.
*costdoubleРассчитанная стоимость (руб)
*formattedValuestringФорматированное значение поля cost (не null для скидок)

tt.taxi.driver.desc.DriverInfo — Информация о водителе

Структура DriverInfoProto — Дескриптор информации о водителе
ПараметрТипПримечание
*organizationNamestringНазвание организации.
*serviceNamestringНазвание службы.
*driverNamestringИмя водителя.
*parkingPointIDint64ID текущей стоянки.
*stateStateСостояние
*serviceModeServiceModeАлгоритм распределения заказов службы.
*driverIdint64Ид водителя.
*allowDriverChangeTariffboolРазрешить смену тарифа водителя.
*isGreenWaveEnabledboolВключен режимзеленой волны.
Перечисление State
НазваниеЗначениеПримечание
*NOT_ACTIVE1Водитель не на смене.
*READY2Водитель на смене (может принимать заказы)
*PENDING_ORDER3Водитель на смене (ему назначен заказ)(приложение не может самостоятельно установить данное значение)
*BUSY4Водитель на смене (находится в процессе выполнения заказа)(приложение не может самостоятельно установить данное значение)
*NOT_READY5Водитель на смене (занят своими делами, не может принимать заказы)
Перечисление ServiceMode — Алгоритм распределения заказов службы
НазваниеЗначениеПримечание
*BY_ONE1Распределение заказов "по одному". Заказ одновременно предлагается только одному водителю. Водители получают заказы по очереди с учетом рейтинга.
*AVALANCHE2Распределение заказов "лавина". Отличается от распределения "по одному" тем, что водитель может взять предложенный заказ в любой момент, пока этот заказ не возьмет другой водитель.
*OPEN3Распределение заказов "открытый эфир". Водитель видит все заказы на стоянке и может взять любой из них.

tt.taxi.driver.desc.Service — Служба

Структура ServiceProto — Дескриптор службы
ПараметрТипПримечание
*idint64ID службы.
*namestringНазвание службы.
*organizationstringНазвание организации.

tt.taxi.driver.desc.ParkingPoint — Стоянка

Структура ParkingPointProto — Дескриптор парковки
ПараметрТипПримечание
*idint64Id стоянки.
*namestringНазвание стоянки.
*notestringОписание
*freeOrdersCountint64Число распределяемых заказов на стоянке.
*driversCountint64Число водителей в очереди.
*placeint32Место в очереди.
*borderGeoPolygonProtoГеометрия стоянки.
*lastChangeint64Время последнего изменения списка заказов на стоянке.

tt.taxi.common.desc.ClientTariff — Тариф клиента

Структура ClientTariffProto — Дескриптор тарифа клиента
ПараметрТипПримечание
*idint64ID тарифа.
*titlestringНазвание
*minimalsMinimalsИнформация о минималке.
*noGpsSegmentsSegment[]Ценовые сегменты для работы без GPS.
*segmentsSegment[]Ценовые сегменты тарифа.
*defaultSegmentSegmentСегмент для срабатывания по-умолчанию, если не сработали сегменты из noGpsSegments и segments.
*finalMultiplierMultiplierФинальный мультипликатор.
*isDefaultboolТариф по умолчанию.
*extraPaymentsExtraPayment[]Описание дополнительных платежей.
*discountDiscountСкидка
*numScalestringШаблон округления.
*discountExtDiscount[]Скидка (ext)
*minCostExtdoubleМинимальная стоимость (ext)
Перечисление ConditionalOperator
НазваниеЗначениеПримечание
*lower1
*greater2
*between3
*equal4
Перечисление TripParameter
НазваниеЗначениеПримечание
*distance1Общая дистанция, в метрах (с сервера передается в виде строки с int)
*time2Общее время в пути, в секундах (с сервера передается в виде строки с int)
*speed3Моментальная скорость, в км/ч (с сервера передается в виде строки с int)
*daytime4Календарное время, строка “ЧЧ:ММ” (с сервера передается в виде строки в формате “ЧЧ:ММ”)
*city5Город/загород, true - если в городе, false - если не в городе.
Структура Multiplier
ПараметрТипПримечание
*titlestringОписание
*mulitplierfloatНеотрицательный - значение.
Структура PartialCondition
ПараметрТипПримечание
*parameterTripParameterПараметр поездки, по которому производится сравнение.
*operatorConditionalOperatorУсловие для сравнения значения параметра.
*valuesstring[]Константные значения для сравнения со значением параметра поездки (для условий больше/меньше - только одно значение, для условия между - два значения), строковое значение будет интерпретироваться в типизированное на основе типа параметра поездки.
Структура Price
ПараметрТипПримечание
*pameterTripParameterПараметр для расчета (только distance или time)
*pricefloatСтоимость за единицу измерения параметра (для distance - км, для time - за минуту)
Структура Condition
ПараметрТипПримечание
*conditionsPartialCondition[]Список условий применимости сегмента по одному условию на параметр поездки.
*pendingTimeint32Минимальное время для определения применимости сегментов с длительным периодом определения применимости, задается в секундах, если задано 0 - значит сегмент не содержит в себе длительный период определения применимости.
Структура Segment
ПараметрТипПримечание
*titlestring
*conditionConditionУсловие срабатывания сегмента, если не задано сегмент будет срабатывать всегда.
*pricesPrice[]Цены для параметров поездки.
*freeTimeint32Время в секундах для установки бесплатного периода при каждом срабатывании сегмента.
Структура ConditionalCost
ПараметрТипПримечание
*conditionConditionУсловие срабатывания разовой стоимости.
*pricefloatСтоимость
Структура Minimals
ПараметрТипПримечание
*minimalPricesConditionalCost[]Список минималок с условиями применения (минималка проверяется в конце поездки)
*boardingPricesConditionalCost[]Список стоимостей посадки с условиями применения (стоимость посадки определяется один раз и в начале поездки)
Структура ExtraPayment — Описание дополнительного платежа
ПараметрТипПримечание
*titlestringНазвание платежа.
*pricefloat[]Цены. Элемент массива с индексом 0 определяет цену за 1 доп. услугу (например, цена за 1 посадку). Элемент с индексом 1 - за 2 услуги, и т.д. Последний элемент массива с индексом n-1 определяет цену за n и более услуг. Пример: название платежа "доп. посадки", в массиве - [50, 30], тогда 1я доп. посадка будет стоить 50 руб., все остальные - 30 руб.
Структура Discount — Скидка
ПараметрТипПримечание
*namestringНазвание скидки.
*discountPercentdoubleСкидка в процентах.
*discountMoneydoubleСкидка в рублях.
*orderCostdoubleСтоимость заказа активирующая скидку. null - скидка действует всегда.

tt.taxi.driver.desc.Notification — Уведомление

Структура NotificationPushProto — Уведомление (всплывающее сообщение)
ПараметрТипПримечание
*textstringТекст сообщения.

tt.taxi.driver.desc.DriverPhoto — Фото автомобиля

Структура DriverPhotoProto — Фото автомобиля для выхода на смену
ПараметрТипПримечание
*databytesФотография в двоичном виде в формате JPEG.

tt.taxi.manager.desc.OrderFormSettings — Настройки формы заказа

Структура OrderFormSettingsProto — Настройки формы заказа для службы
ПараметрТипПримечание
*serviceIdint64Ид службы.
*greetingTextstringФраза начала разговора.
*endWithoutCostTextstringФраза окончания разговора без стоимости.
*endWithCostTextstringФраза окончания разговора со стоимостью.
*showFromboolПоказывать адрес куда.
*showPreorderboolБрать предварительные заказы.
*showLastOrdersboolПоказывать последние поездки.
*showComplexHintboolПоказывать подсказку для сложных адресов.
*allowManualAssignboolНазначать заказы вручную.
*showParkingboolПоказывать стоянку.
*showCarsboolПоказывать число машин.
*serviceTzstringВременная зона службы.
*useTariffAdditionsboolИспользовать дополнения к тарифу клиента.
Структура OrderFormSettingsListProto — Настройки формы заказа для службы (элемент списка)
ПараметрТипПримечание
*serviceIdint64Ид службы.
*servicestringНазвание службы.
*greetingTextstringФраза начала разговора.
*endWithoutCostTextstringФраза окончания разговора без стоимости.
*endWithCostTextstringФраза окончания разговора со стоимостью.
*showFromboolПоказывать адрес куда.
*showPreorderboolБрать предварительные заказы.
*showLastOrdersboolПоказывать последние поездки.
*showComplexHintboolПоказывать подсказку для сложных адресов.
*allowManualAssignboolНазначать заказы вручную.
*showParkingboolПоказывать стоянку.
*showCarsboolПоказывать число машин.

tt.taxi.operator.desc.Address — Адрес

Структура PlaceProto — Описание места (адрес объекта)
ПараметрТипПримечание
*idint32Ид адреса.
*cityIdint32Ид города.
*streetIdint32Ид улицы.
*streetstringНазвание улицы.
*houseNumstringНомер дома.
*placeIdint32Ид места.
*placeNamestringНазвание места.
*addressTipstringПодсказка для адреса.
*streetTipstringПодсказка для улицы.
*placesTipstringПодсказка для объекта.
*coordsGeoPointProtoКоординаты
*notestringПримечание по адресу.
Структура PlaceUpdateProto — Описание объекта (для создания и удаления)
ПараметрТипПримечание
*idint32Ид объекта.
*namestringНазвание объекта.
*addressIdint32Ид адреса.
*cityIdint32Ид города.
*verifiedint321 - проверено, 0 - не проверено.
*coordsGeoPointProtoКоординаты
*placesTipstringПодсказка для объекта.
*addressTipstringПодсказка для адреса.
*streetTipstringПодсказка для улицы.
Структура AddressProto — Адрес
ПараметрТипПримечание
*idint32Ид адреса.
*cityIdint32Ид города.
*streetIdint32Ид улицы.
*streetstringНазвание улицы.
*houseNumstringНомер дома.
*verifiedint321 - проверено, 0 - не проверено, -1 - не используемый.
*coordsGeoPointProtoКоординаты
*notestringОписание
*complexboolСложный адрес.
*addressTipstringПодсказка для удреса.
*streetTipstringПодсказка для улицы.
*placeIdint32ИД объекта.
*placeNamestringИмя объекта.
*creatorIdint64
*creatorNamestring
*createDateint64
Структура StreetProto — Улица
ПараметрТипПримечание
*idint32Ид улицы.
*namestringНазвание улицы.
*cityIdint32Ид города.
*streetTipstringПодсказка для улицы.

tt.taxi.operator.desc.AddressList — Адрес (список)

Структура AddressListProto — Адрес и принадлежащие ему объекты (элемент списка)
ПараметрТипПримечание
*idint32Ид адреса.
*streetIdint32Ид улицы.
*cityIdint32Ид города.
*citystringНазвание города.
*streetstringУлица
*houseNumstringНомер дома.
*placeIdsint32[]Список ид объектов относящихся к этому адресу.
*placesstringСписок объектов через запятую.
*notestringОписание
*complexboolФлаг "сложный"
*verifiedint32Статус адреса. См. VerifiedInfoProto
*ppIdint64Ид стоянки.
*ppNamestringНазвание стоянки.
*coordsGeoPointProtoКоординаты
Перечисление VerifiedInfoProto — Статус адреса
НазваниеЗначениеПримечание
*VERIFIED1Адрес подтвержден.
*UNVERIFIED0Адрес не подтвержден.
*UNUSED-1Адрес не используется.

tt.taxi.manager.desc.City — Город

Структура CityProto — Город
ПараметрТипПримечание
*idint32Ид города.
*namestringНазвание города.
*boundsGeoPolygonProtoГраницы города.
*statestringСтрана
*viewScaleint32Масштаб на Яндекс.Картах.
*mapTypestringТип карт. Пример: "yandex" - Яндекс.Карты.
*phonePrefixstringПрефикс для телефонных номеров. Формат: 8123XXXXXXX - для всех номеров из 7 цифр будет добавлять префикс 8123.

tt.taxi.manager.desc.DoneOrder — Выполненные заказы

Структура DoneOrderListProto — Выполненный заказ (список)
ПараметрТипПримечание
*idint64Ид строки.
*driverIdint64Ид водителя.
*lastNamestringФамилия водителя.
*firstNamestringИмя водителя.
*middleNamestringОтчество водителя.
*serviceIdint64Ид службы водителя.
*serviceNamestringНазвание службы.
*orderIdint64Ид заказа.
*isBorderboolИсточник: с бордюра или служба.
*doneDateint64Дата выполнения заказа.
*pricedoubleСтоимость заказа.
*is_failboolВодитель отказался от заказа.

tt.taxi.manager.desc.AccountOperation — Операции с балансом водителя

Структура AccountOperationListProto — Операция с балансом водителя (список)
ПараметрТипПримечание
*idint64Id операции.
*timestampint64Дата операции.
*opTypeint64Тип операции (см. перечисление AccountOperationTypeProto)
*corrTypeint64Тип корректировки (см. AccountCorrectionTypeProto). Заполняется только в случае, если тип операции - корректировка.
*driverIdint64Id водителя.
*lastNamestringФамилия водителя.
*firstNamestringИмя водителя.
*middleNamestringОтчество водителя.
*serviceIdint64Id службы водителя.
*serviceNamestringНазвание службы водителя.
*amountdoubleСумма операции (положительная - зачисление, отрицательная - списание)
*balancedoubleБаланс после операции.
*commentarystringКомментарий к операции.
*orderIdint64Id заказа, если операция - это списание за заказ.
*operatorIdint64Ид оператора (который сделал корректировку)
*opLastNamestringФамилия оператора.
*opFirstNamestringИмя оператора.
*opMiddleNamestringОтчество оператора.
Перечисление AccountOperationTypeProto — Типы операций
НазваниеЗначениеПримечание
*PAY1Пополнение баланса.
*CHARGE_ORDER2Списание за заказ.
*CHARGE_RENT3Периодическое списание (аренда)
*CORRECTION4Корректировка
*ADVANCE_PAYMENT5Обещанный платеж.
*EXTERNAL_SOURCE6Корректировка из внешнего источника.
Структура AccountCorrectionProto — Корректировка баланса водителя
ПараметрТипПримечание
*driverIdint64Ид водителя.
*corrTypeint64Тип корректировки (см. AccountCorrectionTypeProto)
*amountdoubleСумма операции (положительная - зачисление, отрицательная - списание)
*commentarystringКомментарий к операции.
Перечисление AccountCorrectionTypeProto — Типы корректировок
НазваниеЗначениеПримечание
*INCOME1Зачисление
*CHARGE2Списание
*BONUS3Поощрение
*FINE4Штраф
*ADVANCE_PAYMENT5Обещанный платеж. На самом деле, обещанный платеж - не корректировка, но по некоторым причинам мы его отображаем в отчете "корректировки". Поэтому, нужен этот тип.

tt.taxi.manager.desc.DriverAutoCallsign — Счетчик позывных

Структура DriverAutoCallsignProto — Счетчик позывных
ПараметрТипПримечание
*isAutoCallsignboolАвтоматически присваивать позывной водителю.
*prefixstringПрефикс
*counterint64Текущий счетчик.

tt.taxi.manager.desc.CsvRequest — Заявка

Структура CsvRequestProto — Заявка на создание отчета
ПараметрТипПримечание
*reportIdint64ИД отчета (См. ReportTypeProto)
*reportFromint64Время от.
*reportToint64Время до.
Структура CsvRequestViewProto
ПараметрТипПримечание
*idint64ИД заявки.
*report_idint64ИД отчета.
*create_dateint64Время создания.
*user_idint64Ид пользователя.
*emailstringEmail пользователя.
*status_idint64ИД статуса.
*titlestringИмя заявки.
*userFiostringФИО пользователя.
*statusstringСтатус
Перечисление ReportTypeProto
НазваниеЗначениеПримечание
*ACCOPERATIONS1Логи тарификатора.
*ORDEREVENTS2Логи заказов.
*LOGSCALLSMS3Логи звонков и СМС.
*KARMAEVENTS4Логи кармы.
*USERSOPERATIONS5Логи пользовательских действий.
*CLIENTCORRECTIONS6Логи корректировок клиентов.
*ORDERSLIST7Заказы
*CLIENTSREPORT8Отчет по клиентам.
*DRIVERSSTAT9Статистика по водителям.
*ACCOUNTCORRECTIONS10Отчет по корректировкам.
*DRIVERLIST11Список водителей.

tt.taxi.manager.desc.CsvReport — Отчеты

Структура CsvReportProto — Отчеты
ПараметрТипПримечание
*idint64Ид
*namestringИмя отчета.
*titlestringНазвание метода.
*querystringSql запрос.

tt.taxi.manager.desc.RoutePoint — Точка маршрута

Точка маршрута заказа.

Структура RoutePoint
ПараметрТипПримечание
*addressIdint64Ид адреса.
*placeIdint64Ид объекта (не обязательно)

tt.taxi.manager.desc.Sound — Звук

Структура SoundProto — Звук
ПараметрТипПримечание
*idint64Ид
*namestringИмя
*typestringТип звука.
*fileIdint64ID звукового файла.
*sectionIdint64ID раздела.
Структура SoundListProto — Звук (элемент списка)
ПараметрТипПримечание
*idint64Ид
*namestringИмя
*fileIdint64ID звукового файла.
*sectionIdint64ID раздела.
*isSystemboolЯвляется ли системным.

tt.taxi.manager.desc.SoundSection — Раздел звуков

Структура SoundSectionProto — Справочник разделов звуков
ПараметрТипПримечание
*idint64Ид
*namestringИмя

tt.taxi.manager.desc.Karma — Параметр кармы водителей

Структура KarmaProto — Параметр кармы водителей
ПараметрТипПримечание
*idint64Ид параметра.
*namestringНазвание параметра.
*codestringКод шаблона.
*ratingint32Изменение рейтинга (кармы)
*moneydoubleДенежный штраф или поощрение.
*banboolБлокировка
*durationint64Длительность действия (мс)
*isActiveboolВключен или выключен.
*isManualboolКарма назначается вручную.
Структура KarmaUpdateProto — Поля для изменения - параметр кармы водителей
ПараметрТипПримечание
*ratingint32Изменение рейтинга (кармы)
*moneydoubleДенежный штраф или поощрение.
*namestringНазвание параметра.
*banboolБлокировка
*durationint64Длительность действия (мс)
*isActiveboolВключен или выключен.
*paramsKarmaParameterProto[]Параметры
*codestringКод шаблона.
Структура KarmaTemplateProto — Шаблон
ПараметрТипПримечание
*codestringКод шаблона.
*titleTemplatestringШаблон текста.
*paramsstring[]Параметры
Структура KarmaParameterProto — Параметр (элемент списка)
ПараметрТипПримечание
*paramstringИД параметра.
*valueint32Значение
Структура KarmaExceptionBlockProto — Блок исключений
ПараметрТипПримечание
*idint64Ид параметра.
*tariffIdint64Ид тарифа.
*daysOfWeekint32[]Список дней недели.
*beginTimestringНачало временного интервала. Если указано, то списание действует начиная с этого времени суток.
*endTimestringКонец временного интервала. Если указан, то списание действует до этого времени суток.
*exceptionsKarmaProto[]Список исключений.

tt.taxi.manager.desc.KarmaDrivers — Штрафы и бонусы водителей

Структура KarmaDriversUpdateProto — Поля для корректировки вручную - штрафы и бонусы водителей
ПараметрТипПримечание
*driverIdint64Ид водителя.
*ratingint32Изменение рейтинга (кармы)
*moneydoubleДенежный штраф или поощрение.
*banboolБлокировка
*durationint64Длительность действия (мс)
*notestringКомментарий
Структура KarmaDriversListProto — Штрафы и бонусы водителей - элемент списка
ПараметрТипПримечание
*idint64Ид записи.
*driverIdint64Ид водителя.
*callsignstringПозывной водителя.
*karmaIdint64Ид параметра кармы.
*karmaNamestringНазвание параметра кармы.
*ratingint32Изменение рейтинга (кармы)
*moneydoubleДенежный штраф или поощрение.
*banboolБлокировка
*operatorIdint64Ид оператора.
*operatorNamestringФИО оператора.
*dateBeginint64Начало периода действия.
*dateEndint64Конец периода действия.
*notestringКомментарий
*isActiveboolПравило активно.
*isManualboolПравило назначаемое вручную.
*durationint64Длительность действия (мс)

tt.taxi.client.desc.OrderRating — Отзывы

Структура OrderRatingProto — отзыв
ПараметрТипПримечание
*idint64
*driverIdint64
*clientIdint64
*orderIdint64
*serviceIdint64
*isLikebool
*addDateint64
*commentstring

tt.taxi.manager.desc.CarClass — Класс машины

Структура CarClassProto — Класс автомобиля
ПараметрТипПримечание
*idint64
*namestring

tt.taxi.manager.desc.CarModel — Марка машины

Структура CarModelProto — Марка автомобиля
ПараметрТипПримечание
*idint64Id марки.
*namestringНазвание марки.
*soundIdint64Id звука.

tt.taxi.manager.desc.Car — Машина

Структура CarProto — Автомобиль
ПараметрТипПримечание
*idint64Ид автомобиля.
*modelIdint64Ид марки автомобиля.
*colorIdint64Ид цвета автомобиля.
*numberstringНомер автомобиля.
*classIdint64Ид класса автомобиля.
*notestringПримечание
Структура CarListProto — Автомобиль (элемент списка)
ПараметрТипПримечание
*idint64Ид автомобиля.
*modelIdint64Ид марки автомобиля.
*modelstringМарка автомобиля.
*colorIdint64Ид цвета автомобиля.
*colorstringЦвет автомобиля.
*classIdint64Ид класса автомобиля.
*classNamestringКласс автомобиля.
*numberstringНомер автомобиля.
*notestringПримечание

tt.taxi.manager.desc.CarColor — Цвет машины

Структура CarColorProto — Цвет автомобиля
ПараметрТипПримечание
*idint64Ид цвета.
*namestringНазвание цвета.
*colorstringRgb-код цвета (формат?)
*soundIdint64ID звука из таблички sounds.
Структура CarColorListProto
ПараметрТипПримечание
*idint64Ид цвета.
*namestringНазвание цвета.
*colorstringRgb-код цвета (формат?)
*soundIdint64ID звука из таблички sounds.
*soundstringНазвание звука.

tt.taxi.common.desc.Validation — Валидация

Структура ValidationResult — Результат валидации значений полей объекта
ПараметрТипПримечание
*errorsValidationError[]Список ошибок валидации.
Структура ValidationError — Ошибка валидации
ПараметрТипПримечание
*fieldNamestringНазвание поля.
*errorstringТекст ошибки.
Структура DeleteValidationResult — Результат валидации для методов удаления объектов
ПараметрТипПримечание
*cannotDeleteIdsint64[]Список ид объектов которые нельзя удалить, т.к. они используются в других таблицах.
Структура RestoreValidationResult
ПараметрТипПримечание
*cannotRestoreIdsint64[]

tt.taxi.manager.desc.Get — Запрос списка

Структура GetProto — Описание запроса на список элементов.
ПараметрТипПримечание
*pagingPagingProtoПагинация
*filterFilterAndProtoФильтр
*orderingOrderingProtoСортировка (для обратной совместимости). РЕКОМЕНДУЕТСЯ ИСПОЛЬЗОВАТЬ ПОЛЕ orderingEx!
*orderingExOrderingProto[]Сортировка (новый протокол, можно задать несколько полей)
Структура PagingProto — Пагинация
ПараметрТипПримечание
*pageint32Номер страницы (начиная с 0)
*itemsPerPageint32Количество элементов на странице.
Структура FilterProto — Фильтр. Заполнять только одно поле.
ПараметрТипПримечание
*andFilterAndProtoСоставной фильтр AND.
*orFilterOrProtoСоставной фильтр OR.
*atomFilterAtomProtoПростой фильтр.
Структура FilterAndProto — Фильтр AND
ПараметрТипПримечание
*conditionsFilterProto[]Список условий, объединенных через AND.
Структура FilterOrProto — Фильтр OR
ПараметрТипПримечание
*conditionsFilterProto[]Список условий, объединенных через OR.
Структура FilterAtomProto — Простой фильтр (одно условие).
ПараметрТипПримечание
*fieldstringПоле, по которому идет фильтрация.
*opstringОператор. Возможные значения: <, >, =, !=, <=, >=, in, like, ilike, is null, is not null, any.
*valuestringЗначение, с которым сравнивается поле. В случае in значения перечисляются через запятую.
Структура OrderingProto — Сортировка
ПараметрТипПримечание
*fieldstringПоле, по которому идет сортировка.
*ascendingboolПо возрастанию или по убыванию.

tt.taxi.common.desc.KeyValue — Пара ключ+значение

Пара ключ+значение.

Структура KeyValueProto
ПараметрТипПримечание
*keystring
*valuestring

sys.desc.Account — Аккаунт пользователя

Структура AccountProto — Пользовательский аккаунт
ПараметрТипПримечание
*idint64Ид пользователя.
*loginstringЛогин пользователя.
*passwordHashstringХэш нового пароля SHA-256 (только для изменения)
*emailstringE-mail
*isActiveboolДействительная ли запись.
*roleIdint64Ид роли.
*serviceIdsint64[]Ид служб.
*groupIdsint64[]Ид групп.
*chiefIdsint64[]Ид руководителей.
*lastNamestringФамилия
*firstNamestringИмя
*middleNamestringОтчество
*phonestringТелефон
*isBannedboolЗаблокирован ли пользователь.
*banReasonstringПричина блокировки `
*isFiredboolУволен ли пользователь.
*firedReasonstringПричина увольнения.
*servicesTzServicesTimezonesInfo[]Информация о таймзонах служб.
*passwordStringstringПароль
Структура AccountListProto — Пользовательский аккаунт (список)
ПараметрТипПримечание
*idint64Ид пользователя.
*loginstringЛогин пользователя.
*emailstringE-mail
*dateRegint64Дата регистрации.
*isActiveboolДействительная ли запись.
*lastNamestringФамилия
*firstNamestringИмя
*middleNamestringОтчество
*servicesstring[]Службы пользователя.
*servicesIdsint64[]Список ИД служб пользователя.
*rolestringРоль пользователя.
*groupIdsint64[]Группы пользователя.
*groupsstring[]Группы пользователя.
*lastLoginint64Последний вход пользователя.
*lastIpstringIp пользователя.
*statusint32Статус пользователя (1 - онлайн, 2 - оффлайн, 3 - заблокирован, 4 - уволен)
*chiefsstring[]Руководители пользователя.
Структура ServicesTimezonesInfo — Информация о таймзонах служб (элемент списка)
ПараметрТипПримечание
*serviceIdint64Ид службы.
*tzstringТаймзона

tt.taxi.manager.desc.Group — Группы

Структура GroupProto — Группа пользователей
ПараметрТипПримечание
*idint64Ид группы.
*namestringНазвание группы.
*chiefIdsint64[]Список руководителей группы.
*userIdsint64[]Список пользователей в группе.
*descriptionstringОписание группы.
Структура GroupListProto — Группа пользователей (элемент списка)
ПараметрТипПримечание
*idint64Id группы.
*namestringНазвание группы.
*chiefsstring[]Список руководителей группы.
*usersint64Количество пользователей в группе.
*descriptionstringОписание группы.

tt.taxi.manager.desc.ServiceConnectionsList — Подключения

Структура ServiceConnectionsListProto — Подключения пользователей к службам (элемент списка)
ПараметрТипПримечание
*idint64Id службы.
*namestringНазвание службы.
*usersint64Количество пользователей.

tt.taxi.manager.desc.ConnectionsList — Подключенные пользователи

Структура ConnectionsListProto
ПараметрТипПримечание
*serviceNamestringНазвание службы.
*connectionsint64[]Список ИД подключенных пользователей.

tt.core.user.desc.UserPermission — Разрешения

Структура UserPermissionsProto — Список прав текущего пользователя
ПараметрТипПримечание
*permissionsUserPermissionProto[]Список разрешений.
Структура UserPermissionProto — Описание разрешения (для текущего пользователя)
ПараметрТипПримечание
*idint64Ид разрешения.
*codestringКод разрешения.

tt.core.user.desc.Role — Роль

Структура RoleProto — Роль пользователя в системе
ПараметрТипПримечание
*idint64Ид роли.
*namestringНазвание роли.
*permissionIdsint64[]Список разрешений для роли.
*descriptionstringОписание роли.
*isAdminboolРоль относится к администраторам.
Структура RoleListProto — Роль пользователя в системе (элемент списка)
ПараметрТипПримечание
*idint64Ид роли.
*namestringНазвание роли.
*descriptionstringОписание роли.
*usersint64Количество пользователей.

tt.taxi.manager.desc.Ruleset — Настройки распределения

Структура RulesetProto — Настройки распределения заказов
ПараметрТипПримечание
*idint64Ид набора правил.
*autoRejectTimeint32Время в секундах, через которое водитель автоматически откажется от предложенного заказа, если от приложения водителя не будет получен ответ. При отправке заказа водителю ему дается на принятие решения это время минус 5 секунд. 5 секунд - буферное время, отводимое на задержки в сети при передаче данных (лаг).
*advanceOrdersSilentTimeint32Время в секундах, в течение которого до начала предварительного заказа водитель не получает другие заказы по распределению.
*maxDistancedoubleМаксимальное расстояние в метрах для GPS-распределения. Если водитель находится дальше от точки подачи машины (с учетом графа дорог), чем это расстояние, то заказ ему предложен не будет.
*postponeDelayint32Задержка после круга распределения (сек). После того как заказ был предложен всем подходящим водителям, система ожидает этот промежуток времени, прежде чем предлагать заказ еще раз. Если в течение этого времени появится новый водитель, которому можно будет предложить заказ, то заказ будет ему предложен немедленно.
*maxDistribTimeint32Ограничение по времени для автораспределения заказа (сек). Если заказ не был распределен автоматически в течение этого времени, то мы устанавливаем ему статус "просрочен" и уведомляем клиента о том, что машину найти не удалось. После этого заказ либо продляется, либо отменяется.
*maxExtendTimesint32Макс. количество продлений заказа. После этого заказ будет снят.
*maxParkingDistanceint32Максимальная удаленность стоянки для автораспределения. Если этот параметр равен 0 - заказ будет предложен только водителям на той же стоянке, что и заказ. Если он равен 1 - то заказ будет предложен водителям как на той же стоянке, так и на смежных ей стоянках. Если он равен 2 - заказ будет предложен водителям, находящимся не более чем за 2 стоянки от заказа. И так далее.
*maxRejectsint32Количество отказов, после которых водителю не будет предлагаться данный заказ.
*algorithmint32Алгоритм распределения. См. перечисление AlgorithmType.
*advanceOrdersDistribTimeint32Время начала предварительного заказа (сек). За это время до начала предварительного заказа, если водитель подтвердил выполнение, водитель автоматически начнет выполнять заказ.
*maxDistribRoundsint32Максимальное число раундов распределения. После достижения этого числа заказ становится просроченным, так же, как если истечет время распределения.
*maxAvailOrdersint32Максимальное число доступных заказов, которые будут отправляться водителю.
*rulesPresetint32Приоритетный водитель. 0 - учитываются все параметры (смарт); 1 - учитывается только расстояние до заказа; 2 - учитывается только рейтинг борта.
*maxReserveDriversint32Максимальное число доступных броней на предварительный заказ.
*namestringНазвание набора правил.
*advanceOrdersTimeLimitint32Время (сек), по которому сервер определяет, срочный заказ или предварительный. Если указанное время начала в заказе больше текущей даты на эту величину, то заказ предварительный.
*waitForClientTimeint32Время (сек), через которое на МП будет доступна кнопка "Поторопить клиента".
*startPreorderAfterConfirmboolЕсли true, то предзаказы стартуют сразу же после подтверждения водителем. (Подтверждение приходит за 5 минут до времени начала предзаказа, время начала предзаказа определяется параметром advanceOrdersDistribTime).
*isNotPpAbroadboolНе выходить за границы стоянок.
*isForcedOrdersEnabledboolВключать режим автоназначения.
*advanceOrderNotifyDriverTimeint32Время (сек) до начала выполнения заказа, когда надо уведомить водителя о заказе.
*counterOrderTripPercentsint32% от маршрута для активации режима «встречный заказ».
*counterOrderDisableDistanceint32Радиус автоматического снятия режима «встречный заказ».
*counterOrderAddKarmaint32Изменение рейтинга для режима «встречный заказ».
*counterOrderMinDistanceint32Минимальное расстояние для включения режима «встречный заказ».
*counterOrderRejectsLimitint32Лимит предложений для режима «встречный заказ».
*counterOrderTimeLimitint32Лимит времени действия для режима «встречный заказ».
*isGreenWaveEnabledboolЗеленая волна активна.
*greenWaveAddKarmaint32Изменение к рейтингу водителя на зеленой волне.
*greenWaveRejectsLimitint32Количество предложений заказа которые зеленая волна действует (0 – без ограничений)
*greenWaveTimeLimitint32Количество минут, когда зеленая волна действует (0 – без ограничений; максимум 30 минут)
Перечисление AlgorithmType
НазваниеЗначениеПримечание
*ALL1Распределение "всем". Ставится автоматически при истечении числа попыток распределения, тогда заказ уходит всем водителям службы. Внимание: на веб-клиенте этот алгоритм не должен быть доступен! Выбирать можно только из следующих 3х алгоритмов.
*BY_ONE2Распределение "по одному". Водители получают заказы в порядке приоритета. Заказ одновременно предлагается только одному водителю.
*AVALANCHE3Распределение "лавина". Заказ в начале предлагается лучшему водителю, потом первым двум лучшим, потом первым трем лучшим и тд.
*OPEN4Распределение "открытый эфир". Заказ предлагается всем доступным водителям. Водитель может посмотреть список заказов на стоянке и взять любой из них.
Структура RulesetListProto — Настройки распределения заказов (список)
ПараметрТипПримечание
*idint64Ид набора правил.
*namestringНазвание набора правил.
*algorithmint32Алгоритм распределения. См. перечисление ServiceMode.
*rulesPresetint32Приоритетный водитель. 0 - учитываются все параметры (смарт); 1 - учитывается только расстояние до заказа; 2 - учитывается только рейтинг борта.
*maxDistribTimeint32Ограничение по времени для автораспределения заказа (сек). Если заказ не был распределен автоматически в течение этого времени, то мы устанавливаем ему статус "просрочен" и уведомляем клиента о том, что машину найти не удалось. После этого заказ либо продляется, либо отменяется.
*maxDistribRoundsint32Максимальное число раундов распределения. После достижения этого числа заказ становится просроченным, так же, как если истечет время распределения.
*postponeDelayint32Задержка после круга распределения (сек). После того как заказ был предложен всем подходящим водителям, система ожидает этот промежуток времени, прежде чем предлагать заказ еще раз. Если в течение этого времени появится новый водитель, которому можно будет предложить заказ, то заказ будет ему предложен немедленно.
*maxDistancedoubleМаксимальное расстояние в метрах для GPS-распределения. Если водитель находится дальше от точки подачи машины (с учетом графа дорог), чем это расстояние, то заказ ему предложен не будет.
*maxParkingDistanceint32Максимальная удаленность стоянки для автораспределения. Если этот параметр равен 0 - заказ будет предложен только водителям на той же стоянке, что и заказ. Если он равен 1 - то заказ будет предложен водителям как на той же стоянке, так и на смежных ей стоянках. Если он равен 2 - заказ будет предложен водителям, находящимся не более чем за 2 стоянки от заказа. И так далее.
*serviceIdsint64[]Список служб которые используют этот набор правил.

tt.taxi.manager.desc.Rule — Правило распределения

Структура RuleProto — Правило распределения заказов
ПараметрТипПримечание
*namestringКод правила.
*weightint32Вес правила (макс. баллы рейтинга)
*isEnabledboolВключено или выключено.

tt.taxi.manager.desc.StaticParam — Статический параметр

Статический параметр.

Структура StaticParam
ПараметрТипПримечание
*idint64Ид параметра.
*namestringНазвание параметра.
*weightint32Вес параметра.
*paramTypestringТип параметра (car - параметр авто, driver - параметр водителя)
*commentstring

tt.taxi.manager.desc.ShiftTime — Временной интервал

Структура ShiftTimeProto — Дескриптор временного интервала смены
ПараметрТипПримечание
*beginTimestringВремя начала.
*endTimestringВремя конца.
*dayOfWeekint32День недели (0 - воскресенье, 1 - понедельник, ..., 6 - суббота)

tt.taxi.manager.desc.Shift — Смена

Структура ShiftProto — Дескриптор смены
ПараметрТипПримечание
*idint64Ид смены.
*serviceIdint64Ид службы.
*namestringНазвание смены.
*isActualboolАктивная или архивная.
*timeQuotadoubleНорма выработки (% от времени смены)
*ordersQuotaint32Норма по заказам за смену.
*rejectQuotaint32Норма по отказам.
*sendNotificationsboolОтправлять ли уведомления.
*notifyTimeBeforeint32Отправлять уведомления за столько-то времени (сек.)
*notifyIntervalBeginstringВремя отправки - начало.
*notifyIntervalEndstringВремя отправки - конец.
*notifyTypeint32Вид уведомления (см. ShiftNotifyTypeProto)
*timesShiftTimeProto[]Настройка расписания смены.
*isComeOutControlboolКонтроль выхода на смену.
Структура ShiftListProto — Смена (в списке смен)
ПараметрТипПримечание
*idint64Ид смены.
*namestringНазвание смены.
*driversCountint64Количество водителей на смене.
*serviceIdint64Ид службы.
*serviceNamestringНазвание службы.
*isActualboolАктивная или архивная.
Перечисление ShiftNotifyTypeProto — Тип уведомлений о начале смены
НазваниеЗначениеПримечание
*UNKNOWN0Неизвестно
*SMS1SMS-сообщение
*APP_MESSAGE2Сообщение в приложении.
*CALL3Автодозвон

tt.taxi.manager.desc.Driver — Водитель

Структура DriverProto — Водитель.
ПараметрТипПримечание
*idint64Идентификатор
*lastNamestringФамилия
*firstNamestringИмя
*middleNamestringОтчество
*serviceIdint64Служба
*callsignstringПозывной
*emailstringE-mail водителя.
*loginstringЛогин водителя.
*tariffIdint64Базовый тариф.
*tariffExtint64[]Дополнения к тарифу.
*carIdint64Автомобиль
*putOnJobIdint64Оформил (аккаунт менеджера)
*mediaIdint64Источник (медиа-ресурс)
*firedDateint64Дата увольнения.
*hiredDateint64Дата приема на работу.
*photoIdint64Ид фото.
*stateint64Статус водителя.
*licensestringНомер лицензии.
*homeAddressstring[]Домашний адрес.
*phonestring[]Телефон
*notestringПримечание 1.
*banDateBeginint64Дата снятия со смены - если текущая дата не попадает в интервал бана (бан прошел), то эти поля остаются пустыми.
*banDateEndint64Дата окончания снятия со смены - если текущая дата не попадает в интервал бана (бан прошел), то эти поля остаются пустыми.
*banReasonstringПричина снятия со смены - если текущая дата не попадает в интервал бана (бан прошел), то эти поля остаются пустыми.
*fireReasonstringПричина увольнения.
*shiftIdint64Ид смены водителя.
*allowAdvancePaymentboolДоступен ли обещаный платеж.
*isOnlineboolОнлайн
*fullNamestringФио
*passwordStringstringПароль
*shiftsint64[]Список смен.
*note2stringПримечание 2.
*note3stringПримечание 3.
*dateint64Дата 1.
*date2int64Дата 2.
*date3int64Дата 3.
*extFieldsNamesDriverExtFieldsNamesProto[]Информация о полях с динамическими именами.
Структура DriverUpdateProto — Структура для изменения данных водителя.
ПараметрТипПримечание
*idint64Идентификатор
*serviceIdint64Служба
*callsignstringПозывной
*carIdint64Автомобиль
*putOnJobIdint64Оформил (аккаунт менеджера)
*mediaIdint64Источник (медиа-ресурс)
*firedDateint64Дата увольнения.
*hiredDateint64Дата приема на работу.
*photoIdint64Ид фото.
*licensestringНомер лицензии.
*homeAddressstring[]Домашний адрес.
*phonestring[]Телефон
*notestringПримечание
*banDateBeginint64Дата снятия со смены.
*banDateEndint64Дата окончания снятия со смены.
*banReasonstringПричина снятия со смены.
*fireReasonstringПричина увольнения.
*shiftIdint64Ид смены водителя.
*allowAdvancePaymentboolДоступен ли обещаный платеж.
*shiftsint64[]Список смен.
*note2stringПримечание 2.
*note3stringПримечание 3.
*dateint64Дата 1.
*date2int64Дата 2.
*date3int64Дата 3.
Структура DriverExtFieldsNamesProto — описание полей с динамическими именами
ПараметрТипПримечание
*fieldIdstringИД поля.
*fieldNamestringТекст

tt.taxi.manager.desc.DriverListView — Водитель (элемент списка)

Примечание к полю statusText:
1) Если установлена дата увольнения работника (поле 'firedDateObj') - это "Уволен".
2) Если установлена дата забаненных водителя (поле 'banDateBegin') - это "Отстранен".
3) Если поле "isOnline" установлено как false - то "Оффлайн".
4) Если поле "isOnline" установлено как true то тогда уже проверяется поле "stateId" и выводятся состояния с перечисления DriverInfoProto.State.

Структура DriverListViewProto — Элемент списка водителей.
ПараметрТипПримечание
*idint64Ид водителя.
*callsignstringПозывной
*lastNamestringФамилия
*firstNamestringИмя
*middleNamestringОтчество
*phonestring[]Телефон
*carstringИнформация об автомобиле.
*tariffstringНазвание тарифа.
*hiredDateint64Дата приема на работу.
*hiredSourcestringИсточник
*ratingint32Рейтинг водителя.
*isOnlineboolВ данный момент онлайн.
*serviceIdint64Служба
*carIdint64Ид автомобиля водителя.
*tariffIdint64Ид тарифа водителя.
*firedDateint64Дата увольнения.
*putOnJobIdint64Ид менеджера, который принял водителя на работу.
*pojLastNamestringФамилия менеджера.
*pojFirstNamestringИмя менеджера.
*pojMiddleNamestringОтчество менеджера.
*shiftIdint64Ид смены водителя.
*carClassIdint64Ид класса машины водителя.
*banDateBeginint64Дата снятия со смены.
*banDateEndint64Дата окончания снятия со смены.
*stateIdint64Статус водителя (см. DriverInfoProto.State)
*statusTextstringТекст статуса водителя.
*balancedoubleБаланс водителя.
*serviceNamestringИмя службы.
*cityIdint64ИД города.
*cityNamestringНазвание города.
*phonesStringstringТелефоны строкой.
*notestringПримечание 1.
*note2stringПримечание 2.
*note3stringПримечание 3.
*dateint64Дата 1.
*date2int64Дата 2.
*date3int64Дата 3.
*fullNamestringПолное имя водителя.

tt.taxi.manager.desc.Discount — Дисконтная карта

Структура DiscountProto — Дисконтная карта
ПараметрТипПримечание
*idint64Ид
*namestringНазвание
*numberstringНомер карты.
*codeWordstringКодовое слово.
*clientIdint64Ид клиента.
*phonestringТелефон
*serviceIdsint64[]Ид служб.
*cardTypeint64Тип карты: 1 - накопительная, 2 - разовая, 3 - фиксированная.
*beginDateint64Период действия - дата от.
*endDateint64Период действия - дата до.
*daysint32Срок действия в днях.
*activationSumdoubleНакопительная сумма, после которой активируется карта (руб). 0 - активируется при первой поездке.
*isManualActivationboolГалочка "Договор" в ручном режиме.
*freeRideEnabledboolВключены ли бесплатные поездки.
*freeRideCountint32Число n (каждая n-ая поездка бесплатно)
*partsDiscountPartProto[]Скидки
*bonusesDiscountBonusProto[]Бонусы
*driverEarnsBonusboolФлаг "Зачисление начисленных бонусов на счет водителю по завершении заказа"
*isActualboolАктивная или архивная.
*discountValuedoubleВеличина скидки.
*isMultiUserboolМногопользовательская карта.
*driverEarnsFactordoubleКоэф-т зачисления водителю.
*isOneOrderboolРазовая привязка скидки.
Структура DiscountListProto — Дисконтная карта - элемент списка
ПараметрТипПримечание
*idint64Id
*namestringНазвание
*numberstringНомер карты.
*serviceIdsint64[]Ид служб.
*servicesstring[]Названия служб.
*beginDateint64Начало периода действия.
*endDateint64Конец периода действия.
*discountValuedoubleВеличина скидки.
*bonusMoneydoubleНакопленный бонус.
*clientIdint64Ид клиента.
*isActualboolАктивная или архивная.
*isUserAllowboolКарта доступна для привязки к клиенту.
Структура DiscountPartProto — Скидка (для дисконтных карт)
ПараметрТипПримечание
*discountValuedoubleВеличина скидки.
*accumSumdoubleНакопленная сумма.
*isMoneyboolFalse - %, true - руб.
*ridesint32Количество поездок.
*isMpboolПрименяется для МП клиентов.
*isRidesboolРасчет по поездкам.
*daysint32Количество дней.
Структура DiscountBonusProto — Бонус (для дисконтных карт)
ПараметрТипПримечание
*isMoneyboolFalse - поездки, true - руб.
*accumSumdoubleНакопленная сумма (для бонусов за накопленную сумму)
*factordoubleКоэффициент (для бонусов за накопленную сумму)
*ridesint32Кол-во поездок (для бонусов за кол-во поездок)
*ridesBonusdoubleНоминал (для бонусов за кол-во поездок)

tt.taxi.manager.desc.ExtraPayment — Дополнение к тарифу клиента

Структура ExtraPaymentProto — Описание дополнения к тарифу клиента
ПараметрТипПримечание
*idint64Ид дополнения.
*namestringНазвание дополнения.
*pricedoubleЦена
*serviceIdsint64[]Службы
*isActualboolАктивное/архивное
Структура ExtraPaymentListProto — Описание дополнения к тарифу клиента (элемент списка)
ПараметрТипПримечание
*idint64Ид дополнения.
*namestringНазвание дополнения.
*pricedoubleЦена
*serviceIdsint64[]Службы
*servicesstringСтрока, где через запятую идут названия служб.
*isActualboolАктивное/архивное

tt.taxi.operator.desc.Complaint — Жалоба

Жалоба.

Список допустимых параметров (поле tags)
Название Описание
car_model Марка машины
car_color Цвет машины
car_number Номер машины
car_board Борт
driver_fio ФИО водителя
route_from Пункт отправления
route_to Пункт назначения
phone_received Телефон, с которого была принята жалоба

Список категорий для жалоб клиентов
• Тарифы
• Не перезвонили
• Работа операторов
• Работа службы в целом
• Не приехала машина
• Грубость
• Забыли вещи
• Убрать номер из рассылки
• Другое
Список категорий для жалоб операторов
• Карта города
• ПО Taxi Online
• Тарифы
• Грубость
• ГАИ, сломался
• Случайно взял заказ
• Клиент не доступен
• Другое
Возможные состояния жалобы
• Открыта
• Закрыта
• Черновик.

Структура ComplaintProto
ПараметрТипПримечание
*idint64Идентификатор редактируемой жалобы.
*operatorIdint64Оператор, который зарегистрировал жалобу.
*tagsKeyValueProto[]Опциональные строковые параметры жалобы.
*complaintTextstringТекст жалобы.
*regDateint64Дата регистрации жалобы (кол-во миллисекунд с начала unix эпохи)
*phonestringТелефон для связи.
*categorySetint64[]Список категорий, к которым относится жалоба.
*stateIdint64Состояние жалобы.
*complaintTypestringТип жалобы. Возможные значения: client - жалоба клиента, driver - жалоба водителя, operator - жалоба оператора.
*serviceIdint64Служба, к которой относится жалоба.

tt.taxi.manager.desc.TariffChange — Задача на смену тарифа

Структура TariffChangeProto — Задача на смену тарифа
ПараметрТипПримечание
*idint64Ид
*oldTariffIdint64Ид старого тарифа.
*newTariffIdint64Ид нового тарифа.
*serviceIdint64Служба, в рамках которой нужно поменять тариф.
*dateint64Дата смены тарифа.
*statusint64Статус задачи. 1 - новая, 2 - сделана, 3 - возникла ошибка.
Структура TariffChangeListProto — Задача на смену тарифа (элемент списка)
ПараметрТипПримечание
*idint64Ид
*oldTariffIdint64Ид старого тарифа.
*oldTariffNamestringНазвание старого тарифа.
*newTariffIdint64Ид нового тарифа.
*newTariffNamestringНазвание нового тарифа.
*dateint64Дата смены тарифа.
*isExtensionboolДополнение к тарифу или базовый тариф.
*serviceIdint64Ид службы.
*serviceNamestringНазвание службы.

tt.taxi.manager.desc.Order — Заказ

Структура OrderCarSaveExtProto — Назначение на заказ
ПараметрТипПримечание
*parentIdint64Ид головного заказа.
*orderIdint64Ид заказа.
*driverIdint64Ид водителя которого нужно назначить.
*carClassIdint64Ид класса машины.
Структура OrderClientSaveExtProto
ПараметрТипПримечание
*clientIdint64Ид клиента.
*lastnamestringИмя клиента.
*calledFromstringВходящий телефон.
*clientPhonestringТелефон для связи.
Структура OrderSaveExtProto
ПараметрТипПримечание
*idint64Ид заказа.
*typeIdint64Тип заказа (1 - срочный, 2 - предварительный). Обязательное поле при создании.
*serviceIdint64Ид службы. Обязательное поле при создании.
*tariffIdint64Клиентский тариф для заказа.
*dateNewint64Дата регистрации заказа. Обязательное поле при создании.
*datePlannedStartProtoDatePlannedStartProtoЗапланированная дата подачи автомобиля.
*clientOrderClientSaveExtProto
*discountIdint64Ид дисконтной карты.
*addressFromAddressProtoОткуда
*addressFromPorchstringНомер подъезда (откуда)
*addressFromNotestringКомментарий к заказу.
*addressToAddressProto[]Куда
*isContractboolЗаказ по договору.
*driverIdint64Ид водителя основного заказа.
*carsOrderCarSaveExtProto[]
*isFromClientsApiboolЗаказ создан из клиентского Api.
*rejectStatusstringСтатус отказа См. RejectStatuses.
*isDangerboolПодозрительный заказ.
*tariffAdditionsint64[]Список дополнений к тарифу.
*isForcedboolЗаказ с автоназначением.
Структура DatePlannedStartProto
ПараметрТипПримечание
*timestringВремя
*isTodayboolЗаказ на сегодня.
*datestringДата заказа (необязательное поле, dd/MM/YYYY)
Перечисление RejectStatuses
НазваниеЗначениеПримечание
*NONE1Нет отказа.
*TRYING2Попытка отказа.
*ACCEPTED3Отказ принят.
*REJECTED4Отказ отклонен.
*CONGESTION5Затор
Структура OrderCarExtProto — Описание борта, который выполняет заказ
ПараметрТипПримечание
*parentIdint64Родительский заказ (для заказов с несколькими машинами)
*orderIdint64Ид заказа.
*driverIdint64Ид водителя.
*driverLastNamestringФамилия водителя.
*driverFirstNamestringИмя водителя.
*driverMiddleNamestringОтчество водителя.
*driverCallsignstringПозывной водителя.
*driverCarIdint64Ид машины водителя.
*driverCarClassIdint64Класс машины водителя (эконом, бизнес etc...)
*carModelstringМодель машины.
*carColorstringЦвет машины.
*carNumberstringНомер машины.
Структура OrderExtProto — Заказ (Ext)
ПараметрТипПримечание
*idint64Ид заказа.
*operatorIdint64Ид оператора, принявшего заказ.
*typeIdint64Тип заказа (1 - срочный, 2 - предварительный). Обязательное поле при создании.
*stateIdint64Состояние заказа.
*serviceIdint64Ид службы. Обязательное поле при создании.
*clientIdint64Ид клиента.
*clientNamestringИмя клиента.
*driverIdint64Ид водителя.
*arriveTimeint32Время прибытия в минутах, назначает водитель.
*dateNewint64Дата регистрации заказа. Обязательное поле при создании.
*dateDriverFoundint64Дата когда водителю уходит заказ.
*dateDriverAcceptint64Дата начала выполнения заказа водителем.
*dateWaitForClientint64Дата когда водитель прибыл на место и ожидает клиента.
*dateInProgressint64Дата, когда водитель повез клиента.
*fromAddressIdint64Ид адреса подачи машины. Обязательное поле при создании.
*fromPlaceIdint64Ид объекта подачи машины.
*fromPorchstringНомер квартиры (откуда)
*toAddressIdint64Ид адреса назначения.
*toPlaceIdint64Ид объекта назначения.
*toPorchstringНомер квартиры (куда)
*notestringКомментарий к заказу.
*isEmergencyboolЭкстренный заказ.
*automobileClassint64Класс автомобиля, заказанный клиентом.
*parkingPointIdint64Ид стоянки. Определяется автоматически по адресу. Если адрес не найден или не относится ни к какой стоянке, можно задать стоянку напрямую.
*calledFromstringВходящий телефон.
*clientPhonestringТелефон для связи.
*dateEndint64Дата завершения заказа.
*costdoubleПредварительная стоимость заказа.
*parentIdint64Родительский заказ (для заказов с несколькими машинами)
*parentNumint64Номер подзаказа.
*tariffIdint64Клиентский тариф для заказа.
*discountIdint64Ид дисконтной карты.
*routeLengthdoubleДлина маршрута в метрах.
*isCashboolПлатит ли клиент (false для корпоративных клиентов)
*isContractboolЗаказ по договору.
*costStringstringОтформатированная предварительная стоимость заказа.
*datePlannedStartProtoDatePlannedStartProtoЗапланированная дата подачи автомобиля.
*addressFromAddressProtoОткуда
*addressToAddressProto[]Куда
*driverDriverProtoВодитель
*driverCarCarListProtoАвтомобиль
*clientClientCardProtoКлиент
*costInfoGetOrderCostRsProtoСтоимость
*serviceServiceListProtoСлужба
*formSettingsOrderFormSettingsProtoНастройки формы.
*routeLengthStringstringРастояние строкой в км.
*orderDiscountInfoDiscountProtoИнформация о дисконтной карте.
*orderCarsOrderCarExtProto[]Машины на заказе.
*costBeforeRounddoubleСтоимость без округления.
*rejectStatusstringСтатус отказа См. RejectStatuses.
*tariffAdditionsint64[]Список дополнений к тарифу.
*isForcedboolЗаказ с автоназначением.
Структура OrderProto — Заказ
ПараметрТипПримечание
*idint64Ид заказа.
*operatorIdint64Ид оператора, принявшего заказ.
*typeIdint64Тип заказа (1 - срочный, 2 - предварительный). Обязательное поле при создании.
*stateIdint64Состояние заказа.
*serviceIdint64Ид службы. Обязательное поле при создании.
*clientIdint64Ид клиента.
*clientNamestringИмя клиента.
*driverIdint64Ид водителя.
*arriveTimeint32Время прибытия в минутах, назначает водитель.
*dateNewint64Дата регистрации заказа. Обязательное поле при создании.
*dateDriverFoundint64Дата когда водителю уходит заказ.
*dateDriverAcceptint64Дата начала выполнения заказа водителем.
*dateWaitForClientint64Дата когда водитель прибыл на место и ожидает клиента.
*dateInProgressint64Дата, когда водитель повез клиента.
*fromAddressIdint64Ид адреса подачи машины. Обязательное поле при создании.
*fromPlaceIdint64Ид объекта подачи машины.
*fromPorchstringНомер квартиры (откуда)
*toAddressIdint64Ид адреса назначения.
*toPlaceIdint64Ид объекта назначения.
*toPorchstringНомер квартиры (куда)
*notestringКомментарий к заказу.
*isEmergencyboolЭкстренный заказ.
*automobileClassint64Класс автомобиля, заказанный клиентом.
*datePlannedStartint64Запланированная дата подачи автомобиля, для предварительных заказов.
*parkingPointIdint64Ид стоянки. Определяется автоматически по адресу. Если адрес не найден или не относится ни к какой стоянке, можно задать стоянку напрямую.
*calledFromstringВходящий телефон.
*clientPhonestringТелефон для связи.
*dateEndint64Дата завершения заказа.
*costdoubleПредварительная стоимость заказа.
*parentIdint64Родительский заказ (для заказов с несколькими машинами)
*parentNumint64Номер подзаказа.
*tariffIdint64Клиентский тариф для заказа.
*discountIdint64Ид дисконтной карты.
*routeLengthdoubleДлина маршрута в метрах.
*isCashboolПлатит ли клиент (false для корпоративных клиентов)
*isContractboolЗаказ по договору.
*costStringstringОтформатированная предварительная стоимость заказа.
*datePlannedStartISO8601stringЗапланированная дата подачи автомобиля, для предварительных заказов (строкой в формате ISO8601)
Структура OrderListProto — Заказ (элемент списка)
ПараметрТипПримечание
*idint64Ид заказа.
*typeIdint64Тип заказа (1 - срочный, 2 - предварительный)
*dateNewint64Дата регистрации заказа.
*timeFromStartint64Время, прошедшее с момента создания заказа (мс)
*stateTimerint64Время, прошедшее с начала этапа (мс)
*dateEndint64Дата завершения заказа.
*datePlannedStartint64Планируемая дата подачи машины (для предварительных заказов)
*fromStreetstringАдрес откуда - улица.
*fromHouseNumstringАдрес откуда - номер дома.
*fromPlacestringАдрес откуда - объект.
*toStreetstringАдрес куда - улица.
*toHouseNumstringАдрес куда - номер дома.
*toPlacestringАдрес куда - объект.
*carColorstringЦвет машины.
*carModelstringМодель машины.
*carNumberstringНомер машины.
*calledFromstringНомер телефона, с которого поступил звонок.
*clientPhonestringТелефон клиента для связи.
*operatorNamestringИмя оператора.
*stateIdint64Статус заказа.
*arriveTimeint32Время подачи машины, установленное водителем (в минутах)
*clientNotifyCountint32Количество дозвонов.
*serviceIdint64Ид службы.
*clientNamestringИмя клиента.
*reservationsint64Количество водителей, забронировавших заказ (для пред. заказов)
*callsignstringПозывной водителя, выполняющего заказ.
*costdoubleПредварительная стоимость заказа.
*dateDriverAcceptint64Начало выполнения заказа.
*servicestringСлужба (название)
*serviceTzstringЧасовой пояс службы.
*notestringКомментарий к заказу.
*parentIdint64Родительский заказ (для заказов с несколькими машинами)
*parentNumint64Номер подзаказа.
*timeLimitint64Ограничение времени на текущий этап (мсек)
*isProblemboolЯвляется ли заказ проблемным.
*driverPhonestringТелефон водителя.
*stageIdint64Категория статуса заказа (этап жизненного цикла). См. OrderStageProto
*driverIdint64Ид водителя, которому назначен заказ.
*isCashboolПлатит ли клиент (false для корпоративных клиентов)
*isContractboolЗаказ по договору.
*addr1Idint64ИД адреса откуда.
*addr2Idint64ИД адреса куда.
*addr1CoordGeoPointProtoКоординаты адреса "откуда"
*addr2CoordGeoPointProtoКоординаты адреса "куда"
*isFromClientsApiboolЗаказ создан из клиентского Api.
Структура OrderCarProto — Описание борта, который выполняет заказ
ПараметрТипПримечание
*orderIdint64Ид заказа.
*carModelstringМодель машины.
*carColorstringЦвет машины.
*carNumberstringНомер машины.
*driverLastNamestringФамилия водителя.
*driverFirstNamestringИмя водителя.
*driverMiddleNamestringОтчество водителя.
*driverCallsignstringПозывной водителя.
*parentIdint64Родительский заказ (для заказов с несколькими машинами)
*parentNumint64Номер подзаказа.
Перечисление OrderStageProto — Категории статусов заказа (этапы жизненного цикла).
НазваниеЗначениеПримечание
*UNKNOWN0
*BEFORE_START1Ожидание начала.
*IN_PROGRESS2Выполняется
*SUCCESS3Успешно выполнен.
*FAILURE4Не выполнен.

tt.taxi.manager.desc.ForcedOrdersSettings — Настройка заказов с автоназначением

Структура ForcedOrdersSettings
ПараметрТипПримечание
*longOrderHappenint64Включить автоназначение, если заказ долго на распределении (0 - выключить)
*isPreorderRejectHappenboolВключить автоназначение, если произошел отказ от предварительного заказа.
*isManualboolВключать автоназначение вручную, на форме заказа.
*maxDistancedoubleМаксимальное расстояние в метрах для GPS-распределения.

tt.taxi.manager.desc.CallsAndSms — Звонки и СМС

Структура CallListProto — Звонок
ПараметрТипПримечание
*idint64Id звонка (внутренний)
*externalIdint64Id звонка (на сервере уведомлений)
*customerPhonestringТелефон клиента или водителя.
*servicePhonestringТелефон службы.
*isIncomingboolВходящий или исходящий.
*orderIdint64Ид заказа.
*notificationIdint64Ид уведомления.
*creationDateint64Дата создания.
*endDateint64Дата окончания.
*statusint64Статус звонка (см. CallStatus)
Структура SmsListProto — СМС
ПараметрТипПримечание
*idint64Id смс (внутренний)
*externalIdint64Id смс (на сервере уведомлений)
*phonestringТелефон клиента.
*orderIdint64Ид заказа.
*notificationIdint64Ид уведомления.
*messagestringТекст сообщения.
*creationDateint64Дата создания.
*endDateint64Дата уведомления о доставке.
*statusint64Статус смс: 1 - в процессе доставки, 2 - доставлено, 3 - ошибка при доставке.
Структура CallLogProto — Звонок - запись в журнале