Поиск подходящего адреса.
Параметр | Тип | Примечание |
---|---|---|
*text | string | Шаблон поиска (улица и номер дома через запятую) |
*limit | int32 | Ограничение на кол-во результатов. |
Параметр | Тип | Примечание |
---|---|---|
*data | AddressProto[] | Результаты |
Получение адреса по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int32 |
Параметр | Тип | Примечание |
---|---|---|
*data | AddressProto |
Создается сессия для водителя, водитель переводится в состояние онлайн, у водителя обновляется дата последнего события.
Возобновляется процедура распределения заказов.
Параметр | Тип | Примечание |
---|---|---|
*login | string | Логин |
string | Email водителя. Устарело. Используется, если не заполнено поле логин. | |
*passwordHash | string | SHA256 пароля. |
*deviceId | string | Udid устройства. |
*fcmId | string | FCM instance ID. |
*mpVersion | int32 | Версия клиента (необязательное) |
Параметр | Тип | Примечание |
---|---|---|
*sid | string | Идентификатор сессии. |
*accountId | int64 | Ид водителя. |
Запрос завершает сессию.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Неиспользуемая переменная. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
• Получаем водителя с правом первоочередного выбора для заказа, и время ожидания для других водителей.
• Если это текущий водитель, то время ожидания - 0, и проверять резервирование не нужно.
• Если нужно проверять резервирование, то если какой-то другой водитель уже отправил запрос на взятие заказа, то метод завершается с ошибкой.
• Если время ожидания больше 0, то резервируем заказ за текущим водителем, и отправляем ему в ответ время ожидания. Когда время ожидания истечет, автоматически берем заказ.
• Иначе сразу же берем заказ. Отправляем водителям, которым был доступен этот заказ, оповещение. Отправляем всем водителям службы оповещение об изменении числа доступных заказов на стоянке.
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа. |
*arriveTime | int32 | Время подачи автомобиля (мин) |
Параметр | Тип | Примечание |
---|---|---|
*waitSeconds | int32 | Подождите X секунд. |
*serviceTariffs | ClientTariffProto[] | Тарифы службы. В случае автоматического переключения тарифов возвращаем 1 тариф с разными сегментами, в случае ручного переключения - 2 тарифа, городской и загородный. |
*orderTariffs | ClientTariffProto[] | Тарифы для текущего заказа, если есть. |
Запрос устанавливает окончание поездки
Заказ переводится в состояние "выполнен". Водитель переводится в состояние "готов".
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа, если не указан - заказ с бордюра. |
*doneDate | int64 | Дата выполнения заказа (unix time * 1000) |
*price | double | Стоимость поездки. |
*time | int64 | Время выполнения заказа (мсек) |
*distance | double | Расстояние поездки (метры) |
*tariffId | int64 | Ид клиентского тарифа поездки. |
*internalOrderId | string | Внутренний идентификатор заказа (для заказов с бордюра). Должен был уникальным для всей истории работы водителя. Костыль, нужен чтобы МП не присылал несколько одинаковых запросов о выполнении заказа. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Запрос увеличивает время прибытия автомобиля к месту заказа на указанное количество минут.
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа. |
*timeInc | int32 | Добавочное время (мин.) |
Параметр | Тип | Примечание |
---|---|---|
*time | int32 | Итоговое время прибытия (то что было установлено + указанное в запросе) |
Запрос ставит предзаказ в резерв водителю.
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Запрос устанавливает начало ожидания клиента
Заказ переводится в состояние "ожидание клиента".
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Заказ переводится в состояние "выполняется" (момент начала поездки)
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Заказ снимается, если указан параметр needCancel, иначе переводится в состояние "новый". Водитель переводится в состояние "готов".
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа. |
*needCancel | bool | True - снимать заказ в системе после отказа, false - перевести заказ в состояние "новый" |
*refusalCause | string | Причина отказа (BROKE_CAR - Сломалась машина, CLIENT_REFUSED - Клиент отказался, DANGEROUS_CLIENT - Опасный клиент) |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Запрос снимает бронь с предзаказа.
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Запрос отклоняет заказ (пока заказ еще не взят)
Отказ от доступного заказа. Возобновляется процедура распределения заказов.
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа. |
*isForcedOrder | bool | Отказ от автоназначения. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Подтверждение выполнения предзаказа (отправляется в ответ на запрос подтверждения)
Подтверждаем предварительный заказ. Отправляем оповещение всем водителям службы о том, что с них снята бронь.
Параметр | Тип | Примечание |
---|---|---|
*orderID | int64 | ID заказа. |
PUSH-запрос для подтверждения предзаказа.
Параметр | Тип | Примечание |
---|---|---|
*order | OrderProto | Предзаказ для подтверждения. |
*startDate | int64 | Дата начала выполнения заказа (в случае подтверждения) |
Определить, что должен сделать клиент с данным заказом
Т.к. используем концепцию "тонкого клиента" - то в идеале вся логика клиента должна быть на сервере.
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | Ид заказа. |
Параметр | Тип | Примечание |
---|---|---|
*status | OrderOfferStatus | Команда на клиент. |
*reason | string | Сообщение |
Название | Значение | Примечание |
---|---|---|
*SHOW_OFFER | 1 | Показать форму заказа. |
*WAIT_FOR_OFFER | 2 | Подождать, пока придет предложение заказа. |
*SHOW_CUSTOM_MESSAGE | 3 | Показать сообщение. |
*SHOW_MESSAGE_WAIT | 4 | Показать сообщение "подождите вашей очереди" |
Расчитать растояние до заказов.
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | ИД заказа. |
Параметр | Тип | Примечание |
---|---|---|
*distance | double | Растояние в метрах. |
Получить список всех доступных заказов.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*orders | OrderProto[] | Список заказов. |
*isOnlineOnly | bool | Показывать заказы только на линии. |
Получить список заказов на стоянке, где нет водителей.
Параметр | Тип | Примечание |
---|---|---|
*parkingPointId | int64 |
Параметр | Тип | Примечание |
---|---|---|
*orders | OrderProto[] | Список заказов. |
*success | bool | Удалось ли получить список заказов. |
*isOnlineOnly | bool | Показывать заказы только на линии. |
Возвращает информацию по предварительным заказам.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*orderInfo | OrderInfoProto | Информация о предварительных заказах. |
*advanceOrdersInfo | AdvanceOrdersInfoProto | Доп. информация о предварительных заказах. |
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | ID заказа. |
Параметр | Тип | Примечание |
---|---|---|
*isAccept | bool | Статус взятия заказа. |
*serviceTariffs | ClientTariffProto[] | Тарифы службы. В случае автоматического переключения тарифов возвращаем 1 тариф с разными сегментами, в случае ручного переключения - 2 тарифа, городской и загородный. |
*orderTariffs | ClientTariffProto[] | Тарифы для текущего заказа, если есть. |
tt.core.messages.Send
Отправить сообщение одному или нескольким получателям.
Параметр | Тип | Примечание |
---|---|---|
*message | MessageDescProto | Сообщение |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
tt.core.messages.GetHistory
Получение истории сообщений.
Параметр | Тип | Примечание |
---|---|---|
*contactID | int64 | ID контакта. |
*fromDate | int64 | Дата начиная с которой вернуть историю (UNIX TIMESTAMP сек.) |
*toDate | int64 | Дата до которой вернуть историю (UINIX TIMESTAMP сек.) |
*limit | int32 | Максимальное число сообщений (не более 100) |
Параметр | Тип | Примечание |
---|---|---|
*messages | MessageDescProto[] | Список сообщений. |
tt.core.messages.GetContacts
Получение списка контактов и групп.
Параметр | Тип | Примечание |
---|---|---|
*page | int32 | Номер страницы (начиная с 0) |
*itemsPerPage | int32 | Количество элементов на странице. |
*filter | string | Фильтрация контактов по строке. |
Параметр | Тип | Примечание |
---|---|---|
*groups | GroupDescProto[] | Список групп. |
*contacts | ContactDescProto[] | Список контактов. |
Получение списка контактов по id контактов.
Параметр | Тип | Примечание |
---|---|---|
*contactIds | int64[] | Список ид контактов. |
Параметр | Тип | Примечание |
---|---|---|
*contacts | ContactDescProto[] | Список контактов. |
tt.core.messages.GetMessages
Получение списка новых сообщений. Это же сообщение приходит в PUSH;
Параметр | Тип | Примечание |
---|---|---|
*unused | bool |
Параметр | Тип | Примечание |
---|---|---|
*messages | MessageDescProto[] | Список сообщений. |
Данный прото файл используется в следующих функциях:
tt.core.messages.Delete
Удаление сообщения. Можно удалять только свои сообщения, при этом сообщения у получателя/отправителя остаются;
Параметр | Тип | Примечание |
---|---|---|
*messages | int64[] | Список ID сообщений. Удаляются индивидуальные сообщения. |
Параметр | Тип | Примечание |
---|---|---|
*unused | bool |
tt.core.messages.SetReaded
Отметить соощение как прочитанное. Эту функцию надо вызывать только тогда когда установлен флаг confirmation. Вызывать только после того как пользователь каким либо образом подтвердил прочтение (например кнопку нажал).
tt.core.messages.SetReceived
Отметить сообщение как полученное. Эту функуию надо вызывать каждый раз при получении нового сообщения.
Отменить тревогу.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Ничего не нужно. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид тревоги. |
Поднять тревогу.
Параметр | Тип | Примечание |
---|---|---|
*coords | GeoPointProto | Текущие координаты водителя. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид тревоги. |
*driverId | int64 | Ид водителя, поднявшего тревогу. |
*driverLastName | string | Фамилия водителя, поднявшего тревогу. |
*driverFirstName | string | Имя водителя, поднявшего тревогу. |
*driverMiddleName | string | Отчество водителя, поднявшего тревогу. |
*coords | GeoPointProto | Координаты водителя. |
*street | string | Улица |
*houseNum | string | Номер дома. |
*beginDate | int64 | Дата поднятия тревоги. |
*callsign | string | Позывной водителя. |
*carModel | string | Марка машины. |
*carColor | string | Цвет машины. |
*carNumber | string | Номер машины. |
*endDate | int64 | Дата окончания тревоги. |
*isActive | bool | Активна ли тревога. |
*relevantTo | int64 | Актуальна до. |
Параметр | Тип | Примечание |
---|---|---|
*data | AlarmProto | Информация о тревоге. |
Утверждение или отказ в выходе на смену водителю по фото автомобиля.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*approved | bool | Утверждено или отказ. |
*message | string | Сообщение для водителя. |
Параметр | Тип | Примечание |
---|---|---|
*approved | bool | Утверждено или отказ. |
*message | string | Сообщение для водителя. |
Запрос изменяет профиль водителя.
Параметр | Тип | Примечание |
---|---|---|
*phone | string | Телефон |
string | Эл. почта. |
Запрос изменяет состояние водителя (в том числе выход на смену, уход со смены)
Параметр | Тип | Примечание |
---|---|---|
*state | DriverInfoProto.State | Новое состояние. |
Параметр | Тип | Примечание |
---|---|---|
*state | DriverInfoProto.State | Текущее(установленное) состояние. |
Возвращает необходимость проверки фото автомобиля оператором для выхода на смену.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Параметров нет. |
Параметр | Тип | Примечание |
---|---|---|
*isRequired | bool | Необходимость проверки фото. |
Запрос выполняет обещанный платеж.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Параметр | Тип | Примечание |
---|---|---|
*success | bool | Успех платежа. |
*allowAdvancePayment | bool | Доступность обещанного платежа в будущем. |
*messageText | string | Текст сообщения для пользователя. |
Запрос устанавливает последние координаты (gps) водителя.
Параметр | Тип | Примечание |
---|---|---|
*coords | GeoPointProto | |
*provider | string | Источник |
*accuracy | double | Точность |
*speed | double | Скорость |
Параметр | Тип | Примечание |
---|---|---|
*val | bool |
Послать фотографию автомобиля для выхода на смену.
Параметр | Тип | Примечание |
---|---|---|
*photo | DriverPhotoProto | Фото |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид фотографии на сервере. |
Позвонить клиенту (заглушка)
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Позвонить оператору (заглушка)
Параметр | Тип | Примечание |
---|---|---|
*reason | string | Причина звонка. |
Запрос возвращает текущую версию протокола.
Параметр | Тип | Примечание |
---|---|---|
*clientAppVersion | string | Версия клиентского приложения. |
*clientProtoVersion | string | Версия протокола клиентского приложения. |
Параметр | Тип | Примечание |
---|---|---|
*serverProtoVersion | string | Версия протокола сервера. |
*lastClientAppVersionCode | int32 | Код (целое число) последней доступной версии клиента, соответствующий android:versionCode в манифесте приложения. |
*lastClientAppUrl | string | Адрес для загрузки последней версии клиента. |
Запрос возвращает время, прошедшее с последнего выхода на смену водителя.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*timeElapsed | int64 | Время (в мс), прошедшее с момента выхода водителя на смену. |
Возвращает границы города.
Параметр | Тип | Примечание |
---|---|---|
*cityId | int32 |
Параметр | Тип | Примечание |
---|---|---|
*bounds | GeoPolygonProto |
Возвращает координаты адреса.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id адреса. |
Параметр | Тип | Примечание |
---|---|---|
*coords | GeoPointProto | Координаты |
Запрос возвращает профиль водителя.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Параметр | Тип | Примечание |
---|---|---|
*driver | DriverProfileProto | Информация о водителе. |
*car | CarProfileProto | Информация об автомобиле. |
*ratingParams | RatingParamProto[] | Параметры, влияющие на рейтинг. |
Параметр | Тип | Примечание |
---|---|---|
*phone | string | Телефон |
string | Эл. почта. | |
*driverPhoto | bytes | Фотография водителя. |
*firstName | string | Имя |
*lastName | string | Фамилия |
*middleName | string | Отчество |
*callsign | string | Позывной |
*license | string | Номер лицензии. |
*rating | int32 | Рейтинг |
Параметр | Тип | Примечание |
---|---|---|
*model | string | Модель машины. |
*color | string | Цвет машины. |
*number | string | Номер машины. |
*carPhoto | bytes | Фотография машины. |
Параметр | Тип | Примечание |
---|---|---|
*name | string | Название параметра. |
*type | string | Тип параметра (driver - параметр водителя, car - параметр машины) |
*weight | int32 | Вес параметра (максимально допустимое значение) |
*value | double | Значение параметра (текущее значение параметра для водителя или null если у водителя нет такого параметра) |
Возвращает адрес, зарегистрированный при регистрации по адресу, или null.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*address | OrderProto.Point | Адрес |
*wantHome | bool | Включен ли режим "Хочу домой" |
Запрос возвращает текущее время сервера.
Параметр | Тип | Примечание |
---|---|---|
*time | int64 | Unix time (msec.) время на клиенте. |
Параметр | Тип | Примечание |
---|---|---|
*time | int64 | Unix time (msec.) время на сервере. |
Запрос возвращает текущий баланс водителя и историю операций.
Параметр | Тип | Примечание |
---|---|---|
*beginDate | int64 | Начало периода. |
*endDate | int64 | Конец периода. |
Параметр | Тип | Примечание |
---|---|---|
*balance | double | Текущий баланс. |
*daysLeft | int32 | Кол-во дней, на которое хватит суммы на балансе. |
*allowAdvancePayment | bool | Доступность обещанного платежа. |
*history | AccOperationProto[] | История операций за период. |
Параметр | Тип | Примечание |
---|---|---|
*timestamp | int64 | Дата проведения операции. |
*amount | double | Сумма |
*commentary | string | Комментарий |
Запрос возвращает текущую информацию по водителю (еслть ли назначенные заказы, сообщения, новости и т.д.)
Возвращается информация: личные данные водителя, алгоритм распределения, текущий заказ, доступные заказы, предварительные заказы.
Параметр | Тип | Примечание |
---|---|---|
*driverInfo | bool | Возвращать ли информацию о водителе. |
*ordersInfo | bool | Возвращать ли информацию о заказах. |
Параметр | Тип | Примечание |
---|---|---|
*driverInfo | DriverInfoProto | Информация о водителе. |
*orderInfo | OrderInfoProto | Информация о заказах. |
*advanceOrdersInfo | AdvanceOrdersInfoProto | Доп. информация о предварительных заказах. |
Параметр | Тип | Примечание |
---|---|---|
*orders | OrderProto[] | Список заказов (доступные, назначенные, текущий, предзаказы) |
*orderCount | int32 | Кол-во заказов. |
*advanceCount | int64 | Кол-во предзаказов. |
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | Id заказа. |
*driversCount | int64 | Кол-во водителей, забронировавших этот заказ. |
*driverPos | int64 | Позиция водителя в очереди на этот заказ. |
Параметр | Тип | Примечание |
---|---|---|
*orders | AdvanceOrderInfoProto[] | Список доступных предварительных заказов. |
Поторопить клиента (заглушка)
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Запрос устанавливает текущую стоянку для водителя
Водитель регистрируется на стоянке. Возобновляется процедура распределения заказов. Всем водителям службы отправляются оповещения о появлении нового водителя на стоянке.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ID стоянки. Если не указан, то разрегистрирует водителя с текущей стоянки. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 |
Регистрация по адресу.
Параметр | Тип | Примечание |
---|---|---|
*addressId | int64 | ID адреса. |
*wantHome | bool | Хочу домой. Если установлено, то водителю включается режим "хочу домой". |
Параметр | Тип | Примечание |
---|---|---|
*tariffId | int64 | Ид тарифа. |
Параметр | Тип | Примечание |
---|---|---|
*deviceId | string | Уникальный идентификатор устройства. |
*passwordHash | string | Хеш |
Параметр | Тип | Примечание |
---|---|---|
*login | string | Логин нового водителя. |
*password | string | Пароль нового водителя (4 цифры) |
Возвращается список тарифов водителя.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Неиспользуемая переменная. |
Параметр | Тип | Примечание |
---|---|---|
*activeTariff | DriverTariffInfoProto | Активный тариф водителя. |
*tariffsToChange | DriverTariffInfoProto[] | Тарифы, на которые возможен переход. |
*embargoTime | int64 | Время запрета на смену тарифа. |
Параметр | Тип | Примечание |
---|---|---|
*tariffId | int64 | ИД тарифы. |
*title | string | Наименование тарифа. |
*price | double | Цена перехода. |
*desc | DriverTariffInfoDescProto[] | Описание тарифа. |
Параметр | Тип | Примечание |
---|---|---|
*title | string | Название поля. |
*description | string | Описание |
*isForList | bool | Описание тарифа только для отображения в списке. |
Запрос возвращает список последних выполненных заказов.
Параметр | Тип | Примечание |
---|---|---|
*beginDate | int64 | Дата, начиная с которой возвращать заказы. |
*endDate | int64 | Дата, до которой возвращать заказы. |
Параметр | Тип | Примечание |
---|---|---|
*data | DoneOrderProto[] |
Параметр | Тип | Примечание |
---|---|---|
*date | int64 | Дата завершения заказа. |
*isBorder | bool | Заказ с бордюра? |
*price | double | Стоимость поездки. |
Возвращается список клиентских тарифов для данной службы.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Неиспользуемая переменная. |
Параметр | Тип | Примечание |
---|---|---|
*tariffs | ClientTariffProto[] | Тарифы службы. В случае автоматического переключения тарифов возвращаем 1 тариф с разными сегментами, в случае ручного переключения - 2 тарифа, городской и загородный. |
*orderTariffs | ClientTariffProto[] | Тарифы для текущего заказа, если есть. |
Запрос возвращает временные интервалы, в которых водитель может выходить на смену, начиная с сегодняшнего дня.
Параметр | Тип | Примечание |
---|---|---|
*beginDate | int64 | Дата, начиная с которой возвращать смены. |
*endDate | int64 | Дата, до которой возвращать смены. |
Параметр | Тип | Примечание |
---|---|---|
*data | DriverShiftProto[] |
Параметр | Тип | Примечание |
---|---|---|
*beginDate | int64 | Дата начала интервала. |
*endDate | int64 | Дата конца интервала. |
Возвращается список стоянок, число заказов и водителей на стоянках.
Параметр | Тип | Примечание |
---|---|---|
*getBorders | bool | Если true - возвращаем границы стоянок. |
Параметр | Тип | Примечание |
---|---|---|
*points | ParkingPointProto[] | Список стоянок. |
Добавить нового демо пользователя.
Параметр | Тип | Примечание |
---|---|---|
string | Почта пользователя. | |
*phone | string | Телефон пользователя. |
Параметр | Тип | Примечание |
---|---|---|
*data | DemoUserAccountInfo | Информация о новом пользователе. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового пользователя. |
*pass | string | Пароль нового пользователя. |
*hashPass | string | Хэш пароля нового пользователя. |
*login | string | Логин нового пользователя. |
*isNew | bool | Создан новый аккаунт или востановлен старый. |
Запрос возвращает ссылку на новый билд клиентского приложения
Если указан телефон, отправляет на него ссылку.
Параметр | Тип | Примечание |
---|---|---|
*phone | string | Номер телефона. |
Параметр | Тип | Примечание |
---|---|---|
*lastClientAppUrl | string | Адрес для загрузки клиентского приложения. |
Получить список водителей, которые брали заказы при включенной интеграции, но не были заведены в Такси Онлайн.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*drivers | GetNewDriversDriver[] | Список водителей. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int32 | |
*callsign | int32 | Позывной |
*fio | string | ФИО |
Синхронизация баланса из Таксы в ТО.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*phone | string | Телефон клиента. |
*text | string | Текст сообщения. |
*clientId | int64 | Ид клиента. |
Параметр | Тип | Примечание |
---|---|---|
*rating | OrderRatingProto | Отзыв |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД новой записи. |
Отказаться от текущего водителя.
Параметр | Тип | Примечание |
---|---|---|
*clientId | int64 | ИД клиента. |
*orderId | int64 | ИД заказа. |
Параметр | Тип | Примечание |
---|---|---|
*phone | string | Телефон получателя. |
*text | string | Текст смс. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
Параметр | Тип | Примечание |
---|---|---|
*likeCount | int64 | Количество положительных отзывов. |
*sagCount | int64 | Количество отрицательных отзывов. |
получить подробуую информацию по стоимости заказа.
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | ИД заказа. |
Параметр | Тип | Примечание |
---|---|---|
*cost | double | Стоимость заказа. |
*costDetails | CostDetails[] | Подробная информация по стоимости заказа. |
Параметр | Тип | Примечание |
---|---|---|
*name | string | Параметр |
*value | string | Значение |
получить список Ид активных заказов.
Параметр | Тип | Примечание |
---|---|---|
*clientId | int64 | ИД клиента. |
*serviceId | int64 | ИД службы. |
*stageId | int32 | ИД стадии заказа (если пусто - активные) |
Параметр | Тип | Примечание |
---|---|---|
*ordersIds | int64[] | Список ИД активных заказов. |
предложение заказа водителю.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | ИД водителя. |
*orderId | int64 | ИД заказа. |
Параметр | Тип | Примечание |
---|---|---|
*status | int64 | Статус запрос (1 - запрос отправлен, 2 - водитель взял заказ, 3 - отказался) |
Восстановить адрес или несколько по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int32[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | RestoreValidationResult | Результат валидации. |
Сохранение в базу нового адреса.
Параметр | Тип | Примечание |
---|---|---|
*data | AddressProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Id нового адреса. |
*validationResult | ValidationResult | Результат валидации. |
Сохранение в базу нового адреса. Если такой адрес уже существует (проверяется по ид города, номеру дома и ид/названию улицы), то выдать ид существующего адреса.
Параметр | Тип | Примечание |
---|---|---|
*data | AddressProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Id нового или существующего адреса. |
*validationResult | ValidationResult | Результат валидации. |
Поиск подходящего адреса.
Параметр | Тип | Примечание |
---|---|---|
*text | string | Шаблон поиска (улица и номер дома через запятую) |
*limit | int32 | Ограничение на кол-во результатов. |
Параметр | Тип | Примечание |
---|---|---|
*data | AddressProto[] | Результаты |
Поиск дома на улице.
Параметр | Тип | Примечание |
---|---|---|
*text | string | Часть номера дома. |
*limit | int32 | Ограничение на кол-во результатов. |
*streetId | int32 | Ид улицы. |
*clientId | int64 | Клиент |
Параметр | Тип | Примечание |
---|---|---|
*data | AddressProto[] | Список адресов. |
Получение адреса по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int32 |
Параметр | Тип | Примечание |
---|---|---|
*data | AddressProto |
Получает ид стоянки по адресу.
Параметр | Тип | Примечание |
---|---|---|
*addressId | int64 | Ид адреса. |
Параметр | Тип | Примечание |
---|---|---|
*ppId | int64 | Ид стоянки. |
Редактировать адрес.
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид объекта. |
*data | AddressProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получение списка адресов.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | AddressListProto[] | Список |
*count | int64 | Общее количество строк. |
Получение адресов по списку id.
Параметр | Тип | Примечание |
---|---|---|
*id | int32[] |
Параметр | Тип | Примечание |
---|---|---|
*data | AddressProto[] |
Удалить адрес или несколько по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int32[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Добавить новый город.
Параметр | Тип | Примечание |
---|---|---|
*data | CityProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид нового города. |
*validationResult | ValidationResult | Результат валидации. |
Получить город по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Id города. |
Параметр | Тип | Примечание |
---|---|---|
*data | CityProto | Город |
Редактировать город.
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид объекта. |
*data | CityProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список городов.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CityProto[] | Список |
*count | int64 | Общее количество строк. |
Удалить города по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Сохранение в базу нового объекта (места)
Параметр | Тип | Примечание |
---|---|---|
*data | PlaceUpdateProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Id нового объекта. |
*validationResult | ValidationResult | Результат валидации. |
Получение объекта (места) по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int32 |
Параметр | Тип | Примечание |
---|---|---|
*data | PlaceProto |
Получение списка мест.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | PlaceProto[] | Список мест. |
*count | int64 | Общее количество строк. |
Редактировать объект (место)
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид объекта. |
*data | PlaceUpdateProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Удалить объект(место) или несколько по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int32[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Получить улицу по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Id улицы. |
Параметр | Тип | Примечание |
---|---|---|
*data | StreetProto | Улица |
Поиск ближайшего адреса по координатам.
Параметр | Тип | Примечание |
---|---|---|
*latitude | double | Широта |
*longitude | double | Долгота |
Параметр | Тип | Примечание |
---|---|---|
*data | AddressProto | Ближайший адрес. |
Поиск улицы или места (объекта)
Параметр | Тип | Примечание |
---|---|---|
*cityId | int32 | Ид города. |
*text | string | Шаблон |
*limit | int32 | Ограничение на кол-во результатов. |
Параметр | Тип | Примечание |
---|---|---|
*streets | StreetProto[] | Список улиц. |
*places | PlaceProto[] | Список мест (объектов) |
Запрос создает новую сессию.
Параметр | Тип | Примечание |
---|---|---|
string | Email. Устарело. Используется, если не заполнено поле login. | |
*passwordHash | string | SHA256 пароля. |
*login | string | Логин. |
Параметр | Тип | Примечание |
---|---|---|
*sid | string | Идентификатор сессии. |
*accountId | int64 | Ид пользователя. |
*permissions | UserPermissionsProto | Список разрешений для пользователя. |
Параметр | Тип | Примечание |
---|---|---|
*accessToken | string | Токен авторизации. |
*sign | string | Сигнатура |
*login | string | Логин оператора. |
*fio | string | Фио оператора. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id пользователя. |
*login | string | Логин пользователя. |
*sid | string | Идентификатор сессии. |
*fio | string | ФИО пользователя. |
Запрос завершает сессию.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Неиспользуемая переменная. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Неиспользуемая переменная. |
Получить сумму заработка водителя за определенный период.
Параметр | Тип | Примечание |
---|---|---|
*filter | FilterAndProto | Фильтр |
Параметр | Тип | Примечание |
---|---|---|
*borderTotal | double | Заработок с бордюра. |
*serviceTotal | double | Заработок в службе. |
*fail_count | int64 | Количество отказов во время выполнения. |
Запрос выполняет обещанный платеж.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
Параметр | Тип | Примечание |
---|---|---|
*success | bool | Успех платежа. |
*allowAdvancePayment | bool | Доступность обещанного платежа в будущем. |
*messageText | string | Текст сообщения для пользователя. |
Получить остаток на балансе водителя.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
Параметр | Тип | Примечание |
---|---|---|
*balance | double | Остаток на балансе. |
Провести корректировку баланса водителя.
Параметр | Тип | Примечание |
---|---|---|
*data | AccountCorrectionProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид новой операции. |
*validationResult | ValidationResult | Результат валидации. |
Получить список выполненных заказов водителя.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | DoneOrderListProto[] | Список |
*count | int64 | Общее количество строк. |
Получить список операций с балансом водителя.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | AccountOperationListProto[] | Список |
*count | int64 | Общее количество строк. |
Добавление нового водителя (создание нового аккаунта). Установка статических параметров водителя.
Параметр | Тип | Примечание |
---|---|---|
*data | DriverUpdateProto | Данные водителя. |
*staticParams | int64[] | Статические параметры водителя. |
*login | string | Логин водителя. |
string | Емейл водителя (можно не указывать). Если будет не указан логин, то он будет установлен в email. | |
*passwordHash | string | Хэш пароля. |
*lastName | string | Фамилия |
*firstName | string | Имя |
*middleName | string | Отчество |
*passwordString | string | Пароль |
*shifts | int64[] | Список смен. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового водителя. |
*validationResult | ValidationResult | Результат валидации. |
Добавить заметку для водителя.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*text | string | Текст заметки. |
Отправить сообщение водителю.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*message | string | Текст сообщения. |
Получить водителя по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
Параметр | Тип | Примечание |
---|---|---|
*data | DriverProto |
Запрос получает последние координаты (gps) водителя.
Параметр | Тип | Примечание |
---|---|---|
*statusId | int64 | Статус водителя, если пусто, то всех онлайн. |
*serviceId | int64 | ИД службы. |
Параметр | Тип | Примечание |
---|---|---|
*coords | GeoPointDriverProto[] | Последние координаты водителя. |
*count | int64 | Общее количество отметок. |
Получить настройки счетчика позывных.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*data | DriverAutoCallsignProto | Настройки счетчика позывных. |
Получить текущий счетчик позывных.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*isAutoCallsign | bool | Использовать счетчик позывных. |
*callsign | string | Текущий позывной. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*dateFrom | int64 | |
*dateTo | int64 |
Параметр | Тип | Примечание |
---|---|---|
*coords | GeoPointHistoryProto[] | Координаты водителя. |
*count | int64 | Общее количество отметок. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*orderId | int64 | Ид заказа. |
Параметр | Тип | Примечание |
---|---|---|
*coords | GeoPointHistoryProto[] | Координаты водителя. |
*count | int64 | Общее количество отметок. |
Изменение данных о водителе. У водителя обновляется дата последнего события. Возобновляется процедура распределения заказов.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | DriverUpdateProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult |
Возвращает сводку по водителю.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид водителя. |
Параметр | Тип | Примечание |
---|---|---|
*balance | double | Баланс |
*earnings | double | Заработок (руб/мес) |
*complaints | int32 | Количество жалоб. |
*shiftId | int64 | Работа в смене (ид смены) |
*shift | string | Работа в смене. |
*orders | int64 | Количество заказов за 30 дней. |
*failsTotal | int64 | Количество отказов за 30 дней (всего) |
*failsBrokeCar | int64 | Количество отказов за 30 дней (Сломалась машина) |
*failsClientRefused | int64 | Количество отказов за 30 дней (Клиент отказался) |
*failsDangerousClient | int64 | Количество отказов за 30 дней (Опасный клиент) |
*rejectsTotal | int64 | Количество отказов от предложений за 30 дней. |
*failsOperatorRefused | int64 | Количество отказов за 30 дней (Снят оператором) |
*cancelledIvr | int64 | Количество отказов за 30 дней (Автодозвон) |
Получить информацию о сменах и рабочем времени водителя.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Id водителя. |
*begin | int64 | Начало интервала. |
*end | int64 | Конец интервала. |
*paging | PagingProto | Разбиение на страницы. |
Параметр | Тип | Примечание |
---|---|---|
*times | WorkTimeProto[] | Список интервалов рабочего времени водителя. |
*shifts | WorkShiftProto[] | Список описаний смен. |
*info | WorkInfoProto[] | Информация для каждой даты. |
*summary | WorkSummaryProto | Общая информация. |
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Начало интервала. |
*end | int64 | Конец интервала. |
*shiftId | int64 | Ид смены, если водитель работал в смене. |
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Начало интервала (дата и время) |
*end | int64 | Конец интервала (дата и время) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид смены. |
*name | string | Название смены. |
*times | WorkShiftTimeProto[] | Список временных интервалов смены. |
Параметр | Тип | Примечание |
---|---|---|
*date | int64 | Дата |
*orders | int32 | Количество заказов за дату. |
*fails | int32 | Количество отказов за дату. |
*workTime | int64 | Отработанное время (миллисекунды) |
Параметр | Тип | Примечание |
---|---|---|
*workTimeOnShift | int64 | Отработанное время в сменах за весь период (миллисекунды) |
*workTimeOffShift | int64 | Отработанное время вне смен за весь период (миллисекунды) |
Снять водителя со смены (наложить бан) либо отменить бан.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Id водителя. |
*ban | bool | Забанить или разбанить. |
*banDateBegin | int64 | Опционально - дата начала бана. |
*banDateEnd | int64 | Опционально - дата окончания бана. |
*banReason | string | Опционально - причина бана. |
Получить список водителей (новая версия)
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | |
*isWorking | bool |
Параметр | Тип | Примечание |
---|---|---|
*data | DriverListViewProto[] | |
*count | int64 | |
*extFieldsNames | DriverExtFieldsNamesProto[] | Информация о полях с динамическими именами. |
Получить список водителей, отфильтрованный по ид дополнения к тарифу.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры запроса. |
*extId | int64 | Ид дополнения. |
Параметр | Тип | Примечание |
---|---|---|
*data | DriverListViewProto[] | Список водителей. |
*count | int64 | Общее количество строк. |
Получить список ид водителей, забронировавших заказ.
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | Ид заказа. |
Параметр | Тип | Примечание |
---|---|---|
*driverIds | int64[] | Список ид водителей. |
Получить машины, приписанные к водителю.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id водителя. |
Параметр | Тип | Примечание |
---|---|---|
*data | CarListProto[] | Список его машин. |
Установить дополнения для тарифа водителю.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя, которому нужно установить дополнения. |
*tariffIds | int64[] | Список ид дополнений. |
Установить машины, приписанные к водителю.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id водителя. |
*carId | int64[] | Список id машин. |
Установка настроек счетчика позывных.
Параметр | Тип | Примечание |
---|---|---|
*data | DriverAutoCallsignProto | Настройки |
Установить базовый тариф водителю.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя, которому нужно установить тариф. |
*tariffId | int64 | Ид базового тарифа. |
Параметр | Тип | Примечание |
---|---|---|
*data | CsvRequestProto | Данные |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного объекта. |
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CsvRequestViewProto[] | Список |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CsvReportProto[] | Список |
*count | int64 | Общее количество строк. |
Блок "Водители и заказы" на главной странице.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*data | FrontDriversAndOrdersDataProto[] | Список результатов. |
Параметр | Тип | Примечание |
---|---|---|
*driversOnline | int64 | Водителей онлайн. |
*driversOnPp | int64 | Водителей на стоянках. |
*driversFree | int64 | Свободных водителей. |
*driversInProgress | int64 | Водителей выполняющие заказ. |
*driversNotOnShift | int64 | Водителей не на смене. |
*ordersInProgress | int64 | Заказов выполняется. |
*ordersDistrib | int64 | Заказов на распределении. |
*ordersDone24 | int64 | Выполненных заказов за 24 часа. |
*serviceId | int64 | Ид службы. |
*serviceName | string | Название службы. |
*ordersProblem | int64 | Проблемных заказов. |
*ordersActive | int64 | Активных заказов. |
*ordersAdvance | int64 | Предварительных заказов. |
Блок "Водители и заказы" на главной странице.
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | ИД службы. |
Параметр | Тип | Примечание |
---|---|---|
*driversOnline | int64 | Водителей онлайн. |
*driversOnPp | int64 | Водителей на стоянках. |
*driversFree | int64 | Свободных водителей. |
*driversInProgress | int64 | Водителей выполняющие заказ. |
*driversNotOnShift | int64 | Водителей не на смене. |
*ordersInProgress | int64 | Заказов выполняется. |
*ordersDistrib | int64 | Заказов на распределении. |
*ordersDone24 | int64 | Выполненных заказов за 24 часа. |
*serviceId | int64 | Ид службы. |
*serviceName | string | Название службы. |
*ordersProblem | int64 | Проблемных заказов. |
*ordersActive | int64 | Активных заказов. |
*ordersAdvance | int64 | Предварительных заказов. |
Блок "Работа служб" на главной странице.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*currentData | FrontServicesWorkResultProto | Текущие данные. |
*lastHourData | FrontServicesWorkResultProto | Данные час назад (для отображения динамики) |
Параметр | Тип | Примечание |
---|---|---|
*data | FrontServicesWorkDataProto[] | Список результатов по службам. |
Параметр | Тип | Примечание |
---|---|---|
*donePercent | double | Исполняемость (%) |
*arriveTimeAvg | int64 | Среднее время подачи (мсек) |
*executeTimeAvg | int64 | Среднее время выполнения заказа (мсек) |
*distribTimeAvg | int64 | Среднее время распределения (мсек) |
*serviceId | int64 | Ид службы. |
*serviceName | string | Название службы. |
Блок "Стоянки" на главной странице.
Параметр | Тип | Примечание |
---|---|---|
*cityId | int32 | Город, если не задан то выдается информация по всем городам. |
Параметр | Тип | Примечание |
---|---|---|
*data | FrontPPDataProto[] | Список результатов по стоянкам. |
Параметр | Тип | Примечание |
---|---|---|
*ppId | int64 | Ид стоянки. |
*ppName | string | Название стоянки. |
*ordersTotal | int64 | Поступило заказов. |
*ordersDone | int64 | Выполнено заказов. |
*ordersDistrib | int64 | Свободные заказы. |
*preorders | int64 | Предзаказы |
*ordersActive | int64 | Активные заказы. |
*drivers | FrontPPDriverDataProto[] | Очередь водителей на стоянке. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*callsign | string | Позывной |
*regDate | int64 | Дата и время регистрации на стоянке. |
Архивировать дисконтную карту.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для архивации. |
Добавить новую дисконтную карту.
Параметр | Тип | Примечание |
---|---|---|
*data | DiscountProto | |
*numberTo | string | При создании серии: до какого номера создавать. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид новой карты. |
*validationResult | ValidationResult | Результат валидации. |
Получить дисконтную карту по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
Параметр | Тип | Примечание |
---|---|---|
*data | DiscountProto | Данные |
Получить дисконтную карту по коду.
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*code | string | Кодовое слово или номер карты. |
*clientId | int64 | ИД клиента. |
Параметр | Тип | Примечание |
---|---|---|
*data | DiscountProto | Данные |
Получить историю использования дисконтных карт по номеру телефона.
Параметр | Тип | Примечание |
---|---|---|
*phone | string | Телефон |
*serviceId | int64 | ИД службы. |
Параметр | Тип | Примечание |
---|---|---|
*data | DiscountListProto[] | Список |
*count | int64 | Общее количество строк. |
Редактировать дисконтные карты.
Параметр | Тип | Примечание |
---|---|---|
*numberFrom | string | Номер карты (от, включительно) |
*numberTo | string | Номер карты (до, включительно) |
*clientId | int64 | Ид клиента. |
*phone | string | Телефон |
*serviceIds | int64[] | Ид служб. |
*fields | string[] | Список полей для редактирования (может включать clientId, phone и serviceIds) |
*isActual | bool | Активная |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список дисконтных карт.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | DiscountListProto[] | Список |
*count | int64 | Общее количество строк. |
Отправляется текст специального лога (журнала событий). Пока поддерживается только лог distrib - распределение заказов.
Параметр | Тип | Примечание |
---|---|---|
*logName | string | Ид лога. |
Параметр | Тип | Примечание |
---|---|---|
*contents | string | Текст лога. |
Получить текущую дату на сервере.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*date | int64 | Текущая дата сервера. |
Создание новой жалобы. Отсутствующие в запросе поля будут проинициализированы значениями по умолчанию.
Параметр | Тип | Примечание |
---|---|---|
*data | ComplaintProto |
Редактирование жалобы.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Идентификатор редактируемой жалобы. |
*data | ComplaintProto | Новые данные. |
*fields | string[] | Список полей, которые необходимо поменять (поля из data) |
Получает список жалоб.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*limit | int32 | |
*filter | string | |
*type | string | Тип жалоб. Возможные значения: client - жалоба клиента, driver - жалоба водителя, operator - жалоба оператора. |
Параметр | Тип | Примечание |
---|---|---|
*data | ComplaintProto[] | Список жалоб. |
Назначить заказ водителю.
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | Ид заказа. |
*driverId | int64 | Ид водителя. |
*arriveTime | int32 | Время подачи машины (мин.), по умолчанию будет 10 минут. |
Параметр | Тип | Примечание |
---|---|---|
*success | bool | Флаг успешного завершения. |
Отмена заказа (перевод его в завершенные).
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид заказа. |
*incomingPhone | string | Входящий номер. |
Получить все машины на заказе по ид заказа.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид заказа. |
Параметр | Тип | Примечание |
---|---|---|
*data | OrderCarProto[] |
Получить заказ по ид.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
Параметр | Тип | Примечание |
---|---|---|
*data | OrderProto | |
*stateTimer | int64 | Таймер с начала этапа заказа. |
*isProblem | bool | Является ли заказ проблемным. |
*timeLimit | int64 | Ограничение времени на текущий этап (мсек) |
Получить заказ по ид.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
Параметр | Тип | Примечание |
---|---|---|
*data | OrderExtProto | |
*stateTimer | int64 | Таймер с начала этапа заказа. |
*isProblem | bool | Является ли заказ проблемным. |
*timeLimit | int64 | Ограничение времени на текущий этап (мсек) |
Получение истории заказа.
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | Ид заказа. |
Параметр | Тип | Примечание |
---|---|---|
*data | OrderLogProto[] | Список событий. |
Получить маршрут (планируемый) для заказа.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид заказа. |
Параметр | Тип | Примечание |
---|---|---|
*points | RoutePoint[] | Промежуточные точки маршрута. |
Получить описание борта, выполняющего заказ, по ид заказа.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид заказа. |
Параметр | Тип | Примечание |
---|---|---|
*data | OrderCarProto |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*data | ForcedOrdersSettings | Настройки |
Получить настройки формы заказа.
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
Параметр | Тип | Примечание |
---|---|---|
*data | OrderFormSettingsProto | Данные |
Получить предварительную стоимость заказа.
Параметр | Тип | Примечание |
---|---|---|
*tariffId | int64 | Клиентский тариф для расчета стоимости. |
*serviceId | int64 | Ид службы. |
*route | int64[] | Полный маршрут поездки (начальная точка, промежуточные точки, конечная точка) |
*discountId | int64 | Ид дисконтной карты. |
*clientId | int64 | Ид клиента. |
*isPreorder | bool | Предзаказ |
*isMp | bool | Заказ из МП клиента. |
*tariffAdditions | int64[] | Список дополнений к тарифу. |
Параметр | Тип | Примечание |
---|---|---|
*cost | double | Предварительная стоимость заказа (руб.) |
*numCars | int32 | Приблизительное количество машин, которым уйдет заказ. |
*distance | double | Расстояние до клиента от ближайшей машины (ближайшая машина определяется по прямой) (метры) |
*time | double | Приблизительное время подачи машины (считается по ближайшей машине, ближайшая машина определяется по прямой) (секунды) |
*routeDistance | double | Суммарная длина маршрута поездки (метры) |
*costString | string | Отформатированная предварительная стоимость заказа. |
*discountValue | double | Процент скидки по дисконтной карте. |
*discountMoney | double | Фиксированная скидка (руб.) |
*bonusValue | double | Процентный бонус. |
*bonusMoney | double | Фиксированный бонус (руб.) |
*leftBeforeFreeRide | int64 | Поездок осталось до бесплатной. |
*isCardActivated | bool | Карта активирована (безналичный расчет) |
*isMayContract | bool | Клиент может ехать по безналичному расчету. |
*routeLengthString | string | Растояние строкой в км. |
*clientBalance | double | Баланс клиента. |
*isManualForcedOrderEnabled | bool | Включена галочка "Автоназначение" |
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | Ид заказа. |
Параметр | Тип | Примечание |
---|---|---|
*serverResult | TestOrderCostCalculationsResultProto | Результат расчета сервера. |
*mpResult | TestOrderCostCalculationsResultProto | Результат расчета мобильного приложения. |
Параметр | Тип | Примечание |
---|---|---|
*calcStatus | string | Статус расчета. |
*totalDistance | double | Расстояние (м) |
*totalCost | double | Расчитанная стоимость (руб) |
*calculateLogText | string | Дополнительная информация. |
Изменение заказа. Перерасчет его рейтинга и стоянки. Возобновляется процедура распределения заказов. Завершение заказа.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | OrderProto | |
*fields | string[] | |
*isCancel | bool | Завершить заказ. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult |
Снять бронь на предварительный заказ с водителя.
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | Ид заказа. |
*driverId | int64 | Ид водителя. |
Создает новый заказ, копирует данные из родительского и устанавливает parentId.
Параметр | Тип | Примечание |
---|---|---|
*parentId | int64 | Ид родительского заказа. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного заказа. |
Создать новый заказ
Создание нового заказа. Расчет его рейтинга и стоянки. Отправка оповещения о новом предварительном заказе (если тип заказа - предварительный). Возобновляется процедура распределения заказов.
Параметр | Тип | Примечание |
---|---|---|
*data | OrderProto | Информация о заказе. |
*assign | OrderAssignProto[] | Список назначений. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного заказа. |
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя которого нужно назначить. |
*automobileClass | int64 | Ид класса машины. |
Параметр | Тип | Примечание |
---|---|---|
*data | OrderSaveExtProto | Информация о заказе. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного заказа. |
*validationResult | ValidationResult | Результат валидации. |
Получить список заказов.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto |
Параметр | Тип | Примечание |
---|---|---|
*data | OrderListProto[] | |
*count | int64 |
Установить маршрут (планируемый) для заказа.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид заказа. |
*points | RoutePoint[] | Промежуточные точки маршрута. |
Параметр | Тип | Примечание |
---|---|---|
*data | ForcedOrdersSettings | Настройки |
Установить настройки формы заказа.
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*data | OrderFormSettingsProto | Данные |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить журнал событий для звонка.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CallLogProto[] | Журнал событий. |
*count | int64 | Общее количество строк. |
Получить список СМС.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | SmsListProto[] | Список |
*count | int64 | Общее количество строк. |
Получить список звонков.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CallListProto[] | Список |
*count | int64 | Общее количество строк. |
Получить список звонков и смс.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CallAndSmsListProto[] | Список |
*count | int64 | Общее количество строк. |
Добавить новый звук в справочник звуков.
Параметр | Тип | Примечание |
---|---|---|
*data | SoundProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид новой записи. |
*validationResult | ValidationResult | Результат валидации. |
Получить информацию о Звуке из справочника звуков по ID.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид звука. |
Параметр | Тип | Примечание |
---|---|---|
*data | SoundProto |
Редактировать справочник звуков.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | SoundProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список звуков из справочника звуков.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | SoundListProto[] | Список |
*count | int64 | Общее количество строк. |
Получить список разделов звуков из справочника.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | SoundSectionProto[] | Список |
*count | int64 | Общее количество строк. |
Удалить звуки по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового объекта. |
*validationResult | ValidationResult | Результат валидации. |
Создать новый статический параметр.
Параметр | Тип | Примечание |
---|---|---|
*data | StaticParam | Данные |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид параметра. |
*validationResult | ValidationResult | Результат валидации. |
Добавить нового клиента.
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaDriversUpdateProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид корректировки. |
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*driverKarmaId | int64 | Ид правила кармы водителя. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*karmaId | int64 | Ид правила кармы. |
*comment | string | Комментарий |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
*id | int64 | ИД новой записи. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*data | KarmaExceptionBlockProto | Данные |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Редактировать параметр кармы водителей.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид дополнения. |
*data | KarmaUpdateProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Изменить статический параметр.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид параметра. |
*data | StaticParam | Данные |
*fields | string[] | Список полей для изменения. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaExceptionBlockProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового объекта. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaUpdateProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового объекта. |
*validationResult | ValidationResult | Результат валидации. |
Возвращает список штрафов и бонусов водителей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
*driverId | int64 | Ид водителя. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaDriversListProto[] | Список результатов. |
*count | int64 | Общее количество строк для запроса. |
Параметр | Тип | Примечание |
---|---|---|
*tariffId | int64 | Ид тарифа. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaExceptionBlockProto[] | Список результатов. |
Возвращает список параметров кармы водителей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaProto[] | Список результатов. |
*count | int64 | Общее количество строк для запроса. |
Возвращает список параметров кармы водителей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaProto[] | Список результатов. |
*count | int64 | Общее количество строк для запроса. |
Получение списка существующих статических параметров.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*data | StaticParam[] |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaTemplateProto[] | Список результатов. |
*count | int64 | Общее количество строк для запроса. |
Возвращает список штрафов и бонусов водителей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaDriversListProto[] | Список результатов. |
*count | int64 | Общее количество строк для запроса. |
Возвращает список штрафов и бонусов водителей.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaDriversListProto[] | Список результатов. |
*count | int64 | Общее количество строк для запроса. |
Получение статических параметров для автомобиля.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид автомобиля. |
Параметр | Тип | Примечание |
---|---|---|
*params | StaticParam[] | Список параметров. |
Получение статических параметров для водителя.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид водителя. |
Параметр | Тип | Примечание |
---|---|---|
*params | StaticParam[] | Список параметров. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Удалить правило кармы по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Удалить статические параметры по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Установка статических параметров для автомобиля.
Параметр | Тип | Примечание |
---|---|---|
*carId | int64 | Ид автомобиля. |
*params | int64[] | Список ид параметров. |
Установка статических параметров для водителя.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*params | StaticParam[] | Список параметров. |
Добавить или изменить клиента.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид клиента для обновления. |
*data | ClientUpdateProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид новой записи, если клиент создан. |
*validationResult | ValidationResult | Результат валидации. |
Корректировка баланса клиента.
Параметр | Тип | Примечание |
---|---|---|
*data | ClientBalanceAdjustProto | Информация о корректировке. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид новой записи, если корректировка создана. |
Получить баланс клиента по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид клиента. |
*dateFrom | int64 | Дата От. |
*dateTo | int64 | Дата До. |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientBalanceProto | Информация о балансе. |
Получить историю баланса клиента по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД клиента. |
*params | GetProto | Параметры запроса. |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientBalanceHistoryProto[] | История баланса. |
*count | int64 | Общее количество строк. |
Получить историю поездок клиента по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД клиента. |
*params | GetProto | Параметры запроса. |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientTripHistory[] | Информация о поездках. |
*count | int64 | Количество записей. |
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | ИД заказа. |
*status | string | Статус поездки. |
*serviceId | int64 | ИД службы. |
*serviceName | string | Имя службы. |
*date | int64 | Дата |
*phone | string | Телефон |
*from | string | Откуда |
*to | string | Куда |
*discountId | int64 | ИД дисконтной карты. |
*discountNumber | string | Номер дисконтной карты. |
*cost | double | Стоимость поездки. |
*stageId | int64 | ИД стадии заказа. |
*fromId | int64 | Откуда (Ид адреса) |
*toId | int64 | Куда (Ид адреса) |
Получить клиента по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientCardProto |
Получить клиента по номеру телефона.
Параметр | Тип | Примечание |
---|---|---|
*phone | string | Номер телефона клиента. |
*serviceId | int64 | Ид службы для поиска (пусто - выдаем первого попавшегося) |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientCardProto | Информация о клиенте. |
Получить сводку клиента по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД клиента. |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientTotalsProto | Сводка по клиенту. |
получить типы операций над балансом.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Пустой аргумент. |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientOpTypeProto[] | Типы операций. |
прекрартить работу договорного клиента по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Редактировать данные клиента.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид клиента. |
*data | ClientUpdateProto | Данные |
*fields | string[] | Список полей для изменения. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientCardProto[] | Список |
*count | int64 | Общее количество строк. |
Получить список последних адресов заказов клиента.
Параметр | Тип | Примечание |
---|---|---|
*clientId | int64 | |
*limit | int32 |
Параметр | Тип | Примечание |
---|---|---|
*data | PlaceProto[] |
Получить список наиболее частых адресов заказов клиента.
Параметр | Тип | Примечание |
---|---|---|
*clientId | int64 | |
*limit | int32 |
Параметр | Тип | Примечание |
---|---|---|
*data | PlaceProto[] |
Удалить клиента по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Добавить новый класс машины.
Параметр | Тип | Примечание |
---|---|---|
*data | CarClassProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного объекта. |
*validationResult | ValidationResult | Результат валидации. |
Редактировать класс автомобиля.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | CarClassProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult |
Получить возможные классы автомобилей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto |
Параметр | Тип | Примечание |
---|---|---|
*data | CarClassProto[] | |
*count | int64 |
Удалить классы машин по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Добавить новую марку машины.
Параметр | Тип | Примечание |
---|---|---|
*data | CarModelProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного объекта. |
*validationResult | ValidationResult | Результат валидации. |
Редактировать марку автомобиля.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | CarModelProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult |
Получить возможные марки автомобилей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto |
Параметр | Тип | Примечание |
---|---|---|
*data | CarModelProto[] | |
*count | int64 |
Удалить модели машин по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Добавить новый цвет машины.
Параметр | Тип | Примечание |
---|---|---|
*data | CarColorProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного объекта. |
*validationResult | ValidationResult | Результат валидации. |
Редактировать цвет автомобиля.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | CarColorProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult |
Получить возможные цвета автомобиля.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto |
Параметр | Тип | Примечание |
---|---|---|
*data | CarColorProto[] | |
*count | int64 |
Удалить цвета машин по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Создать новый автомобиль.
Параметр | Тип | Примечание |
---|---|---|
*data | CarProto | Данные о машине. |
*staticParams | int64[] | Статические параметры (оснащение) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного объекта. |
*validationResult | ValidationResult | Результат валидации. |
Обновить данные автомобиля.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | CarProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список автомобилей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CarListProto[] | Список объектов. |
*count | int64 | Количество объектов. |
Создать медиа-ресурс.
Параметр | Тип | Примечание |
---|---|---|
*data | MediaProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового объекта. |
*validationResult | ValidationResult | Результат валидации. |
Получить карточку медиа-ресурса по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
Параметр | Тип | Примечание |
---|---|---|
*data | MediaProto | Данные |
Редактировать медиа-ресурс.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | MediaProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список медиа-ресурсов.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | MediaProto[] | Список |
*count | int64 | Общее количество строк. |
Удалить медиа-ресурсы по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Установить версию мобильного приложения.
Параметр | Тип | Примечание |
---|---|---|
*lastClientAppVersionCode | int32 | Код (целое число) последней доступной версии клиента, соответствующий android:versionCode в манифесте приложения. |
*lastClientAppUrl | string | Адрес для загрузки последней версии клиента. |
Параметр | Тип | Примечание |
---|---|---|
*startDate | string | Начало интервала. |
*endDate | string | Конец интервала. |
*addOrdersCountPerDay | int64 | Сколько заказов добавить в каждый день. |
*successPercent | double | Нужная исполняемость. |
*timeZoneOffset | int64 | Смещение часоого пояса. |
*tariffId | int64 | Тариф |
*orderCostMin | int64 | Примерная стоимость заказа (min) |
*orderCostMax | int64 | Примерная стоимость заказа (max) |
*doChanges | bool | |
*driverId | int64 | |
*addOrdersCoef | double | Сколько заказов добавить в каждый день (коэффициент) |
Получить настройки обмена заказами для службы.
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
Параметр | Тип | Примечание |
---|---|---|
*toAll | bool | Если true, то отдавать всем службам. |
*to | int64[] | Ид служб, которым нужно отдавать заказы. |
*fromAll | bool | Если true, то принимать у всех служб. |
*from | int64[] | Ид служб, у которых нужно брать заказы. |
*changeDriverTariff | bool | Если true, заменять тариф водителя. |
*tariffPerOrderId | int64 | Ид тарифа при оплате за заказ. |
*tariffUnlimitedId | int64 | Ид тарифа при периодическом списании. |
Получить список настроек обмена заказами.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto |
Параметр | Тип | Примечание |
---|---|---|
*data | ServiceExchangeListProto[] | |
*count | int64 |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид службы. |
*name | string | Название службы. |
*fromServices | string | Список служб "брать заказы" |
*toServices | string | Список служб "отдавать заказы" |
Установить настройки обмена заказами для службы.
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*toAll | bool | Если true, то отдавать всем службам. |
*to | int64[] | Ид служб, которым нужно отдавать заказы. |
*fromAll | bool | Если true, то принимать у всех служб. |
*from | int64[] | Ид служб, у которых нужно брать заказы. |
*changeDriverTariff | bool | Если true, заменять тариф водителя. |
*tariffPerOrderId | int64 | Ид тарифа при оплате за заказ. |
*tariffUnlimitedId | int64 | Ид тарифа при периодическом списании. |
Добавить новую организацию.
Параметр | Тип | Примечание |
---|---|---|
*data | CustomerOrganizationUpdateProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового клиента. |
*validationResult | ValidationResult | Результат валидации. |
Получить органзацию по ID.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид организации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CustomerOrganizationViewProto |
Возвращает список всех организаций.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CustomerOrganizationViewProto[] | Список результатов. |
*count | int64 | Общее количество строк для запроса. |
Редактировать данные организации.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид организации. |
*data | CustomerOrganizationUpdateProto | Данные |
*fields | string[] | Список полей для изменения. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Удалить организацию по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
import "tt.taxi.common.desc.Validation.proto";
Параметр | Тип | Примечание |
---|---|---|
*data | PlatProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид новой записи. |
Добавить новую платежную систему.
Получить карточку платежной системы.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид платежной системы. |
Параметр | Тип | Примечание |
---|---|---|
*data | PlatProto |
Изменить платежную систему.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | PlatProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список платежных систем.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | PlatListProto[] | Список |
*count | int64 | Общее количество строк. |
Удалить настройки платежных систем по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Добавить группу пользователей.
Параметр | Тип | Примечание |
---|---|---|
*data | GroupProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового объекта. |
*validationResult | ValidationResult | Результат валидации. |
Получить группу пользователей.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
Параметр | Тип | Примечание |
---|---|---|
*data | GroupProto | Данные |
Редактировать группу пользователей.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | GroupProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список групп пользователей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | GroupListProto[] | Список |
*count | int64 | Общее количество строк. |
Удалить группу пользователей.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Получить список подключений пользователей к службам.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | ServiceConnectionsListProto[] | Список |
*count | int64 | Общее количество строк. |
Установить подключения пользователей к службе.
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*userIds | int64[] | Ид пользователей. |
Получить роль по ид.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид роли. |
Параметр | Тип | Примечание |
---|---|---|
*data | RoleProto | Роль |
Редактировать роль в системе.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | RoleProto | Данные |
*fields | string[] | Список полей для изменения. |
Добавить новую роль в систему.
Параметр | Тип | Примечание |
---|---|---|
*data | RoleProto | Роль |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид новой роли. |
*validationResult | ValidationResult | Результат валидации. |
Получить список ролей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | RoleListProto[] | Список |
*count | int64 | Общее количество строк. |
Удалить роль.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Добавить нового пользователя.
Параметр | Тип | Примечание |
---|---|---|
*data | AccountProto | |
*sendEmail | bool | Отправлять ли данные на почту. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового пользователя. |
*validationResult | ValidationResult | Результат валидации. |
Получить пользовательские настройки в виде JSON.
Параметр | Тип | Примечание |
---|---|---|
*key | string | Название группы настроек. |
Параметр | Тип | Примечание |
---|---|---|
*data | string | Настройки в виде JSON. |
Получить аккаунт пользователя по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
Параметр | Тип | Примечание |
---|---|---|
*data | AccountProto |
Редактировать аккаунт пользователя.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | AccountProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Сохранить пользовательские настройки в виде JSON.
Параметр | Тип | Примечание |
---|---|---|
*key | string | Название группы настроек. |
*data | string | Настройки в виде JSON. |
Получить список аккаунтов в системе.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto |
Параметр | Тип | Примечание |
---|---|---|
*data | AccountListProto[] | |
*count | int64 |
Получить список подключенных пользователей по Ид службы.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id службы. |
Параметр | Тип | Примечание |
---|---|---|
*data | ConnectionsListProto | Список ИД пользователей. |
Получить список пользователей, обладающих определенными привилегиями.
Параметр | Тип | Примечание |
---|---|---|
*permissionCodes | string[] | Коды привилегий. |
Параметр | Тип | Примечание |
---|---|---|
*users | AccountProto[] | Список пользователей. |
Получить список ресурсов в системе (на которые можно назначить права)
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*resources | ResourceProto[] | Список ресурсов. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id ресурса. |
*name | string | Название ресурса. |
*category | string | Категория ресурса. |
*permissions | PermissionProto[] | Действия с ресурсом. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id разрешения. |
*name | string | Название разрешения. |
*code | string | Код разрешения. |
Добавить новые настройки распределения.
Параметр | Тип | Примечание |
---|---|---|
*data | RulesetProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового распределения. |
*validationResult | ValidationResult | Результат валидации. |
Получение описания правил для распределения.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*data | RuleDescriptionProto[] | Список правил. |
Параметр | Тип | Примечание |
---|---|---|
*name | string | Код параметра. |
*title | string | Название параметра. |
*note | string | Описание параметра. |
*canChangeWeight | bool | Можно или нет поменять вес. |
Получить настройки распределения заказов по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
Параметр | Тип | Примечание |
---|---|---|
*data | RulesetProto |
Изменение настроек распределения. При изменении алгоритма распределения удаляем все списки распределения для этой службы и отправляем всем водителям оповещения о смене алгоритма распределения.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | RulesetProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список настроек распределения.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | RulesetListProto[] | Список |
*count | int64 | Общее количество строк. |
Получение правил для распределения.
Параметр | Тип | Примечание |
---|---|---|
*rulesetId | int64 | Ид распределения. Если не передан, то возвращается только правило со статическим рейтингом. |
Параметр | Тип | Примечание |
---|---|---|
*data | RuleProto[] | Список правил. |
Удалить настройки распределения по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Установка правил для распределения.
Параметр | Тип | Примечание |
---|---|---|
*rulesetId | int64 | Ид распределения. |
*data | RuleProto[] | Список правил. |
Архивировать режимы работы по списку id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для архивирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Изменение режима работы.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | WorkModeProto | Данные |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить режим работы по ID.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
Параметр | Тип | Примечание |
---|---|---|
*data | WorkModeProto | Данные |
Получить список режимов работы.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | WorkModeListProto[] | Список |
*count | int64 | Общее количество строк. |
Создание режима работы.
Параметр | Тип | Примечание |
---|---|---|
*data | WorkModeProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового объекта. |
*validationResult | ValidationResult | Результат валидации. |
Удалить режим работы по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Архивировать службы по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для архивации. |
Добавить новую службу.
Параметр | Тип | Примечание |
---|---|---|
*data | ServiceProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного объекта. |
*validationResult | ValidationResult | Результат валидации. |
Получить службу по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
Параметр | Тип | Примечание |
---|---|---|
*data | ServiceProto |
Получить службу по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 |
Параметр | Тип | Примечание |
---|---|---|
*data | ServiceProto |
Редактировать службу.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | ServiceProto | Данные |
*fields | string[] | Список полей для изменения. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список служб.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto |
Параметр | Тип | Примечание |
---|---|---|
*data | ServiceListProto[] | |
*count | int64 |
Удалить службы по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Архивировать смены по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для архивации. |
Получить график смен.
Параметр | Тип | Примечание |
---|---|---|
*dayOfWeek | int32 | День недели (0 - воскресенье, 1 - пн, 6 - сб) |
*serviceId | int64 | Опциональный фильтр по службе. |
Параметр | Тип | Примечание |
---|---|---|
*data | ShiftChartProto[] | Данные по службам. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id |
*name | string | Название смены. |
*times | ShiftTimeProto[] | Расписание смены. |
*drivers | int32 | Количество водителей на смене. |
Создать новую смену.
Параметр | Тип | Примечание |
---|---|---|
*data | ShiftProto |
Установить список водителей, которым назначена смена.
Параметр | Тип | Примечание |
---|---|---|
*shiftId | int64 | Id смены. |
*driverId | int64[] | Список id водителей. |
Параметр | Тип | Примечание |
---|---|---|
*callsigns | string[] | Список позывных. |
Параметр | Тип | Примечание |
---|---|---|
*ids | int64[] | Список ИД водителей. |
Получить смену по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид смены. |
Параметр | Тип | Примечание |
---|---|---|
*data | ShiftProto | Смена |
Редактировать смену.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | ShiftProto | |
*fields | string[] |
Получить список водителей, которым назначена смена.
Параметр | Тип | Примечание |
---|---|---|
*shiftId | int64 | Id смены. |
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*count | int64 | Количество результатов. |
*data | DriverListViewProto[] | Список водителей. |
Получить список смен.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры запроса. |
Параметр | Тип | Примечание |
---|---|---|
*data | ShiftListProto[] | Данные |
*count | int64 | Количество найденных объектов. |
Удалить смены по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | SystemEventTypeProto[] | Список |
*count | int64 | Общее количество строк. |
Добавление новой стоянки.
Параметр | Тип | Примечание |
---|---|---|
*data | ParkingPointProto | Стоянка |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id новой стоянки. |
*validationResult | ValidationResult | Результат валидации. |
Получить стоянку по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id стоянки. |
Параметр | Тип | Примечание |
---|---|---|
*data | ParkingPointProto | Результат |
Изменение данных о стоянке.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | ParkingPointProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult |
Получить список ид стоянок, смежных с новой стоянкой.
Параметр | Тип | Примечание |
---|---|---|
*cityId | int64 | Ид города. |
*border | GeoPolygonProto | Границы стоянки. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список ид стоянок, смежных с заданной. |
Получить список стоянок.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | ParkingPointListProto[] | Список стоянок. |
*count | int64 | Общее кол-во строк. |
Удалить стоянки по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Архивировать тарифы водителя по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для архивации. |
Добавить новую задачу по смене тарифа.
Параметр | Тип | Примечание |
---|---|---|
*data | TariffChangeProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид новой задачи. |
*validationResult | ValidationResult | Результат валидации. |
Создать новый тариф водителя.
Параметр | Тип | Примечание |
---|---|---|
*data | DriverTariffProto | Описание тарифа. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид созданного тарифа. |
*validationResult | ValidationResult | Результат валидации. |
Получить тариф водителя.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид тарифа. |
Параметр | Тип | Примечание |
---|---|---|
*data | DriverTariffProto | Информация о тарифе. |
*isUsed | bool | Назначался ли тариф водителям. |
Получить расписание задач на смену тарифов.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | TariffChangeListProto[] | Список |
*count | int64 | Общее количество строк. |
Редактировать задачу по смене тарифа.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | TariffChangeProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Редактировать тариф водителя.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*data | DriverTariffProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult |
Получить список тарифов водителей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto |
Параметр | Тип | Примечание |
---|---|---|
*data | DriverTariffListViewProto[] | |
*count | int64 |
Удалить задачи по смене тарифов по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Архивировать дополнения к клиентским тарифам по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для архивации. |
Архивировать клиентские тарифы по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для архивации. |
Создание нового дополнения к клиентскому тарифу.
Параметр | Тип | Примечание |
---|---|---|
*data | ExtraPaymentProto | Дополнение |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id созданного объекта. |
Создание нового тарифа.
Параметр | Тип | Примечание |
---|---|---|
*data | ClientTariffExtProto | Дескриптор тарифа. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id созданного объекта. |
*validationResult | ValidationResult | Результат валидации. |
Получить дополнение к тарифу клиента по ид.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид дополнения. |
Параметр | Тип | Примечание |
---|---|---|
*data | ExtraPaymentProto |
Получить тариф клиента по ид.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид тарифа. |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientTariffExtProto | |
*isUsed | bool | Использовался ли тариф. |
Редактировать дополнение к клиентскому тарифу.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид дополнения. |
*data | ExtraPaymentProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Редактировать клиентский тариф.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид тарифа. |
*data | ClientTariffExtProto | Данные |
*fields | string[] | Список полей для изменения. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Возвращает список дополнений к клиентским тарифам
Для получения актуального списка дополнений по службе, необходимо добавить в фильтр GetProto: serviceIds any (?), isActual=true.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | ExtraPaymentListProto[] | Список результатов. |
*count | int64 | Общее количество строк для запроса. |
Возвращает список клиентских тарифов.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientTariffListProto[] | Список результатов. |
*count | int64 | Общее количество строк для запроса. |
Отменить тревогу по ИД.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД тревоги. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Добавить новое уведомление.
Параметр | Тип | Примечание |
---|---|---|
*data | NotificationProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид нового уведомления. |
*validationResult | ValidationResult | Результат валидации. |
Отправить тестовое SMS.
Параметр | Тип | Примечание |
---|---|---|
*number | string | Номер телефона для отправки SMS. |
*text | string | Текст SMS. |
Получить настройки уведомлений.
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
Параметр | Тип | Примечание |
---|---|---|
*data | NotificationSettingsProto | Данные |
Получить уведомление по ид.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид уведомления. |
Параметр | Тип | Примечание |
---|---|---|
*data | NotificationProto | Результат |
Редактировать уведомление.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | NotificationProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Получить список настроек уведомлений.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | NotificationSettingsListProto[] | Список |
*count | int64 | Общее количество строк. |
Получить список событий для уведомлений.
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Нет параметров. |
Параметр | Тип | Примечание |
---|---|---|
*data | NotificationEventProto[] | Список событий. |
Получить список уведомлений.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | NotificationListProto[] | Список |
*count | int64 | Общее количество строк. |
Получить список шаблонов в SMS.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | SmsTemplateProto[] | Список объектов. |
*count | int64 | Количество объектов. |
Удалить уведомления по id.
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Установить настройки уведомлений.
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*data | NotificationSettingsProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Утверждение или отказ в выходе на смену водителю по фото автомобиля.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*approved | bool | Утверждено или отказ. |
*message | string | Сообщение для водителя. |
Параметр | Тип | Примечание |
---|---|---|
*approved | bool | Утверждено или отказ. |
*message | string | Сообщение для водителя. |
Получение фото машины водителя по ид водителя.
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
Параметр | Тип | Примечание |
---|---|---|
*photo | DriverPhotoProto | Последнее фото машины водителя. |
*date | int64 | Дата, когда было сделано фото. |
Получить список городов.
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | ID |
*save | bool | Если true, корректировки записываются в БД, иначе просто выводятся. |
Параметр | Тип | Примечание |
---|---|---|
*data | CorrectionFile[] | Список |
*count | int64 | Общее количество строк. |
*goodCount | int64 | Количество строк, готовых к загрузке. |
*badCount | int64 | Количество строк, не прошедших проверку. |
Получить информацию о тревоге по ИД.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
Параметр | Тип | Примечание |
---|---|---|
*data | AlarmProto | Данные |
Отписаться от уведомлений.
Параметр | Тип | Примечание |
---|---|---|
*event | string | Тип уведомлений. |
Подписаться на уведомления.
Параметр | Тип | Примечание |
---|---|---|
*event | string | Тип уведомлений. |
Проверить доступность операции.
Параметр | Тип | Примечание |
---|---|---|
*actionCode | string | Код операции. |
Параметр | Тип | Примечание |
---|---|---|
*isAllowed | bool | Доступность операции. |
*reason | string | Причина отказа. |
Отчет по водителям.
Параметр | Тип | Примечание |
---|---|---|
*dateFrom | int64 | С |
*dateTo | int64 | По |
*serviceId | int64 | Служба в которой ищем, если не указана то во всех. |
*paging | PagingProto | Пагинация |
*ordering | OrderingProto | Сортировка |
*filter | FilterAndProto | Фильтр |
*isWorking | bool |
Параметр | Тип | Примечание |
---|---|---|
*data | ReportDriversProto[] | Таблица отчета. |
*count | int64 | Количество записей (всего) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид водителя. |
*name | string | ФИО водителя. |
*callsign | string | Позывной |
*serviceName | string | Название службы. |
*ridesCount | int64 | Поездок за период. |
*financePlus | double | Начислено за период (руб) |
*financeMinus | double | Списано за период (руб) |
*carmaChange | double | Изменение кармы за период. |
*rejectsCount | int64 | Предложений за период. |
*offersCount | int64 | Отказов от предложений за период. |
*failsCount | int64 | Отказов от заказов за период. |
*failsPercent | double | Процент отказов за период. |
*successPercent | double | Процент успешных заказов. |
*car | string | Автомобиль |
Отчет по дискотным картам.
Параметр | Тип | Примечание |
---|---|---|
*dateFrom | int64 | С |
*dateTo | int64 | По |
*searchString | string | Строка поиска. |
*serviceId | int64 | Служба в которой ищем, если не указана то во всех. |
*paging | PagingProto | Пагинация |
*ordering | OrderingProto | Сортировка |
Параметр | Тип | Примечание |
---|---|---|
*data | ReportDiscountProto[] | Таблица отчета. |
*count | int64 | Количество записей (всего) |
Параметр | Тип | Примечание |
---|---|---|
*cardId | int64 | Ид карты. |
*name | string | Название карты/акции. |
*cardNum | string | Номер карты. |
*serviceName | string[] | Название службы. |
*tripCount | int64 | Поездок по карте. |
*clientCount | int64 | Клиентов проехало по карте. |
*servicesString | string | Список служб одной строкой. |
Отчет по дискотным картам (Детализация)
Параметр | Тип | Примечание |
---|---|---|
*dateFrom | int64 | С |
*dateTo | int64 | По |
*discountId | int64 | ИД дискотной карты. |
*serviceId | int64 | Служба в которой ищем, если не указана то во всех. |
*paging | PagingProto | Пагинация |
Параметр | Тип | Примечание |
---|---|---|
*data | ReportDiscountDetail | Отчет |
*count | int64 | Количество записей (всего) |
Параметр | Тип | Примечание |
---|---|---|
*cardId | int64 | Ид карты. |
*name | string | Название карты/акции. |
*cardNum | string | Номер карты. |
*clients | ReportDiscountClients[] | Клиенты |
*services | string[] | Имена служб. |
Параметр | Тип | Примечание |
---|---|---|
*clientsIds | int64[] | Ид клиентов. |
*clientsNames | string[] | ФИО клиентов или названия организаций. |
*phone | string | Телефон с которого ездил клиент по этой карте. |
*clientTrips | int64 | Поездок по телефону. |
Отчет "Заказы по времени"
Параметр | Тип | Примечание |
---|---|---|
*begin | string | Временной период - дата "от" |
*end | string | Временной период - дата "до" |
*serviceId | int64 | Ид службы (если не передано, то все службы) |
*timePeriod | TimePeriod | Период, по которому идет группировка (по умолчанию - день) |
Параметр | Тип | Примечание |
---|---|---|
*data | OrdersByTimeDataProto[] | Список результатов. |
Название | Значение | Примечание |
---|---|---|
*DAY | 1 | День |
*WEEK | 2 | Неделя |
*MONTH | 3 | Месяц |
*HOUR | 4 | Час |
Параметр | Тип | Примечание |
---|---|---|
*date | int64 | Дата |
*allOrders | int64 | Всего заказов. |
*successOrders | int64 | Успешных заказов. |
*driversOnline | int64 | Водителей онлайн. |
*tz | string | Временная зона отчета. |
Отчет по клиентам.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
*dateFrom | int64 | С |
*dateTo | int64 | По |
*serviceId | int64 | Служба |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientReportProto[] | Список клиентов. |
*count | int64 | Количество записей. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид клиента. |
*fio | string | ФИО клиента / имя юр. лица. |
*phones | string | Телефоны клиента. |
*contractId | int64 | Номер договора. |
*balance | double | Баланс клиента. |
*isLegal | bool | Юр. лицо. |
*isContract | bool | По контракту. |
*ordersCount | int64 | Количество поездок. |
*ordersAvgCost | double | Средняя стоимость поездки. |
*summ | double | Сумма |
*servicesIds | int64[] | ИД служб. |
*servicesNames | string | Имена служб. |
*balanceOnStart | double | Баланс клиента на начало периода. |
*balanceOnEnd | double | Баланс клиента на конец периода. |
Отчет "Медиа-ресурсы"
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Начало отчетного периода. |
*end | int64 | Конец отчетного периода. |
*mediaId | int64 | Ид ресурса. |
*zeroes | bool | Показать нулевых. |
Параметр | Тип | Примечание |
---|---|---|
*data | MediaDataProto[] | Таблица |
Параметр | Тип | Примечание |
---|---|---|
*mediaId | int64 | Ид ресурса. |
*mediaName | string | Название ресурса. |
*month | int64 | Месяц |
*hiredDrivers | int64 | Привлеченные водители. |
*payingDrivers | int64 | Платящие водители. |
*workingDrivers | int64 | Выполнившие больше 10 заказов. |
Отчет "Медиа-ресурсы" - получить информацию по водителям.
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Начало отчетного периода. |
*end | int64 | Конец отчетного периода. |
*mediaId | int64 | Ид ресурса. |
Параметр | Тип | Примечание |
---|---|---|
*data | MediaDriversDataProto[] | Таблица |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*callsign | string | Позывной водителя. |
*driverLastName | string | Фамилия водителя. |
*driverFirstName | string | Имя водителя. |
*driverMiddleName | string | Отчество водителя. |
*managerId | int64 | Ид менеджера. |
*managerLastName | string | Фамилия менеджера. |
*managerFirstName | string | Имя менеджера. |
*managerMiddleName | string | Отчество менеджера. |
*month | int64 | Дата (округлена до месяца) |
*income | double | Начисления (руб) |
*orders | int64 | Выполнено заказов. |
Отчет "Менеджеры"
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Начало отчетного периода. |
*end | int64 | Конец отчетного периода. |
*managerId | int64 | Ид менеджера. |
*zeroes | bool | Показать нулевых. |
Параметр | Тип | Примечание |
---|---|---|
*data | ManagerReportDataProto[] | Таблица |
Параметр | Тип | Примечание |
---|---|---|
*managerId | int64 | Ид менеджера. |
*managerLastName | string | Фамилия менеджера. |
*managerFirstName | string | Имя менеджера. |
*managerMiddleName | string | Отчество менеджера. |
*month | int64 | Дата (округлена до месяца) |
*income | double | Начисления (руб) |
*drivers | int64 | Водителей |
Отчет "Менеджеры" - получить информацию по водителям.
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Начало отчетного периода. |
*end | int64 | Конец отчетного периода. |
*managerId | int64 | Ид менеджера. |
Параметр | Тип | Примечание |
---|---|---|
*data | ManagerReportDriversDataProto[] | Таблица |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*callsign | string | Позывной водителя. |
*driverLastName | string | Фамилия водителя. |
*driverFirstName | string | Имя водителя. |
*driverMiddleName | string | Отчество водителя. |
*managerId | int64 | Ид менеджера. |
*managerLastName | string | Фамилия менеджера. |
*managerFirstName | string | Имя менеджера. |
*managerMiddleName | string | Отчество менеджера. |
*month | int64 | Дата (округлена до месяца) |
*income | double | Начисления (руб) |
*orders | int64 | Выполнено заказов. |
Отчет "Оснащение"
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Временной период - дата "от" |
*end | int64 | Временной период - дата "до" |
*serviceId | int64 | Ид службы (если не передано, то все службы) |
*equipmentIds | int64[] | Список ид оснащения (статических параметров) |
Параметр | Тип | Примечание |
---|---|---|
*driversTotal | int64 | Всего водителей. |
*driversWithEquipment | int64 | Водителей с оснащением. |
*driversRichButLazy | int64 | Водителей с оснащением, выполнивших <5 заказов за день. |
*driversPoorButHardWorking | int64 | Водителей без оснащения, выполнивших >20 заказов за день. |
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Временной период - дата "от" |
*end | int64 | Временной период - дата "до" |
*serviceId | int64 | Ид службы (если не передано, то все службы) |
*equipmentIds | int64[] | Список ид оснащения (статических параметров) |
Параметр | Тип | Примечание |
---|---|---|
*data | EquipmentReportDriversDataProto[] | Список водителей. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*callsign | string | Позывной водителя. |
*driverLastName | string | Фамилия водителя. |
*driverFirstName | string | Имя водителя. |
*driverMiddleName | string | Отчество водителя. |
*managerId | int64 | Ид менеджера. |
*managerLastName | string | Фамилия менеджера. |
*managerFirstName | string | Имя менеджера. |
*managerMiddleName | string | Отчество менеджера. |
*comment | string |
Отчет "Отток водителей"
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Начало отчетного периода. |
*end | int64 | Конец отчетного периода. |
*managerId | int64 | Ид менеджера. |
*zeroes | bool | Показать нулевых. |
*percent | double | Показать водителей с процентом падения больше заданного. |
Параметр | Тип | Примечание |
---|---|---|
*driversHired | int64 | Водителей пришло. |
*driversFired | int64 | Водителей ушло. |
*data | DriversDecreaseDataProto[] | Таблица |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*driverLastName | string | Фамилия водителя. |
*driverFirstName | string | Имя водителя. |
*driverMiddleName | string | Отчество водителя. |
*driverCallsign | string | Позывной |
*driverPhone | string | Телефон водителя. |
*ordersLastMonth | int64 | Заказы за прошлый период. |
*ordersThisMonth | int64 | Заказы за текущий период. |
*ordersDecrease | double | Падение, % |
*managerId | int64 | Ид менеджера. |
*managerLastName | string | Фамилия менеджера. |
*managerFirstName | string | Имя менеджера. |
*managerMiddleName | string | Отчество менеджера. |
*commentDate | int64 | Дата комментария. |
*commentText | string | Текст комментария. |
Отчет по корректировкам.
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Начало временного периода. |
*end | int64 | Конец временного периода. |
*serviceId | int64 | Ид службы (не указано - отчет по всем службам) |
*corrType | int64 | Тип корректировки (не указано - все корректировки). См. AccountCorrectionTypeProto |
*params | GetProto | Доп. параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | AccountCorrectionListProto[] | Список |
*count | int64 | Общее количество строк. |
*totalPlus | double | Всего поступило, руб. |
*totalMinus | double | Всего списано, руб. |
Отчет по тарифам.
Параметр | Тип | Примечание |
---|---|---|
*begin | string | Временной период - дата "от" |
*end | string | Временной период - дата "до" |
*serviceId | int64 | Ид службы (если не передано, то все службы) |
*text | string | Текст для поиска. |
*params | GetProto | Дополнительные параметры. |
Параметр | Тип | Примечание |
---|---|---|
*data | TariffsReportDataProto[] | Список результатов. |
*count | int64 | Количество записей. |
Параметр | Тип | Примечание |
---|---|---|
*tariffId | int64 | ИД тарифа. |
*tariffName | string | Название тарифа. |
*servicesNames | string | Названия служб. |
*driversCount | int64 | Водителей |
*activeDriversCount | int64 | Активных водителей. |
*ordersCount | int64 | Заказов |
*income | double | Поступлений |
*driversAvg | double | Ср.водитель |
*orderAvg | double | Ср.заказ |
Отчет "Сводный отчет"
Параметр | Тип | Примечание |
---|---|---|
*begin | int64 | Временной период - дата "от" |
*end | int64 | Временной период - дата "до" |
*serviceId | int64 | Ид службы (если не передано, то все службы) |
*byDays | bool | Если true, то группировка по дням, иначе группировка по службам. |
Параметр | Тип | Примечание |
---|---|---|
*data | SummaryReportDataProto[] | Список результатов. |
Параметр | Тип | Примечание |
---|---|---|
*ordersReceived | int64 | Полученные заказы. |
*ordersDone | int64 | Выполненные заказы. |
*ordersFromClientsApi | int64 | Заказы из клиентского апи. |
*preordersAll | int64 | Предзаказы |
*preordersDone | int64 | Успешные предзаказы. |
*ordersDistribTimeAvg | int64 | Среднее время распределения заказов (мсек) |
*ordersArriveTimeAvg | int64 | Среднее время подачи АМ (мсек) |
*ordersBorder | int64 | Заказы с бордюра. |
*driversTotal | int64 | Всего водителей. |
*driversNew | int64 | Новые водители. |
*driversDecrease | int64 | Отток водителей. |
*driversActive | int64 | Активные водители. |
*driversProfit | int64 | Доходные водители. |
*driversLoyal | int64 | Постоянных водителей. |
*financeBankRegistry | double | Получено по реестрам банка (руб) |
*financeBankWithCommission | double | Получено по банку с учетом комиссий ПС (руб) |
*financeDriverCommission | double | Удержано с водителей комиссий ПС (руб) |
*financeContracts | double | Получено по договору (руб) |
*financeDrivers | double | Начислено (руб) |
*financeCorrectionsPlus | double | Корректировки в плюс (руб) |
*financeCorrectionsMinus | double | Корректировки в минус (руб) |
*financeOrderCostAvg | double | Средняя стоимость за заказ (руб) |
*policeClientCancels | int64 | Отказы клиентов от заказов. |
*policeDriverFails | int64 | Отказы водителей от заказов. |
*serviceId | int64 | Ид службы (при группировке по службам) |
*date | int64 | Дата (при группировке по дням) |
*driverOrderCostAvg | double | Средняя стоимость заказа для водителя (руб) |
Получение лога баланса пользователей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | ClientBalanceHistoryProto[] | Список |
*count | int64 | Общее количество строк. |
Получение лога действий пользователей.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | UsersOperationsListProto[] | Список |
*count | int64 | Общее количество строк. |
Получение лога по заказам.
Параметр | Тип | Примечание |
---|---|---|
*params | GetOrderEventsGetProto | Параметры запроса. |
Параметр | Тип | Примечание |
---|---|---|
*data | OrderEventsListProto[] | Список |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*paging | PagingProto | Пагинация |
*ordering | OrderingProto | Сортировка |
*filter | GetOrderEventsFilterProto | Фильтр |
Параметр | Тип | Примечание |
---|---|---|
*from | string | Дата от. |
*to | string | Дата до. |
*text | string | Текст для поиска. |
*eventType | string | Тип события. |
*conditions | FilterProto[] | Заглушка |
Получение лога кармы.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | KarmaEventsListProto[] | Список |
*count | int64 | Общее количество строк. |
Получение лога по стоянкам.
Параметр | Тип | Примечание |
---|---|---|
*params | PPLogGetProto | Параметры запроса. |
Параметр | Тип | Примечание |
---|---|---|
*data | PPLogListProto[] | Список |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*paging | PagingProto | Пагинация |
*ordering | OrderingProto | Сортировка |
*filter | PPLogFilterProto | Фильтр |
Параметр | Тип | Примечание |
---|---|---|
*from | string | Дата от. |
*to | string | Дата до. |
*text | string | Текст для поиска. |
*conditions | FilterProto[] | Заглушка |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Номер (идентификатор записи события) |
*driverId | int64 | ИД водителя. |
*callsign | string | Позывной водителя. |
*firstName | string | Имя водителя. |
*lastName | string | Фамилия водителя. |
*middleName | string | Отчество водителя. |
*date | int64 | Дата и время. |
*text | string | Комментарий |
*ppId | int64 | Ид стоянки. |
*ppName | string | Имя стоянки. |
Получение лога по смс и звонкам.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | CallAndSmsLogListProto[] | Список |
*count | int64 | Общее количество строк. |
Получение лога тарификатора.
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | AccOperationsListProto[] | Список |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*data | MessageUpdateProto | Данные |
*fields | string[] | Список полей для редактирования. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*eventId | int64 | Ид типа системного события. |
*data | SystemEventsNotifyUpdateProto[] | Новые настройки оповещания. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*empty | int32 | Неиспользуемая переменная. |
Параметр | Тип | Примечание |
---|---|---|
*all | int64 | Количество всех сообщений. |
*internal | int64 | Количество простых сообщений. |
*alarm | int64 | Количество сообщений о тревогах. |
*warning | int64 | Количество предупреждений. |
*error | int64 | Количество сообщений об ошибках. |
Параметр | Тип | Примечание |
---|---|---|
*eventId | int64 | Ид типа системного события. |
Параметр | Тип | Примечание |
---|---|---|
*data | SystemEventsNotifyListProto[] | Данные |
*count | int64 | Количество записей в ответе. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
*markAsReaded | bool | Пометить сообение как "прочитано" |
Параметр | Тип | Примечание |
---|---|---|
*data | MessageListProto | Данные |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | MessageListProto[] | Список |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*data | MessageUpdateProto | Данные |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид нового сообщения. |
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид объекта. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид рассылки. |
*data | DistributionProto | |
*fields | string[] |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*distributionId | int64 | Ид рассылки. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат операции. |
Параметр | Тип | Примечание |
---|---|---|
*recipientId | int64 | Ид реципиента. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | ValidationResult | Результат операции. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид рассылки. |
Параметр | Тип | Примечание |
---|---|---|
*data | DistributionProto |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | RecipientFilterProto[] | Список фильтров реципиентов. |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | DistributionTemplateProto[] | Список шаблонов сообщений. |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | DistributionPolicyProto[] | Список ограничений рассылки. |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | DistributionProto[] | |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
*filterId | string | ИД фильтра. |
Параметр | Тип | Примечание |
---|---|---|
*data | DistributionRecipientList | Список реципиентов. |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
*distributionId | int64 | Ид рассылки. |
*status | string | Статус реципиентов. |
Параметр | Тип | Примечание |
---|---|---|
*data | DistributionRecipientList | Список реципиентов. |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*params | GetProto | Параметры фильтрации. |
Параметр | Тип | Примечание |
---|---|---|
*data | RecipientTypeProto[] | Список типов реципиентов. |
*count | int64 | Общее количество строк. |
Параметр | Тип | Примечание |
---|---|---|
*data | DistributionProto | Объект рассылки. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид рассылки. |
*validationResult | ValidationResult | Результат валидации. |
Параметр | Тип | Примечание |
---|---|---|
*genericId | int64 | Типизированный ИД сущности типа (см.поле type) |
*name | string | Видимое имя реципиента. |
*phone | string | Телефон |
string | Почта | |
*type | string | Тип рецпипента (DRIVER) |
*lastTryDate | int64 | Дата последней попытки. |
*tryCount | int64 | Количество попыток. |
*statustext | string | Статус (Доставленые, Не доставленые, В процессе) |
*typeDelivery | string | Способ доставки. |
Параметр | Тип | Примечание |
---|---|---|
*id | string | Ид фильтра. |
*type | string | ANY, DRIVER, OPERATOR. |
*title | string | Название фильтра. |
Параметр | Тип | Примечание |
---|---|---|
*id | string | Ид (ANY, DRIVER, OPERATOR...) |
*title | string | Название |
*allowedPolicyIds | string[] | Допустимые типы рассылок. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид списка. |
*type | RecipientTypeProto | Типы получателей. |
*filterId | string | Фильтр реципиентов. |
*recipients | RecipientProto[] | Список получателей. |
Параметр | Тип | Примечание |
---|---|---|
*id | string | Ид (EMAIL, SMS, MOBILE) |
*title | string | Название |
*maxTextLength | int32 | Максимальная длина текста рассылки. |
*showSender | bool | Показывать отправителя. |
*repeatTimeMin | int32 | Время между повторными отправками. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид шаблона. |
*title | string | Шаблон заголовка. |
*text | string | Шаблон тела сообщения. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид рассылки. |
*policy | DistributionPolicyProto | Правила обработки и проверки сообщения. |
*dateCreated | int64 | Дата создания рассылки. |
*actualDateFrom | int64 | Начало периода актуальности рассылки. |
*actualDateTo | int64 | Конец периода актуальности рассылки. |
*senderName | string | Отправитель |
*text | string | Шаблон текста рассылки. |
*lastTryDate | int64 | Дата последней попытки отправки. |
*tryCount | int32 | Количество попыток отправки. |
*status | int64 | Статус отправки. |
*statusText | string | Детализация статуса. |
*distributionRecipients | DistributionRecipientList | Список получателей. |
*recipientCount | int64 | Количество получателей. |
*recipientDelivery | int64 | Количество доставленых. |
*recipientNotDelivery | int64 | Количество не доставленых. |
*author | int64 | ИД Инициатора. |
*authorFio | string | ФИО Инициатора. |
*isPersonalized | bool | Персонифицированная рассылка. |
*policyId | int64 | ИД типа рассылки. |
*policyName | string | Имя типа рассылки. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64[] | Список id для удаления. |
Параметр | Тип | Примечание |
---|---|---|
*validationResult | DeleteValidationResult | Результат валидации. |
Выдать черный список телефонов.
Параметр | Тип | Примечание |
---|---|---|
*id | int32 |
Параметр | Тип | Примечание |
---|---|---|
*phone | string[] | Список телефонов. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ID группы. |
*name | string | Название |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ID контакта. |
*groupID | int64 | ID группы. |
*name | string | Имя (ник) |
*isOnline | bool | Статус |
Параметр | Тип | Примечание |
---|---|---|
*message | string | Тело сообщения. Устанавливается при отправке. |
*confirmation | bool | Требуется ли подтверждение о прочтении. |
*receivers | int64[] | Список ID получателей (заполняется только при отправке, при получении всегда пустой) |
*senderID | int64 | ID отправителя. |
*messageID | int64 | ID сообщения. |
*dateSend | int64 | Дата создания сообщения (unix time (мс)) |
*dateReceived | int64 | Дата получения сообщения (unix time (мс)) |
*dateReaded | int64 | Дата прочтения сообщения (unix time (мс)). Если дата установлена, то значит есть подтверждение о прочтении. |
Параметр | Тип | Примечание |
---|---|---|
*state | State | Статус заказа. |
*type | Type | Тип заявки. |
*functions | Functions[] | Список доступных действий для заявки. |
*dateNew | string | Дата поступления заявки. |
*datePlannedStart | string | Дата подачи автомобиля (запланированная, используется для предзаказов) |
*dateDriverFound | string | Дата назначения заказа на водителя. |
*dateDriverAccept | string | Дата согласия водителя выполнить заказ. |
*dateWaitForClient | string | Дата начала ожидания клиента. |
*dateInProgress | string | Дата назала выполнения заказа. |
*fromPoint | Point | Точка "откуда" |
*toPoint | Point | Точка "куда" |
*note | string | Примечание |
*clientName | string | Имя/фамилия клиента. |
*arriveTime | int32 | Время подачи автомобиля (в минутах) |
*orderID | int64 | ID заказа. |
*acceptTimeout | int32 | Тaймаут в секундах, в течение которого водитель должен принять решение по предложенному заказу. |
*arriveIntervals | int32[] | Список интервалов (в минутах) подачи авто для выбора водителем. |
*recommendedTime | int32 | Рекомендуемое время подачи авто, которое будет установлено как время подачи авто сразу же при открытии формы приема заказа. |
*offerDate | int64 | Дата, когда заказ был предложен водителю. |
*waitForClientTime | int32 | Время (сек), через которое будет доступна кнопка "Поторопить клиента" |
*tariffId | int64 | Ид клиентского тарифа, установленного оператором. |
*clientPhone | string | Телефон для связи с клиентом. |
*fixedPrice | bool | Заказ с фиксированной стоимостью. |
*cost | double | Рассчитанная стоимость заказа (руб) |
*distance | double | Рассчитанная длина поездки (метры) |
*costDetails | OrderCostDetailProto[] | Информация о маршруте поездки. |
*serviceName | string | Служба, из которой пришел заказ. |
*isCash | bool | Платит ли клиент (false для корпоративных клиентов) |
*isContract | bool | Заказ по договору. |
*clientBonusesAvail | double | Количество бонусов у клиента. |
*distanceTo | double | Растояние до заказа (метры) |
*intermediatePoints | Point[] | Промежуточные точки маршрута. |
*isForced | bool | Заказ с автоназначением. |
*isEnabledCounterOrder | bool | Включен режим встречного заказа. |
Название | Значение | Примечание |
---|---|---|
*UNKNOWN | 0 | |
*PREORDER | 1 | Предварительный заказ. |
*ASSIGNED | 2 | Едет к клиенту. |
*DONE | 3 | Выполнен |
*CANCELLED_OP | 4 | Отменен (звонок оператору) |
*FAILED_NO_CARS_SYS | 5 | Отменен (нет машин, система) |
*DISTRIB_WAIT | 6 | Поиск машины (пауза) |
*DISTRIB | 7 | Поиск машины. |
*WAIT_FOR_CLIENT | 8 | Ждет клиента. |
*IN_PROGRESS | 9 | Везет клиента. |
*PREORDER_CONFIRM_WAIT | 10 | Ожидание подтверждения брони. |
*PREORDER_CONFIRMED | 11 | Бронь подтверждена. |
*INCOMPLETE | 12 | В процессе создания. |
*CLIENT_NOTIFIED | 13 | Ждет клиента, клиент уведомлен. |
*CLIENT_NOTIFY_FAIL | 14 | Уведомить клиента не удалось. |
*CLIENT_CONFIRMED | 15 | Едет к клиенту, заказ подтвержден. |
*FAILED_NO_CARS_OP | 16 | Отменен (нет машин, оператор) |
*CANCELLED_NA | 17 | Отменен (клиент не отвечает) |
*CANCELLED_IVR | 18 | Отменен (автодозвон) |
*FAILED_DRIVER | 19 | Отменен (отказ водителя) |
*FAILED_CHANGE_DRIVER | 20 | Отменен (замена водителя) |
*CANCELLED_24 | 21 | Снят системой. |
Название | Значение | Примечание |
---|---|---|
*ACCEPT_ADVANCE | 1 | Зарезервировать предварительный заказ. |
*REJECT_ADVANCE | 2 | Снять резерв с предварительного заказа. |
*ACCEPT | 3 | Взять заказ. |
*REJECT | 4 | Отказаться от заказа (до того как заказ взят) |
*FAIL | 5 | Заказ невозможно выполнить. |
*WAIT_FOR_CLIENT | 6 | Переход в состояние ожидания клиента. |
*IN_PROGRESS | 7 | Переход в состояние выполнения заказа (клиент сел в машину) |
*DONE | 8 | Заказ выполнен. |
Название | Значение | Примечание |
---|---|---|
*NOW | 1 | Заказ |
*ADVANCE | 2 | Предзаказ |
Параметр | Тип | Примечание |
---|---|---|
*city | string | Город |
*street | string | Улица |
*building | string | Номер здания. |
*porch | string | Номер подъезда. |
*place | string | Название объекта (если есть) |
*coords | GeoPointProto | Координаты |
Параметр | Тип | Примечание |
---|---|---|
*title | string | Текст |
*street | string | Улица |
*building | string | Номер дома. |
*cost | double | Рассчитанная стоимость (руб) |
*formattedValue | string | Форматированное значение поля cost (не null для скидок) |
Параметр | Тип | Примечание |
---|---|---|
*organizationName | string | Название организации. |
*serviceName | string | Название службы. |
*driverName | string | Имя водителя. |
*parkingPointID | int64 | ID текущей стоянки. |
*state | State | Состояние |
*serviceMode | ServiceMode | Алгоритм распределения заказов службы. |
*driverId | int64 | Ид водителя. |
*allowDriverChangeTariff | bool | Разрешить смену тарифа водителя. |
*isGreenWaveEnabled | bool | Включен режимзеленой волны. |
Название | Значение | Примечание |
---|---|---|
*NOT_ACTIVE | 1 | Водитель не на смене. |
*READY | 2 | Водитель на смене (может принимать заказы) |
*PENDING_ORDER | 3 | Водитель на смене (ему назначен заказ)(приложение не может самостоятельно установить данное значение) |
*BUSY | 4 | Водитель на смене (находится в процессе выполнения заказа)(приложение не может самостоятельно установить данное значение) |
*NOT_READY | 5 | Водитель на смене (занят своими делами, не может принимать заказы) |
Название | Значение | Примечание |
---|---|---|
*BY_ONE | 1 | Распределение заказов "по одному". Заказ одновременно предлагается только одному водителю. Водители получают заказы по очереди с учетом рейтинга. |
*AVALANCHE | 2 | Распределение заказов "лавина". Отличается от распределения "по одному" тем, что водитель может взять предложенный заказ в любой момент, пока этот заказ не возьмет другой водитель. |
*OPEN | 3 | Распределение заказов "открытый эфир". Водитель видит все заказы на стоянке и может взять любой из них. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ID службы. |
*name | string | Название службы. |
*organization | string | Название организации. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id стоянки. |
*name | string | Название стоянки. |
*note | string | Описание |
*freeOrdersCount | int64 | Число распределяемых заказов на стоянке. |
*driversCount | int64 | Число водителей в очереди. |
*place | int32 | Место в очереди. |
*border | GeoPolygonProto | Геометрия стоянки. |
*lastChange | int64 | Время последнего изменения списка заказов на стоянке. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ID тарифа. |
*title | string | Название |
*minimals | Minimals | Информация о минималке. |
*noGpsSegments | Segment[] | Ценовые сегменты для работы без GPS. |
*segments | Segment[] | Ценовые сегменты тарифа. |
*defaultSegment | Segment | Сегмент для срабатывания по-умолчанию, если не сработали сегменты из noGpsSegments и segments. |
*finalMultiplier | Multiplier | Финальный мультипликатор. |
*isDefault | bool | Тариф по умолчанию. |
*extraPayments | ExtraPayment[] | Описание дополнительных платежей. |
*discount | Discount | Скидка |
*numScale | string | Шаблон округления. |
*discountExt | Discount[] | Скидка (ext) |
*minCostExt | double | Минимальная стоимость (ext) |
Название | Значение | Примечание |
---|---|---|
*lower | 1 | |
*greater | 2 | |
*between | 3 | |
*equal | 4 |
Название | Значение | Примечание |
---|---|---|
*distance | 1 | Общая дистанция, в метрах (с сервера передается в виде строки с int) |
*time | 2 | Общее время в пути, в секундах (с сервера передается в виде строки с int) |
*speed | 3 | Моментальная скорость, в км/ч (с сервера передается в виде строки с int) |
*daytime | 4 | Календарное время, строка “ЧЧ:ММ” (с сервера передается в виде строки в формате “ЧЧ:ММ”) |
*city | 5 | Город/загород, true - если в городе, false - если не в городе. |
Параметр | Тип | Примечание |
---|---|---|
*title | string | Описание |
*mulitplier | float | Неотрицательный - значение. |
Параметр | Тип | Примечание |
---|---|---|
*parameter | TripParameter | Параметр поездки, по которому производится сравнение. |
*operator | ConditionalOperator | Условие для сравнения значения параметра. |
*values | string[] | Константные значения для сравнения со значением параметра поездки (для условий больше/меньше - только одно значение, для условия между - два значения), строковое значение будет интерпретироваться в типизированное на основе типа параметра поездки. |
Параметр | Тип | Примечание |
---|---|---|
*pameter | TripParameter | Параметр для расчета (только distance или time) |
*price | float | Стоимость за единицу измерения параметра (для distance - км, для time - за минуту) |
Параметр | Тип | Примечание |
---|---|---|
*conditions | PartialCondition[] | Список условий применимости сегмента по одному условию на параметр поездки. |
*pendingTime | int32 | Минимальное время для определения применимости сегментов с длительным периодом определения применимости, задается в секундах, если задано 0 - значит сегмент не содержит в себе длительный период определения применимости. |
Параметр | Тип | Примечание |
---|---|---|
*title | string | |
*condition | Condition | Условие срабатывания сегмента, если не задано сегмент будет срабатывать всегда. |
*prices | Price[] | Цены для параметров поездки. |
*freeTime | int32 | Время в секундах для установки бесплатного периода при каждом срабатывании сегмента. |
Параметр | Тип | Примечание |
---|---|---|
*condition | Condition | Условие срабатывания разовой стоимости. |
*price | float | Стоимость |
Параметр | Тип | Примечание |
---|---|---|
*minimalPrices | ConditionalCost[] | Список минималок с условиями применения (минималка проверяется в конце поездки) |
*boardingPrices | ConditionalCost[] | Список стоимостей посадки с условиями применения (стоимость посадки определяется один раз и в начале поездки) |
Параметр | Тип | Примечание |
---|---|---|
*title | string | Название платежа. |
*price | float[] | Цены. Элемент массива с индексом 0 определяет цену за 1 доп. услугу (например, цена за 1 посадку). Элемент с индексом 1 - за 2 услуги, и т.д. Последний элемент массива с индексом n-1 определяет цену за n и более услуг. Пример: название платежа "доп. посадки", в массиве - [50, 30], тогда 1я доп. посадка будет стоить 50 руб., все остальные - 30 руб. |
Параметр | Тип | Примечание |
---|---|---|
*name | string | Название скидки. |
*discountPercent | double | Скидка в процентах. |
*discountMoney | double | Скидка в рублях. |
*orderCost | double | Стоимость заказа активирующая скидку. null - скидка действует всегда. |
Параметр | Тип | Примечание |
---|---|---|
*text | string | Текст сообщения. |
Параметр | Тип | Примечание |
---|---|---|
*data | bytes | Фотография в двоичном виде в формате JPEG. |
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*greetingText | string | Фраза начала разговора. |
*endWithoutCostText | string | Фраза окончания разговора без стоимости. |
*endWithCostText | string | Фраза окончания разговора со стоимостью. |
*showFrom | bool | Показывать адрес куда. |
*showPreorder | bool | Брать предварительные заказы. |
*showLastOrders | bool | Показывать последние поездки. |
*showComplexHint | bool | Показывать подсказку для сложных адресов. |
*allowManualAssign | bool | Назначать заказы вручную. |
*showParking | bool | Показывать стоянку. |
*showCars | bool | Показывать число машин. |
*serviceTz | string | Временная зона службы. |
*useTariffAdditions | bool | Использовать дополнения к тарифу клиента. |
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*service | string | Название службы. |
*greetingText | string | Фраза начала разговора. |
*endWithoutCostText | string | Фраза окончания разговора без стоимости. |
*endWithCostText | string | Фраза окончания разговора со стоимостью. |
*showFrom | bool | Показывать адрес куда. |
*showPreorder | bool | Брать предварительные заказы. |
*showLastOrders | bool | Показывать последние поездки. |
*showComplexHint | bool | Показывать подсказку для сложных адресов. |
*allowManualAssign | bool | Назначать заказы вручную. |
*showParking | bool | Показывать стоянку. |
*showCars | bool | Показывать число машин. |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид адреса. |
*cityId | int32 | Ид города. |
*streetId | int32 | Ид улицы. |
*street | string | Название улицы. |
*houseNum | string | Номер дома. |
*placeId | int32 | Ид места. |
*placeName | string | Название места. |
*addressTip | string | Подсказка для адреса. |
*streetTip | string | Подсказка для улицы. |
*placesTip | string | Подсказка для объекта. |
*coords | GeoPointProto | Координаты |
*note | string | Примечание по адресу. |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид объекта. |
*name | string | Название объекта. |
*addressId | int32 | Ид адреса. |
*cityId | int32 | Ид города. |
*verified | int32 | 1 - проверено, 0 - не проверено. |
*coords | GeoPointProto | Координаты |
*placesTip | string | Подсказка для объекта. |
*addressTip | string | Подсказка для адреса. |
*streetTip | string | Подсказка для улицы. |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид адреса. |
*cityId | int32 | Ид города. |
*streetId | int32 | Ид улицы. |
*street | string | Название улицы. |
*houseNum | string | Номер дома. |
*verified | int32 | 1 - проверено, 0 - не проверено, -1 - не используемый. |
*coords | GeoPointProto | Координаты |
*note | string | Описание |
*complex | bool | Сложный адрес. |
*addressTip | string | Подсказка для удреса. |
*streetTip | string | Подсказка для улицы. |
*placeId | int32 | ИД объекта. |
*placeName | string | Имя объекта. |
*creatorId | int64 | |
*creatorName | string | |
*createDate | int64 |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид улицы. |
*name | string | Название улицы. |
*cityId | int32 | Ид города. |
*streetTip | string | Подсказка для улицы. |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид адреса. |
*streetId | int32 | Ид улицы. |
*cityId | int32 | Ид города. |
*city | string | Название города. |
*street | string | Улица |
*houseNum | string | Номер дома. |
*placeIds | int32[] | Список ид объектов относящихся к этому адресу. |
*places | string | Список объектов через запятую. |
*note | string | Описание |
*complex | bool | Флаг "сложный" |
*verified | int32 | Статус адреса. См. VerifiedInfoProto |
*ppId | int64 | Ид стоянки. |
*ppName | string | Название стоянки. |
*coords | GeoPointProto | Координаты |
Название | Значение | Примечание |
---|---|---|
*VERIFIED | 1 | Адрес подтвержден. |
*UNVERIFIED | 0 | Адрес не подтвержден. |
*UNUSED | -1 | Адрес не используется. |
Параметр | Тип | Примечание |
---|---|---|
*id | int32 | Ид города. |
*name | string | Название города. |
*bounds | GeoPolygonProto | Границы города. |
*state | string | Страна |
*viewScale | int32 | Масштаб на Яндекс.Картах. |
*mapType | string | Тип карт. Пример: "yandex" - Яндекс.Карты. |
*phonePrefix | string | Префикс для телефонных номеров. Формат: 8123XXXXXXX - для всех номеров из 7 цифр будет добавлять префикс 8123. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид строки. |
*driverId | int64 | Ид водителя. |
*lastName | string | Фамилия водителя. |
*firstName | string | Имя водителя. |
*middleName | string | Отчество водителя. |
*serviceId | int64 | Ид службы водителя. |
*serviceName | string | Название службы. |
*orderId | int64 | Ид заказа. |
*isBorder | bool | Источник: с бордюра или служба. |
*doneDate | int64 | Дата выполнения заказа. |
*price | double | Стоимость заказа. |
*is_fail | bool | Водитель отказался от заказа. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id операции. |
*timestamp | int64 | Дата операции. |
*opType | int64 | Тип операции (см. перечисление AccountOperationTypeProto) |
*corrType | int64 | Тип корректировки (см. AccountCorrectionTypeProto). Заполняется только в случае, если тип операции - корректировка. |
*driverId | int64 | Id водителя. |
*lastName | string | Фамилия водителя. |
*firstName | string | Имя водителя. |
*middleName | string | Отчество водителя. |
*serviceId | int64 | Id службы водителя. |
*serviceName | string | Название службы водителя. |
*amount | double | Сумма операции (положительная - зачисление, отрицательная - списание) |
*balance | double | Баланс после операции. |
*commentary | string | Комментарий к операции. |
*orderId | int64 | Id заказа, если операция - это списание за заказ. |
*operatorId | int64 | Ид оператора (который сделал корректировку) |
*opLastName | string | Фамилия оператора. |
*opFirstName | string | Имя оператора. |
*opMiddleName | string | Отчество оператора. |
Название | Значение | Примечание |
---|---|---|
*PAY | 1 | Пополнение баланса. |
*CHARGE_ORDER | 2 | Списание за заказ. |
*CHARGE_RENT | 3 | Периодическое списание (аренда) |
*CORRECTION | 4 | Корректировка |
*ADVANCE_PAYMENT | 5 | Обещанный платеж. |
*EXTERNAL_SOURCE | 6 | Корректировка из внешнего источника. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*corrType | int64 | Тип корректировки (см. AccountCorrectionTypeProto) |
*amount | double | Сумма операции (положительная - зачисление, отрицательная - списание) |
*commentary | string | Комментарий к операции. |
Название | Значение | Примечание |
---|---|---|
*INCOME | 1 | Зачисление |
*CHARGE | 2 | Списание |
*BONUS | 3 | Поощрение |
*FINE | 4 | Штраф |
*ADVANCE_PAYMENT | 5 | Обещанный платеж. На самом деле, обещанный платеж - не корректировка, но по некоторым причинам мы его отображаем в отчете "корректировки". Поэтому, нужен этот тип. |
Параметр | Тип | Примечание |
---|---|---|
*isAutoCallsign | bool | Автоматически присваивать позывной водителю. |
*prefix | string | Префикс |
*counter | int64 | Текущий счетчик. |
Параметр | Тип | Примечание |
---|---|---|
*reportId | int64 | ИД отчета (См. ReportTypeProto) |
*reportFrom | int64 | Время от. |
*reportTo | int64 | Время до. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД заявки. |
*report_id | int64 | ИД отчета. |
*create_date | int64 | Время создания. |
*user_id | int64 | Ид пользователя. |
string | Email пользователя. | |
*status_id | int64 | ИД статуса. |
*title | string | Имя заявки. |
*userFio | string | ФИО пользователя. |
*status | string | Статус |
Название | Значение | Примечание |
---|---|---|
*ACCOPERATIONS | 1 | Логи тарификатора. |
*ORDEREVENTS | 2 | Логи заказов. |
*LOGSCALLSMS | 3 | Логи звонков и СМС. |
*KARMAEVENTS | 4 | Логи кармы. |
*USERSOPERATIONS | 5 | Логи пользовательских действий. |
*CLIENTCORRECTIONS | 6 | Логи корректировок клиентов. |
*ORDERSLIST | 7 | Заказы |
*CLIENTSREPORT | 8 | Отчет по клиентам. |
*DRIVERSSTAT | 9 | Статистика по водителям. |
*ACCOUNTCORRECTIONS | 10 | Отчет по корректировкам. |
*DRIVERLIST | 11 | Список водителей. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Имя отчета. |
*title | string | Название метода. |
*query | string | Sql запрос. |
Точка маршрута заказа.
Параметр | Тип | Примечание |
---|---|---|
*addressId | int64 | Ид адреса. |
*placeId | int64 | Ид объекта (не обязательно) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Имя |
*type | string | Тип звука. |
*fileId | int64 | ID звукового файла. |
*sectionId | int64 | ID раздела. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Имя |
*fileId | int64 | ID звукового файла. |
*sectionId | int64 | ID раздела. |
*isSystem | bool | Является ли системным. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Имя |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид параметра. |
*name | string | Название параметра. |
*code | string | Код шаблона. |
*rating | int32 | Изменение рейтинга (кармы) |
*money | double | Денежный штраф или поощрение. |
*ban | bool | Блокировка |
*duration | int64 | Длительность действия (мс) |
*isActive | bool | Включен или выключен. |
*isManual | bool | Карма назначается вручную. |
Параметр | Тип | Примечание |
---|---|---|
*rating | int32 | Изменение рейтинга (кармы) |
*money | double | Денежный штраф или поощрение. |
*name | string | Название параметра. |
*ban | bool | Блокировка |
*duration | int64 | Длительность действия (мс) |
*isActive | bool | Включен или выключен. |
*params | KarmaParameterProto[] | Параметры |
*code | string | Код шаблона. |
Параметр | Тип | Примечание |
---|---|---|
*code | string | Код шаблона. |
*titleTemplate | string | Шаблон текста. |
*params | string[] | Параметры |
Параметр | Тип | Примечание |
---|---|---|
*param | string | ИД параметра. |
*value | int32 | Значение |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид параметра. |
*tariffId | int64 | Ид тарифа. |
*daysOfWeek | int32[] | Список дней недели. |
*beginTime | string | Начало временного интервала. Если указано, то списание действует начиная с этого времени суток. |
*endTime | string | Конец временного интервала. Если указан, то списание действует до этого времени суток. |
*exceptions | KarmaProto[] | Список исключений. |
Параметр | Тип | Примечание |
---|---|---|
*driverId | int64 | Ид водителя. |
*rating | int32 | Изменение рейтинга (кармы) |
*money | double | Денежный штраф или поощрение. |
*ban | bool | Блокировка |
*duration | int64 | Длительность действия (мс) |
*note | string | Комментарий |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид записи. |
*driverId | int64 | Ид водителя. |
*callsign | string | Позывной водителя. |
*karmaId | int64 | Ид параметра кармы. |
*karmaName | string | Название параметра кармы. |
*rating | int32 | Изменение рейтинга (кармы) |
*money | double | Денежный штраф или поощрение. |
*ban | bool | Блокировка |
*operatorId | int64 | Ид оператора. |
*operatorName | string | ФИО оператора. |
*dateBegin | int64 | Начало периода действия. |
*dateEnd | int64 | Конец периода действия. |
*note | string | Комментарий |
*isActive | bool | Правило активно. |
*isManual | bool | Правило назначаемое вручную. |
*duration | int64 | Длительность действия (мс) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*driverId | int64 | |
*clientId | int64 | |
*orderId | int64 | |
*serviceId | int64 | |
*isLike | bool | |
*addDate | int64 | |
*comment | string |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | |
*name | string |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id марки. |
*name | string | Название марки. |
*soundId | int64 | Id звука. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид автомобиля. |
*modelId | int64 | Ид марки автомобиля. |
*colorId | int64 | Ид цвета автомобиля. |
*number | string | Номер автомобиля. |
*classId | int64 | Ид класса автомобиля. |
*note | string | Примечание |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид автомобиля. |
*modelId | int64 | Ид марки автомобиля. |
*model | string | Марка автомобиля. |
*colorId | int64 | Ид цвета автомобиля. |
*color | string | Цвет автомобиля. |
*classId | int64 | Ид класса автомобиля. |
*className | string | Класс автомобиля. |
*number | string | Номер автомобиля. |
*note | string | Примечание |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид цвета. |
*name | string | Название цвета. |
*color | string | Rgb-код цвета (формат?) |
*soundId | int64 | ID звука из таблички sounds. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид цвета. |
*name | string | Название цвета. |
*color | string | Rgb-код цвета (формат?) |
*soundId | int64 | ID звука из таблички sounds. |
*sound | string | Название звука. |
Параметр | Тип | Примечание |
---|---|---|
*errors | ValidationError[] | Список ошибок валидации. |
Параметр | Тип | Примечание |
---|---|---|
*fieldName | string | Название поля. |
*error | string | Текст ошибки. |
Параметр | Тип | Примечание |
---|---|---|
*cannotDeleteIds | int64[] | Список ид объектов которые нельзя удалить, т.к. они используются в других таблицах. |
Параметр | Тип | Примечание |
---|---|---|
*cannotRestoreIds | int64[] |
Параметр | Тип | Примечание |
---|---|---|
*paging | PagingProto | Пагинация |
*filter | FilterAndProto | Фильтр |
*ordering | OrderingProto | Сортировка (для обратной совместимости). РЕКОМЕНДУЕТСЯ ИСПОЛЬЗОВАТЬ ПОЛЕ orderingEx! |
*orderingEx | OrderingProto[] | Сортировка (новый протокол, можно задать несколько полей) |
Параметр | Тип | Примечание |
---|---|---|
*page | int32 | Номер страницы (начиная с 0) |
*itemsPerPage | int32 | Количество элементов на странице. |
Параметр | Тип | Примечание |
---|---|---|
*and | FilterAndProto | Составной фильтр AND. |
*or | FilterOrProto | Составной фильтр OR. |
*atom | FilterAtomProto | Простой фильтр. |
Параметр | Тип | Примечание |
---|---|---|
*conditions | FilterProto[] | Список условий, объединенных через AND. |
Параметр | Тип | Примечание |
---|---|---|
*conditions | FilterProto[] | Список условий, объединенных через OR. |
Параметр | Тип | Примечание |
---|---|---|
*field | string | Поле, по которому идет фильтрация. |
*op | string | Оператор. Возможные значения: <, >, =, !=, <=, >=, in, like, ilike, is null, is not null, any. |
*value | string | Значение, с которым сравнивается поле. В случае in значения перечисляются через запятую. |
Параметр | Тип | Примечание |
---|---|---|
*field | string | Поле, по которому идет сортировка. |
*ascending | bool | По возрастанию или по убыванию. |
Пара ключ+значение.
Параметр | Тип | Примечание |
---|---|---|
*key | string | |
*value | string |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид пользователя. |
*login | string | Логин пользователя. |
*passwordHash | string | Хэш нового пароля SHA-256 (только для изменения) |
string | ||
*isActive | bool | Действительная ли запись. |
*roleId | int64 | Ид роли. |
*serviceIds | int64[] | Ид служб. |
*groupIds | int64[] | Ид групп. |
*chiefIds | int64[] | Ид руководителей. |
*lastName | string | Фамилия |
*firstName | string | Имя |
*middleName | string | Отчество |
*phone | string | Телефон |
*isBanned | bool | Заблокирован ли пользователь. |
*banReason | string | Причина блокировки ` |
*isFired | bool | Уволен ли пользователь. |
*firedReason | string | Причина увольнения. |
*servicesTz | ServicesTimezonesInfo[] | Информация о таймзонах служб. |
*passwordString | string | Пароль |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид пользователя. |
*login | string | Логин пользователя. |
string | ||
*dateReg | int64 | Дата регистрации. |
*isActive | bool | Действительная ли запись. |
*lastName | string | Фамилия |
*firstName | string | Имя |
*middleName | string | Отчество |
*services | string[] | Службы пользователя. |
*servicesIds | int64[] | Список ИД служб пользователя. |
*role | string | Роль пользователя. |
*groupIds | int64[] | Группы пользователя. |
*groups | string[] | Группы пользователя. |
*lastLogin | int64 | Последний вход пользователя. |
*lastIp | string | Ip пользователя. |
*status | int32 | Статус пользователя (1 - онлайн, 2 - оффлайн, 3 - заблокирован, 4 - уволен) |
*chiefs | string[] | Руководители пользователя. |
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*tz | string | Таймзона |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид группы. |
*name | string | Название группы. |
*chiefIds | int64[] | Список руководителей группы. |
*userIds | int64[] | Список пользователей в группе. |
*description | string | Описание группы. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id группы. |
*name | string | Название группы. |
*chiefs | string[] | Список руководителей группы. |
*users | int64 | Количество пользователей в группе. |
*description | string | Описание группы. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id службы. |
*name | string | Название службы. |
*users | int64 | Количество пользователей. |
Параметр | Тип | Примечание |
---|---|---|
*serviceName | string | Название службы. |
*connections | int64[] | Список ИД подключенных пользователей. |
Параметр | Тип | Примечание |
---|---|---|
*permissions | UserPermissionProto[] | Список разрешений. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид разрешения. |
*code | string | Код разрешения. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид роли. |
*name | string | Название роли. |
*permissionIds | int64[] | Список разрешений для роли. |
*description | string | Описание роли. |
*isAdmin | bool | Роль относится к администраторам. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид роли. |
*name | string | Название роли. |
*description | string | Описание роли. |
*users | int64 | Количество пользователей. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид набора правил. |
*autoRejectTime | int32 | Время в секундах, через которое водитель автоматически откажется от предложенного заказа, если от приложения водителя не будет получен ответ. При отправке заказа водителю ему дается на принятие решения это время минус 5 секунд. 5 секунд - буферное время, отводимое на задержки в сети при передаче данных (лаг). |
*advanceOrdersSilentTime | int32 | Время в секундах, в течение которого до начала предварительного заказа водитель не получает другие заказы по распределению. |
*maxDistance | double | Максимальное расстояние в метрах для GPS-распределения. Если водитель находится дальше от точки подачи машины (с учетом графа дорог), чем это расстояние, то заказ ему предложен не будет. |
*postponeDelay | int32 | Задержка после круга распределения (сек). После того как заказ был предложен всем подходящим водителям, система ожидает этот промежуток времени, прежде чем предлагать заказ еще раз. Если в течение этого времени появится новый водитель, которому можно будет предложить заказ, то заказ будет ему предложен немедленно. |
*maxDistribTime | int32 | Ограничение по времени для автораспределения заказа (сек). Если заказ не был распределен автоматически в течение этого времени, то мы устанавливаем ему статус "просрочен" и уведомляем клиента о том, что машину найти не удалось. После этого заказ либо продляется, либо отменяется. |
*maxExtendTimes | int32 | Макс. количество продлений заказа. После этого заказ будет снят. |
*maxParkingDistance | int32 | Максимальная удаленность стоянки для автораспределения. Если этот параметр равен 0 - заказ будет предложен только водителям на той же стоянке, что и заказ. Если он равен 1 - то заказ будет предложен водителям как на той же стоянке, так и на смежных ей стоянках. Если он равен 2 - заказ будет предложен водителям, находящимся не более чем за 2 стоянки от заказа. И так далее. |
*maxRejects | int32 | Количество отказов, после которых водителю не будет предлагаться данный заказ. |
*algorithm | int32 | Алгоритм распределения. См. перечисление AlgorithmType. |
*advanceOrdersDistribTime | int32 | Время начала предварительного заказа (сек). За это время до начала предварительного заказа, если водитель подтвердил выполнение, водитель автоматически начнет выполнять заказ. |
*maxDistribRounds | int32 | Максимальное число раундов распределения. После достижения этого числа заказ становится просроченным, так же, как если истечет время распределения. |
*maxAvailOrders | int32 | Максимальное число доступных заказов, которые будут отправляться водителю. |
*rulesPreset | int32 | Приоритетный водитель. 0 - учитываются все параметры (смарт); 1 - учитывается только расстояние до заказа; 2 - учитывается только рейтинг борта. |
*maxReserveDrivers | int32 | Максимальное число доступных броней на предварительный заказ. |
*name | string | Название набора правил. |
*advanceOrdersTimeLimit | int32 | Время (сек), по которому сервер определяет, срочный заказ или предварительный. Если указанное время начала в заказе больше текущей даты на эту величину, то заказ предварительный. |
*waitForClientTime | int32 | Время (сек), через которое на МП будет доступна кнопка "Поторопить клиента". |
*startPreorderAfterConfirm | bool | Если true, то предзаказы стартуют сразу же после подтверждения водителем. (Подтверждение приходит за 5 минут до времени начала предзаказа, время начала предзаказа определяется параметром advanceOrdersDistribTime). |
*isNotPpAbroad | bool | Не выходить за границы стоянок. |
*isForcedOrdersEnabled | bool | Включать режим автоназначения. |
*advanceOrderNotifyDriverTime | int32 | Время (сек) до начала выполнения заказа, когда надо уведомить водителя о заказе. |
*counterOrderTripPercents | int32 | % от маршрута для активации режима «встречный заказ». |
*counterOrderDisableDistance | int32 | Радиус автоматического снятия режима «встречный заказ». |
*counterOrderAddKarma | int32 | Изменение рейтинга для режима «встречный заказ». |
*counterOrderMinDistance | int32 | Минимальное расстояние для включения режима «встречный заказ». |
*counterOrderRejectsLimit | int32 | Лимит предложений для режима «встречный заказ». |
*counterOrderTimeLimit | int32 | Лимит времени действия для режима «встречный заказ». |
*isGreenWaveEnabled | bool | Зеленая волна активна. |
*greenWaveAddKarma | int32 | Изменение к рейтингу водителя на зеленой волне. |
*greenWaveRejectsLimit | int32 | Количество предложений заказа которые зеленая волна действует (0 – без ограничений) |
*greenWaveTimeLimit | int32 | Количество минут, когда зеленая волна действует (0 – без ограничений; максимум 30 минут) |
Название | Значение | Примечание |
---|---|---|
*ALL | 1 | Распределение "всем". Ставится автоматически при истечении числа попыток распределения, тогда заказ уходит всем водителям службы. Внимание: на веб-клиенте этот алгоритм не должен быть доступен! Выбирать можно только из следующих 3х алгоритмов. |
*BY_ONE | 2 | Распределение "по одному". Водители получают заказы в порядке приоритета. Заказ одновременно предлагается только одному водителю. |
*AVALANCHE | 3 | Распределение "лавина". Заказ в начале предлагается лучшему водителю, потом первым двум лучшим, потом первым трем лучшим и тд. |
*OPEN | 4 | Распределение "открытый эфир". Заказ предлагается всем доступным водителям. Водитель может посмотреть список заказов на стоянке и взять любой из них. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид набора правил. |
*name | string | Название набора правил. |
*algorithm | int32 | Алгоритм распределения. См. перечисление ServiceMode. |
*rulesPreset | int32 | Приоритетный водитель. 0 - учитываются все параметры (смарт); 1 - учитывается только расстояние до заказа; 2 - учитывается только рейтинг борта. |
*maxDistribTime | int32 | Ограничение по времени для автораспределения заказа (сек). Если заказ не был распределен автоматически в течение этого времени, то мы устанавливаем ему статус "просрочен" и уведомляем клиента о том, что машину найти не удалось. После этого заказ либо продляется, либо отменяется. |
*maxDistribRounds | int32 | Максимальное число раундов распределения. После достижения этого числа заказ становится просроченным, так же, как если истечет время распределения. |
*postponeDelay | int32 | Задержка после круга распределения (сек). После того как заказ был предложен всем подходящим водителям, система ожидает этот промежуток времени, прежде чем предлагать заказ еще раз. Если в течение этого времени появится новый водитель, которому можно будет предложить заказ, то заказ будет ему предложен немедленно. |
*maxDistance | double | Максимальное расстояние в метрах для GPS-распределения. Если водитель находится дальше от точки подачи машины (с учетом графа дорог), чем это расстояние, то заказ ему предложен не будет. |
*maxParkingDistance | int32 | Максимальная удаленность стоянки для автораспределения. Если этот параметр равен 0 - заказ будет предложен только водителям на той же стоянке, что и заказ. Если он равен 1 - то заказ будет предложен водителям как на той же стоянке, так и на смежных ей стоянках. Если он равен 2 - заказ будет предложен водителям, находящимся не более чем за 2 стоянки от заказа. И так далее. |
*serviceIds | int64[] | Список служб которые используют этот набор правил. |
Параметр | Тип | Примечание |
---|---|---|
*name | string | Код правила. |
*weight | int32 | Вес правила (макс. баллы рейтинга) |
*isEnabled | bool | Включено или выключено. |
Статический параметр.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид параметра. |
*name | string | Название параметра. |
*weight | int32 | Вес параметра. |
*paramType | string | Тип параметра (car - параметр авто, driver - параметр водителя) |
*comment | string |
Параметр | Тип | Примечание |
---|---|---|
*beginTime | string | Время начала. |
*endTime | string | Время конца. |
*dayOfWeek | int32 | День недели (0 - воскресенье, 1 - понедельник, ..., 6 - суббота) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид смены. |
*serviceId | int64 | Ид службы. |
*name | string | Название смены. |
*isActual | bool | Активная или архивная. |
*timeQuota | double | Норма выработки (% от времени смены) |
*ordersQuota | int32 | Норма по заказам за смену. |
*rejectQuota | int32 | Норма по отказам. |
*sendNotifications | bool | Отправлять ли уведомления. |
*notifyTimeBefore | int32 | Отправлять уведомления за столько-то времени (сек.) |
*notifyIntervalBegin | string | Время отправки - начало. |
*notifyIntervalEnd | string | Время отправки - конец. |
*notifyType | int32 | Вид уведомления (см. ShiftNotifyTypeProto) |
*times | ShiftTimeProto[] | Настройка расписания смены. |
*isComeOutControl | bool | Контроль выхода на смену. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид смены. |
*name | string | Название смены. |
*driversCount | int64 | Количество водителей на смене. |
*serviceId | int64 | Ид службы. |
*serviceName | string | Название службы. |
*isActual | bool | Активная или архивная. |
Название | Значение | Примечание |
---|---|---|
*UNKNOWN | 0 | Неизвестно |
*SMS | 1 | SMS-сообщение |
*APP_MESSAGE | 2 | Сообщение в приложении. |
*CALL | 3 | Автодозвон |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Идентификатор |
*lastName | string | Фамилия |
*firstName | string | Имя |
*middleName | string | Отчество |
*serviceId | int64 | Служба |
*callsign | string | Позывной |
string | E-mail водителя. | |
*login | string | Логин водителя. |
*tariffId | int64 | Базовый тариф. |
*tariffExt | int64[] | Дополнения к тарифу. |
*carId | int64 | Автомобиль |
*putOnJobId | int64 | Оформил (аккаунт менеджера) |
*mediaId | int64 | Источник (медиа-ресурс) |
*firedDate | int64 | Дата увольнения. |
*hiredDate | int64 | Дата приема на работу. |
*photoId | int64 | Ид фото. |
*state | int64 | Статус водителя. |
*license | string | Номер лицензии. |
*homeAddress | string[] | Домашний адрес. |
*phone | string[] | Телефон |
*note | string | Примечание 1. |
*banDateBegin | int64 | Дата снятия со смены - если текущая дата не попадает в интервал бана (бан прошел), то эти поля остаются пустыми. |
*banDateEnd | int64 | Дата окончания снятия со смены - если текущая дата не попадает в интервал бана (бан прошел), то эти поля остаются пустыми. |
*banReason | string | Причина снятия со смены - если текущая дата не попадает в интервал бана (бан прошел), то эти поля остаются пустыми. |
*fireReason | string | Причина увольнения. |
*shiftId | int64 | Ид смены водителя. |
*allowAdvancePayment | bool | Доступен ли обещаный платеж. |
*isOnline | bool | Онлайн |
*fullName | string | Фио |
*passwordString | string | Пароль |
*shifts | int64[] | Список смен. |
*note2 | string | Примечание 2. |
*note3 | string | Примечание 3. |
*date | int64 | Дата 1. |
*date2 | int64 | Дата 2. |
*date3 | int64 | Дата 3. |
*extFieldsNames | DriverExtFieldsNamesProto[] | Информация о полях с динамическими именами. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Идентификатор |
*serviceId | int64 | Служба |
*callsign | string | Позывной |
*carId | int64 | Автомобиль |
*putOnJobId | int64 | Оформил (аккаунт менеджера) |
*mediaId | int64 | Источник (медиа-ресурс) |
*firedDate | int64 | Дата увольнения. |
*hiredDate | int64 | Дата приема на работу. |
*photoId | int64 | Ид фото. |
*license | string | Номер лицензии. |
*homeAddress | string[] | Домашний адрес. |
*phone | string[] | Телефон |
*note | string | Примечание |
*banDateBegin | int64 | Дата снятия со смены. |
*banDateEnd | int64 | Дата окончания снятия со смены. |
*banReason | string | Причина снятия со смены. |
*fireReason | string | Причина увольнения. |
*shiftId | int64 | Ид смены водителя. |
*allowAdvancePayment | bool | Доступен ли обещаный платеж. |
*shifts | int64[] | Список смен. |
*note2 | string | Примечание 2. |
*note3 | string | Примечание 3. |
*date | int64 | Дата 1. |
*date2 | int64 | Дата 2. |
*date3 | int64 | Дата 3. |
Параметр | Тип | Примечание |
---|---|---|
*fieldId | string | ИД поля. |
*fieldName | string | Текст |
Примечание к полю statusText:
1) Если установлена дата увольнения работника (поле 'firedDateObj') - это "Уволен".
2) Если установлена дата забаненных водителя (поле 'banDateBegin') - это "Отстранен".
3) Если поле "isOnline" установлено как false - то "Оффлайн".
4) Если поле "isOnline" установлено как true то тогда уже проверяется поле "stateId" и выводятся состояния с перечисления DriverInfoProto.State.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид водителя. |
*callsign | string | Позывной |
*lastName | string | Фамилия |
*firstName | string | Имя |
*middleName | string | Отчество |
*phone | string[] | Телефон |
*car | string | Информация об автомобиле. |
*tariff | string | Название тарифа. |
*hiredDate | int64 | Дата приема на работу. |
*hiredSource | string | Источник |
*rating | int32 | Рейтинг водителя. |
*isOnline | bool | В данный момент онлайн. |
*serviceId | int64 | Служба |
*carId | int64 | Ид автомобиля водителя. |
*tariffId | int64 | Ид тарифа водителя. |
*firedDate | int64 | Дата увольнения. |
*putOnJobId | int64 | Ид менеджера, который принял водителя на работу. |
*pojLastName | string | Фамилия менеджера. |
*pojFirstName | string | Имя менеджера. |
*pojMiddleName | string | Отчество менеджера. |
*shiftId | int64 | Ид смены водителя. |
*carClassId | int64 | Ид класса машины водителя. |
*banDateBegin | int64 | Дата снятия со смены. |
*banDateEnd | int64 | Дата окончания снятия со смены. |
*stateId | int64 | Статус водителя (см. DriverInfoProto.State) |
*statusText | string | Текст статуса водителя. |
*balance | double | Баланс водителя. |
*serviceName | string | Имя службы. |
*cityId | int64 | ИД города. |
*cityName | string | Название города. |
*phonesString | string | Телефоны строкой. |
*note | string | Примечание 1. |
*note2 | string | Примечание 2. |
*note3 | string | Примечание 3. |
*date | int64 | Дата 1. |
*date2 | int64 | Дата 2. |
*date3 | int64 | Дата 3. |
*fullName | string | Полное имя водителя. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Название |
*number | string | Номер карты. |
*codeWord | string | Кодовое слово. |
*clientId | int64 | Ид клиента. |
*phone | string | Телефон |
*serviceIds | int64[] | Ид служб. |
*cardType | int64 | Тип карты: 1 - накопительная, 2 - разовая, 3 - фиксированная. |
*beginDate | int64 | Период действия - дата от. |
*endDate | int64 | Период действия - дата до. |
*days | int32 | Срок действия в днях. |
*activationSum | double | Накопительная сумма, после которой активируется карта (руб). 0 - активируется при первой поездке. |
*isManualActivation | bool | Галочка "Договор" в ручном режиме. |
*freeRideEnabled | bool | Включены ли бесплатные поездки. |
*freeRideCount | int32 | Число n (каждая n-ая поездка бесплатно) |
*parts | DiscountPartProto[] | Скидки |
*bonuses | DiscountBonusProto[] | Бонусы |
*driverEarnsBonus | bool | Флаг "Зачисление начисленных бонусов на счет водителю по завершении заказа" |
*isActual | bool | Активная или архивная. |
*discountValue | double | Величина скидки. |
*isMultiUser | bool | Многопользовательская карта. |
*driverEarnsFactor | double | Коэф-т зачисления водителю. |
*isOneOrder | bool | Разовая привязка скидки. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id |
*name | string | Название |
*number | string | Номер карты. |
*serviceIds | int64[] | Ид служб. |
*services | string[] | Названия служб. |
*beginDate | int64 | Начало периода действия. |
*endDate | int64 | Конец периода действия. |
*discountValue | double | Величина скидки. |
*bonusMoney | double | Накопленный бонус. |
*clientId | int64 | Ид клиента. |
*isActual | bool | Активная или архивная. |
*isUserAllow | bool | Карта доступна для привязки к клиенту. |
Параметр | Тип | Примечание |
---|---|---|
*discountValue | double | Величина скидки. |
*accumSum | double | Накопленная сумма. |
*isMoney | bool | False - %, true - руб. |
*rides | int32 | Количество поездок. |
*isMp | bool | Применяется для МП клиентов. |
*isRides | bool | Расчет по поездкам. |
*days | int32 | Количество дней. |
Параметр | Тип | Примечание |
---|---|---|
*isMoney | bool | False - поездки, true - руб. |
*accumSum | double | Накопленная сумма (для бонусов за накопленную сумму) |
*factor | double | Коэффициент (для бонусов за накопленную сумму) |
*rides | int32 | Кол-во поездок (для бонусов за кол-во поездок) |
*ridesBonus | double | Номинал (для бонусов за кол-во поездок) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид дополнения. |
*name | string | Название дополнения. |
*price | double | Цена |
*serviceIds | int64[] | Службы |
*isActual | bool | Активное/архивное |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид дополнения. |
*name | string | Название дополнения. |
*price | double | Цена |
*serviceIds | int64[] | Службы |
*services | string | Строка, где через запятую идут названия служб. |
*isActual | bool | Активное/архивное |
Жалоба.
Список допустимых параметров (поле tags)
Название Описание
car_model Марка машины
car_color Цвет машины
car_number Номер машины
car_board Борт
driver_fio ФИО водителя
route_from Пункт отправления
route_to Пункт назначения
phone_received Телефон, с которого была принята жалоба
Список категорий для жалоб клиентов
• Тарифы
• Не перезвонили
• Работа операторов
• Работа службы в целом
• Не приехала машина
• Грубость
• Забыли вещи
• Убрать номер из рассылки
• Другое
Список категорий для жалоб операторов
• Карта города
• ПО Taxi Online
• Тарифы
• Грубость
• ГАИ, сломался
• Случайно взял заказ
• Клиент не доступен
• Другое
Возможные состояния жалобы
• Открыта
• Закрыта
• Черновик.
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Идентификатор редактируемой жалобы. |
*operatorId | int64 | Оператор, который зарегистрировал жалобу. |
*tags | KeyValueProto[] | Опциональные строковые параметры жалобы. |
*complaintText | string | Текст жалобы. |
*regDate | int64 | Дата регистрации жалобы (кол-во миллисекунд с начала unix эпохи) |
*phone | string | Телефон для связи. |
*categorySet | int64[] | Список категорий, к которым относится жалоба. |
*stateId | int64 | Состояние жалобы. |
*complaintType | string | Тип жалобы. Возможные значения: client - жалоба клиента, driver - жалоба водителя, operator - жалоба оператора. |
*serviceId | int64 | Служба, к которой относится жалоба. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*oldTariffId | int64 | Ид старого тарифа. |
*newTariffId | int64 | Ид нового тарифа. |
*serviceId | int64 | Служба, в рамках которой нужно поменять тариф. |
*date | int64 | Дата смены тарифа. |
*status | int64 | Статус задачи. 1 - новая, 2 - сделана, 3 - возникла ошибка. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*oldTariffId | int64 | Ид старого тарифа. |
*oldTariffName | string | Название старого тарифа. |
*newTariffId | int64 | Ид нового тарифа. |
*newTariffName | string | Название нового тарифа. |
*date | int64 | Дата смены тарифа. |
*isExtension | bool | Дополнение к тарифу или базовый тариф. |
*serviceId | int64 | Ид службы. |
*serviceName | string | Название службы. |
Параметр | Тип | Примечание |
---|---|---|
*parentId | int64 | Ид головного заказа. |
*orderId | int64 | Ид заказа. |
*driverId | int64 | Ид водителя которого нужно назначить. |
*carClassId | int64 | Ид класса машины. |
Параметр | Тип | Примечание |
---|---|---|
*clientId | int64 | Ид клиента. |
*lastname | string | Имя клиента. |
*calledFrom | string | Входящий телефон. |
*clientPhone | string | Телефон для связи. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид заказа. |
*typeId | int64 | Тип заказа (1 - срочный, 2 - предварительный). Обязательное поле при создании. |
*serviceId | int64 | Ид службы. Обязательное поле при создании. |
*tariffId | int64 | Клиентский тариф для заказа. |
*dateNew | int64 | Дата регистрации заказа. Обязательное поле при создании. |
*datePlannedStartProto | DatePlannedStartProto | Запланированная дата подачи автомобиля. |
*client | OrderClientSaveExtProto | |
*discountId | int64 | Ид дисконтной карты. |
*addressFrom | AddressProto | Откуда |
*addressFromPorch | string | Номер подъезда (откуда) |
*addressFromNote | string | Комментарий к заказу. |
*addressTo | AddressProto[] | Куда |
*isContract | bool | Заказ по договору. |
*driverId | int64 | Ид водителя основного заказа. |
*cars | OrderCarSaveExtProto[] | |
*isFromClientsApi | bool | Заказ создан из клиентского Api. |
*rejectStatus | string | Статус отказа См. RejectStatuses. |
*isDanger | bool | Подозрительный заказ. |
*tariffAdditions | int64[] | Список дополнений к тарифу. |
*isForced | bool | Заказ с автоназначением. |
Параметр | Тип | Примечание |
---|---|---|
*time | string | Время |
*isToday | bool | Заказ на сегодня. |
*date | string | Дата заказа (необязательное поле, dd/MM/YYYY) |
Название | Значение | Примечание |
---|---|---|
*NONE | 1 | Нет отказа. |
*TRYING | 2 | Попытка отказа. |
*ACCEPTED | 3 | Отказ принят. |
*REJECTED | 4 | Отказ отклонен. |
*CONGESTION | 5 | Затор |
Параметр | Тип | Примечание |
---|---|---|
*parentId | int64 | Родительский заказ (для заказов с несколькими машинами) |
*orderId | int64 | Ид заказа. |
*driverId | int64 | Ид водителя. |
*driverLastName | string | Фамилия водителя. |
*driverFirstName | string | Имя водителя. |
*driverMiddleName | string | Отчество водителя. |
*driverCallsign | string | Позывной водителя. |
*driverCarId | int64 | Ид машины водителя. |
*driverCarClassId | int64 | Класс машины водителя (эконом, бизнес etc...) |
*carModel | string | Модель машины. |
*carColor | string | Цвет машины. |
*carNumber | string | Номер машины. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид заказа. |
*operatorId | int64 | Ид оператора, принявшего заказ. |
*typeId | int64 | Тип заказа (1 - срочный, 2 - предварительный). Обязательное поле при создании. |
*stateId | int64 | Состояние заказа. |
*serviceId | int64 | Ид службы. Обязательное поле при создании. |
*clientId | int64 | Ид клиента. |
*clientName | string | Имя клиента. |
*driverId | int64 | Ид водителя. |
*arriveTime | int32 | Время прибытия в минутах, назначает водитель. |
*dateNew | int64 | Дата регистрации заказа. Обязательное поле при создании. |
*dateDriverFound | int64 | Дата когда водителю уходит заказ. |
*dateDriverAccept | int64 | Дата начала выполнения заказа водителем. |
*dateWaitForClient | int64 | Дата когда водитель прибыл на место и ожидает клиента. |
*dateInProgress | int64 | Дата, когда водитель повез клиента. |
*fromAddressId | int64 | Ид адреса подачи машины. Обязательное поле при создании. |
*fromPlaceId | int64 | Ид объекта подачи машины. |
*fromPorch | string | Номер квартиры (откуда) |
*toAddressId | int64 | Ид адреса назначения. |
*toPlaceId | int64 | Ид объекта назначения. |
*toPorch | string | Номер квартиры (куда) |
*note | string | Комментарий к заказу. |
*isEmergency | bool | Экстренный заказ. |
*automobileClass | int64 | Класс автомобиля, заказанный клиентом. |
*parkingPointId | int64 | Ид стоянки. Определяется автоматически по адресу. Если адрес не найден или не относится ни к какой стоянке, можно задать стоянку напрямую. |
*calledFrom | string | Входящий телефон. |
*clientPhone | string | Телефон для связи. |
*dateEnd | int64 | Дата завершения заказа. |
*cost | double | Предварительная стоимость заказа. |
*parentId | int64 | Родительский заказ (для заказов с несколькими машинами) |
*parentNum | int64 | Номер подзаказа. |
*tariffId | int64 | Клиентский тариф для заказа. |
*discountId | int64 | Ид дисконтной карты. |
*routeLength | double | Длина маршрута в метрах. |
*isCash | bool | Платит ли клиент (false для корпоративных клиентов) |
*isContract | bool | Заказ по договору. |
*costString | string | Отформатированная предварительная стоимость заказа. |
*datePlannedStartProto | DatePlannedStartProto | Запланированная дата подачи автомобиля. |
*addressFrom | AddressProto | Откуда |
*addressTo | AddressProto[] | Куда |
*driver | DriverProto | Водитель |
*driverCar | CarListProto | Автомобиль |
*client | ClientCardProto | Клиент |
*costInfo | GetOrderCostRsProto | Стоимость |
*service | ServiceListProto | Служба |
*formSettings | OrderFormSettingsProto | Настройки формы. |
*routeLengthString | string | Растояние строкой в км. |
*orderDiscountInfo | DiscountProto | Информация о дисконтной карте. |
*orderCars | OrderCarExtProto[] | Машины на заказе. |
*costBeforeRound | double | Стоимость без округления. |
*rejectStatus | string | Статус отказа См. RejectStatuses. |
*tariffAdditions | int64[] | Список дополнений к тарифу. |
*isForced | bool | Заказ с автоназначением. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид заказа. |
*operatorId | int64 | Ид оператора, принявшего заказ. |
*typeId | int64 | Тип заказа (1 - срочный, 2 - предварительный). Обязательное поле при создании. |
*stateId | int64 | Состояние заказа. |
*serviceId | int64 | Ид службы. Обязательное поле при создании. |
*clientId | int64 | Ид клиента. |
*clientName | string | Имя клиента. |
*driverId | int64 | Ид водителя. |
*arriveTime | int32 | Время прибытия в минутах, назначает водитель. |
*dateNew | int64 | Дата регистрации заказа. Обязательное поле при создании. |
*dateDriverFound | int64 | Дата когда водителю уходит заказ. |
*dateDriverAccept | int64 | Дата начала выполнения заказа водителем. |
*dateWaitForClient | int64 | Дата когда водитель прибыл на место и ожидает клиента. |
*dateInProgress | int64 | Дата, когда водитель повез клиента. |
*fromAddressId | int64 | Ид адреса подачи машины. Обязательное поле при создании. |
*fromPlaceId | int64 | Ид объекта подачи машины. |
*fromPorch | string | Номер квартиры (откуда) |
*toAddressId | int64 | Ид адреса назначения. |
*toPlaceId | int64 | Ид объекта назначения. |
*toPorch | string | Номер квартиры (куда) |
*note | string | Комментарий к заказу. |
*isEmergency | bool | Экстренный заказ. |
*automobileClass | int64 | Класс автомобиля, заказанный клиентом. |
*datePlannedStart | int64 | Запланированная дата подачи автомобиля, для предварительных заказов. |
*parkingPointId | int64 | Ид стоянки. Определяется автоматически по адресу. Если адрес не найден или не относится ни к какой стоянке, можно задать стоянку напрямую. |
*calledFrom | string | Входящий телефон. |
*clientPhone | string | Телефон для связи. |
*dateEnd | int64 | Дата завершения заказа. |
*cost | double | Предварительная стоимость заказа. |
*parentId | int64 | Родительский заказ (для заказов с несколькими машинами) |
*parentNum | int64 | Номер подзаказа. |
*tariffId | int64 | Клиентский тариф для заказа. |
*discountId | int64 | Ид дисконтной карты. |
*routeLength | double | Длина маршрута в метрах. |
*isCash | bool | Платит ли клиент (false для корпоративных клиентов) |
*isContract | bool | Заказ по договору. |
*costString | string | Отформатированная предварительная стоимость заказа. |
*datePlannedStartISO8601 | string | Запланированная дата подачи автомобиля, для предварительных заказов (строкой в формате ISO8601) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид заказа. |
*typeId | int64 | Тип заказа (1 - срочный, 2 - предварительный) |
*dateNew | int64 | Дата регистрации заказа. |
*timeFromStart | int64 | Время, прошедшее с момента создания заказа (мс) |
*stateTimer | int64 | Время, прошедшее с начала этапа (мс) |
*dateEnd | int64 | Дата завершения заказа. |
*datePlannedStart | int64 | Планируемая дата подачи машины (для предварительных заказов) |
*fromStreet | string | Адрес откуда - улица. |
*fromHouseNum | string | Адрес откуда - номер дома. |
*fromPlace | string | Адрес откуда - объект. |
*toStreet | string | Адрес куда - улица. |
*toHouseNum | string | Адрес куда - номер дома. |
*toPlace | string | Адрес куда - объект. |
*carColor | string | Цвет машины. |
*carModel | string | Модель машины. |
*carNumber | string | Номер машины. |
*calledFrom | string | Номер телефона, с которого поступил звонок. |
*clientPhone | string | Телефон клиента для связи. |
*operatorName | string | Имя оператора. |
*stateId | int64 | Статус заказа. |
*arriveTime | int32 | Время подачи машины, установленное водителем (в минутах) |
*clientNotifyCount | int32 | Количество дозвонов. |
*serviceId | int64 | Ид службы. |
*clientName | string | Имя клиента. |
*reservations | int64 | Количество водителей, забронировавших заказ (для пред. заказов) |
*callsign | string | Позывной водителя, выполняющего заказ. |
*cost | double | Предварительная стоимость заказа. |
*dateDriverAccept | int64 | Начало выполнения заказа. |
*service | string | Служба (название) |
*serviceTz | string | Часовой пояс службы. |
*note | string | Комментарий к заказу. |
*parentId | int64 | Родительский заказ (для заказов с несколькими машинами) |
*parentNum | int64 | Номер подзаказа. |
*timeLimit | int64 | Ограничение времени на текущий этап (мсек) |
*isProblem | bool | Является ли заказ проблемным. |
*driverPhone | string | Телефон водителя. |
*stageId | int64 | Категория статуса заказа (этап жизненного цикла). См. OrderStageProto |
*driverId | int64 | Ид водителя, которому назначен заказ. |
*isCash | bool | Платит ли клиент (false для корпоративных клиентов) |
*isContract | bool | Заказ по договору. |
*addr1Id | int64 | ИД адреса откуда. |
*addr2Id | int64 | ИД адреса куда. |
*addr1Coord | GeoPointProto | Координаты адреса "откуда" |
*addr2Coord | GeoPointProto | Координаты адреса "куда" |
*isFromClientsApi | bool | Заказ создан из клиентского Api. |
Параметр | Тип | Примечание |
---|---|---|
*orderId | int64 | Ид заказа. |
*carModel | string | Модель машины. |
*carColor | string | Цвет машины. |
*carNumber | string | Номер машины. |
*driverLastName | string | Фамилия водителя. |
*driverFirstName | string | Имя водителя. |
*driverMiddleName | string | Отчество водителя. |
*driverCallsign | string | Позывной водителя. |
*parentId | int64 | Родительский заказ (для заказов с несколькими машинами) |
*parentNum | int64 | Номер подзаказа. |
Название | Значение | Примечание |
---|---|---|
*UNKNOWN | 0 | |
*BEFORE_START | 1 | Ожидание начала. |
*IN_PROGRESS | 2 | Выполняется |
*SUCCESS | 3 | Успешно выполнен. |
*FAILURE | 4 | Не выполнен. |
Параметр | Тип | Примечание |
---|---|---|
*longOrderHappen | int64 | Включить автоназначение, если заказ долго на распределении (0 - выключить) |
*isPreorderRejectHappen | bool | Включить автоназначение, если произошел отказ от предварительного заказа. |
*isManual | bool | Включать автоназначение вручную, на форме заказа. |
*maxDistance | double | Максимальное расстояние в метрах для GPS-распределения. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id звонка (внутренний) |
*externalId | int64 | Id звонка (на сервере уведомлений) |
*customerPhone | string | Телефон клиента или водителя. |
*servicePhone | string | Телефон службы. |
*isIncoming | bool | Входящий или исходящий. |
*orderId | int64 | Ид заказа. |
*notificationId | int64 | Ид уведомления. |
*creationDate | int64 | Дата создания. |
*endDate | int64 | Дата окончания. |
*status | int64 | Статус звонка (см. CallStatus) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id смс (внутренний) |
*externalId | int64 | Id смс (на сервере уведомлений) |
*phone | string | Телефон клиента. |
*orderId | int64 | Ид заказа. |
*notificationId | int64 | Ид уведомления. |
*message | string | Текст сообщения. |
*creationDate | int64 | Дата создания. |
*endDate | int64 | Дата уведомления о доставке. |
*status | int64 | Статус смс: 1 - в процессе доставки, 2 - доставлено, 3 - ошибка при доставке. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id записи. |
*callId | int64 | Id звонка. |
*date | int64 | Дата записи. |
*eventName | string | Код события. |
*eventDescription | string | Описание события. |
*soundIds | int64[] | Список звуков для проигрывания (если есть) |
*sounds | string | Названия звуков через пробел. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид автомобиля. |
*modelId | int64 | Ид марки автомобиля. |
*model | string | Марка автомобиля. |
*colorId | int64 | Ид цвета автомобиля. |
*color | string | Цвет автомобиля. |
*classId | int64 | Ид класса автомобиля. |
*className | string | Класс автомобиля. |
*number | string | Номер автомобиля. |
*note | string | Примечание |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id (внутренний) |
*externalId | int64 | Id (на сервере уведомлений) |
*customerPhone | string | Телефон клиента. |
*orderId | int64 | Id заказа. |
*notificationId | int64 | Ид уведомления. |
*creationDate | int64 | Дата создания. |
*endDate | int64 | Дата окончания / дата уведомления о доставке. |
*status | int64 | Статус |
*servicePhone | string | Телефон службы (для звонков) |
*isIncoming | bool | Входящий или исходящий звонок ( для смс пока false) |
*message | string | Текст сообщения (для смс) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД |
*isLegal | bool | Юр лицо. |
*isActive | bool | Активен |
*isBlacklisted | bool | Черный список. |
*firstname | string | Имя |
*lastname | string | Фамилия |
*middlename | string | Отчество |
*phones | string[] | Телефоны |
*emails | string[] | Эл почта. |
*comment | string | Примечание о клиенте. |
*isContract | bool | Договорный |
*balance | int32 | Баланс |
*title | string | Название организации (для юр.) |
*contract | ContractInfoProto | Контракт |
*availServices | ClientServiceInfoProto[] | Доступные службы такси. |
*currentServices | ClientServiceInfoProto[] | Службы такси клиента. |
*availDiscounts | ClientDiscountsInfoProto[] | Номера дисконтных карт доступные для клиента. |
*currentDiscounts | DiscountListProto[] | Дисконтные карты привязанные к клиенту. |
*availRateOption | RateInfoProto[] | Доступные опции рейтинга. |
*currentRateOption | int32 | Выбранный рейтинг. |
*availKarmaOptions | KarmaInfoProto[] | Доступные опции кармы. |
*currentKarmaOptions | int32[] | Выбранные опции кармы. |
*availManagers | ClientManagerInfoProto[] | Менеджеры доступные. |
*currentManager | int64 | Выбранный менеджер. |
*availAdSources | SourcesInfoProto[] | Доступные источники. |
*currentAdSource | int64 | Источник |
*adSourceComment | string | Другой источник. |
*balanceMinSum | double | Минимальная сумма на балансе. |
*blacklistedReason | string | Причина добавления в черный список. |
*banReason | string | Причина бана. |
*phonesString | string | Телефоны одной строкой. |
*statusString | string | Статус клиента строкой. |
*discountsString | string | Список номеров дискотных карт строкой. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*dateReg | int64 | Дата регистрации клиента. |
*firstname | string | Имя клиента. |
*lastname | string | Фамилия клиента. |
*middlename | string | Отчество клиента. |
*note | string | Примечание |
*isActive | bool | Активен |
*isContract | bool | По контракту. |
*karma | int32 | Карма |
*title | string | Пусто для физов. |
string[] | E-mail клиента. | |
*phones | string[] | Телефоны клиента. |
*servicesIds | int64[] | Ид служб клиента. |
*rate | int32 | — новичек, постонный, супер, vip. |
*discountIds | int64[] | ИД дисконтных карт клиента. |
*managerId | int64 | ИД менеджера. |
*contract | ContractInfoProto | Контракт |
*adSource | int64 | Источник |
*balanceMinSum | double | Минимальная сумма на балансе. |
*isBlacklisted | bool | Черный список. |
*blacklistedReason | string | Причина добавления в черный список. |
*isLegal | bool | Юр. лицо. |
*banReason | string | Причина бана. |
*contractId | int64 | Ид контракта. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД клиента. |
*firstname | string | Имя |
*lastname | string | Фамилия |
*middlename | string | Отчество |
*status | string | Статус активноски. |
*isContract | bool | Договорный |
*balance | double | Баланс |
*currency | string | Валюта |
*tripCount | int32 | Поездки |
*serviceList | ClientServiceInfoProto[] | Службы такси. |
*discounts | DiscountListProto[] | Номера дисконтных карт. |
*rateString | string | Рейтинг |
*karmaString | string | Карма |
*compliantCount | int32 | Жалобы клиента. |
*comment | string | Примечание |
*title | string | Название организации (для юр.) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД службы. |
*name | string | Имя службы. |
*phones | string[] | Телефоны службы. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД дисконтной карты. |
*number | string | Номер |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД менеджера. |
*namer | string | ФИО |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД клиента. |
*currency | string | Валюта |
*balance | double | Баланс |
*incomingTotals | double | Всего поступило. |
*outgoingTotals | double | Всего списанно. |
*incomingTotalsPeriod | double | Всего поступило за период. |
*outgoingTotalsPeriod | double | Всего списанно за период. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД записи. |
*client_id | int64 | ИД слиента. |
*date | int64 | Дата изменения. |
*order | int64 | Заказ операции. |
*service | int64 | Служба операции. |
*inbound | double | Поступило |
*outbound | double | Списано |
*balanceAfter | double | Баланс после операции. |
*discountValue | double | Скидка в % |
*comment | string | Комментарий |
*serviceName | string | Имя службы. |
*discountId | int64 | ИД дисконтной карты. |
*discountNumber | string | Номер дисконтной карты. |
*opType | int64 | ИД типа операции. |
*opName | string | Тип операции. |
*clientName | string | ФИО клиента. |
*operatorId | int64 | ИД инициатора. |
*operatorName | string | ФИО инициатора. |
*opSum | double | Сумма операции. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД клиента. |
*currentType | int64 | Текущая операция. |
*sum | double | Сумма операции. |
*comment | string | Комментарий |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД типа операции. |
*title | string | Наименование операции. |
Параметр | Тип | Примечание |
---|---|---|
*inn | string | Инн |
*kpp | string | КПП |
*account | string | Расч счет. |
*bankName | string | Наименование банка. |
*bik | string | БИК |
*contractAddress | string | Адрес по договору. |
*respPost | string | Пост отв лица. |
*respFirstname | string | Имя отв лица. |
*respLastname | string | Фамилия отв лица. |
*respMiddlename | string | Отчество отв лица. |
*comment | string | Примечание к договору. |
*number | string | Номер договора. |
*corrAccount | string | Корреспондентский счет. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД опции рейтинга. |
*title | string | Наименование опции рейтинга. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД опции кармы. |
*title | string | Наименование опции кармы. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД типа источника. |
*title | string | Наименование типа источника. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*eventType | int64 | Тип события. 1 - смена статуса, 2 - распределение заказа, 3 - уведомление, 4 - создание заказа. |
*orderId | int64 | Ид заказа. |
*driverId | int64 | Ид водителя (пока не используется) |
*date | int64 | Дата события. |
*text | string | Текст события. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id |
*name | string | Название ресурса. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Имя организации. |
*contractId | int64 | Ид договора. |
*phones | string[] | Телефоны (с возможностью указать несколько телефонов) |
*services | int64[] | Службы (можно указать несколько служб, для которых он будет корпоративным клиентом, для остальных - обычным) |
*servicesNames | string[] | Имена служб. |
*discountId | int64 | ИД дисконтной карты. |
*discountName | string | Имя дисконтной карты. |
*note | string | Примечание |
Параметр | Тип | Примечание |
---|---|---|
*name | string | Имя организации. |
*contractId | int64 | Ид договора. |
*phones | string[] | Телефоны (с возможностью указать несколько телефонов) |
*services | int64[] | Службы (можно указать несколько служб, для которых он будет корпоративным клиентом, для остальных - обычным) |
*discountId | int64 | ИД дисконтной карты. |
*note | string | Примечание |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Название платежной системы. |
*isActual | bool | Активный/архивный |
*paymentMethod | int32 | 1 - Через такси Онлайн, 2- Через свой аккаунт. |
*commissionSystem | double | Комисcия системы. |
*commissionDriver | double | Комисcия водителя. |
*isSystem | bool | Являются ли настройки системными. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Название платежной системы. |
*urlplat | string | URL системы. |
*username | string | Имя пользователя системы. |
*passwd | string | Пароль пользователя системы. |
*city | string | Город (латиницей) |
*isActual | bool | Активный/архивный |
*displayName | bool | Отображать ФИО. |
*paymentMethod | int32 | 1 - Через такси Онлайн, 2- Через свой аккаунт. |
*commissionSystem | double | Комисcия системы. |
*commissionDriver | double | Комисcия водителя. |
*originId | int64 | Если это поле установлено, то все данные будут браться из настроек с данным id! |
*isSystem | bool | Являются ли настройки системными. Если они являются системными, то редактировать их нельзя! |
*systemId | int64 | Класс системы (указывает на системные настройки, от которых взяты данные) |
*platIp | string[] | Описание разрешенных IP. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД водителя. |
*callsign | string | Позывной водителя. |
*driverName | string | ФИО водителя. |
*amount | double | Поступило/Списано |
*note | string | Коментарий |
*status | bool | Статус |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Идентификатор |
*name | string | Имя режима. |
*dateStart | int64 | Дата начала действия режима (мс) |
*dateEnd | int64 | Дата окончания действия режима (мс) |
*serviceId | int64 | ИД службы. |
*priority | int32 | Приоритет (0 по умолчанию) |
*cityTariffId | int64 | ИД тарифа клиента по городу. |
*outOfCityTariffId | int64 | ИД тарифа клиента за городом. |
*rulesetId | int64 | ИД настройки распределения. |
*schedule | WorkModeScheduleProto[] | Расписание |
*driverTariffs | WorkModeDriverTariffsProto[] | Изменения водительских тарифов. |
*isActive | bool | Режим активен. |
*isArchive | bool | Режим архивирован. |
*ordersExchange | bool | Обмен заказами. |
*clientExtraPaymentsId | int64 | Авьтоматическое дополнение для клиентов. |
Параметр | Тип | Примечание |
---|---|---|
*daysOfWeek | int32[] | Список дней недели. |
*beginTime | string | Начало временного интервала. |
*endTime | string | Конец временного интервала. |
Параметр | Тип | Примечание |
---|---|---|
*fromDriverTariffId | int64 | Какой тариф менять. |
*toDriverTariffId | int64 | На какой тариф менять. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Идентификатор |
*name | string | Имя режима. |
*dateStart | int64 | Дата начала действия режима (мс) |
*dateEnd | int64 | Дата окончания действия режима (мс) |
*serviceId | int64 | ИД службы. |
*serviceName | string | Имя службы. |
*cityTariffId | int64 | ИД тарифа клиента по городу. |
*cityTariffName | string | Имя тарифа клиента по городу. |
*outOfCityTariffId | int64 | ИД тарифа клиента за городом. |
*outOfCityTariffName | string | Имя тарифа клиента за городом. |
*rulesetId | int64 | ИД настройки распределения. |
*rulesetName | string | Имя настройки распределения. |
*isActive | bool | Режим активен. |
*isArchive | bool | Режим архивирован. |
*ordersExchange | bool | Обмен заказами. |
*priority | int32 | Приоритет (0 по умолчанию) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ID службы. |
*name | string | Название службы. |
*phones | string[] | Список телефонов службы. |
*cityId | int32 | Ид города. |
*isActual | bool | Активная / архивная. |
*rulesetId | int64 | Ид активного набора правил. |
*cityTariff | int64 | Используемый городской тариф. |
*outOfCityTariff | int64 | Используемый загородный тариф. |
*autoChangeTariff | bool | Автоматически переключать тариф на загородный при выезде из города. |
*tz | string | Часовой пояс службы. У нас по умолчанию 'UTC-4' |
*fixedPrice | bool | Использовать ли фиксированную стоимость для поездок. |
*driverNonCash | bool | Зачисление денег на счет водителю при безналичном расчете. |
*driverShowCost | bool | Показывать водителю стоимость поездки до взятия заказа. |
*driverShowToAddress | bool | Показывать водителю поле 'Куда' до взятия заказа. |
*cityName | string | Имя города. |
*orderCalculateType | string | Тип расчета поездки (CITY - всегда городской тариф, CITY_AND_OUT_OF_CITY - автоматическое переключение тарифа, OUT_OF_CITY - если начальная точка за городом, всегда загородный тариф) |
*defaultDiscountId | int64 | Ид дисконтной карты по умолчанию. |
*isClientsApiVisible | bool | Служба видна в МП для клиентов. |
*isOpenRoundEnabled | bool | Включение отрытого круга распределния. |
*openRound | int32 | С какого круга распределения заказ отдавать всем водителям. |
*isShowKarma | bool | Показывать карму водителям. |
*isShowAccounting | bool | Показывать бухглалтерию. |
*isShowOpenOrdersOnly | bool | Показывать в списке заказов только заказы с открытым эфиром. |
*mobileBonusValue | double | Мобильный бонус руб. |
*brokeCarAction | string | Действие при отказе "Сломалась машина" См. BrokeCarActions. |
*clientRefusedAction | string | Действие при отказе "Клиент отказался" См. ClientRefusedActions. |
*dangerousClientAction | string | Действие при отказе "Опасный клиент" См. DangerousClientActions. |
*mpShowAllTariffs | bool | Показывать все тарифы службы в приложении водителя. |
*disableClientCall | bool | Отключить кнопку "Позвонить клиенту" в МП. |
*isShowClientPhone | bool | Показывать телефон клиента. |
*notSendExtraPayment | bool | Не отправлять водителю дополнения. |
*isShowDistance | bool | Показывать километраж для водителя. |
*isShowTime | bool | Показывать время заказа для водителя. |
*isShowOrdersOnlineOnly | bool | Показывать заказы только на линиия. |
*isPenaltyRejectsEnabled | bool | Выкидывать из очереди. |
*penaltyRejects | int32 | Выкидывать из очереди при отказе от предложения N заказа. |
*allowDriverChangeTariff | bool | Разрешить смену тарифа водителя. |
Название | Значение | Примечание |
---|---|---|
*NO_ACTION | 1 | Кнопка отключена. |
*NOTIFY_CLIENT | 2 | Уведомление: Клиент отказался через водителя (сообщение клиенту) |
*NOTIFY_OPERATOR | 3 | Уведомление: Клиент отказался через водителя (IVR) |
*NOTIFY_JOIN_OPERATOR | 4 | Уведомление: Позвонить оператору. |
Название | Значение | Примечание |
---|---|---|
*NO_ACTION | 1 | Кнопка отключена. |
*NOTIFY_DANGEROUS_CLIENT | 2 | Уведомление: Опасный клиент. |
*NOTIFY_JOIN_OPERATOR | 3 | Уведомление: Позвонить оператору. |
Название | Значение | Примечание |
---|---|---|
*NO_ACTION | 1 | Кнопка отключена. |
*NOTIFY_REPLACE_CAR | 2 | Уведомление: Замена автомобиля. |
*NOTIFY_JOIN_OPERATOR | 3 | Уведомление: Позвонить оператору. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ID службы. |
*name | string | Название службы. |
*phones | string[] | Список телефонов службы. |
*cityId | int32 | Ид города. |
*isActual | bool | Активная / архивная. |
*city | string | Город |
*rulesetId | int64 | Ид режима работы службы. |
*ruleset | string | Название режима работы службы. |
*tz | string | Часовой пояс службы. |
*isClientsApiVisible | bool | Служба видна в МП для клиентов. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид стоянки. |
*name | string | Название стоянки. |
*border | GeoPolygonProto | Границы стоянки. |
*adjacent | int64[] | Смежные с данной стоянки. |
*cityId | int32 | Ид города. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид стоянки. |
*name | string | Название стоянки. |
*adjacentStr | string | Список смежных стоянок через запятую. |
*cityId | int32 | Ид города. |
*city | string | Название города. |
*border | GeoPolygonProto | Границы стоянки. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Название тарифа. Обязательное поле при создании. |
*serviceIds | int64[] | Список служб. Обязательное поле при создании. |
*beginDate | int64 | Дата начала действия тарифа. |
*endDate | int64 | Дата окончания действия тарифа. |
*carClassId | int64 | Ид класса авто (бизнес, эконом...) |
*sendAnnouncements | bool | Флаг "отсылать уведомления" |
*allowNoShift | bool | Флаг "возможна работа вне смены" |
*isActual | bool | Действителен ли тариф (если false - тариф архивный) |
*minOrders | int32 | Минимальное кол-во заказов, за которое взимается плата по тарифу. |
*payOnOrderStart | bool | Списание за заказ: с момента взятия заказа или с момента завершения заказа. |
*orderPayPercent | double | Списание в процентах за заказ. |
*orderPayMoney | double | Списание в валюте (рублях) за заказ. |
*orderMinCost | double | Минимальная плата за заказ (в случае взятия процентов) |
*orderMaxCost | double | Максимальная плата за заказ (в случае взятия процентов) |
*orderNorm | double | Минимальная сумма, которая списывается за период. |
*orderNormPeriod | int32 | Период, за который списывается минимальная сумма (день/неделя/месяц). См. перечисление TariffTimePeriod. |
*payOnFirstOrder | bool | Периодические списания: момент списания (с первого заказа, по календарным дням) |
*rentPayPeriod | int32 | Период списания (день/неделя/месяц) (блок фиксированной стоимости). См. перечисление TariffTimePeriod. |
*rentCost | double | Величина списания (блок фиксированной стоимости). |
*rentPayTime | string | Время списания (блок фиксированной стоимости). |
*isExtension | bool | Это дополнение или базовый тариф. |
*orderDetails | DriverTariffDetailOrderProto[] | Исключения для списаний за заказ. |
*duration | int64 | Срок действия тарифа (мсек) |
*karmaExceptions | KarmaExceptionBlockProto[] | Исключения для правил кармы. |
*changeTariffs | ChangeDriverTariffProto[] | Замена тарифа водителем. |
*toAddressSettings | int32 | Показывать водителю поле «Куда» до взятия заказа . См. перечисление ToAddressSettings. |
*isChangeTariffOneTime | bool | Разовое применение смены тарифа. |
Название | Значение | Примечание |
---|---|---|
*SERVICE | 1 | Настройки службы. |
*VISIBLE | 2 | Показывать |
*GONE | 3 | Показывать |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*name | string | Название тарифа. |
*serviceIds | int64[] | Список ид служб. |
*services | string | Список названий служб через запятую. |
*beginDate | int64 | Дата начала действия тарифа. |
*endDate | int64 | Дата окончания действия тарифа. |
*isActual | bool | Действителен ли тариф (если false - тариф архивный) |
*driversOnTariff | int64 | Количество водителей, работающих по тарифу. |
*isExtension | bool | Это дополнение или базовый тариф. |
*duration | int64 | Срок действия тарифа. |
*creationDate | int64 | Дата создания тарифа. |
Название | Значение | Примечание |
---|---|---|
*DAY | 1 | День |
*WEEK | 2 | Неделя |
*MONTH | 3 | Месяц |
*THREE_DAYS | 4 | Три дня. |
Параметр | Тип | Примечание |
---|---|---|
*daysOfWeek | int32[] | Список дней недели. |
*beginTime | string | Начало временного интервала. Если указано, то списание действует начиная с этого времени суток. |
*endTime | string | Конец временного интервала. Если указан, то списание действует до этого времени суток. |
*conditionCost | double | Условие по стоимости заказа. Если указано, то списание действует, если стоимость заказа более указанной величины. |
*conditionOnShift | bool | Если true, то списывается, если водитель работает в своей смене. Если false, то списывается, когда водитель работает вне смены. По умолчанию true. |
*isAddCost | bool | Если true, то указанная стоимость прибавляется или вычитается (в зависимости от знака) к общему списанию, иначе величина списания устанавливается в указанную. По умолчанию true. |
*payMoney | double | Списание в валюте (рублях) за заказ. |
*isMoney | bool | Руб или проценты. |
Параметр | Тип | Примечание |
---|---|---|
*toTariffId | int64 | Тариф водителя. |
*cost | double | Стоимость замены. |
*embargoTime | int32 | Запрет на смену, мин. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id тарифа. |
*name | string | Название |
*tariffType | int32 | Тип тарифа. |
*serviceIds | int64[] | Список служб. |
*services | string | Строка, где через запятую идут названия служб. |
*isActual | bool | Активный/архивный |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Id тарифа. |
*name | string | Название тарифа. |
*tariffType | int32 | Тип тарифа (1 - gps-тарификация, 2 - тарифная сетка) |
*serviceIds | int64[] | Список служб. |
*isActual | bool | Активный/архивный |
*minCost | MinCost | Минимальная стоимость. |
*cost | Cost[] | Стоимость |
*boardingCost | BoardingCost | Стоимость посадки. |
*trafficJamCost | StopCost | Пробка |
*trafficLightsCost | StopCost | Светофор |
*exclusions | Exclusion[] | Исключения |
*fixedPriceTrips | FixedPriceTrip[] | Наценки |
*tariffScaleItems | TariffScaleItem[] | Тарифная сетка. |
*numScale | string | Шаблон округления суммы (0,00) |
*tariffGridDefaultGpsTariff | int64 | GPS тариф по умолчанию для тарифной сетки. |
*fixMargin | double | Оплата за дополнительные остановки в сложных маршрутах. |
*minCostId | int64 | |
*boardingCostId | int64 | |
*trafficJamCostId | int64 | |
*trafficLightsCostId | int64 |
Параметр | Тип | Примечание |
---|---|---|
*parkingA | int64 | Стоянка "Откуда" |
*parkingB | int64 | Стоянка "Куда" |
*cost | double | Стоимость поездки (руб) |
Параметр | Тип | Примечание |
---|---|---|
*tripType | int32 | Тип наценки. 1 - между стоянками, 2 - между адресами/объектами, 3 - между улицами. |
*ppFromId | int64 | Стоянка "откуда" |
*addressFromId | int32 | Адрес "откуда" |
*placeFromId | int32 | Место "откуда" |
*streetFromId | int32 | Улица "откуда" |
*ppToId | int64 | Стоянка "куда" |
*addressToId | int32 | Адрес "куда" |
*placeToId | int32 | Место "куда" |
*streetToId | int32 | Улица "куда" |
*cost | double | Величина наценки (руб) |
Параметр | Тип | Примечание |
---|---|---|
*cost | double | Стоимость (руб) |
*distance | double | Кол-во км. |
*time | double | Кол-во минут. |
Параметр | Тип | Примечание |
---|---|---|
*distanceCost | double | Стоимость руб/км. |
*timeCost | double | Стоимость руб/мин. |
*tariffId | int64 | Ид тарифа. |
*exclusionId | int64 | Ид исключения. |
*value | double | Расстояние/время срабатывания. |
Параметр | Тип | Примечание |
---|---|---|
*current | double | Стоимость посадки при срочном заказе (руб) |
*preorder | double | Стоимость посадки при предзаказе (руб) |
Параметр | Тип | Примечание |
---|---|---|
*cost | double | Стоимость остановки (руб/мин) |
*minSpeed | double | Если скорость меньше minSpeed км/ч. |
*minTime | double | ...дольше minTime сек. |
*freeTime | double | ...бесплатно freeTime сек. |
Параметр | Тип | Примечание |
---|---|---|
*exclusionType | int32 | Тип исключения. 1 - мин. стоимость, 2 - стоимость, 3 - посадка, 4 - пробка, 5 - светофор. |
*daysOfWeek | int32[] | Список дней недели, 0 - воскресенье, 1 - понедельник, 6 - суббота. |
*timeBegin | string | Начало временного интервала. |
*timeEnd | string | Конец временного интервала. |
*minCost | MinCost | |
*cost | Cost[] | |
*boardingCost | BoardingCost | |
*trafficJamCost | StopCost | |
*trafficLightsCost | StopCost |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*eventName | string | Имя события. |
*eventTitle | string | Заголовок события. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид уведомления. |
*eventId | int64 | Событие |
*serviceIds | int64[] | Ид служб. |
*notifyType | int32 | Тип уведомления. См. NotifyTypeProto. |
*sms | string | Смс для отправки. |
*call | int64[] | Список ид звуков для проигрывания. |
*push | string | Сообщение для отправки на таксометр. |
*pushConfirm | bool | Подтверждение о получении сообщения. |
*isNotifyDriverCallback | bool | Уведомить водилеля о статусе уведомления клиенту. |
Название | Значение | Примечание |
---|---|---|
*NONE | 0 | Нет уведомлений. |
*SMS | 1 | Отправить смс клиенту. |
*CALL | 2 | Позвонить на телефон клиенту. |
*SMS_OR_CALL | 3 | Смс, при недоставке звонок. |
*SMS_AND_CALL | 4 | Смс + звонок. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид события. |
*name | string | Наименование события. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид уведомления. |
*eventId | int64 | Ид события. |
*eventName | string | Наименование события. |
*serviceIds | int64[] | Список ид служб. |
*services | string[] | Список названий служб. |
*notifyType | int32 | Тип уведомления. См. NotifyTypeProto. |
*sms | string | Текст смс для отправки. |
*push | string | Текст сообщения для отправки на таксометр. |
*call | int64[] | Список ид звуков для проигрывания. |
*callStr | string[] | Список названий звуков для проигрывания. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид |
*text | string | Текст шаблона. |
*allowInSms | bool | Шаблон доступен в SMS. |
*allowInPush | bool | Шаблон доступен в Push. |
Многоугольник
Параметр | Тип | Примечание |
---|---|---|
*vertices | GeoPointProto[] |
Параметр | Тип | Примечание |
---|---|---|
*lon | double | Долгота (в градусах) |
*lat | double | Широта (в градусах) |
Параметр | Тип | Примечание |
---|---|---|
*date | int64 | Дата отметки. |
*lon | double | Долгота (в градусах) |
*lat | double | Широта (в градусах) |
*orderStatus | string | Статус заказа (текст) |
Параметр | Тип | Примечание |
---|---|---|
*date | int64 | Дата отметки. |
*driverId | int64 | Ид водителя. |
*statusId | int64 | Статус водителя. |
*lon | double | Долгота (в градусах) |
*lat | double | Широта (в градусах) |
*callsign | string | Позывной водителя. |
*firstName | string | Имя водителя. |
*lastName | string | Фамилия водителя. |
*serviceName | string | Название службы. |
Параметр | Тип | Примечание |
---|---|---|
*success | bool |
Формат протокола обмена данными.
Параметр | Тип | Примечание |
---|---|---|
*guid | string | Идентификатор запроса (не может быть равен '0') |
*method | string | Имя вызываемого метода. |
*sid | string | Идентификатор сессии. |
*sig | string | Сигнатура данных (данный заголовок не включается) |
*contentLength | int32 | Длина передаваемых данных (данный заголовок не включается) |
*deviceId | string | Udid устройства. |
Параметр | Тип | Примечание |
---|---|---|
*guid | string | Идентификатор ответа (совпадает с идентификатором запроса, '0' - PUSH сообщение инициировано сервером) |
*res | ErrorCode | Результат выполнения запроса. |
*errMsg | string | Текстовое пояснение к результату запроса (возвращается только в случае ошибки) |
*contentLength | int32 | Длина передаваемых данных (данный заголовок не включается) |
*method | string | Имя метода (только для PUSH) |
*displayErrorMessage | bool | Необходимо ли выводить сообщение об ошибке. |
Название | Значение | Примечание |
---|---|---|
*OK | 1 | Успешное выполнение запроса. |
*FAILED | 2 | Ошибка на уровне работы сервера/протокола (обработка запроса бросила исключение) |
*SESSION_INVALID_ALLOW_RECONNECT | 3 | Сессия не найдена либо недействительна. Переподключение разрешено. |
*AUTH_FAIL | 4 | Ошибка авторизации. |
*ACCESS_DENIED | 5 | Доступ к запрашиваемому методу запрещен. |
*SESSION_INVALID_NO_RECONNECT | 6 | Сессия недействительна. Переподключение запрещено. |
*INVALID_METHOD_NAME | 7 | Неверное имя метода. |
*AUTH_FAIL_UNIQUE_SESSION | 8 | Ошибка выдается, когда пользователь(водитель) пытается создать новую сессию с другого устройства при активной сессии. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид корректировки. |
*timestamp | int64 | Дата корректировки. |
*serviceId | int64 | Ид службы. |
*driverLastName | string | Фамилия водителя. |
*driverFirstName | string | Имя водителя. |
*driverMiddleName | string | Отчество водителя. |
*callsign | string | Позывной водителя. |
*amount | double | Сумма корректировки. |
*commentary | string | Комментарий |
*operatorId | int64 | Ид оператора (который сделал корректировку) |
*opLastName | string | Фамилия оператора. |
*opFirstName | string | Имя оператора. |
*opMiddleName | string | Отчество оператора. |
*corrType | int64 | Тип корректировки (для фильтрации). См. AccountCorrectionTypeProto |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Номер |
*date | int64 | Дата действия. |
*login | string | Логин пользователя. |
*ip | string | IP |
*methodName | string | Имя метода. |
*action | string | Действие |
*isSuccess | bool | Результат (успешно/неуспешно) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Номер (идентификатор записи события) |
*eventType | string | Тип события ("ORDER_STATUS_CHANGE - Смена статуса заказа, DISTRIB - Распределение, NOTIFICATION - Уведомление, CREATE_ORDER - Создание заказа, OTHER - Прочее, DRIVER_FAIL - водитель отказался) |
*orderId | int64 | ИД заказа. |
*driverId | int64 | ИД водителя. |
*callsign | string | Позывной водителя. |
*firstName | string | Имя водителя. |
*lastName | string | Фамилия водителя. |
*middleName | string | Отчество водителя. |
*date | int64 | Дата и время. |
*text | string | Комментарий |
*eventName | string | Имя события. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД записи. |
*dateBegin | int64 | Дата применения правила. |
*driverId | int64 | ИД водителя (для ссылки на карточку) |
*callsign | string | Позывной водителя. |
*driverLastName | string | Фамилия водителя. |
*driverFirstName | string | Имя водителя. |
*driverMiddleName | string | Отчество водителя. |
*karmaId | int64 | ИД правила кармы. |
*ruleName | string | Название правила (если назначено автоматически)/комментарий (если назначено вручную) |
*rating | int64 | Изменение рейтинга (количество баллов рейтинга изменяемый данным правилом) |
*money | double | Сумма (сумма зачисления/списания со счета водителя по данному правилу) |
*ban= | bool | Блокировка (чекбокс, установлен если в правиле настроена временная блокировка водителя) |
*duration | int64 | Время действия (мс) |
*operatorId | int64 | ИД инициатора (оператора) |
*operatorLastName | string | Фамилия оператора. |
*operatorFirstName | string | Имя оператора. |
*operatorMiddleName | string | Отчество оператора. |
*isActive | bool | Статус (true - если установлено время действия и само правило действует в данный момент, false - во всех остальных случаях) |
*orderId | int64 | Ид заказа. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Ид записи. |
*creationDate | int64 | Дата создания. |
*orderId | int64 | ИД заказа. |
*phone | string | Номер телефона. |
*status | int64 | ИД статуса. |
*statusText | string | Статус |
*message | string | Текст сообщения (только для смс) |
*isIncoming | bool | Входящий или исходящий звонок ( для смс пока false) |
*notificationId | int64 | ИД уведомления (если null - произвольная рассылка, иначе инициатор - событие бизнес-процесса выполнения заказа) |
*eventName | string | Имя уведомления. |
*lastTryTime | int64 | Дата и время последней попытки (Пока не используется, нужна доработка) |
*attemptsCount | int64 | Количество попыток (Пока не используется, нужна доработка) |
*type | string | Тип (CALL, SMS) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | Номер (идентификатор записи действий с аккаунтом пользователя) |
*driver_id | int64 | ИД водителя. |
*callsign | string | Позывной (ссылка на карточку водителя) |
*lastName | string | Фамилия водителя. |
*firstName | string | Имя водителя. |
*middleName | string | Отчество водителя. |
*timestamp | int64 | Дата |
*amount | double | Сумма (положительные - зеленым цветом с явным плюсом впереди, отрицательные - красным) |
*opType | string | Тип операции (зачисление/списание/обещанный платеж/поощрение/штраф/комиссия) |
*platName | string | Наименование платежной системы. |
*commentary | string | Комментарий |
*orderId | int64 | ИД заказа. |
*txnId | string | Внешний ИД платежа. |
*operatorId | int64 | Инициатор (если корректировка создана вручную) |
*operatorLastName | string | Фамилия инициатора. |
*operatorFirstName | string | Имя инициатора. |
*operatorMiddleName | string | Отчество инициатора. |
*balance | double | Баланс после проведения этой операции. |
Параметр | Тип | Примечание |
---|---|---|
*policy | int64[] | Транспорты рассылки. См. PolicyTypesProto |
*recipientType | int64 | Тип реципиента. См. RecipientTypeProto |
*extId | int64 | ИД ссылка на внешний источник. Зависит от типа реципиента (Например, для типа ROLE, поле хранит ИД группы) |
string | E-mail реципиента. | |
*emailSend | bool | Отправлять оповещания на e-mail. |
*phone | string | Телефон реципиента. |
*phoneSend | bool | Отправлять оповещания на телефон (смс) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД записи. |
*systemEventId | int64 | ИД события системы. |
*policy | int64[] | Транспорты рассылки. См. PolicyTypesProto |
*recipientType | int64 | Тип реципиента. См. RecipientTypeProto |
*extId | int64 | ИД ссылка на внешний источник. Зависит от типа реципиента (Например, для типа ROLE, поле хранит ИД группы) |
string | E-mail реципиента. | |
*emailSend | bool | Отправлять оповещания на e-mail. |
*phone | string | Телефон реципиента. |
*phoneSend | bool | Отправлять оповещания на телефон (смс) |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД записи. |
*systemEventId | int64 | ИД события системы. |
*policy | int64[] | Транспорты рассылки. См. PolicyTypesProto |
*recipientType | int64 | Тип реципиента. См. RecipientTypeProto |
*extId | int64 | ИД ссылка на внешний источник. Зависит от типа реципиента (Например, для типа ROLE, поле хранит ИД группы) |
string | E-mail реципиента. | |
*emailSend | bool | Отправлять оповещания на e-mail. |
*phone | string | Телефон реципиента. |
*phoneSend | bool | Отправлять оповещания на телефон (смс) |
Название | Значение | Примечание |
---|---|---|
*TO | 1 | Система сообщений ТаксиОнлайн. |
*SMS | 2 | СМС |
3 |
Название | Значение | Примечание |
---|---|---|
*USER | 1 | Пользователь |
*ROLE | 2 | Роль |
*GROUP | 3 | Группа пользователей. |
*OTHER | 4 | Произвольный номер или email. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД сообщения. |
*typeId | int64 | ИД типа сообщения. См. MessageTypesProto |
*sourceId | int64 | ИД источника сообщения. См. MessageSourceProto |
*senderId | int64 | ИД аккаунта отправителя. |
*subject | string | Тема сообщения. |
*recipientId | int64 | ИД аккаунта получателя. |
*messageText | string | Текст сообщения. |
*receivedDate | int64 | Дата получения. |
*readDate | int64 | Дата прочтения (null - непрочитано) |
*recipientIds | int64[] | ИД аккаунтов получателей копии сообщения. |
Параметр | Тип | Примечание |
---|---|---|
*id | int64 | ИД сообщения. |
*typeId | int64 | ИД типа сообщения. См. MessageTypesProto |
*typeName | string | Тип сообщения. |
*sourceId | int64 | ИД источника сообщения. См. MessageSourceProto |
*sourceName | string | Источник сообщения. |
*senderId | int64 | ИД аккаунта отправителя. |
*senderFirstname | string | Имя отправителя. |
*senderLastname | string | Фамилия отправителя. |
*senderMiddlename | string | Отчество отправителя. |
*subject | string | Тема сообщения. |
*recipientIds | int64[] | ИД аккаунтов получателей копии сообщения. |
*recipientNames | string[] | Имена получателей копии сообщения. |
*messageText | string | Текст сообщения. |
*receivedDate | int64 | Дата получения. |
*readDate | int64 | Дата прочтения (null - непрочитано) |
*extId | int64 | ИД ссылка на внешний источник (если тип сообщения ALARM - ИД тревоги) |
*context | Context | Контекстные поля. |
*recipientId | int64 | ИД аккаунта получателя. |
Параметр | Тип | Примечание |
---|---|---|
*drivers | DriverProto[] | Список водителей. |
*orders | OrderProto[] | Список заказов. |
*clients | ClientCardProto[] | Список клиентов. |
*accounts | AccountProto[] | Список пользователей. |
Название | Значение | Примечание |
---|---|---|
*INTERNAL | 1 | Простое сообщение (чаты с водителями, деловая переписка между менеджерами внутри системы) |
*ALARM | 2 | Тревога |
*WARNING | 3 | Предупреждение |
*ERROR | 4 | Ошибка |
Название | Значение | Примечание |
---|---|---|
*SYSTEM | 1 | Система |
*USER | 2 | Пользователь |
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*smsFromName | string | Имя отправителя SMS. |
*mobileRegex | string[] | Сотовый телефон. |
*landlineRegex | string[] | Стационарный телефон. |
*bannedRegex | string[] | Запрещенные номера. |
*callAttempts | int32 | Количество дозвонов. |
*callAttemptsDelay | int64 | Пауза между дозвонами (с) |
*smsTimeout | int64 | Пауза между дозвонами (с) |
Параметр | Тип | Примечание |
---|---|---|
*serviceId | int64 | Ид службы. |
*service | string | Название службы. |
*smsFromName | string | Имя отправителя SMS. |
*mobileRegex | string[] | Сотовый телефон. |
*landlineRegex | string[] | Стационарный телефон. |
*bannedRegex | string[] | Запрещенные номера. |
*callAttempts | int32 | Количество дозвонов. |
*callAttemptsDelay | int64 | Пауза между дозвонами (с) |
Параметр | Тип | Примечание |
---|---|---|
*soundId | int64[] | Список ид звуков. |
*closeWhenDone | bool | Завершить звонок после проговаривания всех звуков. |
*joinNumber | string | Подключить этот номер к звонку после проговаривания всех звуков. |
Название | Значение | Примечание |
---|---|---|
*DIALING | 1 | Идет дозвон. |
*ACTIVE | 2 | Дозвонились |
*COMPLETED | 3 | Звонок завершен. |
*FAILED | 4 | Занято или не отвечают. |
*ERROR | 5 | Ошибка при дозвоне. |
*REDIRECT | 6 | Переведен на оператора. |