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

Summary

Details

Icon Page properties
Content
... ... @@ -356,23 +356,8 @@
356 356  
357 357  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
358 358  
359 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
359 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
360 360  
361 -(% class="box warningmessage" %)
362 -(((
363 -**PUT /api/v3/agents/{id}/changeStatus/{status}**
364 -)))
365 -
366 -Метод позволяет изменить статус клиента, указанного в запросе.
367 -
368 -В пути указывается GUID клиента и статус клиента.
369 -
370 -**status **- значение 0 - заблокирован, 1 - активен.
371 -
372 -Ответ: Code 204
373 -
374 -== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) ==
375 -
376 376  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
377 377  
378 378  (% class="box successmessage" %)
... ... @@ -3065,19 +3065,13 @@
3065 3065   {
3066 3066   "name": "string",
3067 3067   "number": 0,
3068 - "period": 0,
3053 + "period": 0, ~/~/ Частота трансляции радиометки
3069 3069   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3070 3070   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3056 + "deleted": true
3071 3071   }
3072 3072  ]
3073 3073  
3074 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3075 -|parentId|ID клиента
3076 -|name|Название карты-метки
3077 -|number|Номер
3078 -|period|Период запросов в секундах (работает только для агрегатов)
3079 -|id|ID карты-метки
3080 -
3081 3081  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3082 3082  
3083 3083  (% class="box infomessage" %)
... ... @@ -3093,19 +3093,13 @@
3093 3093   {
3094 3094   "name": "string",
3095 3095   "number": 0,
3096 - "period": 0,
3075 + "period": 0, ~/~/ Частота трансляции радиометки
3097 3097   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3098 3098   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3078 + "deleted": true
3099 3099   }
3100 3100  ]
3101 3101  
3102 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3103 -|name|Название карты-метки
3104 -|number|Номер
3105 -|period|Период запросов в секундах (работает только для агрегатов)
3106 -|id|ID карты-метки
3107 -|parentId|ID клиента
3108 -
3109 3109  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3110 3110  
3111 3111  (% class="box successmessage" %)
... ... @@ -3120,6 +3120,7 @@
3120 3120   "number": 0,
3121 3121   "period": 0,
3122 3122   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3096 + "deleted": true
3123 3123  }
3124 3124  
3125 3125  Ответ:
... ... @@ -3130,15 +3130,9 @@
3130 3130   "period": 0,
3131 3131   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3132 3132   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3107 + "deleted": true
3133 3133  }
3134 3134  
3135 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3136 -|name|Название карты-метки
3137 -|number|Номер
3138 -|period|Период запросов в секундах (работает только для агрегатов)
3139 -|id|ID карты-метки
3140 -|parentId|ID клиента
3141 -
3142 3142  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3143 3143  
3144 3144  (% class="box warningmessage" %)
... ... @@ -3154,6 +3154,7 @@
3154 3154   "period": 0,
3155 3155   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3156 3156   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3125 + "deleted": true
3157 3157  }
3158 3158  
3159 3159  Ответ:
... ... @@ -3164,15 +3164,9 @@
3164 3164   "period": 0,
3165 3165   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3166 3166   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3136 + "deleted": true
3167 3167  }
3168 3168  
3169 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3170 -|name|Название карты-метки
3171 -|number|Номер
3172 -|period|Период запросов в секундах (работает только для агрегатов)
3173 -|id|ID карты-метки
3174 -|parentId|ID клиента
3175 -
3176 3176  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3177 3177  
3178 3178  (% class="box errormessage" %)
... ... @@ -3421,8 +3421,6 @@
3421 3421  **PUT /api/v3/Billing/client/balance**
3422 3422  )))
3423 3423  
3424 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3425 -
3426 3426  Тело запроса:
3427 3427  
3428 3428  {
... ... @@ -3436,50 +3436,6 @@
3436 3436  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3437 3437  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3438 3438  
3439 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3440 -
3441 -(% class="box warningmessage" %)
3442 -(((
3443 -**PUT /api/v3/billing/client/balance/deposit**
3444 -)))
3445 -
3446 -Создает операцию **Пополнение **с указанной суммой
3447 -
3448 -Тело запроса:
3449 -
3450 -{
3451 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3452 - "Balance": 0
3453 -}
3454 -
3455 -Ответ: Success
3456 -
3457 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3458 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3459 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3460 -
3461 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3462 -
3463 -Создает операцию **Списание **с указанной суммой
3464 -
3465 -(% class="box warningmessage" %)
3466 -(((
3467 -**PUT /api/v3/billing/client/balance/withdraw**
3468 -)))
3469 -
3470 -Тело запроса:
3471 -
3472 -{
3473 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3474 - "Balance": 0
3475 -}
3476 -
3477 -Ответ: Success
3478 -
3479 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3480 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3481 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3482 -
3483 3483  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3484 3484  
3485 3485  (% class="box warningmessage" %)
... ... @@ -3554,11 +3554,7 @@
3554 3554  
3555 3555  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3556 3556  
3557 -(% class="box warningmessage" %)
3558 -(((
3559 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3560 -)))
3561 -
3474 +(% class="wikigeneratedid" %)
3562 3562  == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3563 3563  
3564 3564  (% class="box infomessage" %)
... ... @@ -3566,95 +3566,22 @@
3566 3566  **POST /api/v3/vehicles/import/{agentId}**
3567 3567  )))
3568 3568  
3569 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3482 +**agentId** - id клиента.
3570 3570  
3571 -В пути указывается **agentId** - id клиента.
3572 3572  
3573 -**Заголовок**
3574 -
3575 -**X-Auth: [токен авторизации]**
3576 -
3577 -**Параметры**
3578 -
3579 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3580 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3581 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3582 -
3583 -В теле использовать тип **form-data,** тип значения** file**
3584 -
3585 -**Ключи**
3586 -
3587 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3588 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3589 -|csv|В значении передаем файл датчиков, формат **csv**
3590 -
3591 -Ответ:
3592 -
3593 -{
3594 - "vehicleId": 0,
3595 - "name": "string",
3596 - "errors": ["string"]
3597 -}
3598 -
3599 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3600 -|vehicleId|ID созданного объекта
3601 -|name|Имя созданного объекта
3602 -|errors|Ошибки и их описание
3603 -
3485 +(% class="wikigeneratedid" %)
3604 3604  == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3605 3605  
3606 3606  (% class="box infomessage" %)
3607 3607  (((
3608 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3490 +**POST /api/v3/vehicles/import/history/{vehicleId}**
3609 3609  )))
3610 3610  
3611 3611  (% class="wikigeneratedid" %)
3612 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3494 +**vehicleId **- id объекта.
3613 3613  
3614 -(% class="wikigeneratedid" %)
3615 -В пути указывается **vehicleId **- id объекта.
3616 3616  
3617 -**Заголовок**
3618 -
3619 -**X-Auth: [токен авторизации]**
3620 -
3621 -В теле использовать тип **form-data.**
3622 -
3623 -Ключи:
3624 -
3625 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3626 -|**history**|В значении передавать файл с историей
3627 -
3628 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3629 -
3630 -Ответ:
3631 -
3632 -{
3633 - "results": [
3634 - {
3635 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3636 - "vehicleId": 0,
3637 - "errors": [
3638 - "string"
3639 - ],
3640 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3641 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3642 - "producedCount": 0,
3643 - "msgCount": 0
3644 - }
3645 - ]
3646 -}
3647 -
3648 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3649 -|results|Результаты импорта в разрезе ТС
3650 -|vehicleGuid|Guid ТС
3651 -|vehicleId|ID ТС
3652 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3653 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3654 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3655 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3656 -|msgCount|Кол-во обработанных сообщений всего
3657 -
3497 +(% class="wikigeneratedid" %)
3658 3658  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3659 3659  
3660 3660  (% class="box infomessage" %)
... ... @@ -3662,20 +3662,7 @@
3662 3662  **GET /api/v3/vehicles/import/history/status**
3663 3663  )))
3664 3664  
3665 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3666 3666  
3667 -Ответ:
3668 -
3669 -{
3670 - "activity": true,
3671 - "progress": 0,
3672 - "message": "string"
3673 -}
3674 -
3675 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3676 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3677 -|progress|Guid ТС
3678 -
3679 3679  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3680 3680  
3681 3681  (% class="box infomessage" %)
... ... @@ -3745,7 +3745,8 @@
3745 3745  
3746 3746  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3747 3747  
3748 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3575 +(% class="wikigeneratedid" %)
3576 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3749 3749  
3750 3750  (% class="box infomessage" %)
3751 3751  (((
... ... @@ -3752,7 +3752,7 @@
3752 3752  **POST /api/v3/EcoDriving/rating**
3753 3753  )))
3754 3754  
3755 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3583 +Позволяет получить список нарушений массива объектов объектов за выбранный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3756 3756  
3757 3757  Тело запроса:
3758 3758  
... ... @@ -3851,6 +3851,7 @@
3851 3851  |driverName|Имя водителя
3852 3852  |driverRfid|Номер Карты-метки
3853 3853  
3682 +
3854 3854  (% class="box" lang="en-US" style="text-align: center;" %)
3855 3855  (((
3856 3856  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

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