Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. SupportZhuchkov1 +XWiki.krainovim - Content
-
... ... @@ -14,18 +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 - 20 -(% style="color:#000000; font-size:16px" %)**Рекомендации** 21 - 22 -- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 23 - 24 24 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 25 25 26 26 == (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 27 27 28 -(% class="box successmessage" %)23 +(% class="box infomessage" %) 29 29 ((( 30 30 (% lang="en-US" %)**POST /api/v3/auth/login** 31 31 ))) ... ... @@ -36,7 +36,7 @@ 36 36 37 37 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 38 38 39 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 40 40 41 41 (% style="color:#000000" %)Параметры в теле запроса (JSON): 42 42 ... ... @@ -45,25 +45,21 @@ 45 45 "password": "testuser" 46 46 } 47 47 43 + 48 48 (% style="color:#000000" %)**Ответ:** 49 49 50 50 (% lang="en-US" %) 51 51 (% style="color:#000000" %){ 52 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 53 - "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" %) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 58 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 59 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 60 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 61 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 62 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 63 - 64 -(% class="wikigeneratedid" %) 65 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 66 - 67 67 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 68 68 69 69 (% class="box infomessage" %) ... ... @@ -102,51 +102,30 @@ 102 102 Запрос должен содержать данные параметра "**agentId**" 103 103 104 104 (% style="color:#000000" %)Ответ: 96 +А 105 105 { 106 - "agentId": "", (%%) 107 - "parentId": "", 108 - "parentName": "string", 109 - "name": "string", 110 - "fullName": "string", 111 - "agentInfoType": 0, 112 - "isForeign": true/false, 113 - "district": "string", 114 - "region": "string", 115 - "city": "string", 116 - "inn": "string", 117 - "kpp": "string", 118 - "address": "string", 119 - "addressFact": "string", 120 - "email": "string", 121 - "director": "string", 122 - "bankName": "string", 123 - "bankBIK": "string", 124 - "bankRS": "string", 125 - "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" ~/~/ Корр. счет 126 126 } 127 127 128 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 129 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 130 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 131 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 132 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 133 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 134 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 135 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 136 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 137 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 138 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 139 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 140 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 141 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 142 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 143 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 144 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 145 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 146 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 147 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 148 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 149 - 150 150 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 151 151 152 152 (% class="box infomessage" %) ... ... @@ -160,7 +160,7 @@ 160 160 161 161 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 162 162 163 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 164 164 165 165 (% style="color:#000000" %)Метод запроса: **POST** 166 166 ... ... @@ -175,23 +175,15 @@ 175 175 (% style="color:#000000" %)Ответ: 176 176 177 177 { 178 - "agentId": "",(% style="color:#000000" %) (%%) 179 - "parentId": "", 180 - "name": "string", 181 - "fullName": "string", 182 - "agentInfoType": 0, 183 -(% 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 - Отказ) 184 184 } 185 185 186 - 187 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 188 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 189 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 190 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 191 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 192 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 193 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 194 - 195 195 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 196 196 197 197 (% class="box successmessage" %) ... ... @@ -210,7 +210,7 @@ 210 210 Параметры в теле запроса (JSON): 211 211 212 212 { 213 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 214 214 "name": "string", ~/~/ имя 215 215 "fullName": "string", ~/~/ полное наименование 216 216 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -230,6 +230,7 @@ 230 230 "bankKS": "string" ~/~/ корр. счёт 231 231 } 232 232 195 + 233 233 Ответ: 234 234 235 235 { ... ... @@ -254,28 +254,6 @@ 254 254 "bankKS": "string" ~/~/ корр. счёт 255 255 } 256 256 257 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 258 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 259 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 260 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 261 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 262 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 263 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 264 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 265 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 266 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 267 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 268 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 269 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 270 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 271 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 272 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 273 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 274 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 275 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 276 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 277 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 278 - 279 279 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 280 280 281 281 (% class="box warningmessage" %) ... ... @@ -291,6 +291,7 @@ 291 291 292 292 В заголовках запроса: X-Auth: Токен авторизации 293 293 235 + 294 294 Параметры в теле запроса (JSON): 295 295 296 296 { ... ... @@ -315,6 +315,7 @@ 315 315 "bankKS": "string" ~/~/ корр. счёт 316 316 } 317 317 260 + 318 318 Ответ: 319 319 320 320 { ... ... @@ -357,21 +357,6 @@ 357 357 358 358 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 359 359 360 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 361 - 362 -(% class="box warningmessage" %) 363 -((( 364 -**PUT /api/v3/agents/{id}/changeStatus/{status}** 365 -))) 366 - 367 -Метод позволяет изменить статус клиента, указанного в запросе. 368 - 369 -В пути указывается GUID клиента и статус клиента. 370 - 371 -**status **- значение 0 - заблокирован, 1 - активен. 372 - 373 -Ответ: Code 204 374 - 375 375 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 376 376 377 377 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -423,6 +423,7 @@ 423 423 ], 424 424 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 425 425 } 354 + 426 426 { 427 427 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 428 428 "lastName": "string", ... ... @@ -434,10 +434,15 @@ 434 434 "password": "string", 435 435 "email": "string", 436 436 366 + 437 437 (% style="text-align:left" %) 438 438 (% style="color:#000000; font-weight:normal" %)Ответ: 439 -{ 440 - "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 пользователя 441 441 "lastName": "" , ~/~/ Фамилия , 442 442 "firstName": "" , ~/~/ Имя 443 443 "position": "" , ~/~/ Должность ... ... @@ -454,8 +454,9 @@ 454 454 "kind": "" , ~/~/ тип аутентификации 455 455 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 456 456 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 457 -} 458 458 392 +(% style="text-align:left" %) 393 +(% style="color:#000000; font-weight:normal" %)} 459 459 460 460 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 461 461 ... ... @@ -476,16 +476,19 @@ 476 476 477 477 (% style="color:#000000" %)Параметры в теле запроса (JSON): 478 478 479 -(% style="color:#000000" %){(%%) 414 +(% style="color:#000000" %){ 415 + 480 480 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 481 481 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 482 482 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 483 483 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 + 484 484 (% style="color:#000000" %)} 485 485 486 486 (% style="color:#000000" %)Ответ: 487 487 488 488 (% style="color:#000000" %){ (%%) 426 + 489 489 "id": "" , ~/~/ идентификатор пользователя 490 490 "lastName": "" , ~/~/ фамилия 491 491 "firstName": "" , ~/~/ имя ... ... @@ -499,6 +499,7 @@ 499 499 "sessionDuration":"", ~/~/ длительность сессии в минутах 500 500 "status": "1", ~/~/ статус пользователя 501 501 "lastLogged": "", ~/~/ дата/время последней авторизации 440 + 502 502 (% style="color:#000000" %)} 503 503 504 504 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -572,8 +572,10 @@ 572 572 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 573 573 574 574 (% lang="en-US" style="text-align:left" %) 575 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 576 - "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 пользователя 577 577 "lastName": "" , ~/~/ фамилия 578 578 "firstName": "" , ~/~/ имя 579 579 "position": "" , ~/~/ должность ... ... @@ -595,7 +595,9 @@ 595 595 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 596 596 }, 597 597 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 598 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 + 541 +(% lang="en-US" style="text-align:left" %) 599 599 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 600 600 601 601 (% lang="en-US" style="text-align:left" %) ... ... @@ -602,8 +602,10 @@ 602 602 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 603 603 604 604 (% lang="en-US" style="text-align:left" %) 605 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 606 - "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": "" , ~/~/ идентификатор пользователя 607 607 "lastName": "" , ~/~/ фамилия 608 608 "firstName": "" , ~/~/ имя 609 609 "position": "" , ~/~/ должность ... ... @@ -624,8 +624,10 @@ 624 624 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 625 625 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 626 626 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 627 -} 628 628 573 +(% lang="en-US" style="text-align:left" %) 574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 + 629 629 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 630 630 631 631 (% class="box warningmessage" %) ... ... @@ -645,10 +645,12 @@ 645 645 646 646 (% style="color:#000000" %)Параметры в теле запроса (JSON): 647 647 648 -(% style="color:#000000" %){(%%) 595 +(% style="color:#000000" %){ 596 + 649 649 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 650 650 "description": "" , ~/~/ описание 651 651 "data": "" , ~/~/ данные, связанные со сменой статуса 600 + 652 652 (% style="color:#000000" %)} 653 653 654 654 (% style="text-align:left" %) ... ... @@ -670,7 +670,7 @@ 670 670 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 671 671 672 672 [ 673 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 674 674 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 675 675 ] 676 676 ... ... @@ -762,6 +762,7 @@ 762 762 "maxspeed": 0, 763 763 "width": 0, 764 764 "imbeddedtrailer": true, 714 + "fueloutlay": 0, 765 765 "hoppercapacity": 0, 766 766 "hopperdischargespeed": 0, 767 767 "modelType": 0, ... ... @@ -778,8 +778,9 @@ 778 778 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 779 779 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 780 780 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 781 781 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 782 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость 2выгрузки из бункера, л/сек733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 783 783 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 784 784 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 785 785 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -871,24 +871,12 @@ 871 871 "maxspeed": 0, 872 872 "width": 0, 873 873 "imbeddedtrailer": true, 825 + "fueloutlay": 0, 874 874 "hoppercapacity": 0, 875 875 "hopperdischargespeed": 0, 876 876 "modelType": 0 877 877 } 878 878 879 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 880 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 881 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 882 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 883 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 884 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 885 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 886 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 887 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 888 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 889 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 890 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 891 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 892 892 893 893 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 894 894 ... ... @@ -943,20 +943,6 @@ 943 943 "modelType": 0 944 944 } 945 945 946 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 947 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 948 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 949 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 950 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 951 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 952 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 953 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 954 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 955 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 956 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 957 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 958 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 959 - 960 960 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 961 961 962 962 (% class="box errormessage" %) ... ... @@ -1012,15 +1012,19 @@ 1012 1012 "deviceTypeName": "", ~/~/ Название типа устройства 1013 1013 "sim1": "", ~/~/ Номер SIM1 1014 1014 "sim2": "", ~/~/ Номер SIM2 940 + 1015 1015 "parentId": "", ~/~/ ID клиента-родителя 1016 1016 "parentName": "", ~/~/ Наименование клиента-родителя 1017 1017 "modelId": "", ~/~/ ID модели объекта 1018 1018 "modelName": "", ~/~/ Имя модели объекта 945 + 1019 1019 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1020 1020 "unitName": "string", ~/~/ Наименование подразделения 1021 1021 "status": 0, ~/~/ Статус объекта 949 + 1022 1022 "createdAt": "", ~/~/ Дата создания объекта 1023 1023 }, 952 + 1024 1024 "customFields": [ ~/~/ Произвольные поля 1025 1025 { 1026 1026 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1043,7 +1043,8 @@ 1043 1043 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1044 1044 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1045 1045 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1046 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 975 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 + 1047 1047 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1048 1048 "mileageCoeff": 0, ~/~/ коэффициент пробега 1049 1049 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1073,6 +1073,7 @@ 1073 1073 "retries": 0 ~/~/ Количество попыток 1074 1074 } 1075 1075 ], 1006 + 1076 1076 "sensors": [ ~/~/ Датчики 1077 1077 { 1078 1078 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1113,19 +1113,31 @@ 1113 1113 }, 1114 1114 1115 1115 ~/~/ Характерные для произвольного: 1047 + 1116 1116 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 + 1117 1117 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 + 1118 1118 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 + 1119 1119 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 + 1120 1120 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 + 1121 1121 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 + 1122 1122 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 + 1123 1123 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 + 1124 1124 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 + 1125 1125 ~/~/ "ValueOn": "Вкл.", 1067 + 1126 1126 ~/~/ "ValueOff": "Выкл." 1127 1127 "summaryMaxValue": 0 ~/~/ Макс. значение 1128 1128 } 1071 + 1129 1129 "drivers": [ ~/~/ Водители 1130 1130 { 1131 1131 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1134,6 +1134,7 @@ 1134 1134 "isDefault": true ~/~/ По умолчанию 1135 1135 } 1136 1136 ], 1080 + 1137 1137 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1138 1138 { 1139 1139 "id": "", ~/~/ ID задания ... ... @@ -1150,7 +1150,8 @@ 1150 1150 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1151 1151 } 1152 1152 ], 1153 -"statusHistory": [ ~/~/ История статусов 1097 + 1098 + "statusHistory": [ ~/~/ История статусов 1154 1154 { 1155 1155 "status": 0, 1156 1156 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1158,6 +1158,7 @@ 1158 1158 "additionalInfo": "string" 1159 1159 } 1160 1160 ] 1106 + 1161 1161 } 1162 1162 ))) 1163 1163 ... ... @@ -1167,73 +1167,6 @@ 1167 1167 (% style="text-align:left" %) 1168 1168 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1169 1169 1170 - 1171 -== **Отправить команду на терминал** == 1172 - 1173 -(% class="box successmessage" %) 1174 -((( 1175 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1176 -))) 1177 - 1178 -Команда для отправки на тс. 1179 - 1180 -{ 1181 -"id": "", ~/~/идентификатор произвольного поля 1182 -"command": "", ~/~/ Текст команды 1183 -"retries": "", ~/~/ Количество попыток 1184 -"idTemplate": "" ~/~/ ID шаблона команды 1185 -} 1186 - 1187 - 1188 -== **Получить ответ на отправленную на ТС команду** == 1189 - 1190 -(% class="box infomessage" %) 1191 -((( 1192 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1193 -))) 1194 - 1195 -Идентификатор команды: cmdid 1196 - 1197 -Запрос от терминала на ответ команды 1198 - 1199 -Пример ответ от терминала: 1200 - 1201 -ID= "" ~/~/ идентификатор произвольного поля 1202 -Soft="" ~/~/ версия софта 1203 -GPS=4 ~/~/ тип трекера 1204 -Time=11:05:43 28.06.24 ~/~/ время запроса 1205 -Lat=45.056221 ~/~/ широта 1206 -Lon=39.035938 ~/~/ долгота 1207 -Speed=0.0 ~/~/ скорость 1208 -Course=181.4 ~/~/направление 1209 - 1210 -((( 1211 -== **Список отправленных объекту команд с ответами** == 1212 - 1213 -(% class="box infomessage" %) 1214 -((( 1215 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1216 -))) 1217 - 1218 -Идентификатор ТС: vehicleId 1219 - 1220 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1221 - 1222 -Пример ответа терминала 1223 - 1224 -[ 1225 -{ 1226 -"id": "", ~/~/ идентификатор пользователя 1227 -"commandText": "", ~/~/Текст команды. 1228 -"templateId": "", ~/~/Идентификатор шаблона 1229 -"updated": "", ~/~/ Время отправки 1230 -"tryCount": 0, ~/~/ Количество попыток отправки команды 1231 -"answer": "", ~/~/ Ответ терминала. 1232 -"status": "" ~/~/ Статус отправки 1233 -} 1234 -] 1235 -))) 1236 - 1237 1237 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1238 1238 1239 1239 (% class="box successmessage" %) ... ... @@ -1251,7 +1251,8 @@ 1251 1251 1252 1252 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1253 1253 1254 -(% style="color:#000000" %){(%%) 1133 +(% style="color:#000000" %){ 1134 + 1255 1255 "parentId": "" , ~/~/ ID клиента 1256 1256 "name": "" , ~/~/ имя ТС 1257 1257 "imei": "" , ~/~/ IMEI ... ... @@ -1272,6 +1272,7 @@ 1272 1272 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1273 1273 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1274 1274 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 + 1275 1275 "mileageCalcMethod": 0, 1276 1276 "mileageCoeff": 0, 1277 1277 "locationByCellId": true, ... ... @@ -1304,6 +1304,7 @@ 1304 1304 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1305 1305 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1306 1306 } 1188 + 1307 1307 "drivers": [ ~/~/ Водители 1308 1308 { 1309 1309 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1318,7 +1318,8 @@ 1318 1318 "retries": 0 1319 1319 } 1320 1320 ], 1321 -"sensors": [ ~/~/ Датчики 1203 + 1204 + "sensors": [ ~/~/ Датчики 1322 1322 { 1323 1323 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1324 1324 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1356,17 +1356,29 @@ 1356 1356 "additionalProp2": "string", 1357 1357 "additionalProp3": "string" 1358 1358 }, 1242 + 1359 1359 ~/~/ Характерные для произвольного: 1244 + 1360 1360 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 + 1361 1361 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 + 1362 1362 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 + 1363 1363 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 + 1364 1364 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 + 1365 1365 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 + 1366 1366 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 + 1367 1367 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 + 1368 1368 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 + 1369 1369 ~/~/ "ValueOn": "Вкл.", 1264 + 1370 1370 ~/~/ "ValueOff": "Выкл." 1371 1371 "summaryMaxValue": 0 ~/~/ Макс. значение 1372 1372 } ... ... @@ -1385,7 +1385,8 @@ 1385 1385 1386 1386 (% style="color:#000000" %)Ответ: 1387 1387 1388 -(% style="color:#000000" %){(%%) 1283 +(% style="color:#000000" %){ 1284 + 1389 1389 "vehicleId": "", ~/~/ID ТС 1390 1390 "parentId": "", ~/~/Guid владельца ТС 1391 1391 "name": "", ~/~/Имя объекта ... ... @@ -1423,6 +1423,8 @@ 1423 1423 "kind": "", ~/~/ Вид периодичности по времени 1424 1424 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1425 1425 } 1322 + 1323 +(% style="text-align:left" %) 1426 1426 (% style="color:#000000" %)} 1427 1427 1428 1428 **Валидация:** ... ... @@ -1437,7 +1437,7 @@ 1437 1437 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1438 1438 ))) 1439 1439 1440 -(% style="color:#000000" %)Метод позволяет получить список доступныхобъектовмониторинга (транспортных средств)с их основнымипараметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1338 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1441 1441 1442 1442 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1443 1443 ... ... @@ -1481,7 +1481,8 @@ 1481 1481 (% style="color:#000000" %)Ответ: 1482 1482 1483 1483 (% style="color:#000000" %){ 1484 - "vehicleId": "" ~/~/ идентификатор объекта 1382 + 1383 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1485 1485 "name": "" ~/~/ наименование объекта 1486 1486 "imei": "" ~/~/ IMEI объекта 1487 1487 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1540,11 +1540,13 @@ 1540 1540 "data": "", ~/~/ Данные 1541 1541 "overwrite": false, ~/~/ Флаг перезаписи 1542 1542 "stage": "", ~/~/ Состояние, может быть null 1442 + 1543 1543 (% style="color:#000000" %)} 1544 1544 1545 1545 (% style="color:#000000" %)Ответ: 1546 1546 1547 -(% style="color:#000000" %){(%%) 1447 +(% style="color:#000000" %){ 1448 + 1548 1548 "status": "", ~/~/ значение статуса 1549 1549 "date": "", ~/~/ Дата смены статуса 1550 1550 "description": "", ~/~/ Описание ... ... @@ -1551,10 +1551,10 @@ 1551 1551 "data": "", ~/~/ Данные 1552 1552 "overwrite": false, ~/~/ Флаг перезаписи 1553 1553 "stage": "", ~/~/ Состояние 1455 + 1456 +(% style="text-align:left" %) 1554 1554 (% style="color:#000000" %) } 1555 1555 1556 -== == 1557 - 1558 1558 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1559 1559 1560 1560 (% class="box warningmessage" %) ... ... @@ -1642,7 +1642,8 @@ 1642 1642 "retries": 0 1643 1643 } 1644 1644 ], 1645 -"sensors": [ ~/~/ Датчики 1546 + 1547 + "sensors": [ ~/~/ Датчики 1646 1646 { 1647 1647 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1648 1648 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1680,17 +1680,29 @@ 1680 1680 "additionalProp2": "string", 1681 1681 "additionalProp3": "string" 1682 1682 }, 1585 + 1683 1683 ~/~/ Характерные для произвольного: 1587 + 1684 1684 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 + 1685 1685 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 + 1686 1686 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 + 1687 1687 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 + 1688 1688 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 + 1689 1689 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 + 1690 1690 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 + 1691 1691 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 + 1692 1692 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 + 1693 1693 ~/~/ "ValueOn": "Вкл.", 1607 + 1694 1694 ~/~/ "ValueOff": "Выкл." 1695 1695 "summaryMaxValue": 0 ~/~/ Макс. значение 1696 1696 } ... ... @@ -1710,7 +1710,9 @@ 1710 1710 (% style="color:#000000" %)Ответ: 1711 1711 1712 1712 (% lang="en-US" style="text-align:left" %) 1713 -(% 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" %) 1714 1714 "vehicleId": "", ~/~/ ID ТС 1715 1715 "parentId": "", ~/~/ ID клиента 1716 1716 "name": "", ~/~/ имя ТС ... ... @@ -1751,6 +1751,8 @@ 1751 1751 "kind": "", ~/~/ Вид периодичности по времени 1752 1752 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1753 1753 } 1670 + 1671 +(% lang="en-US" style="text-align:left" %) 1754 1754 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1755 1755 1756 1756 **Валидация:** ... ... @@ -1791,15 +1791,18 @@ 1791 1791 1792 1792 (% style="color:#000000" %)Метод запроса: **GET** 1793 1793 1794 -(% 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]] 1795 1795 1796 1796 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1797 1797 1798 1798 (% style="color:#000000" %)Ответ: 1799 1799 1800 -(% style="color:#000000" %){(%%) 1718 +(% style="color:#000000" %){ 1719 + 1801 1801 "deviceTypeId" : "", ~/~/ ID типа устройства 1802 1802 "deviceTypeName" : "" ~/~/ Название типа устройства 1722 + 1723 +(% style="text-align:left" %) 1803 1803 (% style="color:#000000" %)} 1804 1804 1805 1805 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1821,10 +1821,13 @@ 1821 1821 1822 1822 (% style="color:#000000" %)Ответ: 1823 1823 1824 -(% style="color:#000000" %){(%%) 1745 +(% style="color:#000000" %){ 1746 + 1825 1825 "id": "", ~/~/ ID типа датчика 1826 1826 "name": "", ~/~/ Название 1827 1827 "description": "", ~/~/ Описание 1750 + 1751 +(% style="text-align:left" %) 1828 1828 (% style="color:#000000" %)} 1829 1829 1830 1830 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1868,56 +1868,6 @@ 1868 1868 } 1869 1869 ] 1870 1870 1871 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1872 - 1873 -(% class="box infomessage" style="text-align: left;" %) 1874 -((( 1875 -**POST /api/v3/terminalMessages/mapping** 1876 -))) 1877 - 1878 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1879 - 1880 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1881 - 1882 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1883 - 1884 -{ 1885 - "protocolType": 0, 1886 - "params": ["string"] 1887 -} 1888 - 1889 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1890 -|protocolType|ID типа протокола 1891 -|params|((( 1892 -Массив наименований параметров в сообщении 1893 -))) 1894 - 1895 -Ответ: 1896 - 1897 -{ 1898 - "protocolType": 0, 1899 - "mapping": { 1900 - "additionalProp1": { 1901 - "inputType": 0, 1902 - "inputNumber": 0 1903 - }, 1904 - "additionalProp2": { 1905 - "inputType": 0, 1906 - "inputNumber": 0 1907 - } 1908 - } 1909 -} 1910 - 1911 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1912 -|protocolType|Тип протокола 1913 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1914 -|inputNumber|((( 1915 -Номер входа 1916 -))) 1917 - 1918 -(% class="wikigeneratedid" %) 1919 -Перечень 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/]] 1920 - 1921 1921 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1922 1922 1923 1923 (% class="box infomessage" %) ... ... @@ -1942,11 +1942,6 @@ 1942 1942 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1943 1943 } 1944 1944 1945 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1946 -|vehicleId|ID объекта 1947 -|from|Дата и время начала периода запроса 1948 -|to|Дата и время окончания периода запроса 1949 - 1950 1950 Ответ: 1951 1951 1952 1952 [ ... ... @@ -1953,43 +1953,80 @@ 1953 1953 { 1954 1954 "messages": [ 1955 1955 { 1956 - "deviceTime": "2023-11-29T07:40:44.052Z", 1957 - "serverTime": "2023-11-29T07:40:44.052Z", 1958 - "speed": 0, 1959 - "altitude": 0, 1960 - "latitude": 0, 1961 - "longitude": 0, 1962 - "satellites": 0, 1963 - "course": 0, 1964 - "voltage": 0, 1965 - "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": { ~/~/ список параметров датчиков передаваемых терминалом 1966 1966 "additionalProp1": "string", 1967 1967 "additionalProp2": "string", 1968 1968 "additionalProp3": "string" 1969 1969 }, 1970 - "photoCount": 0, 1971 - "lbsCorrectedCoords": true, 1972 - "protocolType": 0 1838 + "photoCount": 0 ~/~/ Кол-во фото 1973 1973 } 1974 1974 ] 1975 1975 } 1976 1976 ] 1977 1977 1978 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1979 -|deviceTime|Время сообщения терминала 1980 -|serverTime|Время когда сообщение поступило на сервер 1981 -|speed|Скорость 1982 -|altitude|Высота над уровнем моря 1983 -|latitude|Широта 1984 -|longitude|Долгота 1985 -|satellites|Кол-во спутников 1986 -|course|Курс 1987 -|voltage|Бортовое напряжение 1988 -|parameters|Список параметров и их значений 1989 -|photoCount|Количество фото 1990 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 1991 -|protocolType|ID типа протокола 1844 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1992 1992 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 + 1993 1993 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1994 1994 1995 1995 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2123,96 +2123,6 @@ 2123 2123 } 2124 2124 ] 2125 2125 2126 - 2127 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2128 - 2129 -(% class="box infomessage" %) 2130 -((( 2131 -**POST /api/v3/vehicles/moveStop** 2132 -))) 2133 - 2134 -Метод запроса: **POST** 2135 - 2136 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2137 - 2138 -В заголовках запроса: X-Auth: Токен авторизации 2139 - 2140 - 2141 -Тело запроса: 2142 - 2143 -{ 2144 - "vehicleIds": [ ], ~/~/ Список ID объектов 2145 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2146 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2147 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2148 -} 2149 - 2150 -Ответ: 2151 - 2152 -[ 2153 - { 2154 - "vehicleId": 0, ~/~/ ID объекта 2155 - "vehicleName": "string", ~/~/ Имя объекта 2156 - "moves": [ ~/~/ Событие движения 2157 - { 2158 - "mileage": 0, ~/~/ Пробег, км 2159 - "eventId": 0, ~/~/ Идентификатор события 2160 - "eventName": "string", ~/~/ Название события 2161 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2162 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2163 - "duration": 0 ~/~/ Продолжительность события, секунд 2164 - } 2165 - ], 2166 - "stops": [ ~/~/ События стоянок 2167 - { 2168 - "address": "string", ~/~/ Адрес события 2169 - "eventId": 0, ~/~/ Идентификатор события 2170 - "eventName": "string", ~/~/ Название события 2171 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2172 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2173 - "duration": 0 ~/~/ Продолжительность события, секунд 2174 - } 2175 - ] 2176 - } 2177 -] 2178 - 2179 - 2180 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2181 - 2182 -(% class="box infomessage" %) 2183 -((( 2184 -**POST /api/v3/vehicles/getlastdata** 2185 -))) 2186 - 2187 -Метод запроса: **POST** 2188 - 2189 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2190 - 2191 -В заголовках запроса: X-Auth: Токен авторизации 2192 - 2193 - 2194 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2195 - 2196 -Ответ: 2197 - { 2198 - "vehicleId": 0, ~/~/Идентификатор объекта. 2199 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2200 - "vehicleNumber": "string",~/~/Номер объекта. 2201 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2202 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2203 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2204 - "speed": 0,~/~/Скорость объекта. 2205 - "course": 0,~/~/Курс движения [0;360] 2206 - "latitude": 0,~/~/Широта [-90°;90°]. 2207 - "longitude": 0,~/~/Долгота [-180°;180°]. 2208 - "address": "string",~/~/Адрес. 2209 - "geozones": [ ~/~/Сведения по геозонам. 2210 - { 2211 - "id": 0, 2212 - "name": "string" 2213 - } 2214 - 2215 - 2216 2216 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2217 2217 2218 2218 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -3111,83 +3111,6 @@ 3111 3111 Success 3112 3112 3113 3113 3114 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3115 - 3116 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3117 - 3118 -(% class="box infomessage" %) 3119 -((( 3120 -**POST /api/v3/Trailers** 3121 -))) 3122 - 3123 -Пример запроса: 3124 - 3125 -{ 3126 - "startDate": "2023-11-14T10:48:03.671Z", 3127 - "endDate": "2023-11-14T10:48:03.671Z", 3128 - "ids": [ 0 ], 3129 - "timezone": 0 3130 -} 3131 - 3132 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3133 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3134 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3135 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3136 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3137 - 3138 -Пример ответа: 3139 - 3140 -[ 3141 - { 3142 - "SD": "2023-11-14T10:48:03.717Z", 3143 - "ED": "2023-11-14T10:48:03.717Z", 3144 - "id": 0, 3145 - "SLat": 0, 3146 - "SLon": 0, 3147 - "ELat": 0, 3148 - "ELon": 0, 3149 - "mileage": 0 3150 - "Duration": 0 3151 - "Address": "string", 3152 - "Address2": "string", 3153 - "name": "string", 3154 - "rid": "string", 3155 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3156 - "trailer": { 3157 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3158 - "Number": "string", 3159 - "Description": "string", 3160 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3161 - "ExternalID": "string", 3162 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3163 - "CreateTime": "2023-11-14T10:48:03.717Z", 3164 - "UpdateTime": "2023-11-14T10:48:03.717Z", 3165 - "IsDeleted": true 3166 - }, 3167 - "filesCount": 0, 3168 - } 3169 -] 3170 - 3171 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3172 -|SD|Дата и время начала события 3173 -|ED|Дата и время окончания события 3174 -|id|ID объекта 3175 -|SLat|Широта начальной координаты 3176 -|SLon|Долгота начальной координаты 3177 -|ELat|Широта конечной координаты 3178 -|ELon|Долгота конечной координаты 3179 -|mileage|Пробег 3180 -|Duration|Продолжительность 3181 -|Address|Адрес начального местоположения 3182 -|Address2|Адрес конечного местоположения 3183 -|name|Имя радиометки 3184 -|rid|Номер радиометки 3185 -|rguid|ID радиометки 3186 -|trailer|Информация об агрегате 3187 -|ModelGuid|ID агрегата 3188 -|Number|Название/номер агрегата 3189 -|Description|Текст примечания агрегата 3190 - 3191 3191 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3192 3192 3193 3193 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -3209,19 +3209,13 @@ 3209 3209 { 3210 3210 "name": "string", 3211 3211 "number": 0, 3212 - "period": 0, 2951 + "period": 0, ~/~/ Частота трансляции радиометки 3213 3213 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3214 3214 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 + "deleted": true 3215 3215 } 3216 3216 ] 3217 3217 3218 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3219 -|parentId|ID клиента 3220 -|name|Название карты-метки 3221 -|number|Номер 3222 -|period|Период запросов в секундах (работает только для агрегатов) 3223 -|id|ID карты-метки 3224 - 3225 3225 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3226 3226 3227 3227 (% class="box infomessage" %) ... ... @@ -3237,18 +3237,13 @@ 3237 3237 { 3238 3238 "name": "string", 3239 3239 "number": 0, 3240 - "period": 0, 2973 + "period": 0, ~/~/ Частота трансляции радиометки 3241 3241 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3242 3242 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 + "deleted": true 3243 3243 } 3244 3244 ] 3245 3245 3246 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3247 -|name|Название карты-метки 3248 -|number|Номер 3249 -|period|Период запросов в секундах (работает только для агрегатов) 3250 -|id|ID карты-метки 3251 -|parentId|ID клиента 3252 3252 3253 3253 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3254 3254 ... ... @@ -3264,6 +3264,7 @@ 3264 3264 "number": 0, 3265 3265 "period": 0, 3266 3266 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 + "deleted": true 3267 3267 } 3268 3268 3269 3269 Ответ: ... ... @@ -3274,15 +3274,9 @@ 3274 3274 "period": 0, 3275 3275 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3276 3276 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 + "deleted": true 3277 3277 } 3278 3278 3279 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3280 -|name|Название карты-метки 3281 -|number|Номер 3282 -|period|Период запросов в секундах (работает только для агрегатов) 3283 -|id|ID карты-метки 3284 -|parentId|ID клиента 3285 - 3286 3286 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3287 3287 3288 3288 (% class="box warningmessage" %) ... ... @@ -3298,6 +3298,7 @@ 3298 3298 "period": 0, 3299 3299 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3300 3300 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 + "deleted": true 3301 3301 } 3302 3302 3303 3303 Ответ: ... ... @@ -3308,15 +3308,9 @@ 3308 3308 "period": 0, 3309 3309 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3310 3310 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 + "deleted": true 3311 3311 } 3312 3312 3313 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3314 -|name|Название карты-метки 3315 -|number|Номер 3316 -|period|Период запросов в секундах (работает только для агрегатов) 3317 -|id|ID карты-метки 3318 -|parentId|ID клиента 3319 - 3320 3320 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3321 3321 3322 3322 (% class="box errormessage" %) ... ... @@ -3324,7 +3324,7 @@ 3324 3324 **DELETE /api/v3/Rfids/{rfidGuid}** 3325 3325 ))) 3326 3326 3327 -Передаем параметр **rfidGuid**- идентификатор карты-метки3045 +Передаем параметр rfidGuid - идентификатор карты-метки 3328 3328 3329 3329 Ответ: 3330 3330 ... ... @@ -3565,8 +3565,6 @@ 3565 3565 **PUT /api/v3/Billing/client/balance** 3566 3566 ))) 3567 3567 3568 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3569 - 3570 3570 Тело запроса: 3571 3571 3572 3572 { ... ... @@ -3580,50 +3580,6 @@ 3580 3580 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3581 3581 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3582 3582 3583 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3584 - 3585 -(% class="box warningmessage" %) 3586 -((( 3587 -**PUT /api/v3/billing/client/balance/deposit** 3588 -))) 3589 - 3590 -Создает операцию **Пополнение **с указанной суммой 3591 - 3592 -Тело запроса: 3593 - 3594 -{ 3595 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3596 - "Balance": 0 3597 -} 3598 - 3599 -Ответ: Success 3600 - 3601 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3602 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3603 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3604 - 3605 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3606 - 3607 -Создает операцию **Списание **с указанной суммой 3608 - 3609 -(% class="box warningmessage" %) 3610 -((( 3611 -**PUT /api/v3/billing/client/balance/withdraw** 3612 -))) 3613 - 3614 -Тело запроса: 3615 - 3616 -{ 3617 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3618 - "Balance": 0 3619 -} 3620 - 3621 -Ответ: Success 3622 - 3623 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3624 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3625 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3626 - 3627 3627 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3628 3628 3629 3629 (% class="box warningmessage" %) ... ... @@ -3686,7 +3686,6 @@ 3686 3686 3687 3687 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3688 3688 |ClientId|Идентификатор клиента 3689 -|PlanId|Идентификатор тарифного плана 3690 3690 |Feature|Код услуги 3691 3691 |IsEnabled|Признак, определяющий активирована ли услуга 3692 3692 |IsFactual|Признак, определяющий расчёт по факту ... ... @@ -3696,743 +3696,6 @@ 3696 3696 |PeriodValue|Значение периода. 3697 3697 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3698 3698 3699 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3700 - 3701 -(% class="box warningmessage" %) 3702 -((( 3703 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3704 -))) 3705 - 3706 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3707 - 3708 -(% class="box infomessage" %) 3709 -((( 3710 -**POST /api/v3/vehicles/import/{agentId}** 3711 -))) 3712 - 3713 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3714 - 3715 -В пути указывается **agentId** - id клиента. 3716 - 3717 -**Заголовок** 3718 - 3719 -**X-Auth: [токен авторизации]** 3720 - 3721 -**Параметры** 3722 - 3723 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3724 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3725 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3726 - 3727 -В теле использовать тип **form-data,** тип значения** file** 3728 - 3729 -**Ключи** 3730 - 3731 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3732 -|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3733 -|csv|В значении передаем файл датчиков, формат **csv** 3734 - 3735 -Ответ: 3736 - 3737 -{ 3738 - "vehicleId": 0, 3739 - "name": "string", 3740 - "errors": ["string"] 3741 -} 3742 - 3743 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3744 -|vehicleId|ID созданного объекта 3745 -|name|Имя созданного объекта 3746 -|errors|Ошибки и их описание 3747 - 3748 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3749 - 3750 -(% class="box infomessage" %) 3751 -((( 3752 -**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3753 -))) 3754 - 3755 -(% class="wikigeneratedid" %) 3756 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3757 - 3758 -(% class="wikigeneratedid" %) 3759 -В пути указывается **vehicleId **- id объекта. 3760 - 3761 -**Заголовок** 3762 - 3763 -**X-Auth: [токен авторизации]** 3764 - 3765 -В теле использовать тип **form-data.** 3766 - 3767 -Ключи: 3768 - 3769 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3770 -|**history**|В значении передавать файл с историей 3771 - 3772 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3773 - 3774 -Ответ: 3775 - 3776 -{ 3777 - "results": [ 3778 - { 3779 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3780 - "vehicleId": 0, 3781 - "errors": [ 3782 - "string" 3783 - ], 3784 - "firstMessageDate": "2023-11-28T09:27:58.949Z", 3785 - "lastMessageDate": "2023-11-28T09:27:58.949Z", 3786 - "producedCount": 0, 3787 - "msgCount": 0 3788 - } 3789 - ] 3790 -} 3791 - 3792 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3793 -|results|Результаты импорта в разрезе ТС 3794 -|vehicleGuid|Guid ТС 3795 -|vehicleId|ID ТС 3796 -|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3797 -|firstMessageDate|Дата первого импортированного сообщения (UTC) 3798 -|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3799 -|producedCount|Кол-во успешно отправленных в шину данных сообщений 3800 -|msgCount|Кол-во обработанных сообщений всего 3801 - 3802 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3803 - 3804 -(% class="box infomessage" %) 3805 -((( 3806 -**GET /api/v3/vehicles/import/history/status** 3807 -))) 3808 - 3809 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3810 - 3811 -Ответ: 3812 - 3813 -{ 3814 - "activity": true, 3815 - "progress": 0, 3816 - "message": "string" 3817 -} 3818 - 3819 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3820 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3821 -|progress|Guid ТС 3822 - 3823 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3824 - 3825 -(% class="box infomessage" %) 3826 -((( 3827 -**POST /api/v3/vehicles/export** 3828 -))) 3829 - 3830 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3831 - 3832 -Тело запроса: 3833 - 3834 -[ 3835 - id 3836 -] 3837 - 3838 -Ответ: Success 200, получаете файлы с настройками. 3839 - 3840 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3841 - 3842 -(% class="box infomessage" %) 3843 -((( 3844 -**POST /api/v3/vehicles/export/history** 3845 -))) 3846 - 3847 -Метод возвращает список сообщений терминала объекта за выбранный период. 3848 - 3849 -Тело запроса: 3850 - 3851 -{ 3852 - "vehicleId": 0, 3853 - "asArchive": true, 3854 - "from": "2023-09-27T12:17:45.973Z", 3855 - "to": "2023-09-27T12:17:45.973Z" 3856 -} 3857 - 3858 -Ответ: 3859 - 3860 -Получаете файл. Сообщение: Code 200/Success 3861 - 3862 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3863 -|vehicleId|ID объекта 3864 -|asArchive|true - Архивировать файл, False - не архивировать 3865 -|from|Дата и время начала запроса 3866 -|to|Дата и время окончания запроса 3867 - 3868 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3869 - 3870 -(% class="box infomessage" %) 3871 -((( 3872 -**GET /api/v3/vehicles/export/history/status** 3873 -))) 3874 - 3875 -Метод возвращает список сообщений терминала объекта за выбранный период. 3876 - 3877 -Ответ: 3878 - 3879 -{ 3880 - "activity": true, 3881 - "progress": 0, 3882 - "message": "string" 3883 -} 3884 - 3885 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3886 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3887 -|progress|Прогресс экспорта, от 0 до 100% 3888 -|message|Текст описывающий статус 3889 - 3890 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3891 - 3892 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3893 - 3894 -(% class="box infomessage" %) 3895 -((( 3896 -**POST /api/v3/EcoDriving/rating** 3897 -))) 3898 - 3899 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3900 - 3901 -Тело запроса: 3902 - 3903 -{ 3904 - "vehicleIds": [vehicleId], 3905 - "from": "2023-11-22T09:29:48.051Z", 3906 - "to": "2023-11-22T09:29:48.051Z" 3907 -} 3908 - 3909 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3910 -|vehicleIds|Массив ID объектов 3911 -|from|Дата начала запроса 3912 -|to|Дата окончания запроса 3913 - 3914 -Ответ: 3915 - 3916 -{ 3917 - "items": [ 3918 - { 3919 - "from": "2023-11-22T09:29:48.052Z", 3920 - "to": "2023-11-22T09:29:48.052Z", 3921 - "vehicleId": 0, 3922 - "vehicleName": "string", 3923 - "vehicleModel": "string", 3924 - "penalty": 0, 3925 - "score": 0, 3926 - "totalViolations": 0, 3927 - "violationsByType": { 3928 - "overspeedingViolations": 0, 3929 - "accelerationViolations": 0, 3930 - "brakingViolations": 0, 3931 - "turningViolations": 0, 3932 - "dangerousDrivingViolations": 0, 3933 - "sensorViolations": 0 3934 - }, 3935 - "moveTime": 0, 3936 - "mileage": 0, 3937 - "tripsCount": 0, 3938 - "trips": [ 3939 - { 3940 - "penalty": 0, 3941 - "score": 0, 3942 - "violationsCount": 0, 3943 - "violationsByType": { 3944 - "overspeedingViolations": 0, 3945 - "accelerationViolations": 0, 3946 - "brakingViolations": 0, 3947 - "turningViolations": 0, 3948 - "dangerousDrivingViolations": 0, 3949 - "sensorViolations": 0 3950 - }, 3951 - "moveTime": 0, 3952 - "mileage": 0, 3953 - "motohours": 0, 3954 - "maxSpeed": 0, 3955 - "startAddress": "string", 3956 - "endAddress": "string", 3957 - "drivers": [ 3958 - { 3959 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3960 - "driverName": "string", 3961 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3962 - } 3963 - ] 3964 - } 3965 - ] 3966 - } 3967 - ] 3968 -} 3969 - 3970 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3971 -|from|Дата начала запроса 3972 -|to|Дата окончания 3973 -|vehicleId|ID объекта 3974 -|vehicleName|Имя объекта 3975 -|vehicleModel|Модель объекта 3976 -|penalty|Сумма штрафных баллов 3977 -|score|Оценка 3978 -|totalViolations|Суммарное количество нарушений 3979 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3980 -|overspeedingViolations|Превышение скорости 3981 -|accelerationViolations|Ускорение 3982 -|brakingViolations|Торможение 3983 -|turningViolations|Резкий поворот 3984 -|dangerousDrivingViolations|Резкое вождение 3985 -|sensorViolations|Нарушение по датчику 3986 -|moveTime|Время в движении 3987 -|mileage|Пробег 3988 -|tripsCount|Количество рейсов 3989 -|motohours|Моточасы 3990 -|maxSpeed|Максимальная скорость 3991 -|startAddress|Адрес начала рейса 3992 -|endAddress|Адрес окончания рейса 3993 -|drivers|Список водителей, которые были на объекте в течениии рейса 3994 -|driverGuid|Guid водителя 3995 -|driverName|Имя водителя 3996 -|driverRfid|Номер Карты-метки 3997 - 3998 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 3999 - 4000 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4001 - 4002 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4003 - 4004 -(% class="box infomessage" %) 4005 -((( 4006 -POST /api/v3/fuelcards/transactions 4007 -))) 4008 - 4009 -Метод запроса: POST 4010 - 4011 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4012 -\\В заголовках запроса: X-Auth: Токен авторизации 4013 - 4014 -Параметры в теле запроса (JSON): 4015 - 4016 -{ 4017 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4018 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4019 - "ids": [ 4020 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4021 - ], 4022 - "timezone": 0 ~/~/Таймзона 4023 -} 4024 - 4025 - 4026 -Ответ: 4027 - { 4028 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4029 - "driver": "string", ~/~/Водители, привязанные к ТК 4030 - "object": "string", ~/~/Наименование ТС 4031 - "amount": 0, ~/~/Количество топлива 4032 - "amountDut": 0, ~/~/Количество по ДУТ 4033 - "amountDiff": 0, ~/~/Разница, л 4034 - "amountDiffPerc": 0, ~/~/Разница, % 4035 - "summa": 0, ~/~/Стоимость, руб 4036 - "serviceName": "string", ~/~/Тип топлива 4037 - "price": 0, ~/~/Цена за литр, руб 4038 - "cardName": "string", ~/~/Наименование ТК 4039 - "cardNum": "string", ~/~/Номер ТК 4040 - "operator": "string", ~/~/Оператор ТК 4041 - "address": "string" ~/~/Адрес АЗС 4042 - } 4043 - 4044 - 4045 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4046 - 4047 - 4048 -== **Получение полных данных о ретрансляторе** == 4049 - 4050 -(% class="box infomessage" %) 4051 -((( 4052 -**GET ** **/api/v3/retranslations/{id}** 4053 -))) 4054 - 4055 -Идентификатор запроса: ID 4056 - 4057 - 4058 -Пример ответа: 4059 - 4060 -{ 4061 -"description": "", ~/~/ Определяет описание 4062 -"subscriberId": "", ~/~/ Подписчик 4063 -"protocolType": 0, ~/~/ Тип протокола 4064 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4065 -"address": "string", ~/~/ Адрес события 4066 -"objects": [ ~/~/Объекты для ретрансляции 4067 -{ 4068 -"id": "", ~/~/ Идентификатор объекта ретрансляции 4069 -"name": "", ~/~/ Наименование объекта ретрансляции 4070 -"imei": "", ~/~/ IMEI объекта 4071 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4072 -} 4073 - ], 4074 -"id": "", ~/~/ идентификатор пользователя 4075 -"parentId": "", ~/~/Guid родителя 4076 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4077 -} 4078 - 4079 - 4080 -== **Удаление данных ретранслятора** == 4081 - 4082 -(% class="box infomessage" %) 4083 -((( 4084 -**DELETE** **/api/v3/retranslations/{id}** 4085 -))) 4086 - 4087 -Параметр запроса: ID 4088 - 4089 - 4090 -== **Создание ретранслятора** == 4091 - 4092 -(% class="box infomessage" %) 4093 -((( 4094 -**POST ** **/api/v3/retranslations/{id}** 4095 -))) 4096 - 4097 -Запрос: 4098 - 4099 -{ 4100 -"description": "", ~/~/ Описание 4101 -"subscriberId": "", ~/~/ Подписчик 4102 -"protocolType": 0, ~/~/ Тип протокола 4103 -"address": "", ~/~/ Адрес ретрансляции 4104 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4105 -"objects": [ ~/~/Объекты для ретрансляции 4106 -{ 4107 -"id": "", ~/~/ идентификатор пользователя 4108 -"imei": "", ~/~/IMEI объекта 4109 -"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4110 -} 4111 - ] 4112 -} 4113 - 4114 - 4115 -Ответ: 4116 - 4117 -{ 4118 -"description": "string", ~/~/ Определяет описание 4119 -"subscriberId": "", ~/~/ идентификатор запроса 4120 -"protocolType": 0, ~/~/ Тип протокола 4121 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4122 -"address": "", ~/~/ Адрес события 4123 -"objects": [ ~/~/Объекты для ретрансляции 4124 -{ 4125 -"id": "", ~/~/ идентификатор пользователя 4126 -"name": "string", ~/~/ Название уведомления 4127 -"imei": "string", ~/~/IMEI объекта 4128 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4129 -} 4130 - ], 4131 -"id": "", ~/~/ идентификатор пользователя 4132 -"parentId": "", ~/~/ Guid идентификатор родителя 4133 -"deleted": true ~/~/ Признак удаления 4134 -} 4135 - 4136 - 4137 -== **Редактирование ретранслятора** == 4138 - 4139 -(% class="box infomessage" %) 4140 -((( 4141 -**PUT** **/api/v3/retranslations** 4142 -))) 4143 - 4144 -Пример запроса: 4145 - 4146 -{ 4147 -"id": "", ~/~/ идентификатор пользователя 4148 -"description": "string", ~/~/ Определяет описание 4149 -"subscriberId": "", ~/~/ идентификатор запроса 4150 -"protocolType": 0, ~/~/ Тип протокола 4151 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4152 -"address": "string", ~/~/ Адрес события 4153 -"objects": ~/~/Объекты для ретрансляции 4154 -[ 4155 -{ 4156 -"id": "", ~/~/ идентификатор пользователя 4157 -"imei": "", ~/~/IMEI объекта 4158 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4159 -} 4160 - ] 4161 -} 4162 - 4163 - 4164 -Пример ответа: 4165 - 4166 -{ 4167 -"description": "", ~/~/ Определяет описание 4168 -"subscriberId": "", ~/~/ идентификатор запроса 4169 -"protocolType": 0, ~/~/ Тип протокола 4170 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4171 -"address": "string", ~/~/ Адрес события 4172 -"objects": [ ~/~/Объекты для ретрансляции 4173 -{ 4174 -"id": "", ~/~/ идентификатор пользователя 4175 -"name": "string", ~/~/ Название уведомления 4176 -"imei": "", ~/~/IMEI объекта 4177 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4178 -} 4179 - ], 4180 -"id": "", ~/~/ идентификатор пользователя 4181 -"parentId": "", ~/~/ Guid идентификатор родителя 4182 -"deleted": true ~/~/ Признак удаления 4183 -} 4184 - 4185 - 4186 -== **Получение списка ретранслятора клиента** == 4187 - 4188 -(% class="box infomessage" %) 4189 -((( 4190 -**POST /api/v3/retranslations/find** 4191 -))) 4192 - 4193 -Пример запроса: 4194 - 4195 -{ 4196 -"id": "", ~/~/ идентификатор пользователя 4197 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4198 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4199 -} 4200 - 4201 -Ответ: 4202 - 4203 -[ 4204 -{ 4205 -"description": "", ~/~/ Определяет описание 4206 -"subscriberId": "", ~/~/ идентификатор запроса 4207 -"protocolType": 0, ~/~/ Тип протокола 4208 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4209 -"address": "string", ~/~/ Адрес события 4210 -"id": "", ~/~/ идентификатор пользователя 4211 -"parentId": "", ~/~/ Guid идентификатор родителя 4212 -"deleted": true ~/~/ Признак удаления 4213 -} 4214 -] 4215 - 4216 - 4217 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4218 - 4219 -== **API для отчета по выгрузке комбайнов** == 4220 - 4221 -(% class="box infomessage" %) 4222 -((( 4223 -POST **/api/v3/Reports/harvesterUnloading** 4224 -))) 4225 - 4226 -Пример запроса: 4227 - 4228 -{ 4229 - "byTime": 0, ~/~/ Объединение событий по времени 4230 - "byDist": 0, ~/~/ Объединение событий по расстоянию 4231 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4232 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4233 - "showNearestObjects": true, ~/~/Показывать объекты рядом? 4234 - "vehicleIds": [ ~/~/ Список id объектов для анализа 4235 - 0 4236 - ], 4237 - "from": "", ~/~/ Дата и время начало запроса 4238 - "to": "", ~/~/ Дата и время окончания запроса 4239 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4240 -} 4241 - 4242 -Пример ответа: 4243 - 4244 -[ 4245 - { 4246 - "harvesterName": "", ~/~/Комбайн, номер 4247 - "harvesterId": 0, ~/~/Комбайн, id 4248 -"harvesterModel": "", ~/~/ Модель комбайна 4249 -"hopperCapacity": 0, ~/~/ Объем бункера м3 4250 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4251 - "events": [ ~/~/Список событий в разрезе комбайна 4252 - { 4253 - "driverId": "", ~/~/Идентификатор водителя 4254 - "driverName": "", ~/~/Водитель комбайна, ФИО 4255 - "RFID": "", ~/~/ идентификатор карты-метки 4256 - "rfidName": "", ~/~/Водитель комбайна, имя метки 4257 - "vehicleId": 0, ~/~/идентификатор объекта 4258 - "vehicleName": "string", ~/~/ Имя объекта 4259 - "modelName": "string", ~/~/ Имя модели объекта 4260 - "nearestVehicles": [ ~/~/Объекты рядом 4261 - { 4262 - "vehicleId": 0, ~/~/идентификатор объекта 4263 - "vehicleName": "string" ~/~/ Имя объекта 4264 - } 4265 - ], 4266 - "fields": [ ~/~/Поля, где происходила выгрузка 4267 - { 4268 - "id": 0, ~/~/ идентификатор пользователя 4269 - "name": "string" ~/~/ имя пользователя 4270 - } 4271 - ], 4272 - "event": "string", ~/~/Событие 4273 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4274 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4275 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4276 - "cultureName": "string", ~/~/ название культуры 4277 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4278 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4279 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4280 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4281 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4282 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4283 - "issued": 0, ~/~/Выдано, бункеров 4284 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4285 - "latitude": 0, ~/~/Широта 4286 - "longitude": 0, ~/~/ Долгота 4287 - "litresAway": 0, ~/~/Отдано, л 4288 - "m3Away": 0 ~/~/Отдано, м3 4289 - } 4290 - ] 4291 - } 4292 -] 4293 - 4294 - 4295 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4296 - 4297 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4298 - 4299 - 4300 -(% class="box infomessage" %) 4301 -((( 4302 -GET api/v3/Vehicles/recyclebin/all 4303 -))) 4304 - 4305 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4306 - 4307 -Параметр запроса: {parentId} - идентификатор агента 4308 - 4309 -В заголовках запроса: X-Auth: Токен авторизации 4310 - 4311 -Ответ: 4312 - 4313 -[ 4314 - { 4315 - "recordTime": "", ~/~/Время записи 4316 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4317 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4318 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4319 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4320 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4321 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4322 - "items": [ ~/~/ 4323 -nullable: true ~/~/Детали 4324 - { 4325 - "name": "string", ~/~/наименование столбца 4326 - "value": "string" ~/~/содержание столбца 4327 - } 4328 - ] 4329 - }, 4330 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4331 - "string" 4332 - ] 4333 - } 4334 -] 4335 - 4336 - 4337 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4338 - 4339 -(% class="box infomessage" %) 4340 -((( 4341 -POST/api/v3/Vehicles/recyclebin/erase 4342 -))) 4343 - 4344 -В заголовках запроса: X-Auth: Токен авторизации 4345 - 4346 -Пример запроса: 4347 - 4348 -[ 4349 -0 4350 -] 4351 - 4352 - 4353 -Пример ответа: 4354 - 4355 -[ 4356 -{ 4357 - "recordTime": "", ~/~/Время записи 4358 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4359 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4360 - "objectId": 0, ~/~/ID объекта, помещённого в корзин 4361 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4362 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4363 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4364 - "items": [ ~/~/Детали 4365 - { 4366 - "name": "", ~/~/Имя свойства 4367 - "value": "" ~/~/Значение свойства 4368 - } 4369 - ] 4370 - }, 4371 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4372 - "" 4373 - ] 4374 - } 4375 -] 4376 - 4377 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4378 - 4379 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4380 - 4381 -(% class="box infomessage" %) 4382 -((( 4383 -POST/api/v3/Vehicles/recyclebin/restore 4384 -))) 4385 - 4386 -В заголовках запроса: X-Auth: Токен авторизации 4387 - 4388 -Параметры в теле запроса (JSON): 4389 - 4390 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4391 - 4392 -В заголовках запроса: X-Auth: Токен авторизации 4393 - 4394 - 4395 -Пример запроса: 4396 - 4397 -((( 4398 -[ 4399 -))) 4400 - 4401 -((( 4402 - 0 4403 -))) 4404 - 4405 -((( 4406 -] 4407 -))) 4408 - 4409 - 4410 -Пример ответа: 4411 - 4412 -[ 4413 -{ 4414 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4415 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4416 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4417 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4418 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4419 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4420 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4421 - "items": [ ~/~/Детали 4422 - { 4423 - "name": "string", ~/~/Имя свойства 4424 - "value": "string" ~/~/Значение свойства 4425 - } 4426 - ] 4427 - }, 4428 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4429 - "string" 4430 - ] 4431 - } 4432 -] 4433 - 4434 - 4435 - 4436 4436 (% class="box" lang="en-US" style="text-align: center;" %) 4437 4437 ((( 4438 4438 (% 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,1 +1,0 @@ 1 -XWiki.krainovim - Size
-
... ... @@ -1,1 +1,0 @@ 1 -268.0 KB - Content