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:
Загрузить новое вложение image-20231020124453-1.png
Summary
Details
-
Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. Gadmin1 +XWiki.krainovim - 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 successmessage" %)23 +(% class="box infomessage" %) 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,25 +40,21 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 + 43 43 (% style="color:#000000" %)**Ответ:** 44 44 45 45 (% lang="en-US" %) 46 46 (% style="color:#000000" %){ 47 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 48 - "User": "testuser" , ~/~/ имя пользователя(%%) 48 + 49 +(% lang="en-US" %) 50 +(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 + "User": "testuser" , ~/~/ имя пользователя 52 + 53 +(% lang="en-US" %) 49 49 } 50 50 51 51 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 52 52 53 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 54 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 55 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 56 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 57 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 58 - 59 -(% class="wikigeneratedid" %) 60 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 61 - 62 62 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 63 63 64 64 (% class="box infomessage" %) ... ... @@ -97,51 +97,30 @@ 97 97 Запрос должен содержать данные параметра "**agentId**" 98 98 99 99 (% style="color:#000000" %)Ответ: 96 +А 100 100 { 101 - "agentId": "", (%%) 102 - "parentId": "", 103 - "parentName": "string", 104 - "name": "string", 105 - "fullName": "string", 106 - "agentInfoType": 0, 107 - "isForeign": true/false, 108 - "district": "string", 109 - "region": "string", 110 - "city": "string", 111 - "inn": "string", 112 - "kpp": "string", 113 - "address": "string", 114 - "addressFact": "string", 115 - "email": "string", 116 - "director": "string", 117 - "bankName": "string", 118 - "bankBIK": "string", 119 - "bankRS": "string", 120 - "bankKS": "string" 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" ~/~/ Корр. счет 121 121 } 122 122 123 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 124 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 125 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 126 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 127 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 128 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 129 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 130 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 131 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 132 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 133 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 134 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 135 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 136 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 137 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 138 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 139 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 140 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 141 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 142 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 143 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 144 - 145 145 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 146 146 147 147 (% class="box infomessage" %) ... ... @@ -155,7 +155,7 @@ 155 155 156 156 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 157 157 158 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 159 159 160 160 (% style="color:#000000" %)Метод запроса: **POST** 161 161 ... ... @@ -170,23 +170,15 @@ 170 170 (% style="color:#000000" %)Ответ: 171 171 172 172 { 173 - "agentId": "",(% style="color:#000000" %) (%%) 174 - "parentId": "", 175 - "name": "string", 176 - "fullName": "string", 177 - "agentInfoType": 0, 178 -(% style="color:#000000" %) "status": "", 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 - Отказ) 179 179 } 180 180 181 - 182 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 183 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 184 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 185 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 186 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 187 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 188 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 189 - 190 190 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 191 191 192 192 (% class="box successmessage" %) ... ... @@ -205,7 +205,7 @@ 205 205 Параметры в теле запроса (JSON): 206 206 207 207 { 208 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 209 209 "name": "string", ~/~/ имя 210 210 "fullName": "string", ~/~/ полное наименование 211 211 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -225,6 +225,7 @@ 225 225 "bankKS": "string" ~/~/ корр. счёт 226 226 } 227 227 195 + 228 228 Ответ: 229 229 230 230 { ... ... @@ -249,28 +249,6 @@ 249 249 "bankKS": "string" ~/~/ корр. счёт 250 250 } 251 251 252 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 253 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 254 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 255 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 256 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 257 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 258 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 259 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 260 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 261 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 262 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 263 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 264 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 265 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 266 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 267 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 268 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 269 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 270 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 271 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 272 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 273 - 274 274 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 275 275 276 276 (% class="box warningmessage" %) ... ... @@ -286,6 +286,7 @@ 286 286 287 287 В заголовках запроса: X-Auth: Токен авторизации 288 288 235 + 289 289 Параметры в теле запроса (JSON): 290 290 291 291 { ... ... @@ -310,6 +310,7 @@ 310 310 "bankKS": "string" ~/~/ корр. счёт 311 311 } 312 312 260 + 313 313 Ответ: 314 314 315 315 { ... ... @@ -352,21 +352,6 @@ 352 352 353 353 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 354 354 355 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 356 - 357 -(% class="box warningmessage" %) 358 -((( 359 -**PUT /api/v3/agents/{id}/changeStatus/{status}** 360 -))) 361 - 362 -Метод позволяет изменить статус клиента, указанного в запросе. 363 - 364 -В пути указывается GUID клиента и статус клиента. 365 - 366 -**status **- значение 0 - заблокирован, 1 - активен. 367 - 368 -Ответ: Code 204 369 - 370 370 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 371 371 372 372 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -418,6 +418,7 @@ 418 418 ], 419 419 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 420 420 } 354 + 421 421 { 422 422 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 423 423 "lastName": "string", ... ... @@ -429,10 +429,15 @@ 429 429 "password": "string", 430 430 "email": "string", 431 431 366 + 432 432 (% style="text-align:left" %) 433 433 (% style="color:#000000; font-weight:normal" %)Ответ: 434 -{ 435 - "id": "" , ~/~/ ID пользователя 369 + 370 +(% style="text-align:left" %) 371 +(% style="color:#000000; font-weight:normal" %){ 372 + 373 +(% style="text-align:left" %) 374 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 436 436 "lastName": "" , ~/~/ Фамилия , 437 437 "firstName": "" , ~/~/ Имя 438 438 "position": "" , ~/~/ Должность ... ... @@ -449,8 +449,9 @@ 449 449 "kind": "" , ~/~/ тип аутентификации 450 450 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 451 451 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 452 -} 453 453 392 +(% style="text-align:left" %) 393 +(% style="color:#000000; font-weight:normal" %)} 454 454 455 455 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 456 456 ... ... @@ -471,16 +471,19 @@ 471 471 472 472 (% style="color:#000000" %)Параметры в теле запроса (JSON): 473 473 474 -(% style="color:#000000" %){(%%) 414 +(% style="color:#000000" %){ 415 + 475 475 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 476 476 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 477 477 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 478 478 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 + 479 479 (% style="color:#000000" %)} 480 480 481 481 (% style="color:#000000" %)Ответ: 482 482 483 483 (% style="color:#000000" %){ (%%) 426 + 484 484 "id": "" , ~/~/ идентификатор пользователя 485 485 "lastName": "" , ~/~/ фамилия 486 486 "firstName": "" , ~/~/ имя ... ... @@ -494,6 +494,7 @@ 494 494 "sessionDuration":"", ~/~/ длительность сессии в минутах 495 495 "status": "1", ~/~/ статус пользователя 496 496 "lastLogged": "", ~/~/ дата/время последней авторизации 440 + 497 497 (% style="color:#000000" %)} 498 498 499 499 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -567,8 +567,10 @@ 567 567 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 568 568 569 569 (% lang="en-US" style="text-align:left" %) 570 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 571 - "id": "" , ~/~/ ID пользователя 514 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 + 516 +(% lang="en-US" style="text-align:left" %) 517 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 572 572 "lastName": "" , ~/~/ фамилия 573 573 "firstName": "" , ~/~/ имя 574 574 "position": "" , ~/~/ должность ... ... @@ -590,7 +590,9 @@ 590 590 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 591 591 }, 592 592 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 593 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 + 541 +(% lang="en-US" style="text-align:left" %) 594 594 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 595 595 596 596 (% lang="en-US" style="text-align:left" %) ... ... @@ -597,8 +597,10 @@ 597 597 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 598 598 599 599 (% lang="en-US" style="text-align:left" %) 600 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 601 - "id": "" , ~/~/ идентификатор пользователя 548 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 549 + 550 +(% lang="en-US" style="text-align:left" %) 551 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 602 602 "lastName": "" , ~/~/ фамилия 603 603 "firstName": "" , ~/~/ имя 604 604 "position": "" , ~/~/ должность ... ... @@ -619,8 +619,10 @@ 619 619 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 620 620 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 621 621 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 622 -} 623 623 573 +(% lang="en-US" style="text-align:left" %) 574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 + 624 624 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 625 625 626 626 (% class="box warningmessage" %) ... ... @@ -640,10 +640,12 @@ 640 640 641 641 (% style="color:#000000" %)Параметры в теле запроса (JSON): 642 642 643 -(% style="color:#000000" %){(%%) 595 +(% style="color:#000000" %){ 596 + 644 644 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 645 645 "description": "" , ~/~/ описание 646 646 "data": "" , ~/~/ данные, связанные со сменой статуса 600 + 647 647 (% style="color:#000000" %)} 648 648 649 649 (% style="text-align:left" %) ... ... @@ -665,7 +665,7 @@ 665 665 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 666 666 667 667 [ 668 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 669 669 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 670 670 ] 671 671 ... ... @@ -757,6 +757,7 @@ 757 757 "maxspeed": 0, 758 758 "width": 0, 759 759 "imbeddedtrailer": true, 714 + "fueloutlay": 0, 760 760 "hoppercapacity": 0, 761 761 "hopperdischargespeed": 0, 762 762 "modelType": 0, ... ... @@ -773,8 +773,9 @@ 773 773 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 774 774 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 775 775 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 776 776 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 777 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость 2выгрузки из бункера, л/сек733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 778 778 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 779 779 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 780 780 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -866,24 +866,12 @@ 866 866 "maxspeed": 0, 867 867 "width": 0, 868 868 "imbeddedtrailer": true, 825 + "fueloutlay": 0, 869 869 "hoppercapacity": 0, 870 870 "hopperdischargespeed": 0, 871 871 "modelType": 0 872 872 } 873 873 874 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 875 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 876 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 877 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 878 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 879 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 880 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 881 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 882 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 883 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 884 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 885 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 886 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 887 887 888 888 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 889 889 ... ... @@ -938,20 +938,6 @@ 938 938 "modelType": 0 939 939 } 940 940 941 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 942 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 943 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 944 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 945 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 946 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 947 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 948 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 949 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 950 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 951 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 952 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 953 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 954 - 955 955 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 956 956 957 957 (% class="box errormessage" %) ... ... @@ -1007,15 +1007,19 @@ 1007 1007 "deviceTypeName": "", ~/~/ Название типа устройства 1008 1008 "sim1": "", ~/~/ Номер SIM1 1009 1009 "sim2": "", ~/~/ Номер SIM2 940 + 1010 1010 "parentId": "", ~/~/ ID клиента-родителя 1011 1011 "parentName": "", ~/~/ Наименование клиента-родителя 1012 1012 "modelId": "", ~/~/ ID модели объекта 1013 1013 "modelName": "", ~/~/ Имя модели объекта 945 + 1014 1014 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1015 1015 "unitName": "string", ~/~/ Наименование подразделения 1016 1016 "status": 0, ~/~/ Статус объекта 949 + 1017 1017 "createdAt": "", ~/~/ Дата создания объекта 1018 1018 }, 952 + 1019 1019 "customFields": [ ~/~/ Произвольные поля 1020 1020 { 1021 1021 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1038,7 +1038,8 @@ 1038 1038 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1039 1039 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1040 1040 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1041 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 975 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 + 1042 1042 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1043 1043 "mileageCoeff": 0, ~/~/ коэффициент пробега 1044 1044 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1068,6 +1068,7 @@ 1068 1068 "retries": 0 ~/~/ Количество попыток 1069 1069 } 1070 1070 ], 1006 + 1071 1071 "sensors": [ ~/~/ Датчики 1072 1072 { 1073 1073 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1108,19 +1108,31 @@ 1108 1108 }, 1109 1109 1110 1110 ~/~/ Характерные для произвольного: 1047 + 1111 1111 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 + 1112 1112 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 + 1113 1113 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 + 1114 1114 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 + 1115 1115 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 + 1116 1116 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 + 1117 1117 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 + 1118 1118 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 + 1119 1119 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 + 1120 1120 ~/~/ "ValueOn": "Вкл.", 1067 + 1121 1121 ~/~/ "ValueOff": "Выкл." 1122 1122 "summaryMaxValue": 0 ~/~/ Макс. значение 1123 1123 } 1071 + 1124 1124 "drivers": [ ~/~/ Водители 1125 1125 { 1126 1126 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1129,6 +1129,7 @@ 1129 1129 "isDefault": true ~/~/ По умолчанию 1130 1130 } 1131 1131 ], 1080 + 1132 1132 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1133 1133 { 1134 1134 "id": "", ~/~/ ID задания ... ... @@ -1145,7 +1145,8 @@ 1145 1145 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1146 1146 } 1147 1147 ], 1148 -"statusHistory": [ ~/~/ История статусов 1097 + 1098 + "statusHistory": [ ~/~/ История статусов 1149 1149 { 1150 1150 "status": 0, 1151 1151 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1153,6 +1153,7 @@ 1153 1153 "additionalInfo": "string" 1154 1154 } 1155 1155 ] 1106 + 1156 1156 } 1157 1157 ))) 1158 1158 ... ... @@ -1162,56 +1162,6 @@ 1162 1162 (% style="text-align:left" %) 1163 1163 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1164 1164 1165 - 1166 -== **Получить ответ на отправленную на ТС команду** == 1167 - 1168 -(% class="box infomessage" %) 1169 -((( 1170 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1171 -))) 1172 - 1173 -Идентификатор команды: cmdid 1174 - 1175 -Запрос от терминала на ответ команды 1176 - 1177 -Пример ответ от терминала: 1178 - 1179 -ID= "" ~/~/ идентификатор произвольного поля 1180 -Soft="" ~/~/ версия софта 1181 -GPS=4 ~/~/ тип трекера 1182 -Time=11:05:43 28.06.24 ~/~/ время запроса 1183 -Lat=45.056221 ~/~/ широта 1184 -Lon=39.035938 ~/~/ долгота 1185 -Speed=0.0 ~/~/ скорость 1186 -Course=181.4 ~/~/направление 1187 - 1188 -((( 1189 -== **Список отправленных объекту команд с ответами** == 1190 - 1191 -(% class="box infomessage" %) 1192 -((( 1193 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1194 -))) 1195 - 1196 -Идентификатор ТС: vehicleId 1197 - 1198 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1199 - 1200 -Пример ответа терминала 1201 - 1202 -[ 1203 -{ 1204 -"id": "", ~/~/ идентификатор пользователя 1205 -"commandText": "", ~/~/Текст команды. 1206 -"templateId": "", ~/~/Идентификатор шаблона 1207 -"updated": "", ~/~/ Время отправки 1208 -"tryCount": 0, ~/~/ Количество попыток отправки команды 1209 -"answer": "", ~/~/ Ответ терминала. 1210 -"status": "" ~/~/ Статус отправки 1211 -} 1212 -] 1213 -))) 1214 - 1215 1215 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1216 1216 1217 1217 (% class="box successmessage" %) ... ... @@ -1229,7 +1229,8 @@ 1229 1229 1230 1230 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1231 1231 1232 -(% style="color:#000000" %){(%%) 1133 +(% style="color:#000000" %){ 1134 + 1233 1233 "parentId": "" , ~/~/ ID клиента 1234 1234 "name": "" , ~/~/ имя ТС 1235 1235 "imei": "" , ~/~/ IMEI ... ... @@ -1250,6 +1250,7 @@ 1250 1250 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1251 1251 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1252 1252 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 + 1253 1253 "mileageCalcMethod": 0, 1254 1254 "mileageCoeff": 0, 1255 1255 "locationByCellId": true, ... ... @@ -1282,6 +1282,7 @@ 1282 1282 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1283 1283 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1284 1284 } 1188 + 1285 1285 "drivers": [ ~/~/ Водители 1286 1286 { 1287 1287 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1296,7 +1296,8 @@ 1296 1296 "retries": 0 1297 1297 } 1298 1298 ], 1299 -"sensors": [ ~/~/ Датчики 1203 + 1204 + "sensors": [ ~/~/ Датчики 1300 1300 { 1301 1301 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1302 1302 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1334,17 +1334,29 @@ 1334 1334 "additionalProp2": "string", 1335 1335 "additionalProp3": "string" 1336 1336 }, 1242 + 1337 1337 ~/~/ Характерные для произвольного: 1244 + 1338 1338 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 + 1339 1339 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 + 1340 1340 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 + 1341 1341 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 + 1342 1342 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 + 1343 1343 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 + 1344 1344 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 + 1345 1345 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 + 1346 1346 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 + 1347 1347 ~/~/ "ValueOn": "Вкл.", 1264 + 1348 1348 ~/~/ "ValueOff": "Выкл." 1349 1349 "summaryMaxValue": 0 ~/~/ Макс. значение 1350 1350 } ... ... @@ -1363,7 +1363,8 @@ 1363 1363 1364 1364 (% style="color:#000000" %)Ответ: 1365 1365 1366 -(% style="color:#000000" %){(%%) 1283 +(% style="color:#000000" %){ 1284 + 1367 1367 "vehicleId": "", ~/~/ID ТС 1368 1368 "parentId": "", ~/~/Guid владельца ТС 1369 1369 "name": "", ~/~/Имя объекта ... ... @@ -1401,6 +1401,8 @@ 1401 1401 "kind": "", ~/~/ Вид периодичности по времени 1402 1402 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1403 1403 } 1322 + 1323 +(% style="text-align:left" %) 1404 1404 (% style="color:#000000" %)} 1405 1405 1406 1406 **Валидация:** ... ... @@ -1415,7 +1415,7 @@ 1415 1415 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1416 1416 ))) 1417 1417 1418 -(% style="color:#000000" %)Метод позволяет получить список доступныхобъектовмониторинга (транспортных средств)с их основнымипараметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1338 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1419 1419 1420 1420 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1421 1421 ... ... @@ -1459,7 +1459,8 @@ 1459 1459 (% style="color:#000000" %)Ответ: 1460 1460 1461 1461 (% style="color:#000000" %){ 1462 - "vehicleId": "" ~/~/ идентификатор объекта 1382 + 1383 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1463 1463 "name": "" ~/~/ наименование объекта 1464 1464 "imei": "" ~/~/ IMEI объекта 1465 1465 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1518,11 +1518,13 @@ 1518 1518 "data": "", ~/~/ Данные 1519 1519 "overwrite": false, ~/~/ Флаг перезаписи 1520 1520 "stage": "", ~/~/ Состояние, может быть null 1442 + 1521 1521 (% style="color:#000000" %)} 1522 1522 1523 1523 (% style="color:#000000" %)Ответ: 1524 1524 1525 -(% style="color:#000000" %){(%%) 1447 +(% style="color:#000000" %){ 1448 + 1526 1526 "status": "", ~/~/ значение статуса 1527 1527 "date": "", ~/~/ Дата смены статуса 1528 1528 "description": "", ~/~/ Описание ... ... @@ -1529,25 +1529,10 @@ 1529 1529 "data": "", ~/~/ Данные 1530 1530 "overwrite": false, ~/~/ Флаг перезаписи 1531 1531 "stage": "", ~/~/ Состояние 1455 + 1456 +(% style="text-align:left" %) 1532 1532 (% style="color:#000000" %) } 1533 1533 1534 -== **Отправить команду на терминал** == 1535 - 1536 -(% class="box successmessage" %) 1537 -((( 1538 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1539 -))) 1540 - 1541 -Команда для отправки на тс. 1542 - 1543 -{ 1544 -"id": "", ~/~/идентификатор произвольного поля 1545 -"command": "", ~/~/ Текст команды 1546 -"retries": "", ~/~/ Количество попыток 1547 -"idTemplate": "" ~/~/ ID шаблона команды 1548 -} 1549 - 1550 - 1551 1551 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1552 1552 1553 1553 (% class="box warningmessage" %) ... ... @@ -1635,7 +1635,8 @@ 1635 1635 "retries": 0 1636 1636 } 1637 1637 ], 1638 -"sensors": [ ~/~/ Датчики 1546 + 1547 + "sensors": [ ~/~/ Датчики 1639 1639 { 1640 1640 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1641 1641 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1673,17 +1673,29 @@ 1673 1673 "additionalProp2": "string", 1674 1674 "additionalProp3": "string" 1675 1675 }, 1585 + 1676 1676 ~/~/ Характерные для произвольного: 1587 + 1677 1677 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 + 1678 1678 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 + 1679 1679 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 + 1680 1680 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 + 1681 1681 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 + 1682 1682 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 + 1683 1683 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 + 1684 1684 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 + 1685 1685 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 + 1686 1686 ~/~/ "ValueOn": "Вкл.", 1607 + 1687 1687 ~/~/ "ValueOff": "Выкл." 1688 1688 "summaryMaxValue": 0 ~/~/ Макс. значение 1689 1689 } ... ... @@ -1703,7 +1703,9 @@ 1703 1703 (% style="color:#000000" %)Ответ: 1704 1704 1705 1705 (% lang="en-US" style="text-align:left" %) 1706 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%) 1627 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1628 + 1629 +(% lang="en-US" style="text-align:left" %) 1707 1707 "vehicleId": "", ~/~/ ID ТС 1708 1708 "parentId": "", ~/~/ ID клиента 1709 1709 "name": "", ~/~/ имя ТС ... ... @@ -1744,6 +1744,8 @@ 1744 1744 "kind": "", ~/~/ Вид периодичности по времени 1745 1745 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1746 1746 } 1670 + 1671 +(% lang="en-US" style="text-align:left" %) 1747 1747 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1748 1748 1749 1749 **Валидация:** ... ... @@ -1784,15 +1784,18 @@ 1784 1784 1785 1785 (% style="color:#000000" %)Метод запроса: **GET** 1786 1786 1787 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1712 +(% 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]] 1788 1788 1789 1789 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1790 1790 1791 1791 (% style="color:#000000" %)Ответ: 1792 1792 1793 -(% style="color:#000000" %){(%%) 1718 +(% style="color:#000000" %){ 1719 + 1794 1794 "deviceTypeId" : "", ~/~/ ID типа устройства 1795 1795 "deviceTypeName" : "" ~/~/ Название типа устройства 1722 + 1723 +(% style="text-align:left" %) 1796 1796 (% style="color:#000000" %)} 1797 1797 1798 1798 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1814,10 +1814,13 @@ 1814 1814 1815 1815 (% style="color:#000000" %)Ответ: 1816 1816 1817 -(% style="color:#000000" %){(%%) 1745 +(% style="color:#000000" %){ 1746 + 1818 1818 "id": "", ~/~/ ID типа датчика 1819 1819 "name": "", ~/~/ Название 1820 1820 "description": "", ~/~/ Описание 1750 + 1751 +(% style="text-align:left" %) 1821 1821 (% style="color:#000000" %)} 1822 1822 1823 1823 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1861,56 +1861,6 @@ 1861 1861 } 1862 1862 ] 1863 1863 1864 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1865 - 1866 -(% class="box infomessage" style="text-align: left;" %) 1867 -((( 1868 -**POST /api/v3/terminalMessages/mapping** 1869 -))) 1870 - 1871 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1872 - 1873 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1874 - 1875 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1876 - 1877 -{ 1878 - "protocolType": 0, 1879 - "params": ["string"] 1880 -} 1881 - 1882 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1883 -|protocolType|ID типа протокола 1884 -|params|((( 1885 -Массив наименований параметров в сообщении 1886 -))) 1887 - 1888 -Ответ: 1889 - 1890 -{ 1891 - "protocolType": 0, 1892 - "mapping": { 1893 - "additionalProp1": { 1894 - "inputType": 0, 1895 - "inputNumber": 0 1896 - }, 1897 - "additionalProp2": { 1898 - "inputType": 0, 1899 - "inputNumber": 0 1900 - } 1901 - } 1902 -} 1903 - 1904 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1905 -|protocolType|Тип протокола 1906 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1907 -|inputNumber|((( 1908 -Номер входа 1909 -))) 1910 - 1911 -(% class="wikigeneratedid" %) 1912 -Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]] 1913 - 1914 1914 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1915 1915 1916 1916 (% class="box infomessage" %) ... ... @@ -1935,11 +1935,6 @@ 1935 1935 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1936 1936 } 1937 1937 1938 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1939 -|vehicleId|ID объекта 1940 -|from|Дата и время начала периода запроса 1941 -|to|Дата и время окончания периода запроса 1942 - 1943 1943 Ответ: 1944 1944 1945 1945 [ ... ... @@ -1946,43 +1946,80 @@ 1946 1946 { 1947 1947 "messages": [ 1948 1948 { 1949 - "deviceTime": "2023-11-29T07:40:44.052Z", 1950 - "serverTime": "2023-11-29T07:40:44.052Z", 1951 - "speed": 0, 1952 - "altitude": 0, 1953 - "latitude": 0, 1954 - "longitude": 0, 1955 - "satellites": 0, 1956 - "course": 0, 1957 - "voltage": 0, 1958 - "parameters": { 1825 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 + "speed": 0, ~/~/ Скорость, км/ч 1828 + "altitude": 0, ~/~/ Высота, м 1829 + "latitude": 0, ~/~/ Широта [-90°;90°] 1830 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 + "satellites": 0, ~/~/ Кол-во спутников 1832 + "voltage": 0, ~/~/ Напряжение 1833 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1959 1959 "additionalProp1": "string", 1960 1960 "additionalProp2": "string", 1961 1961 "additionalProp3": "string" 1962 1962 }, 1963 - "photoCount": 0, 1964 - "lbsCorrectedCoords": true, 1965 - "protocolType": 0 1838 + "photoCount": 0 ~/~/ Кол-во фото 1966 1966 } 1967 1967 ] 1968 1968 } 1969 1969 ] 1970 1970 1971 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1972 -|deviceTime|Время сообщения терминала 1973 -|serverTime|Время когда сообщение поступило на сервер 1974 -|speed|Скорость 1975 -|altitude|Высота над уровнем моря 1976 -|latitude|Широта 1977 -|longitude|Долгота 1978 -|satellites|Кол-во спутников 1979 -|course|Курс 1980 -|voltage|Бортовое напряжение 1981 -|parameters|Список параметров и их значений 1982 -|photoCount|Количество фото 1983 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 1984 -|protocolType|ID типа протокола 1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1985 1985 1846 +(% class="box infomessage" %) 1847 +((( 1848 +**POST /api/v3/vehicles/export/history** 1849 +))) 1850 + 1851 +Метод возвращает список сообщений терминала объекта за выбранный период. 1852 + 1853 +(% style="text-align: left;" %) 1854 +Метод запроса **POST** 1855 + 1856 +(% style="text-align: left;" %) 1857 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 + 1859 +(% style="text-align: left;" %) 1860 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 + 1862 +{ 1863 + "vehicleId": 0, ~/~/ ID объекта 1864 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 +} 1868 + 1869 +Ответ: 1870 + 1871 +Получаете файл. Сообщение: Code 200/Success 1872 + 1873 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 + 1875 +(% class="box infomessage" %) 1876 +((( 1877 +**GET /api/v3/vehicles/export/history/status** 1878 +))) 1879 + 1880 +Метод возвращает список сообщений терминала объекта за выбранный период. 1881 + 1882 +(% style="text-align: left;" %) 1883 +Метод запроса **GET** 1884 + 1885 +(% style="text-align: left;" %) 1886 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 + 1888 +(% style="text-align: left;" %) 1889 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 + 1891 +Ответ: 1892 + 1893 +{ 1894 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 + "message": "string" ~/~/ текст описывающий статус. 1897 +} 1898 + 1986 1986 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1987 1987 1988 1988 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2116,96 +2116,6 @@ 2116 2116 } 2117 2117 ] 2118 2118 2119 - 2120 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2121 - 2122 -(% class="box infomessage" %) 2123 -((( 2124 -**POST /api/v3/vehicles/moveStop** 2125 -))) 2126 - 2127 -Метод запроса: **POST** 2128 - 2129 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2130 - 2131 -В заголовках запроса: X-Auth: Токен авторизации 2132 - 2133 - 2134 -Тело запроса: 2135 - 2136 -{ 2137 - "vehicleIds": [ ], ~/~/ Список ID объектов 2138 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2139 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2140 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2141 -} 2142 - 2143 -Ответ: 2144 - 2145 -[ 2146 - { 2147 - "vehicleId": 0, ~/~/ ID объекта 2148 - "vehicleName": "string", ~/~/ Имя объекта 2149 - "moves": [ ~/~/ Событие движения 2150 - { 2151 - "mileage": 0, ~/~/ Пробег, км 2152 - "eventId": 0, ~/~/ Идентификатор события 2153 - "eventName": "string", ~/~/ Название события 2154 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2155 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2156 - "duration": 0 ~/~/ Продолжительность события, секунд 2157 - } 2158 - ], 2159 - "stops": [ ~/~/ События стоянок 2160 - { 2161 - "address": "string", ~/~/ Адрес события 2162 - "eventId": 0, ~/~/ Идентификатор события 2163 - "eventName": "string", ~/~/ Название события 2164 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2165 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2166 - "duration": 0 ~/~/ Продолжительность события, секунд 2167 - } 2168 - ] 2169 - } 2170 -] 2171 - 2172 - 2173 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2174 - 2175 -(% class="box infomessage" %) 2176 -((( 2177 -**POST /api/v3/vehicles/getlastdata** 2178 -))) 2179 - 2180 -Метод запроса: **POST** 2181 - 2182 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2183 - 2184 -В заголовках запроса: X-Auth: Токен авторизации 2185 - 2186 - 2187 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2188 - 2189 -Ответ: 2190 - { 2191 - "vehicleId": 0, ~/~/Идентификатор объекта. 2192 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2193 - "vehicleNumber": "string",~/~/Номер объекта. 2194 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2195 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2196 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2197 - "speed": 0,~/~/Скорость объекта. 2198 - "course": 0,~/~/Курс движения [0;360] 2199 - "latitude": 0,~/~/Широта [-90°;90°]. 2200 - "longitude": 0,~/~/Долгота [-180°;180°]. 2201 - "address": "string",~/~/Адрес. 2202 - "geozones": [ ~/~/Сведения по геозонам. 2203 - { 2204 - "id": 0, 2205 - "name": "string" 2206 - } 2207 - 2208 - 2209 2209 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2210 2210 2211 2211 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -3104,83 +3104,6 @@ 3104 3104 Success 3105 3105 3106 3106 3107 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3108 - 3109 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3110 - 3111 -(% class="box infomessage" %) 3112 -((( 3113 -**POST /api/v3/Trailers** 3114 -))) 3115 - 3116 -Пример запроса: 3117 - 3118 -{ 3119 - "startDate": "2023-11-14T10:48:03.671Z", 3120 - "endDate": "2023-11-14T10:48:03.671Z", 3121 - "ids": [ 0 ], 3122 - "timezone": 0 3123 -} 3124 - 3125 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3126 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3127 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3128 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3129 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3130 - 3131 -Пример ответа: 3132 - 3133 -[ 3134 - { 3135 - "SD": "2023-11-14T10:48:03.717Z", 3136 - "ED": "2023-11-14T10:48:03.717Z", 3137 - "id": 0, 3138 - "SLat": 0, 3139 - "SLon": 0, 3140 - "ELat": 0, 3141 - "ELon": 0, 3142 - "mileage": 0 3143 - "Duration": 0 3144 - "Address": "string", 3145 - "Address2": "string", 3146 - "name": "string", 3147 - "rid": "string", 3148 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3149 - "trailer": { 3150 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3151 - "Number": "string", 3152 - "Description": "string", 3153 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3154 - "ExternalID": "string", 3155 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3156 - "CreateTime": "2023-11-14T10:48:03.717Z", 3157 - "UpdateTime": "2023-11-14T10:48:03.717Z", 3158 - "IsDeleted": true 3159 - }, 3160 - "filesCount": 0, 3161 - } 3162 -] 3163 - 3164 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3165 -|SD|Дата и время начала события 3166 -|ED|Дата и время окончания события 3167 -|id|ID объекта 3168 -|SLat|Широта начальной координаты 3169 -|SLon|Долгота начальной координаты 3170 -|ELat|Широта конечной координаты 3171 -|ELon|Долгота конечной координаты 3172 -|mileage|Пробег 3173 -|Duration|Продолжительность 3174 -|Address|Адрес начального местоположения 3175 -|Address2|Адрес конечного местоположения 3176 -|name|Имя радиометки 3177 -|rid|Номер радиометки 3178 -|rguid|ID радиометки 3179 -|trailer|Информация об агрегате 3180 -|ModelGuid|ID агрегата 3181 -|Number|Название/номер агрегата 3182 -|Description|Текст примечания агрегата 3183 - 3184 3184 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3185 3185 3186 3186 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -3202,19 +3202,13 @@ 3202 3202 { 3203 3203 "name": "string", 3204 3204 "number": 0, 3205 - "period": 0, 2951 + "period": 0, ~/~/ Частота трансляции радиометки 3206 3206 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3207 3207 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 + "deleted": true 3208 3208 } 3209 3209 ] 3210 3210 3211 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3212 -|parentId|ID клиента 3213 -|name|Название карты-метки 3214 -|number|Номер 3215 -|period|Период запросов в секундах (работает только для агрегатов) 3216 -|id|ID карты-метки 3217 - 3218 3218 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3219 3219 3220 3220 (% class="box infomessage" %) ... ... @@ -3230,18 +3230,13 @@ 3230 3230 { 3231 3231 "name": "string", 3232 3232 "number": 0, 3233 - "period": 0, 2973 + "period": 0, ~/~/ Частота трансляции радиометки 3234 3234 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3235 3235 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 + "deleted": true 3236 3236 } 3237 3237 ] 3238 3238 3239 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3240 -|name|Название карты-метки 3241 -|number|Номер 3242 -|period|Период запросов в секундах (работает только для агрегатов) 3243 -|id|ID карты-метки 3244 -|parentId|ID клиента 3245 3245 3246 3246 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3247 3247 ... ... @@ -3257,6 +3257,7 @@ 3257 3257 "number": 0, 3258 3258 "period": 0, 3259 3259 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 + "deleted": true 3260 3260 } 3261 3261 3262 3262 Ответ: ... ... @@ -3267,15 +3267,9 @@ 3267 3267 "period": 0, 3268 3268 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3269 3269 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 + "deleted": true 3270 3270 } 3271 3271 3272 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3273 -|name|Название карты-метки 3274 -|number|Номер 3275 -|period|Период запросов в секундах (работает только для агрегатов) 3276 -|id|ID карты-метки 3277 -|parentId|ID клиента 3278 - 3279 3279 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3280 3280 3281 3281 (% class="box warningmessage" %) ... ... @@ -3291,6 +3291,7 @@ 3291 3291 "period": 0, 3292 3292 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3293 3293 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 + "deleted": true 3294 3294 } 3295 3295 3296 3296 Ответ: ... ... @@ -3301,15 +3301,9 @@ 3301 3301 "period": 0, 3302 3302 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3303 3303 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 + "deleted": true 3304 3304 } 3305 3305 3306 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3307 -|name|Название карты-метки 3308 -|number|Номер 3309 -|period|Период запросов в секундах (работает только для агрегатов) 3310 -|id|ID карты-метки 3311 -|parentId|ID клиента 3312 - 3313 3313 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3314 3314 3315 3315 (% class="box errormessage" %) ... ... @@ -3317,7 +3317,7 @@ 3317 3317 **DELETE /api/v3/Rfids/{rfidGuid}** 3318 3318 ))) 3319 3319 3320 -Передаем параметр **rfidGuid**- идентификатор карты-метки3045 +Передаем параметр rfidGuid - идентификатор карты-метки 3321 3321 3322 3322 Ответ: 3323 3323 ... ... @@ -3558,8 +3558,6 @@ 3558 3558 **PUT /api/v3/Billing/client/balance** 3559 3559 ))) 3560 3560 3561 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3562 - 3563 3563 Тело запроса: 3564 3564 3565 3565 { ... ... @@ -3573,50 +3573,6 @@ 3573 3573 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3574 3574 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3575 3575 3576 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3577 - 3578 -(% class="box warningmessage" %) 3579 -((( 3580 -**PUT /api/v3/billing/client/balance/deposit** 3581 -))) 3582 - 3583 -Создает операцию **Пополнение **с указанной суммой 3584 - 3585 -Тело запроса: 3586 - 3587 -{ 3588 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3589 - "Balance": 0 3590 -} 3591 - 3592 -Ответ: Success 3593 - 3594 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3595 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3596 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3597 - 3598 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3599 - 3600 -Создает операцию **Списание **с указанной суммой 3601 - 3602 -(% class="box warningmessage" %) 3603 -((( 3604 -**PUT /api/v3/billing/client/balance/withdraw** 3605 -))) 3606 - 3607 -Тело запроса: 3608 - 3609 -{ 3610 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3611 - "Balance": 0 3612 -} 3613 - 3614 -Ответ: Success 3615 - 3616 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3617 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3618 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3619 - 3620 3620 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3621 3621 3622 3622 (% class="box warningmessage" %) ... ... @@ -3689,743 +3689,6 @@ 3689 3689 |PeriodValue|Значение периода. 3690 3690 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3691 3691 3692 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3693 - 3694 -(% class="box warningmessage" %) 3695 -((( 3696 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3697 -))) 3698 - 3699 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3700 - 3701 -(% class="box infomessage" %) 3702 -((( 3703 -**POST /api/v3/vehicles/import/{agentId}** 3704 -))) 3705 - 3706 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.** 3707 - 3708 -В пути указывается **agentId** - id клиента. 3709 - 3710 -**Заголовок** 3711 - 3712 -**X-Auth: [токен авторизации]** 3713 - 3714 -**Параметры** 3715 - 3716 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3717 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3718 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление 3719 - 3720 -В теле использовать тип **form-data,** тип значения** file** 3721 - 3722 -**Ключи** 3723 - 3724 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3725 -|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3726 -|csv|В значении передаем файл датчиков, формат **csv** 3727 - 3728 -Ответ: 3729 - 3730 -{ 3731 - "vehicleId": 0, 3732 - "name": "string", 3733 - "errors": ["string"] 3734 -} 3735 - 3736 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3737 -|vehicleId|ID созданного объекта 3738 -|name|Имя созданного объекта 3739 -|errors|Ошибки и их описание 3740 - 3741 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3742 - 3743 -(% class="box infomessage" %) 3744 -((( 3745 -**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3746 -))) 3747 - 3748 -(% class="wikigeneratedid" %) 3749 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3750 - 3751 -(% class="wikigeneratedid" %) 3752 -В пути указывается **vehicleId **- id объекта. 3753 - 3754 -**Заголовок** 3755 - 3756 -**X-Auth: [токен авторизации]** 3757 - 3758 -В теле использовать тип **form-data.** 3759 - 3760 -Ключи: 3761 - 3762 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3763 -|**history**|В значении передавать файл с историей 3764 - 3765 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3766 - 3767 -Ответ: 3768 - 3769 -{ 3770 - "results": [ 3771 - { 3772 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3773 - "vehicleId": 0, 3774 - "errors": [ 3775 - "string" 3776 - ], 3777 - "firstMessageDate": "2023-11-28T09:27:58.949Z", 3778 - "lastMessageDate": "2023-11-28T09:27:58.949Z", 3779 - "producedCount": 0, 3780 - "msgCount": 0 3781 - } 3782 - ] 3783 -} 3784 - 3785 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3786 -|results|Результаты импорта в разрезе ТС 3787 -|vehicleGuid|Guid ТС 3788 -|vehicleId|ID ТС 3789 -|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3790 -|firstMessageDate|Дата первого импортированного сообщения (UTC) 3791 -|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3792 -|producedCount|Кол-во успешно отправленных в шину данных сообщений 3793 -|msgCount|Кол-во обработанных сообщений всего 3794 - 3795 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3796 - 3797 -(% class="box infomessage" %) 3798 -((( 3799 -**GET /api/v3/vehicles/import/history/status** 3800 -))) 3801 - 3802 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3803 - 3804 -Ответ: 3805 - 3806 -{ 3807 - "activity": true, 3808 - "progress": 0, 3809 - "message": "string" 3810 -} 3811 - 3812 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3813 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3814 -|progress|Guid ТС 3815 - 3816 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3817 - 3818 -(% class="box infomessage" %) 3819 -((( 3820 -**POST /api/v3/vehicles/export** 3821 -))) 3822 - 3823 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3824 - 3825 -Тело запроса: 3826 - 3827 -[ 3828 - id 3829 -] 3830 - 3831 -Ответ: Success 200, получаете файлы с настройками. 3832 - 3833 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3834 - 3835 -(% class="box infomessage" %) 3836 -((( 3837 -**POST /api/v3/vehicles/export/history** 3838 -))) 3839 - 3840 -Метод возвращает список сообщений терминала объекта за выбранный период. 3841 - 3842 -Тело запроса: 3843 - 3844 -{ 3845 - "vehicleId": 0, 3846 - "asArchive": true, 3847 - "from": "2023-09-27T12:17:45.973Z", 3848 - "to": "2023-09-27T12:17:45.973Z" 3849 -} 3850 - 3851 -Ответ: 3852 - 3853 -Получаете файл. Сообщение: Code 200/Success 3854 - 3855 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3856 -|vehicleId|ID объекта 3857 -|asArchive|true - Архивировать файл, False - не архивировать 3858 -|from|Дата и время начала запроса 3859 -|to|Дата и время окончания запроса 3860 - 3861 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3862 - 3863 -(% class="box infomessage" %) 3864 -((( 3865 -**GET /api/v3/vehicles/export/history/status** 3866 -))) 3867 - 3868 -Метод возвращает список сообщений терминала объекта за выбранный период. 3869 - 3870 -Ответ: 3871 - 3872 -{ 3873 - "activity": true, 3874 - "progress": 0, 3875 - "message": "string" 3876 -} 3877 - 3878 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3879 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3880 -|progress|Прогресс экспорта, от 0 до 100% 3881 -|message|Текст описывающий статус 3882 - 3883 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3884 - 3885 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3886 - 3887 -(% class="box infomessage" %) 3888 -((( 3889 -**POST /api/v3/EcoDriving/rating** 3890 -))) 3891 - 3892 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3893 - 3894 -Тело запроса: 3895 - 3896 -{ 3897 - "vehicleIds": [vehicleId], 3898 - "from": "2023-11-22T09:29:48.051Z", 3899 - "to": "2023-11-22T09:29:48.051Z" 3900 -} 3901 - 3902 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3903 -|vehicleIds|Массив ID объектов 3904 -|from|Дата начала запроса 3905 -|to|Дата окончания запроса 3906 - 3907 -Ответ: 3908 - 3909 -{ 3910 - "items": [ 3911 - { 3912 - "from": "2023-11-22T09:29:48.052Z", 3913 - "to": "2023-11-22T09:29:48.052Z", 3914 - "vehicleId": 0, 3915 - "vehicleName": "string", 3916 - "vehicleModel": "string", 3917 - "penalty": 0, 3918 - "score": 0, 3919 - "totalViolations": 0, 3920 - "violationsByType": { 3921 - "overspeedingViolations": 0, 3922 - "accelerationViolations": 0, 3923 - "brakingViolations": 0, 3924 - "turningViolations": 0, 3925 - "dangerousDrivingViolations": 0, 3926 - "sensorViolations": 0 3927 - }, 3928 - "moveTime": 0, 3929 - "mileage": 0, 3930 - "tripsCount": 0, 3931 - "trips": [ 3932 - { 3933 - "penalty": 0, 3934 - "score": 0, 3935 - "violationsCount": 0, 3936 - "violationsByType": { 3937 - "overspeedingViolations": 0, 3938 - "accelerationViolations": 0, 3939 - "brakingViolations": 0, 3940 - "turningViolations": 0, 3941 - "dangerousDrivingViolations": 0, 3942 - "sensorViolations": 0 3943 - }, 3944 - "moveTime": 0, 3945 - "mileage": 0, 3946 - "motohours": 0, 3947 - "maxSpeed": 0, 3948 - "startAddress": "string", 3949 - "endAddress": "string", 3950 - "drivers": [ 3951 - { 3952 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3953 - "driverName": "string", 3954 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3955 - } 3956 - ] 3957 - } 3958 - ] 3959 - } 3960 - ] 3961 -} 3962 - 3963 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3964 -|from|Дата начала запроса 3965 -|to|Дата окончания 3966 -|vehicleId|ID объекта 3967 -|vehicleName|Имя объекта 3968 -|vehicleModel|Модель объекта 3969 -|penalty|Сумма штрафных баллов 3970 -|score|Оценка 3971 -|totalViolations|Суммарное количество нарушений 3972 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3973 -|overspeedingViolations|Превышение скорости 3974 -|accelerationViolations|Ускорение 3975 -|brakingViolations|Торможение 3976 -|turningViolations|Резкий поворот 3977 -|dangerousDrivingViolations|Резкое вождение 3978 -|sensorViolations|Нарушение по датчику 3979 -|moveTime|Время в движении 3980 -|mileage|Пробег 3981 -|tripsCount|Количество рейсов 3982 -|motohours|Моточасы 3983 -|maxSpeed|Максимальная скорость 3984 -|startAddress|Адрес начала рейса 3985 -|endAddress|Адрес окончания рейса 3986 -|drivers|Список водителей, которые были на объекте в течениии рейса 3987 -|driverGuid|Guid водителя 3988 -|driverName|Имя водителя 3989 -|driverRfid|Номер Карты-метки 3990 - 3991 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 3992 - 3993 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 3994 - 3995 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 3996 - 3997 -(% class="box infomessage" %) 3998 -((( 3999 -POST /api/v3/fuelcards/transactions 4000 -))) 4001 - 4002 -Метод запроса: POST 4003 - 4004 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4005 -\\В заголовках запроса: X-Auth: Токен авторизации 4006 - 4007 -Параметры в теле запроса (JSON): 4008 - 4009 -{ 4010 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4011 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4012 - "ids": [ 4013 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4014 - ], 4015 - "timezone": 0 ~/~/Таймзона 4016 -} 4017 - 4018 - 4019 -Ответ: 4020 - { 4021 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4022 - "driver": "string", ~/~/Водители, привязанные к ТК 4023 - "object": "string", ~/~/Наименование ТС 4024 - "amount": 0, ~/~/Количество топлива 4025 - "amountDut": 0, ~/~/Количество по ДУТ 4026 - "amountDiff": 0, ~/~/Разница, л 4027 - "amountDiffPerc": 0, ~/~/Разница, % 4028 - "summa": 0, ~/~/Стоимость, руб 4029 - "serviceName": "string", ~/~/Тип топлива 4030 - "price": 0, ~/~/Цена за литр, руб 4031 - "cardName": "string", ~/~/Наименование ТК 4032 - "cardNum": "string", ~/~/Номер ТК 4033 - "operator": "string", ~/~/Оператор ТК 4034 - "address": "string" ~/~/Адрес АЗС 4035 - } 4036 - 4037 - 4038 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4039 - 4040 - 4041 -== **Получение полных данных о ретрансляторе** == 4042 - 4043 -(% class="box infomessage" %) 4044 -((( 4045 -**GET ** **/api/v3/retranslations/{id}** 4046 -))) 4047 - 4048 -Идентификатор запроса: ID 4049 - 4050 - 4051 -Пример ответа: 4052 - 4053 -{ 4054 -"description": "", ~/~/ Определяет описание 4055 -"subscriberId": "", ~/~/ Подписчик 4056 -"protocolType": 0, ~/~/ Тип протокола 4057 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4058 -"address": "string", ~/~/ Адрес события 4059 -"objects": [ ~/~/Объекты для ретрансляции 4060 -{ 4061 -"id": "", ~/~/ Идентификатор объекта ретрансляции 4062 -"name": "", ~/~/ Наименование объекта ретрансляции 4063 -"imei": "", ~/~/ IMEI объекта 4064 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4065 -} 4066 - ], 4067 -"id": "", ~/~/ идентификатор пользователя 4068 -"parentId": "", ~/~/Guid родителя 4069 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4070 -} 4071 - 4072 - 4073 -== **Удаление данных ретранслятора** == 4074 - 4075 -(% class="box infomessage" %) 4076 -((( 4077 -**DELETE** **/api/v3/retranslations/{id}** 4078 -))) 4079 - 4080 -Параметр запроса: ID 4081 - 4082 - 4083 -== **Создание ретранслятора** == 4084 - 4085 -(% class="box infomessage" %) 4086 -((( 4087 -**POST ** **/api/v3/retranslations/{id}** 4088 -))) 4089 - 4090 -Запрос: 4091 - 4092 -{ 4093 -"description": "", ~/~/ Описание 4094 -"subscriberId": "", ~/~/ Подписчик 4095 -"protocolType": 0, ~/~/ Тип протокола 4096 -"address": "", ~/~/ Адрес ретрансляции 4097 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4098 -"objects": [ ~/~/Объекты для ретрансляции 4099 -{ 4100 -"id": "", ~/~/ идентификатор пользователя 4101 -"imei": "", ~/~/IMEI объекта 4102 -"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4103 -} 4104 - ] 4105 -} 4106 - 4107 - 4108 -Ответ: 4109 - 4110 -{ 4111 -"description": "string", ~/~/ Определяет описание 4112 -"subscriberId": "", ~/~/ идентификатор запроса 4113 -"protocolType": 0, ~/~/ Тип протокола 4114 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4115 -"address": "", ~/~/ Адрес события 4116 -"objects": [ ~/~/Объекты для ретрансляции 4117 -{ 4118 -"id": "", ~/~/ идентификатор пользователя 4119 -"name": "string", ~/~/ Название уведомления 4120 -"imei": "string", ~/~/IMEI объекта 4121 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4122 -} 4123 - ], 4124 -"id": "", ~/~/ идентификатор пользователя 4125 -"parentId": "", ~/~/ Guid идентификатор родителя 4126 -"deleted": true ~/~/ Признак удаления 4127 -} 4128 - 4129 - 4130 -== **Редактирование ретранслятора** == 4131 - 4132 -(% class="box infomessage" %) 4133 -((( 4134 -**PUT** **/api/v3/retranslations** 4135 -))) 4136 - 4137 -Пример запроса: 4138 - 4139 -{ 4140 -"id": "", ~/~/ идентификатор пользователя 4141 -"description": "string", ~/~/ Определяет описание 4142 -"subscriberId": "", ~/~/ идентификатор запроса 4143 -"protocolType": 0, ~/~/ Тип протокола 4144 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4145 -"address": "string", ~/~/ Адрес события 4146 -"objects": ~/~/Объекты для ретрансляции 4147 -[ 4148 -{ 4149 -"id": "", ~/~/ идентификатор пользователя 4150 -"imei": "", ~/~/IMEI объекта 4151 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4152 -} 4153 - ] 4154 -} 4155 - 4156 - 4157 -Пример ответа: 4158 - 4159 -{ 4160 -"description": "", ~/~/ Определяет описание 4161 -"subscriberId": "", ~/~/ идентификатор запроса 4162 -"protocolType": 0, ~/~/ Тип протокола 4163 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4164 -"address": "string", ~/~/ Адрес события 4165 -"objects": [ ~/~/Объекты для ретрансляции 4166 -{ 4167 -"id": "", ~/~/ идентификатор пользователя 4168 -"name": "string", ~/~/ Название уведомления 4169 -"imei": "", ~/~/IMEI объекта 4170 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4171 -} 4172 - ], 4173 -"id": "", ~/~/ идентификатор пользователя 4174 -"parentId": "", ~/~/ Guid идентификатор родителя 4175 -"deleted": true ~/~/ Признак удаления 4176 -} 4177 - 4178 - 4179 -== **Получение списка ретранслятора клиента** == 4180 - 4181 -(% class="box infomessage" %) 4182 -((( 4183 -**POST /api/v3/retranslations/find** 4184 -))) 4185 - 4186 -Пример запроса: 4187 - 4188 -{ 4189 -"id": "", ~/~/ идентификатор пользователя 4190 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4191 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4192 -} 4193 - 4194 -Ответ: 4195 - 4196 -[ 4197 -{ 4198 -"description": "", ~/~/ Определяет описание 4199 -"subscriberId": "", ~/~/ идентификатор запроса 4200 -"protocolType": 0, ~/~/ Тип протокола 4201 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4202 -"address": "string", ~/~/ Адрес события 4203 -"id": "", ~/~/ идентификатор пользователя 4204 -"parentId": "", ~/~/ Guid идентификатор родителя 4205 -"deleted": true ~/~/ Признак удаления 4206 -} 4207 -] 4208 - 4209 - 4210 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4211 - 4212 -== **API для отчета по выгрузке комбайнов** == 4213 - 4214 -(% class="box infomessage" %) 4215 -((( 4216 -POST **/api/v3/Reports/harvesterUnloading** 4217 -))) 4218 - 4219 -Пример запроса: 4220 - 4221 -{ 4222 - "byTime": 0, ~/~/ Объединение событий по времени 4223 - "byDist": 0, ~/~/ Объединение событий по расстоянию 4224 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4225 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4226 - "showNearestObjects": true, ~/~/Показывать объекты рядом? 4227 - "vehicleIds": [ ~/~/ Список id объектов для анализа 4228 - 0 4229 - ], 4230 - "from": "", ~/~/ Дата и время начало запроса 4231 - "to": "", ~/~/ Дата и время окончания запроса 4232 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4233 -} 4234 - 4235 -Пример ответа: 4236 - 4237 -[ 4238 - { 4239 - "harvesterName": "", ~/~/Комбайн, номер 4240 - "harvesterId": 0, ~/~/Комбайн, id 4241 -"harvesterModel": "", ~/~/ Модель комбайна 4242 -"hopperCapacity": 0, ~/~/ Объем бункера м3 4243 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4244 - "events": [ ~/~/Список событий в разрезе комбайна 4245 - { 4246 - "driverId": "", ~/~/Идентификатор водителя 4247 - "driverName": "", ~/~/Водитель комбайна, ФИО 4248 - "RFID": "", ~/~/ идентификатор карты-метки 4249 - "rfidName": "", ~/~/Водитель комбайна, имя метки 4250 - "vehicleId": 0, ~/~/идентификатор объекта 4251 - "vehicleName": "string", ~/~/ Имя объекта 4252 - "modelName": "string", ~/~/ Имя модели объекта 4253 - "nearestVehicles": [ ~/~/Объекты рядом 4254 - { 4255 - "vehicleId": 0, ~/~/идентификатор объекта 4256 - "vehicleName": "string" ~/~/ Имя объекта 4257 - } 4258 - ], 4259 - "fields": [ ~/~/Поля, где происходила выгрузка 4260 - { 4261 - "id": 0, ~/~/ идентификатор пользователя 4262 - "name": "string" ~/~/ имя пользователя 4263 - } 4264 - ], 4265 - "event": "string", ~/~/Событие 4266 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4267 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4268 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4269 - "cultureName": "string", ~/~/ название культуры 4270 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4271 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4272 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4273 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4274 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4275 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4276 - "issued": 0, ~/~/Выдано, бункеров 4277 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4278 - "latitude": 0, ~/~/Широта 4279 - "longitude": 0, ~/~/ Долгота 4280 - "litresAway": 0, ~/~/Отдано, л 4281 - "m3Away": 0 ~/~/Отдано, м3 4282 - } 4283 - ] 4284 - } 4285 -] 4286 - 4287 - 4288 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4289 - 4290 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4291 - 4292 - 4293 -(% class="box infomessage" %) 4294 -((( 4295 -GET api/v3/Vehicles/recyclebin/all 4296 -))) 4297 - 4298 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4299 - 4300 -Параметр запроса: {parentId} - идентификатор агента 4301 - 4302 -В заголовках запроса: X-Auth: Токен авторизации 4303 - 4304 -Ответ: 4305 - 4306 -[ 4307 - { 4308 - "recordTime": "", ~/~/Время записи 4309 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4310 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4311 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4312 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4313 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4314 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4315 - "items": [ ~/~/ 4316 -nullable: true ~/~/Детали 4317 - { 4318 - "name": "string", ~/~/наименование столбца 4319 - "value": "string" ~/~/содержание столбца 4320 - } 4321 - ] 4322 - }, 4323 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4324 - "string" 4325 - ] 4326 - } 4327 -] 4328 - 4329 - 4330 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4331 - 4332 -(% class="box infomessage" %) 4333 -((( 4334 -POST/api/v3/Vehicles/recyclebin/erase 4335 -))) 4336 - 4337 -В заголовках запроса: X-Auth: Токен авторизации 4338 - 4339 -Пример запроса: 4340 - 4341 -[ 4342 -0 4343 -] 4344 - 4345 - 4346 -Пример ответа: 4347 - 4348 -[ 4349 -{ 4350 - "recordTime": "", ~/~/Время записи 4351 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4352 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4353 - "objectId": 0, ~/~/ID объекта, помещённого в корзин 4354 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4355 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4356 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4357 - "items": [ ~/~/Детали 4358 - { 4359 - "name": "", ~/~/Имя свойства 4360 - "value": "" ~/~/Значение свойства 4361 - } 4362 - ] 4363 - }, 4364 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4365 - "" 4366 - ] 4367 - } 4368 -] 4369 - 4370 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4371 - 4372 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4373 - 4374 -(% class="box infomessage" %) 4375 -((( 4376 -POST/api/v3/Vehicles/recyclebin/restore 4377 -))) 4378 - 4379 -В заголовках запроса: X-Auth: Токен авторизации 4380 - 4381 -Параметры в теле запроса (JSON): 4382 - 4383 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4384 - 4385 -В заголовках запроса: X-Auth: Токен авторизации 4386 - 4387 - 4388 -Пример запроса: 4389 - 4390 -((( 4391 -[ 4392 -))) 4393 - 4394 -((( 4395 - 0 4396 -))) 4397 - 4398 -((( 4399 -] 4400 -))) 4401 - 4402 - 4403 -Пример ответа: 4404 - 4405 -[ 4406 -{ 4407 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4408 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4409 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4410 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4411 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4412 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4413 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4414 - "items": [ ~/~/Детали 4415 - { 4416 - "name": "string", ~/~/Имя свойства 4417 - "value": "string" ~/~/Значение свойства 4418 - } 4419 - ] 4420 - }, 4421 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4422 - "string" 4423 - ] 4424 - } 4425 -] 4426 - 4427 - 4428 - 4429 4429 (% class="box" lang="en-US" style="text-align: center;" %) 4430 4430 ((( 4431 4431 (% 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]] **