Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 118.1 >
edited by Илья Крайнов
on 2023/11/22 13:01
To version < 122.1 >
edited by Илья Крайнов
on 2023/11/28 12:37
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -3406,6 +3406,8 @@
3406 3406  **PUT /api/v3/Billing/client/balance**
3407 3407  )))
3408 3408  
3409 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3410 +
3409 3409  Тело запроса:
3410 3410  
3411 3411  {
... ... @@ -3419,6 +3419,50 @@
3419 3419  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3420 3420  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3421 3421  
3424 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3425 +
3426 +(% class="box warningmessage" %)
3427 +(((
3428 +**PUT /api/v3/billing/client/balance/deposit**
3429 +)))
3430 +
3431 +Создает операцию **Пополнение **с указанной суммой
3432 +
3433 +Тело запроса:
3434 +
3435 +{
3436 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3437 + "Balance": 0
3438 +}
3439 +
3440 +Ответ: Success
3441 +
3442 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3443 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3444 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3445 +
3446 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3447 +
3448 +Создает операцию **Списание **с указанной суммой
3449 +
3450 +(% class="box warningmessage" %)
3451 +(((
3452 +**PUT /api/v3/billing/client/balance/withdraw**
3453 +)))
3454 +
3455 +Тело запроса:
3456 +
3457 +{
3458 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3459 + "Balance": 0
3460 +}
3461 +
3462 +Ответ: Success
3463 +
3464 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3465 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3466 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3467 +
3422 3422  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3423 3423  
3424 3424  (% class="box warningmessage" %)
... ... @@ -3493,6 +3493,11 @@
3493 3493  
3494 3494  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3495 3495  
3542 +(% class="box warningmessage" %)
3543 +(((
3544 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3545 +)))
3546 +
3496 3496  == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3497 3497  
3498 3498  (% class="box infomessage" %)
... ... @@ -3500,11 +3500,43 @@
3500 3500  **POST /api/v3/vehicles/import/{agentId}**
3501 3501  )))
3502 3502  
3503 -**agentId** - id клиента.
3554 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3504 3504  
3556 +В пути указывается **agentId** - id клиента.
3505 3505  
3506 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3558 +**Заголовок**
3507 3507  
3560 +**X-Auth: [токен авторизации]**
3561 +
3562 +**Параметры**
3563 +
3564 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3565 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3566 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3567 +
3568 +В теле использовать тип **form-data,** тип значения** file**
3569 +
3570 +**Ключи**
3571 +
3572 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3573 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3574 +|csv|В значении передаем файл датчиков, формат **csv**
3575 +
3576 +Ответ:
3577 +
3578 +{
3579 + "vehicleId": 0,
3580 + "name": "string",
3581 + "errors": ["string"]
3582 +}
3583 +
3584 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3585 +|vehicleId|ID созданного объекта
3586 +|name|Имя созданного объекта
3587 +|errors|Ошибки и их описание
3588 +
3589 +(% style="color:#000000; font-size:16px" %)**Импорт объектов**
3590 +
3508 3508  (% class="box infomessage" %)
3509 3509  (((
3510 3510  **POST /api/v3/vehicles/import/history/{vehicleId}**
... ... @@ -3511,9 +3511,52 @@
3511 3511  )))
3512 3512  
3513 3513  (% class="wikigeneratedid" %)
3514 -**vehicleId **- id объекта.
3597 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3515 3515  
3599 +(% class="wikigeneratedid" %)
3600 +В пути указывается **vehicleId **- id объекта.
3516 3516  
3602 +**Заголовок**
3603 +
3604 +**X-Auth: [токен авторизации]**
3605 +
3606 +В теле использовать тип **form-data.**
3607 +
3608 +Ключи:
3609 +
3610 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3611 +|**history**|В значении передавать файл с историей
3612 +
3613 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3614 +
3615 +Ответ:
3616 +
3617 +{
3618 + "results": [
3619 + {
3620 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3621 + "vehicleId": 0,
3622 + "errors": [
3623 + "string"
3624 + ],
3625 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3626 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3627 + "producedCount": 0,
3628 + "msgCount": 0
3629 + }
3630 + ]
3631 +}
3632 +
3633 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3634 +|results|Результаты импорта в разрезе ТС
3635 +|vehicleGuid|Guid ТС
3636 +|vehicleId|ID ТС
3637 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3638 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3639 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3640 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3641 +|msgCount|Кол-во обработанных сообщений всего
3642 +
3517 3517  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3518 3518  
3519 3519  (% class="box infomessage" %)
... ... @@ -3521,7 +3521,20 @@
3521 3521  **GET /api/v3/vehicles/import/history/status**
3522 3522  )))
3523 3523  
3650 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3524 3524  
3652 +Ответ:
3653 +
3654 +{
3655 + "activity": true,
3656 + "progress": 0,
3657 + "message": "string"
3658 +}
3659 +
3660 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3661 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3662 +|progress|Guid ТС
3663 +
3525 3525  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3526 3526  
3527 3527  (% class="box infomessage" %)
... ... @@ -3591,7 +3591,7 @@
3591 3591  
3592 3592  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3593 3593  
3594 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3733 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3595 3595  
3596 3596  (% class="box infomessage" %)
3597 3597  (((
... ... @@ -3598,7 +3598,7 @@
3598 3598  **POST /api/v3/EcoDriving/rating**
3599 3599  )))
3600 3600  
3601 -Позволяет получить список нарушений массива объектов объектов за выбранный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3740 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3602 3602  
3603 3603  Тело запроса:
3604 3604  

Меню

ГЛОНАССSoft wiki - 2024 г.