Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
- Manage
-
Copy
- Actions
-
Export
-
Print Preview
- Viewers
-
Source
-
Children
-
Content
-
Attachments (1)
-
History
-
Information
-
Просмотреть отметки "Нравится"
Change comment:
There is no comment for this version
Summary
Details
-
Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -14,13 +14,13 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 17 +(% style="color:#000000" %)− (%%)При **редактировании** необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 21 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 22 22 23 -(% class="box infomessage" %)23 +(% class="box successmessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,7 +40,6 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) ... ... @@ -55,6 +55,12 @@ 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 57 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 58 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 59 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 60 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 61 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 62 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,51 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 97 97 { 98 - "agentId": "", ~/~/идентификатор клиента(%%)99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)104 - "isForeign": true/false, ~/~/ Иностранный контрагент105 - "district": "string", ~/~/ округ106 - "region": "string", ~/~/ регион107 - "city": "string", ~/~/ город108 - "inn": "string", ~/~/ ИНН клиента109 - "kpp": "string", ~/~/ КПП клиента110 - "address": "string", ~/~/ юридический адрес111 - "addressFact": "string", ~/~/ фактический адрес112 - "email": "string", ~/~/ почта113 - "director": "string", ~/~/ ФИО руководителя114 - "bankName": "string", ~/~/ Банк115 - "bankBIK": "string", ~/~/ БИК116 - "bankRS": "string", ~/~/ Номер счета117 - "bankKS": "string" ~/~/ Корр. счет102 + "agentId": "", (%%) 103 + "parentId": "", 104 + "parentName": "string", 105 + "name": "string", 106 + "fullName": "string", 107 + "agentInfoType": 0, 108 + "isForeign": true/false, 109 + "district": "string", 110 + "region": "string", 111 + "city": "string", 112 + "inn": "string", 113 + "kpp": "string", 114 + "address": "string", 115 + "addressFact": "string", 116 + "email": "string", 117 + "director": "string", 118 + "bankName": "string", 119 + "bankBIK": "string", 120 + "bankRS": "string", 121 + "bankKS": "string" 118 118 } 119 119 124 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 125 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 126 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 127 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 128 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 129 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 130 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 131 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 132 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 133 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 134 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 135 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 136 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 137 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 138 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 139 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 140 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 141 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 142 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 143 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 144 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 145 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».159 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,23 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 174 + "agentId": "",(% style="color:#000000" %) (%%) 175 + "parentId": "", 176 + "name": "string", 177 + "fullName": "string", 178 + "agentInfoType": 0, 179 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 182 + 183 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 184 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 185 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 186 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 187 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 188 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 189 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 190 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 209 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 254 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 255 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 256 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 257 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 258 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 259 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 260 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 261 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 262 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 263 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 264 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 265 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 266 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 267 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 268 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 269 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 270 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 271 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 272 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 273 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 274 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 275 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 357 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 358 + 359 +(% class="box warningmessage" %) 360 +((( 361 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 362 +))) 363 + 364 +Метод позволяет изменить статус клиента, указанного в запросе. 365 + 366 +В пути указывается GUID клиента и статус клиента. 367 + 368 +**status **- значение 0 - заблокирован, 1 - активен. 369 + 370 +Ответ: Code 204 371 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -363,7 +363,6 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 369 ... ... @@ -392,6 +392,7 @@ 392 392 (% style="text-align:left" %) 393 393 (% style="color:#000000; font-weight:normal" %)} 394 394 463 + 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 397 397 (% class="box infomessage" %) ... ... @@ -682,6 +682,249 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 754 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 755 + 756 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 757 + 758 +(% class="box infomessage" %) 759 +((( 760 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 761 +))) 762 + 763 +Метод возвращает полную информацию о модели объекта. 764 + 765 +(% style="color:#000000" %)Метод запроса: **GET** 766 + 767 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 768 + 769 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 770 + 771 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 772 + 773 +(% style="color:#000000" %)Ответ: 774 + 775 +(% style="color:#000000" %){ 776 + "parentName": "string", 777 + "name": "string", 778 + "picture": "string", 779 + "minspeed": 0, 780 + "maxspeed": 0, 781 + "width": 0, 782 + "imbeddedtrailer": true, 783 + "hoppercapacity": 0, 784 + "hopperdischargespeed": 0, 785 + "modelType": 0, 786 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 787 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 788 + "deleted": true 789 +} 790 + 791 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 792 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 793 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 794 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 795 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 796 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 797 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 798 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 799 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 800 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 801 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 802 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 803 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 804 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 805 + 806 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 807 + 808 +(% class="box successmessage" %) 809 +((( 810 +(% lang="en-US" %)**POST /api/v3/models/find** 811 +))) 812 + 813 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 814 + 815 +(% style="color:#000000" %)Метод запроса: **POST** 816 + 817 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 818 + 819 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 820 + 821 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 822 + 823 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 824 +} 825 + 826 +(% style="color:#000000" %)Ответ: 827 + 828 +(% style="color:#000000" %)[ 829 + { 830 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 831 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 832 + "parentName": "string", 833 + "name": "string", 834 + "modelType": 0 835 + } 836 +] 837 + 838 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 839 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 840 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 841 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 842 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 843 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 844 + 845 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 846 + 847 +(% class="box successmessage" %) 848 +((( 849 +(% lang="en-US" %)**POST /api/v3/models** 850 +))) 851 + 852 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 853 + 854 +(% style="color:#000000" %)Метод запроса: **POST** 855 + 856 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 857 + 858 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 859 + 860 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 861 + 862 +{ 863 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 864 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 865 + "deleted": true, 866 + "extId": "string", 867 + "name": "string", 868 + "picture": "string", 869 + "minspeed": 0, 870 + "maxspeed": 0, 871 + "width": 0, 872 + "imbeddedtrailer": true, 873 + "fueloutlay": 0, 874 + "hoppercapacity": 0, 875 + "hopperdischargespeed": 0, 876 + "modelType": 0 877 +} 878 + 879 +Ответ: 880 + 881 +{ 882 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 883 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 884 + "deleted": true, 885 + "extId": "string", 886 + "name": "string", 887 + "picture": "string", 888 + "minspeed": 0, 889 + "maxspeed": 0, 890 + "width": 0, 891 + "imbeddedtrailer": true, 892 + "hoppercapacity": 0, 893 + "hopperdischargespeed": 0, 894 + "modelType": 0 895 +} 896 + 897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 898 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 899 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 900 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 901 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 902 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 903 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 904 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 905 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 906 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 907 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 908 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 909 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 910 + 911 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 912 + 913 +(% class="box warningmessage" %) 914 +((( 915 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 916 +))) 917 + 918 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 919 + 920 +(% style="color:#000000" %)Метод запроса: **PUT** 921 + 922 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 923 + 924 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 925 + 926 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 927 + 928 +{ 929 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 930 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 931 + "deleted": true, 932 + "extId": "string", 933 + "name": "string", 934 + "picture": "string", 935 + "minspeed": 0, 936 + "maxspeed": 0, 937 + "width": 0, 938 + "imbeddedtrailer": true, 939 + "fueloutlay": 0, 940 + "hoppercapacity": 0, 941 + "hopperdischargespeed": 0, 942 + "modelType": 0 943 +} 944 + 945 +Ответ: 946 + 947 +{ 948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 949 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 950 + "deleted": true, 951 + "extId": "string", 952 + "name": "string", 953 + "picture": "string", 954 + "minspeed": 0, 955 + "maxspeed": 0, 956 + "width": 0, 957 + "imbeddedtrailer": true, 958 + "fueloutlay": 0, 959 + "hoppercapacity": 0, 960 + "hopperdischargespeed": 0, 961 + "modelType": 0 962 +} 963 + 964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 965 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 966 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 967 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 968 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 969 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 970 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 971 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 972 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 973 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 974 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 975 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 976 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 977 + 978 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 979 + 980 +(% class="box errormessage" %) 981 +((( 982 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 983 +))) 984 + 985 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 986 + 987 +(% style="color:#000000" %)Метод запроса: **DELETE** 988 + 989 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 990 + 991 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 992 + 993 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 994 + 995 +Ответ: В случае успеха **Success 200** 996 + 685 685 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 686 686 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == ... ... @@ -1490,7 +1490,7 @@ 1490 1490 1491 1491 (% style="color:#000000" %)Метод запроса: **GET** 1492 1492 1493 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]1805 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1494 1494 1495 1495 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1496 1496 ... ... @@ -1573,6 +1573,51 @@ 1573 1573 } 1574 1574 ] 1575 1575 1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1889 + 1890 +(% class="box infomessage" style="text-align: left;" %) 1891 +((( 1892 +**POST /api/v3/terminalMessages/mapping** 1893 +))) 1894 + 1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1896 + 1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1898 + 1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1900 + 1901 +{ 1902 + "protocolType": 0, 1903 + "params": ["string"] 1904 +} 1905 + 1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1907 +|protocolType|ID типа протокола 1908 +|params|((( 1909 +Массив наименований параметров в сообщении 1910 +))) 1911 + 1912 +Ответ: 1913 + 1914 +{ 1915 + "protocolType": 0, 1916 + "mapping": { 1917 + "additionalProp1": { 1918 + "inputType": 0, 1919 + "inputNumber": 0 1920 + }, 1921 + "additionalProp2": { 1922 + "inputType": 0, 1923 + "inputNumber": 0 1924 + } 1925 + } 1926 +} 1927 + 1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1929 +|protocolType|Тип протокола 1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1931 +|inputNumber|Номер входа 1932 + 1576 1576 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1577 1577 1578 1578 (% class="box infomessage" %) ... ... @@ -1597,6 +1597,11 @@ 1597 1597 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1598 1598 } 1599 1599 1957 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1958 +|vehicleId|ID объекта 1959 +|from|Дата и время начала периода запроса 1960 +|to|Дата и время окончания периода запроса 1961 + 1600 1600 Ответ: 1601 1601 1602 1602 [ ... ... @@ -1603,25 +1603,43 @@ 1603 1603 { 1604 1604 "messages": [ 1605 1605 { 1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1608 - "speed": 0, ~/~/ Скорость, км/ч 1609 - "altitude": 0, ~/~/ Высота, м 1610 - "latitude": 0, ~/~/ Широта [-90°;90°] 1611 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1612 - "satellites": 0, ~/~/ Кол-во спутников 1613 - "voltage": 0, ~/~/ Напряжение 1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1968 + "deviceTime": "2023-11-29T07:40:44.052Z", 1969 + "serverTime": "2023-11-29T07:40:44.052Z", 1970 + "speed": 0, 1971 + "altitude": 0, 1972 + "latitude": 0, 1973 + "longitude": 0, 1974 + "satellites": 0, 1975 + "course": 0, 1976 + "voltage": 0, 1977 + "parameters": { 1615 1615 "additionalProp1": "string", 1616 1616 "additionalProp2": "string", 1617 1617 "additionalProp3": "string" 1618 1618 }, 1619 - "photoCount": 0 ~/~/ Кол-во фото 1982 + "photoCount": 0, 1983 + "lbsCorrectedCoords": true, 1984 + "protocolType": 0 1620 1620 } 1621 1621 ] 1622 1622 } 1623 1623 ] 1624 1624 1990 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1991 +|deviceTime|Время сообщения терминала 1992 +|serverTime|Время когда сообщение поступило на сервер 1993 +|speed|Скорость 1994 +|altitude|Высота над уровнем моря 1995 +|latitude|Широта 1996 +|longitude|Долгота 1997 +|satellites|Кол-во спутников 1998 +|course|Курс 1999 +|voltage|Бортовое напряжение 2000 +|parameters|Список параметров и их значений 2001 +|photoCount|Количество фото 2002 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2003 +|protocolType|ID типа протокола 2004 + 1625 1625 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1626 1626 1627 1627 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1755,6 +1755,91 @@ 1755 1755 } 1756 1756 ] 1757 1757 2138 + 2139 +(% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов** 2140 + 2141 +(% class="box infomessage" %) 2142 +((( 2143 +**POST/api/v3/vehicles/moveStop** 2144 +))) 2145 + 2146 +Метод запроса: **POST** 2147 + 2148 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2149 + 2150 +В заголовках запроса: X-Auth: Токен авторизации 2151 + 2152 + 2153 +Тело запроса: 2154 + 2155 +{ 2156 + 2157 + "vehicleIds": [ ], ~/~/ Список ID объектов 2158 + 2159 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2160 + 2161 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2162 + 2163 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2164 + 2165 +} 2166 + 2167 + 2168 +Ответ: 2169 + 2170 +[ 2171 + 2172 + { 2173 + 2174 + "vehicleId": 0, ~/~/ ID объекта 2175 + 2176 + "vehicleName": "string", ~/~/ Имя объекта 2177 + 2178 + "moves": [ ~/~/ Событие движения 2179 + 2180 + { 2181 + 2182 + "mileage": 0, ~/~/ Пробег, км 2183 + 2184 + "eventId": 0, ~/~/ Идентификатор события 2185 + 2186 + "eventName": "string", ~/~/ Название события 2187 + 2188 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2189 + 2190 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2191 + 2192 + "duration": 0 ~/~/ Продолжительность события, секунд 2193 + 2194 + } 2195 + 2196 + ], 2197 + 2198 + "stops": [ ~/~/ События стоянок 2199 + 2200 + { 2201 + 2202 + "address": "string", ~/~/ Адрес события 2203 + 2204 + "eventId": 0, ~/~/ Идентификатор события 2205 + 2206 + "eventName": "string", ~/~/ Название события 2207 + 2208 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2209 + 2210 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2211 + 2212 + "duration": 0 ~/~/ Продолжительность события, секунд 2213 + 2214 + 2215 + } 2216 + 2217 + ] 2218 + 2219 + } 2220 + 2221 +] 2222 + 1758 1758 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 1759 1759 1760 1760 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -1768,7 +1768,7 @@ 1768 1768 1769 1769 (% style="color:#000000" %)Метод запроса: **POST** 1770 1770 1771 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/ users/api/v3/gis/find2236 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 1772 1772 1773 1773 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1774 1774 ... ... @@ -2653,6 +2653,83 @@ 2653 2653 Success 2654 2654 2655 2655 3121 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3122 + 3123 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3124 + 3125 +(% class="box infomessage" %) 3126 +((( 3127 +**POST /api/v3/Trailers** 3128 +))) 3129 + 3130 +Пример запроса: 3131 + 3132 +{ 3133 + "startDate": "2023-11-14T10:48:03.671Z", 3134 + "endDate": "2023-11-14T10:48:03.671Z", 3135 + "ids": [ 0 ], 3136 + "timezone": 0 3137 +} 3138 + 3139 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3140 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3141 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3142 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3143 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3144 + 3145 +Пример ответа: 3146 + 3147 +[ 3148 + { 3149 + "SD": "2023-11-14T10:48:03.717Z", 3150 + "ED": "2023-11-14T10:48:03.717Z", 3151 + "id": 0, 3152 + "SLat": 0, 3153 + "SLon": 0, 3154 + "ELat": 0, 3155 + "ELon": 0, 3156 + "mileage": 0 3157 + "Duration": 0 3158 + "Address": "string", 3159 + "Address2": "string", 3160 + "name": "string", 3161 + "rid": "string", 3162 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3163 + "trailer": { 3164 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3165 + "Number": "string", 3166 + "Description": "string", 3167 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3168 + "ExternalID": "string", 3169 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3170 + "CreateTime": "2023-11-14T10:48:03.717Z", 3171 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3172 + "IsDeleted": true 3173 + }, 3174 + "filesCount": 0, 3175 + } 3176 +] 3177 + 3178 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3179 +|SD|Дата и время начала события 3180 +|ED|Дата и время окончания события 3181 +|id|ID объекта 3182 +|SLat|Широта начальной координаты 3183 +|SLon|Долгота начальной координаты 3184 +|ELat|Широта конечной координаты 3185 +|ELon|Долгота конечной координаты 3186 +|mileage|Пробег 3187 +|Duration|Продолжительность 3188 +|Address|Адрес начального местоположения 3189 +|Address2|Адрес конечного местоположения 3190 +|name|Имя радиометки 3191 +|rid|Номер радиометки 3192 +|rguid|ID радиометки 3193 +|trailer|Информация об агрегате 3194 +|ModelGuid|ID агрегата 3195 +|Number|Название/номер агрегата 3196 +|Description|Текст примечания агрегата 3197 + 2656 2656 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2657 2657 2658 2658 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2674,13 +2674,18 @@ 2674 2674 { 2675 2675 "name": "string", 2676 2676 "number": 0, 2677 - "period": 0, ~/~/ Частота трансляции радиометки3219 + "period": 0, 2678 2678 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2679 2679 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2680 - "deleted": true 2681 2681 } 2682 2682 ] 2683 2683 3225 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3226 +|parentId|ID клиента 3227 +|name|Название карты-метки 3228 +|number|Номер 3229 +|period|Период запросов в секундах (работает только для агрегатов) 3230 +|id|ID карты-метки 2684 2684 2685 2685 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2686 2686 ... ... @@ -2697,13 +2697,18 @@ 2697 2697 { 2698 2698 "name": "string", 2699 2699 "number": 0, 2700 - "period": 0, ~/~/ Частота трансляции радиометки3247 + "period": 0, 2701 2701 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2702 2702 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2703 - "deleted": true 2704 2704 } 2705 2705 ] 2706 2706 3253 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3254 +|name|Название карты-метки 3255 +|number|Номер 3256 +|period|Период запросов в секундах (работает только для агрегатов) 3257 +|id|ID карты-метки 3258 +|parentId|ID клиента 2707 2707 2708 2708 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2709 2709 ... ... @@ -2719,7 +2719,6 @@ 2719 2719 "number": 0, 2720 2720 "period": 0, 2721 2721 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2722 - "deleted": true 2723 2723 } 2724 2724 2725 2725 Ответ: ... ... @@ -2730,9 +2730,14 @@ 2730 2730 "period": 0, 2731 2731 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2732 2732 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2733 - "deleted": true 2734 2734 } 2735 2735 3286 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3287 +|name|Название карты-метки 3288 +|number|Номер 3289 +|period|Период запросов в секундах (работает только для агрегатов) 3290 +|id|ID карты-метки 3291 +|parentId|ID клиента 2736 2736 2737 2737 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2738 2738 ... ... @@ -2749,7 +2749,6 @@ 2749 2749 "period": 0, 2750 2750 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2751 2751 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2752 - "deleted": true 2753 2753 } 2754 2754 2755 2755 Ответ: ... ... @@ -2760,9 +2760,14 @@ 2760 2760 "period": 0, 2761 2761 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2762 2762 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2763 - "deleted": true 2764 2764 } 2765 2765 3320 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3321 +|name|Название карты-метки 3322 +|number|Номер 3323 +|period|Период запросов в секундах (работает только для агрегатов) 3324 +|id|ID карты-метки 3325 +|parentId|ID клиента 2766 2766 2767 2767 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2768 2768 ... ... @@ -2771,7 +2771,7 @@ 2771 2771 **DELETE /api/v3/Rfids/{rfidGuid}** 2772 2772 ))) 2773 2773 2774 -Передаем параметр rfidGuid - идентификатор карты-метки 3334 +Передаем параметр **rfidGuid** - идентификатор карты-метки 2775 2775 2776 2776 Ответ: 2777 2777 ... ... @@ -2778,6 +2778,670 @@ 2778 2778 Success 2779 2779 2780 2780 3341 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3342 + 3343 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3344 + 3345 +(% class="box infomessage" %) 3346 +((( 3347 +**GET /api/v3/Billing/client/balance/{clientId}** 3348 +))) 3349 + 3350 +Параметр запроса: **clientId **- идентификатор клиента. 3351 + 3352 +Ответ: 3353 + 3354 +{ 3355 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3356 + "Balance": 0 3357 +} 3358 + 3359 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3360 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3361 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3362 + 3363 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3364 + 3365 +(% class="box infomessage" %) 3366 +((( 3367 +**GET /api/v3/Billing/client/constraint/{clientId}** 3368 +))) 3369 + 3370 +Параметр запроса: **clientId **- идентификатор клиента. 3371 + 3372 +Ответ: 3373 + 3374 +{ 3375 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3376 + "CalculationType": 0, 3377 + "PermissibleBalance": 0, 3378 + "DefermentDays": 0, 3379 + "SendUiNotifications": true, 3380 + "SendEmailNotifications": true, 3381 + "IsPrivate": true, 3382 +} 3383 + 3384 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3385 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3386 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3387 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3388 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3389 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3390 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3391 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3392 + 3393 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3394 + 3395 +(% class="box infomessage" %) 3396 +((( 3397 +**GET /api/v3/Billing/client/plan/{clientId}** 3398 +))) 3399 + 3400 +Параметры запроса: 3401 + 3402 +**clientId **- идентификатор клиента. 3403 + 3404 +**planId **- идентификатор тарифного плана. 3405 + 3406 +Ответ: 3407 + 3408 +{ 3409 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3410 + "Plan": { **~/~/ Описание тарифного плана** 3411 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3412 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3413 + "Name": "string", 3414 + "IsArchived": true, 3415 + "Constraint": { 3416 + "CalculationType": 0, 3417 + "PermissibleBalance": 0, 3418 + "DefermentDays": 0 3419 + }, 3420 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3421 + { 3422 + "Feature": "string", 3423 + "IsFactual": true, 3424 + "Limit": 0, 3425 + "Price": 0, 3426 + "PeriodValue": 0, 3427 + "PeriodType": 0 3428 + } 3429 + ] 3430 + }, 3431 + "DebitDate": "2023-10-18T12:46:24.213Z", 3432 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3433 + { 3434 + "Feature": "string", 3435 + "IsEnabled": true, 3436 + "IsPrivate": true, 3437 + "IsFactual": true, 3438 + "Limit": 0, 3439 + "Price": 0, 3440 + "DebitDate": "2023-10-18T12:46:24.213Z", 3441 + "PeriodValue": 0, 3442 + "PeriodType": 0 3443 + } 3444 + ] 3445 +} 3446 + 3447 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3448 +|ClientId|Идентификатор клиента 3449 +|Id|Идентификатор тарифного плана 3450 +|OwnerId|Идентификатор клиента-владельца 3451 +|Name|Наименование тарифного плана 3452 +|IsArchived|Признак, определяющий архивный тарифный план 3453 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3454 +|PermissibleBalance|Допустимый баланс 3455 +|DefermentDays|Отсрочка, количество дней 3456 +|Feature|Код услуги 3457 +|IsEnabled|Признак, определяющий активирована ли услуга 3458 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3459 +|IsFactual|Признак, определяющий расчёт по факту 3460 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3461 +|Price|Цена за единицу. 3462 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3463 +|PeriodValue|Значение периода. 3464 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3465 + 3466 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3467 + 3468 +(% class="box infomessage" %) 3469 +((( 3470 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3471 +))) 3472 + 3473 +Параметр запроса: **clientId **- идентификатор клиента. 3474 + 3475 +Ответ: 3476 + 3477 +[ 3478 + { 3479 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3480 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3481 + "Name": "string", 3482 + "IsArchived": true, 3483 + "Constraint": { 3484 + "CalculationType": 0, 3485 + "PermissibleBalance": 0, 3486 + "DefermentDays": 0 3487 + }, 3488 + "Features": [ 3489 + { 3490 + "Feature": "string", 3491 + "IsFactual": true, 3492 + "Limit": 0, 3493 + "Price": 0, 3494 + "PeriodValue": 0, 3495 + "PeriodType": 0 3496 + } 3497 + ] 3498 + } 3499 +] 3500 + 3501 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3502 +|ClientId|Идентификатор клиента 3503 +|Id|Идентификатор тарифного плана 3504 +|OwnerId|Идентификатор клиента-владельца 3505 +|Name|Наименование тарифного плана 3506 +|IsArchived|Признак, определяющий архивный тарифный план 3507 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3508 +|PermissibleBalance|Допустимый баланс 3509 +|DefermentDays|Отсрочка, количество дней 3510 +|Feature|Код услуги 3511 +|IsFactual|Признак, определяющий расчёт по факту 3512 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3513 +|Price|Цена за единицу. 3514 +|PeriodValue|Значение периода. 3515 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3516 + 3517 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3518 + 3519 +(% class="box infomessage" %) 3520 +((( 3521 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3522 +))) 3523 + 3524 +Параметр запроса: **clientId **- идентификатор клиента. 3525 + 3526 +Ответ: 3527 + 3528 +[ 3529 + { 3530 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3531 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3532 + "Name": "string", 3533 + "IsArchived": true, 3534 + "Constraint": { 3535 + "CalculationType": 0, 3536 + "PermissibleBalance": 0, 3537 + "DefermentDays": 0 3538 + }, 3539 + "Features": [ 3540 + { 3541 + "Feature": "string", 3542 + "IsFactual": true, 3543 + "Limit": 0, 3544 + "Price": 0, 3545 + "PeriodValue": 0, 3546 + "PeriodType": 0 3547 + } 3548 + ] 3549 + } 3550 +] 3551 + 3552 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3553 +|ClientId|Идентификатор клиента 3554 +|Id|Идентификатор тарифного плана 3555 +|OwnerId|Идентификатор клиента-владельца 3556 +|Name|Наименование тарифного плана 3557 +|IsArchived|Признак, определяющий архивный тарифный план 3558 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3559 +|PermissibleBalance|Допустимый баланс 3560 +|DefermentDays|Отсрочка, количество дней 3561 +|Feature|Код услуги 3562 +|IsFactual|Признак, определяющий расчёт по факту 3563 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3564 +|Price|Цена за единицу. 3565 +|PeriodValue|Значение периода. 3566 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3567 + 3568 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3569 + 3570 +(% class="box warningmessage" %) 3571 +((( 3572 +**PUT /api/v3/Billing/client/balance** 3573 +))) 3574 + 3575 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3576 + 3577 +Тело запроса: 3578 + 3579 +{ 3580 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3581 + "Balance": 0 3582 +} 3583 + 3584 +Ответ: Success 3585 + 3586 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3587 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3588 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3589 + 3590 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3591 + 3592 +(% class="box warningmessage" %) 3593 +((( 3594 +**PUT /api/v3/billing/client/balance/deposit** 3595 +))) 3596 + 3597 +Создает операцию **Пополнение **с указанной суммой 3598 + 3599 +Тело запроса: 3600 + 3601 +{ 3602 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3603 + "Balance": 0 3604 +} 3605 + 3606 +Ответ: Success 3607 + 3608 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3609 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3610 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3611 + 3612 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3613 + 3614 +Создает операцию **Списание **с указанной суммой 3615 + 3616 +(% class="box warningmessage" %) 3617 +((( 3618 +**PUT /api/v3/billing/client/balance/withdraw** 3619 +))) 3620 + 3621 +Тело запроса: 3622 + 3623 +{ 3624 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3625 + "Balance": 0 3626 +} 3627 + 3628 +Ответ: Success 3629 + 3630 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3631 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3632 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3633 + 3634 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3635 + 3636 +(% class="box warningmessage" %) 3637 +((( 3638 +**PUT /api/v3/Billing/client/constraint** 3639 +))) 3640 + 3641 +Тело запроса: 3642 + 3643 +{ 3644 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3645 + "CalculationType": 0, 3646 + "PermissibleBalance": 0, 3647 + "DefermentDays": 0, 3648 + "SendUiNotifications": true, 3649 + "SendEmailNotifications": true, 3650 + "IsPrivate": true, 3651 +} 3652 + 3653 +Ответ: Success 3654 + 3655 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3656 +|ClientId|Идентификатор клиента 3657 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3658 +|PermissibleBalance|Допустимый баланс 3659 +|DefermentDays|((( 3660 +Отсрочка, количество дней 3661 +))) 3662 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3663 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3664 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3665 + 3666 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3667 + 3668 +(% class="box warningmessage" %) 3669 +((( 3670 +**PUT /api/v3/Billing/client/plan** 3671 +))) 3672 + 3673 +Тело запроса: 3674 + 3675 +{ 3676 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3677 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3678 + "Features": [ 3679 + { 3680 + "Feature": "string", 3681 + "IsEnabled": true, 3682 + "IsFactual": true, 3683 + "Limit": 0, 3684 + "Price": 0, 3685 + "DebitDate": "2023-10-18T13:26:58.987Z", 3686 + "PeriodValue": 0, 3687 + "PeriodType": 0 3688 + } 3689 + ] 3690 +} 3691 + 3692 +Ответ: Success 3693 + 3694 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3695 +|ClientId|Идентификатор клиента 3696 +|PlanId|Идентификатор тарифного плана 3697 +|Feature|Код услуги 3698 +|IsEnabled|Признак, определяющий активирована ли услуга 3699 +|IsFactual|Признак, определяющий расчёт по факту 3700 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3701 +|Price|Цена за единицу. 3702 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3703 +|PeriodValue|Значение периода. 3704 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3705 + 3706 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3707 + 3708 +(% class="box warningmessage" %) 3709 +((( 3710 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3711 +))) 3712 + 3713 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3714 + 3715 +(% class="box infomessage" %) 3716 +((( 3717 +**POST /api/v3/vehicles/import/{agentId}** 3718 +))) 3719 + 3720 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3721 + 3722 +В пути указывается **agentId** - id клиента. 3723 + 3724 +**Заголовок** 3725 + 3726 +**X-Auth: [токен авторизации]** 3727 + 3728 +**Параметры** 3729 + 3730 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3731 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3732 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3733 + 3734 +В теле использовать тип **form-data,** тип значения** file** 3735 + 3736 +**Ключи** 3737 + 3738 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3739 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3740 +|csv|В значении передаем файл датчиков, формат **csv** 3741 + 3742 +Ответ: 3743 + 3744 +{ 3745 + "vehicleId": 0, 3746 + "name": "string", 3747 + "errors": ["string"] 3748 +} 3749 + 3750 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3751 +|vehicleId|ID созданного объекта 3752 +|name|Имя созданного объекта 3753 +|errors|Ошибки и их описание 3754 + 3755 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3756 + 3757 +(% class="box infomessage" %) 3758 +((( 3759 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3760 +))) 3761 + 3762 +(% class="wikigeneratedid" %) 3763 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3764 + 3765 +(% class="wikigeneratedid" %) 3766 +В пути указывается **vehicleId **- id объекта. 3767 + 3768 +**Заголовок** 3769 + 3770 +**X-Auth: [токен авторизации]** 3771 + 3772 +В теле использовать тип **form-data.** 3773 + 3774 +Ключи: 3775 + 3776 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3777 +|**history**|В значении передавать файл с историей 3778 + 3779 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3780 + 3781 +Ответ: 3782 + 3783 +{ 3784 + "results": [ 3785 + { 3786 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3787 + "vehicleId": 0, 3788 + "errors": [ 3789 + "string" 3790 + ], 3791 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 3792 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 3793 + "producedCount": 0, 3794 + "msgCount": 0 3795 + } 3796 + ] 3797 +} 3798 + 3799 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3800 +|results|Результаты импорта в разрезе ТС 3801 +|vehicleGuid|Guid ТС 3802 +|vehicleId|ID ТС 3803 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3804 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 3805 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3806 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 3807 +|msgCount|Кол-во обработанных сообщений всего 3808 + 3809 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3810 + 3811 +(% class="box infomessage" %) 3812 +((( 3813 +**GET /api/v3/vehicles/import/history/status** 3814 +))) 3815 + 3816 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3817 + 3818 +Ответ: 3819 + 3820 +{ 3821 + "activity": true, 3822 + "progress": 0, 3823 + "message": "string" 3824 +} 3825 + 3826 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3827 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3828 +|progress|Guid ТС 3829 + 3830 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3831 + 3832 +(% class="box infomessage" %) 3833 +((( 3834 +**POST /api/v3/vehicles/export** 3835 +))) 3836 + 3837 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3838 + 3839 +Тело запроса: 3840 + 3841 +[ 3842 + id 3843 +] 3844 + 3845 +Ответ: Success 200, получаете файлы с настройками. 3846 + 3847 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3848 + 3849 +(% class="box infomessage" %) 3850 +((( 3851 +**POST /api/v3/vehicles/export/history** 3852 +))) 3853 + 3854 +Метод возвращает список сообщений терминала объекта за выбранный период. 3855 + 3856 +Тело запроса: 3857 + 3858 +{ 3859 + "vehicleId": 0, 3860 + "asArchive": true, 3861 + "from": "2023-09-27T12:17:45.973Z", 3862 + "to": "2023-09-27T12:17:45.973Z" 3863 +} 3864 + 3865 +Ответ: 3866 + 3867 +Получаете файл. Сообщение: Code 200/Success 3868 + 3869 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3870 +|vehicleId|ID объекта 3871 +|asArchive|true - Архивировать файл, False - не архивировать 3872 +|from|Дата и время начала запроса 3873 +|to|Дата и время окончания запроса 3874 + 3875 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3876 + 3877 +(% class="box infomessage" %) 3878 +((( 3879 +**GET /api/v3/vehicles/export/history/status** 3880 +))) 3881 + 3882 +Метод возвращает список сообщений терминала объекта за выбранный период. 3883 + 3884 +Ответ: 3885 + 3886 +{ 3887 + "activity": true, 3888 + "progress": 0, 3889 + "message": "string" 3890 +} 3891 + 3892 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3893 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3894 +|progress|Прогресс экспорта, от 0 до 100% 3895 +|message|Текст описывающий статус 3896 + 3897 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3898 + 3899 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3900 + 3901 +(% class="box infomessage" %) 3902 +((( 3903 +**POST /api/v3/EcoDriving/rating** 3904 +))) 3905 + 3906 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3907 + 3908 +Тело запроса: 3909 + 3910 +{ 3911 + "vehicleIds": [vehicleId], 3912 + "from": "2023-11-22T09:29:48.051Z", 3913 + "to": "2023-11-22T09:29:48.051Z" 3914 +} 3915 + 3916 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3917 +|vehicleIds|Массив ID объектов 3918 +|from|Дата начала запроса 3919 +|to|Дата окончания запроса 3920 + 3921 +Ответ: 3922 + 3923 +{ 3924 + "items": [ 3925 + { 3926 + "from": "2023-11-22T09:29:48.052Z", 3927 + "to": "2023-11-22T09:29:48.052Z", 3928 + "vehicleId": 0, 3929 + "vehicleName": "string", 3930 + "vehicleModel": "string", 3931 + "penalty": 0, 3932 + "score": 0, 3933 + "totalViolations": 0, 3934 + "violationsByType": { 3935 + "overspeedingViolations": 0, 3936 + "accelerationViolations": 0, 3937 + "brakingViolations": 0, 3938 + "turningViolations": 0, 3939 + "dangerousDrivingViolations": 0, 3940 + "sensorViolations": 0 3941 + }, 3942 + "moveTime": 0, 3943 + "mileage": 0, 3944 + "tripsCount": 0, 3945 + "trips": [ 3946 + { 3947 + "penalty": 0, 3948 + "score": 0, 3949 + "violationsCount": 0, 3950 + "violationsByType": { 3951 + "overspeedingViolations": 0, 3952 + "accelerationViolations": 0, 3953 + "brakingViolations": 0, 3954 + "turningViolations": 0, 3955 + "dangerousDrivingViolations": 0, 3956 + "sensorViolations": 0 3957 + }, 3958 + "moveTime": 0, 3959 + "mileage": 0, 3960 + "motohours": 0, 3961 + "maxSpeed": 0, 3962 + "startAddress": "string", 3963 + "endAddress": "string", 3964 + "drivers": [ 3965 + { 3966 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3967 + "driverName": "string", 3968 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3969 + } 3970 + ] 3971 + } 3972 + ] 3973 + } 3974 + ] 3975 +} 3976 + 3977 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3978 +|from|Дата начала запроса 3979 +|to|Дата окончания 3980 +|vehicleId|ID объекта 3981 +|vehicleName|Имя объекта 3982 +|vehicleModel|Модель объекта 3983 +|penalty|Сумма штрафных баллов 3984 +|score|Оценка 3985 +|totalViolations|Суммарное количество нарушений 3986 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3987 +|overspeedingViolations|Превышение скорости 3988 +|accelerationViolations|Ускорение 3989 +|brakingViolations|Торможение 3990 +|turningViolations|Резкий поворот 3991 +|dangerousDrivingViolations|Резкое вождение 3992 +|sensorViolations|Нарушение по датчику 3993 +|moveTime|Время в движении 3994 +|mileage|Пробег 3995 +|tripsCount|Количество рейсов 3996 +|motohours|Моточасы 3997 +|maxSpeed|Максимальная скорость 3998 +|startAddress|Адрес начала рейса 3999 +|endAddress|Адрес окончания рейса 4000 +|drivers|Список водителей, которые были на объекте в течениии рейса 4001 +|driverGuid|Guid водителя 4002 +|driverName|Имя водителя 4003 +|driverRfid|Номер Карты-метки 4004 + 2781 2781 (% class="box" lang="en-US" style="text-align: center;" %) 2782 2782 ((( 2783 2783 (% 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]] **
-
image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB -
Content