Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 126.1 >
edited by Илья Крайнов
on 2023/11/29 10:18
To version < 116.1 >
edited by Илья Крайнов
on 2023/11/20 18:01
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -356,21 +356,6 @@
356 356  
357 357  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
358 358  
359 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
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 374  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
375 375  
376 376  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -1887,51 +1887,6 @@
1887 1887   }
1888 1888  ]
1889 1889  
1890 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1891 -
1892 -(% class="box infomessage" style="text-align: left;" %)
1893 -(((
1894 -**POST /api/v3/terminalMessages/mapping**
1895 -)))
1896 -
1897 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1898 -
1899 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1900 -
1901 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1902 -
1903 -{
1904 - "protocolType": 0,
1905 - "params": ["string"]
1906 -}
1907 -
1908 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1909 -|protocolType|ID типа протокола
1910 -|params|(((
1911 -Массив наименований параметров в сообщении
1912 -)))
1913 -
1914 -Ответ:
1915 -
1916 -{
1917 - "protocolType": 0,
1918 - "mapping": {
1919 - "additionalProp1": {
1920 - "inputType": 0,
1921 - "inputNumber": 0
1922 - },
1923 - "additionalProp2": {
1924 - "inputType": 0,
1925 - "inputNumber": 0
1926 - }
1927 - }
1928 -}
1929 -
1930 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1931 -|protocolType|Тип протокола
1932 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1933 -|inputNumber|Номер входа
1934 -
1935 1935  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1936 1936  
1937 1937  (% class="box infomessage" %)
... ... @@ -3110,19 +3110,13 @@
3110 3110   {
3111 3111   "name": "string",
3112 3112   "number": 0,
3113 - "period": 0,
3053 + "period": 0, ~/~/ Частота трансляции радиометки
3114 3114   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3115 3115   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3056 + "deleted": true
3116 3116   }
3117 3117  ]
3118 3118  
3119 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3120 -|parentId|ID клиента
3121 -|name|Название карты-метки
3122 -|number|Номер
3123 -|period|Период запросов в секундах (работает только для агрегатов)
3124 -|id|ID карты-метки
3125 -
3126 3126  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3127 3127  
3128 3128  (% class="box infomessage" %)
... ... @@ -3138,19 +3138,13 @@
3138 3138   {
3139 3139   "name": "string",
3140 3140   "number": 0,
3141 - "period": 0,
3075 + "period": 0, ~/~/ Частота трансляции радиометки
3142 3142   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3143 3143   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3078 + "deleted": true
3144 3144   }
3145 3145  ]
3146 3146  
3147 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3148 -|name|Название карты-метки
3149 -|number|Номер
3150 -|period|Период запросов в секундах (работает только для агрегатов)
3151 -|id|ID карты-метки
3152 -|parentId|ID клиента
3153 -
3154 3154  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3155 3155  
3156 3156  (% class="box successmessage" %)
... ... @@ -3165,6 +3165,7 @@
3165 3165   "number": 0,
3166 3166   "period": 0,
3167 3167   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3096 + "deleted": true
3168 3168  }
3169 3169  
3170 3170  Ответ:
... ... @@ -3175,15 +3175,9 @@
3175 3175   "period": 0,
3176 3176   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3177 3177   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3107 + "deleted": true
3178 3178  }
3179 3179  
3180 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3181 -|name|Название карты-метки
3182 -|number|Номер
3183 -|period|Период запросов в секундах (работает только для агрегатов)
3184 -|id|ID карты-метки
3185 -|parentId|ID клиента
3186 -
3187 3187  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3188 3188  
3189 3189  (% class="box warningmessage" %)
... ... @@ -3199,6 +3199,7 @@
3199 3199   "period": 0,
3200 3200   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3201 3201   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3125 + "deleted": true
3202 3202  }
3203 3203  
3204 3204  Ответ:
... ... @@ -3209,15 +3209,9 @@
3209 3209   "period": 0,
3210 3210   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 3211   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3136 + "deleted": true
3212 3212  }
3213 3213  
3214 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3215 -|name|Название карты-метки
3216 -|number|Номер
3217 -|period|Период запросов в секундах (работает только для агрегатов)
3218 -|id|ID карты-метки
3219 -|parentId|ID клиента
3220 -
3221 3221  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3222 3222  
3223 3223  (% class="box errormessage" %)
... ... @@ -3466,8 +3466,6 @@
3466 3466  **PUT /api/v3/Billing/client/balance**
3467 3467  )))
3468 3468  
3469 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3470 -
3471 3471  Тело запроса:
3472 3472  
3473 3473  {
... ... @@ -3481,50 +3481,6 @@
3481 3481  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3482 3482  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3483 3483  
3484 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3485 -
3486 -(% class="box warningmessage" %)
3487 -(((
3488 -**PUT /api/v3/billing/client/balance/deposit**
3489 -)))
3490 -
3491 -Создает операцию **Пополнение **с указанной суммой
3492 -
3493 -Тело запроса:
3494 -
3495 -{
3496 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3497 - "Balance": 0
3498 -}
3499 -
3500 -Ответ: Success
3501 -
3502 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3503 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3504 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3505 -
3506 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3507 -
3508 -Создает операцию **Списание **с указанной суммой
3509 -
3510 -(% class="box warningmessage" %)
3511 -(((
3512 -**PUT /api/v3/billing/client/balance/withdraw**
3513 -)))
3514 -
3515 -Тело запроса:
3516 -
3517 -{
3518 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519 - "Balance": 0
3520 -}
3521 -
3522 -Ответ: Success
3523 -
3524 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3525 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3526 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3527 -
3528 3528  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3529 3529  
3530 3530  (% class="box warningmessage" %)
... ... @@ -3599,145 +3599,6 @@
3599 3599  
3600 3600  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3601 3601  
3602 -(% class="box warningmessage" %)
3603 -(((
3604 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3605 -)))
3606 -
3607 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3608 -
3609 -(% class="box infomessage" %)
3610 -(((
3611 -**POST /api/v3/vehicles/import/{agentId}**
3612 -)))
3613 -
3614 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3615 -
3616 -В пути указывается **agentId** - id клиента.
3617 -
3618 -**Заголовок**
3619 -
3620 -**X-Auth: [токен авторизации]**
3621 -
3622 -**Параметры**
3623 -
3624 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3625 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3626 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3627 -
3628 -В теле использовать тип **form-data,** тип значения** file**
3629 -
3630 -**Ключи**
3631 -
3632 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3633 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3634 -|csv|В значении передаем файл датчиков, формат **csv**
3635 -
3636 -Ответ:
3637 -
3638 -{
3639 - "vehicleId": 0,
3640 - "name": "string",
3641 - "errors": ["string"]
3642 -}
3643 -
3644 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3645 -|vehicleId|ID созданного объекта
3646 -|name|Имя созданного объекта
3647 -|errors|Ошибки и их описание
3648 -
3649 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3650 -
3651 -(% class="box infomessage" %)
3652 -(((
3653 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3654 -)))
3655 -
3656 -(% class="wikigeneratedid" %)
3657 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3658 -
3659 -(% class="wikigeneratedid" %)
3660 -В пути указывается **vehicleId **- id объекта.
3661 -
3662 -**Заголовок**
3663 -
3664 -**X-Auth: [токен авторизации]**
3665 -
3666 -В теле использовать тип **form-data.**
3667 -
3668 -Ключи:
3669 -
3670 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3671 -|**history**|В значении передавать файл с историей
3672 -
3673 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3674 -
3675 -Ответ:
3676 -
3677 -{
3678 - "results": [
3679 - {
3680 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3681 - "vehicleId": 0,
3682 - "errors": [
3683 - "string"
3684 - ],
3685 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3686 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3687 - "producedCount": 0,
3688 - "msgCount": 0
3689 - }
3690 - ]
3691 -}
3692 -
3693 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3694 -|results|Результаты импорта в разрезе ТС
3695 -|vehicleGuid|Guid ТС
3696 -|vehicleId|ID ТС
3697 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3698 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3699 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3700 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3701 -|msgCount|Кол-во обработанных сообщений всего
3702 -
3703 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3704 -
3705 -(% class="box infomessage" %)
3706 -(((
3707 -**GET /api/v3/vehicles/import/history/status**
3708 -)))
3709 -
3710 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3711 -
3712 -Ответ:
3713 -
3714 -{
3715 - "activity": true,
3716 - "progress": 0,
3717 - "message": "string"
3718 -}
3719 -
3720 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3721 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3722 -|progress|Guid ТС
3723 -
3724 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3725 -
3726 -(% class="box infomessage" %)
3727 -(((
3728 -**POST /api/v3/vehicles/export**
3729 -)))
3730 -
3731 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3732 -
3733 -Тело запроса:
3734 -
3735 -[
3736 - id
3737 -]
3738 -
3739 -Ответ: Success 200, получаете файлы с настройками.
3740 -
3741 3741  == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3742 3742  
3743 3743  (% class="box infomessage" %)
... ... @@ -3788,114 +3788,24 @@
3788 3788  |progress|Прогресс экспорта, от 0 до 100%
3789 3789  |message|Текст описывающий статус
3790 3790  
3791 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3524 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3792 3792  
3793 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3794 -
3795 3795  (% class="box infomessage" %)
3796 3796  (((
3797 -**POST /api/v3/EcoDriving/rating**
3528 +**POST /api/v3/vehicles/export**
3798 3798  )))
3799 3799  
3800 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3531 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3801 3801  
3802 3802  Тело запроса:
3803 3803  
3804 -{
3805 - "vehicleIds": [vehicleId],
3806 - "from": "2023-11-22T09:29:48.051Z",
3807 - "to": "2023-11-22T09:29:48.051Z"
3808 -}
3535 +[
3536 + id
3537 +]
3809 3809  
3810 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3811 -|vehicleIds|Массив ID объектов
3812 -|from|Дата начала запроса
3813 -|to|Дата окончания запроса
3539 +Ответ: Success 200, получаете файлы с настройками.
3814 3814  
3815 -Ответ:
3816 3816  
3817 -{
3818 - "items": [
3819 - {
3820 - "from": "2023-11-22T09:29:48.052Z",
3821 - "to": "2023-11-22T09:29:48.052Z",
3822 - "vehicleId": 0,
3823 - "vehicleName": "string",
3824 - "vehicleModel": "string",
3825 - "penalty": 0,
3826 - "score": 0,
3827 - "totalViolations": 0,
3828 - "violationsByType": {
3829 - "overspeedingViolations": 0,
3830 - "accelerationViolations": 0,
3831 - "brakingViolations": 0,
3832 - "turningViolations": 0,
3833 - "dangerousDrivingViolations": 0,
3834 - "sensorViolations": 0
3835 - },
3836 - "moveTime": 0,
3837 - "mileage": 0,
3838 - "tripsCount": 0,
3839 - "trips": [
3840 - {
3841 - "penalty": 0,
3842 - "score": 0,
3843 - "violationsCount": 0,
3844 - "violationsByType": {
3845 - "overspeedingViolations": 0,
3846 - "accelerationViolations": 0,
3847 - "brakingViolations": 0,
3848 - "turningViolations": 0,
3849 - "dangerousDrivingViolations": 0,
3850 - "sensorViolations": 0
3851 - },
3852 - "moveTime": 0,
3853 - "mileage": 0,
3854 - "motohours": 0,
3855 - "maxSpeed": 0,
3856 - "startAddress": "string",
3857 - "endAddress": "string",
3858 - "drivers": [
3859 - {
3860 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3861 - "driverName": "string",
3862 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3863 - }
3864 - ]
3865 - }
3866 - ]
3867 - }
3868 - ]
3869 -}
3870 -
3871 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3872 -|from|Дата начала запроса
3873 -|to|Дата  окончания
3874 -|vehicleId|ID объекта
3875 -|vehicleName|Имя объекта
3876 -|vehicleModel|Модель объекта
3877 -|penalty|Сумма штрафных баллов
3878 -|score|Оценка
3879 -|totalViolations|Суммарное количество нарушений
3880 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3881 -|overspeedingViolations|Превышение скорости
3882 -|accelerationViolations|Ускорение
3883 -|brakingViolations|Торможение
3884 -|turningViolations|Резкий поворот
3885 -|dangerousDrivingViolations|Резкое вождение
3886 -|sensorViolations|Нарушение по датчику
3887 -|moveTime|Время в движении
3888 -|mileage|Пробег
3889 -|tripsCount|Количество рейсов
3890 -|motohours|Моточасы
3891 -|maxSpeed|Максимальная скорость
3892 -|startAddress|Адрес начала рейса
3893 -|endAddress|Адрес окончания рейса
3894 -|drivers|Список водителей, которые были на объекте в течениии рейса
3895 -|driverGuid|Guid водителя
3896 -|driverName|Имя водителя
3897 -|driverRfid|Номер Карты-метки
3898 -
3899 3899  (% class="box" lang="en-US" style="text-align: center;" %)
3900 3900  (((
3901 3901  (% 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 г.