Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -3050,19 +3050,13 @@ 3050 3050 { 3051 3051 "name": "string", 3052 3052 "number": 0, 3053 - "period": 0, 3053 + "period": 0, ~/~/ Частота трансляции радиометки 3054 3054 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3055 3055 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3056 + "deleted": true 3056 3056 } 3057 3057 ] 3058 3058 3059 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3060 -|parentId|ID клиента 3061 -|name|Название карты-метки 3062 -|number|Номер 3063 -|period|Период запросов в секундах (работает только для агрегатов) 3064 -|id|ID карты-метки 3065 - 3066 3066 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3067 3067 3068 3068 (% class="box infomessage" %) ... ... @@ -3078,19 +3078,13 @@ 3078 3078 { 3079 3079 "name": "string", 3080 3080 "number": 0, 3081 - "period": 0, 3075 + "period": 0, ~/~/ Частота трансляции радиометки 3082 3082 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3083 3083 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3078 + "deleted": true 3084 3084 } 3085 3085 ] 3086 3086 3087 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3088 -|name|Название карты-метки 3089 -|number|Номер 3090 -|period|Период запросов в секундах (работает только для агрегатов) 3091 -|id|ID карты-метки 3092 -|parentId|ID клиента 3093 - 3094 3094 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3095 3095 3096 3096 (% class="box successmessage" %) ... ... @@ -3105,6 +3105,7 @@ 3105 3105 "number": 0, 3106 3106 "period": 0, 3107 3107 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3096 + "deleted": true 3108 3108 } 3109 3109 3110 3110 Ответ: ... ... @@ -3115,15 +3115,9 @@ 3115 3115 "period": 0, 3116 3116 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3117 3117 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3107 + "deleted": true 3118 3118 } 3119 3119 3120 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3121 -|name|Название карты-метки 3122 -|number|Номер 3123 -|period|Период запросов в секундах (работает только для агрегатов) 3124 -|id|ID карты-метки 3125 -|parentId|ID клиента 3126 - 3127 3127 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3128 3128 3129 3129 (% class="box warningmessage" %) ... ... @@ -3139,6 +3139,7 @@ 3139 3139 "period": 0, 3140 3140 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3141 3141 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3125 + "deleted": true 3142 3142 } 3143 3143 3144 3144 Ответ: ... ... @@ -3149,15 +3149,9 @@ 3149 3149 "period": 0, 3150 3150 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3151 3151 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3136 + "deleted": true 3152 3152 } 3153 3153 3154 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3155 -|name|Название карты-метки 3156 -|number|Номер 3157 -|period|Период запросов в секундах (работает только для агрегатов) 3158 -|id|ID карты-метки 3159 -|parentId|ID клиента 3160 - 3161 3161 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3162 3162 3163 3163 (% class="box errormessage" %) ... ... @@ -3406,8 +3406,6 @@ 3406 3406 **PUT /api/v3/Billing/client/balance** 3407 3407 ))) 3408 3408 3409 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3410 - 3411 3411 Тело запроса: 3412 3412 3413 3413 { ... ... @@ -3421,50 +3421,6 @@ 3421 3421 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3422 3422 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3423 3423 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 - 3468 3468 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3469 3469 3470 3470 (% class="box warningmessage" %) ... ... @@ -3539,11 +3539,7 @@ 3539 3539 3540 3540 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3541 3541 3542 -(% class="box warningmessage" %) 3543 -((( 3544 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3545 -))) 3546 - 3474 +(% class="wikigeneratedid" %) 3547 3547 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3548 3548 3549 3549 (% class="box infomessage" %) ... ... @@ -3551,43 +3551,12 @@ 3551 3551 **POST /api/v3/vehicles/import/{agentId}** 3552 3552 ))) 3553 3553 3554 - Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате**xml**или**wlp.**Такжеони могутнаходится в** zip-архиве.**3482 +**agentId** - id клиента. 3555 3555 3556 -В пути указывается **agentId** - id клиента. 3557 3557 3558 -**Заголовок** 3485 +(% class="wikigeneratedid" %) 3486 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3559 3559 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 - 3591 3591 (% class="box infomessage" %) 3592 3592 ((( 3593 3593 **POST /api/v3/vehicles/import/history/{vehicleId}** ... ... @@ -3594,52 +3594,10 @@ 3594 3594 ))) 3595 3595 3596 3596 (% class="wikigeneratedid" %) 3597 - Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат**wln**или**json**.Такжеони могутбыть упакованы и переданы в виде в **zip-архива**.3494 +**vehicleId **- id объекта. 3598 3598 3599 -(% class="wikigeneratedid" %) 3600 -В пути указывается **vehicleId **- id объекта. 3601 3601 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 - 3497 +(% class="wikigeneratedid" %) 3643 3643 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3644 3644 3645 3645 (% class="box infomessage" %) ... ... @@ -3647,20 +3647,7 @@ 3647 3647 **GET /api/v3/vehicles/import/history/status** 3648 3648 ))) 3649 3649 3650 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3651 3651 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 - 3664 3664 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3665 3665 3666 3666 (% class="box infomessage" %) ... ... @@ -3730,7 +3730,8 @@ 3730 3730 3731 3731 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3732 3732 3733 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) == 3575 +(% class="wikigeneratedid" %) 3576 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3734 3734 3735 3735 (% class="box infomessage" %) 3736 3736 ((( ... ... @@ -3737,7 +3737,7 @@ 3737 3737 **POST /api/v3/EcoDriving/rating** 3738 3738 ))) 3739 3739 3740 -Позволяет получить данные рейтинганарушений выбранныхобъектов зауказанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.3583 +Позволяет получить список нарушений массива объектов объектов за выбранный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3741 3741 3742 3742 Тело запроса: 3743 3743 ... ... @@ -3836,6 +3836,7 @@ 3836 3836 |driverName|Имя водителя 3837 3837 |driverRfid|Номер Карты-метки 3838 3838 3682 + 3839 3839 (% class="box" lang="en-US" style="text-align: center;" %) 3840 3840 ((( 3841 3841 (% 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]] **