Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
- Manage
-
Copy
- Actions
-
Export
-
Print Preview
- Viewers
-
Source
-
Children
-
Content
-
Attachments (1)
-
History
-
Information
-
Просмотреть отметки "Нравится"
Change comment:
There is no comment for this version
Summary
Details
-
Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. SupportZhuchkov1 +XWiki.krainovim - Content
-
... ... @@ -14,22 +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 -(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 27 -((( 28 -(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 29 -(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 30 -))) 21 +== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 31 31 32 -(% class="box successmessage" %)23 +(% class="box infomessage" %) 33 33 ((( 34 34 (% lang="en-US" %)**POST /api/v3/auth/login** 35 35 ))) ... ... @@ -40,7 +40,7 @@ 40 40 41 41 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 42 42 43 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 34 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__». 44 44 45 45 (% style="color:#000000" %)Параметры в теле запроса (JSON): 46 46 ... ... @@ -49,25 +49,21 @@ 49 49 "password": "testuser" 50 50 } 51 51 43 + 52 52 (% style="color:#000000" %)**Ответ:** 53 53 54 54 (% lang="en-US" %) 55 55 (% style="color:#000000" %){ 56 - "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 57 - "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" %) 58 58 } 59 59 60 60 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 61 61 62 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 63 -|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 64 -|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 65 -|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 66 -|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 67 - 68 -(% class="wikigeneratedid" %) 69 -Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 70 - 71 71 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 72 72 73 73 (% class="box infomessage" %) ... ... @@ -106,51 +106,30 @@ 106 106 Запрос должен содержать данные параметра "**agentId**" 107 107 108 108 (% style="color:#000000" %)Ответ: 96 +А 109 109 { 110 - "agentId": "", (%%) 111 - "parentId": "", 112 - "parentName": "string", 113 - "name": "string", 114 - "fullName": "string", 115 - "agentInfoType": 0, 116 - "isForeign": true/false, 117 - "district": "string", 118 - "region": "string", 119 - "city": "string", 120 - "inn": "string", 121 - "kpp": "string", 122 - "address": "string", 123 - "addressFact": "string", 124 - "email": "string", 125 - "director": "string", 126 - "bankName": "string", 127 - "bankBIK": "string", 128 - "bankRS": "string", 129 - "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" ~/~/ Корр. счет 130 130 } 131 131 132 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 133 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 134 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 135 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 136 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 137 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 138 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 139 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 140 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 141 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 142 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 143 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 144 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 145 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 146 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 147 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 148 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 149 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 150 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 151 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 152 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 153 - 154 154 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 155 155 156 156 (% class="box infomessage" %) ... ... @@ -164,7 +164,7 @@ 164 164 165 165 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 166 166 167 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 133 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 168 168 169 169 (% style="color:#000000" %)Метод запроса: **POST** 170 170 ... ... @@ -179,23 +179,15 @@ 179 179 (% style="color:#000000" %)Ответ: 180 180 181 181 { 182 - "agentId": "",(% style="color:#000000" %) (%%) 183 - "parentId": "", 184 - "name": "string", 185 - "fullName": "string", 186 - "agentInfoType": 0, 187 -(% 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 - Отказ) 188 188 } 189 189 190 - 191 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 192 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 193 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 194 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 195 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 196 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 197 -|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 198 - 199 199 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 200 200 201 201 (% class="box successmessage" %) ... ... @@ -214,7 +214,7 @@ 214 214 Параметры в теле запроса (JSON): 215 215 216 216 { 217 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 175 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 218 218 "name": "string", ~/~/ имя 219 219 "fullName": "string", ~/~/ полное наименование 220 220 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -234,6 +234,7 @@ 234 234 "bankKS": "string" ~/~/ корр. счёт 235 235 } 236 236 195 + 237 237 Ответ: 238 238 239 239 { ... ... @@ -258,28 +258,6 @@ 258 258 "bankKS": "string" ~/~/ корр. счёт 259 259 } 260 260 261 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 262 -|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 263 -|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 264 -|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 265 -|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 266 -|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 267 -|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 268 -|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 269 -|(% style="width:215px" %)district|(% style="width:861px" %)Округ 270 -|(% style="width:215px" %)region|(% style="width:861px" %)Регион 271 -|(% style="width:215px" %)city|(% style="width:861px" %)Город 272 -|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 273 -|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 274 -|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 275 -|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 276 -|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 277 -|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 278 -|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 279 -|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 280 -|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 281 -|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 282 - 283 283 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 284 284 285 285 (% class="box warningmessage" %) ... ... @@ -295,6 +295,7 @@ 295 295 296 296 В заголовках запроса: X-Auth: Токен авторизации 297 297 235 + 298 298 Параметры в теле запроса (JSON): 299 299 300 300 { ... ... @@ -319,6 +319,7 @@ 319 319 "bankKS": "string" ~/~/ корр. счёт 320 320 } 321 321 260 + 322 322 Ответ: 323 323 324 324 { ... ... @@ -361,21 +361,6 @@ 361 361 362 362 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 363 363 364 -== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 365 - 366 -(% class="box warningmessage" %) 367 -((( 368 -**PUT /api/v3/agents/{id}/changeStatus/{status}** 369 -))) 370 - 371 -Метод позволяет изменить статус клиента, указанного в запросе. 372 - 373 -В пути указывается GUID клиента и статус клиента. 374 - 375 -**status **- значение 0 - заблокирован, 1 - активен. 376 - 377 -Ответ: Code 204 378 - 379 379 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 380 380 381 381 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -427,6 +427,7 @@ 427 427 ], 428 428 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 429 429 } 354 + 430 430 { 431 431 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 432 432 "lastName": "string", ... ... @@ -438,10 +438,15 @@ 438 438 "password": "string", 439 439 "email": "string", 440 440 366 + 441 441 (% style="text-align:left" %) 442 442 (% style="color:#000000; font-weight:normal" %)Ответ: 443 -{ 444 - "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 пользователя 445 445 "lastName": "" , ~/~/ Фамилия , 446 446 "firstName": "" , ~/~/ Имя 447 447 "position": "" , ~/~/ Должность ... ... @@ -458,8 +458,9 @@ 458 458 "kind": "" , ~/~/ тип аутентификации 459 459 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 460 460 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 461 -} 462 462 392 +(% style="text-align:left" %) 393 +(% style="color:#000000; font-weight:normal" %)} 463 463 464 464 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 465 465 ... ... @@ -480,16 +480,19 @@ 480 480 481 481 (% style="color:#000000" %)Параметры в теле запроса (JSON): 482 482 483 -(% style="color:#000000" %){(%%) 414 +(% style="color:#000000" %){ 415 + 484 484 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 485 485 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 486 486 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 487 487 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 + 488 488 (% style="color:#000000" %)} 489 489 490 490 (% style="color:#000000" %)Ответ: 491 491 492 492 (% style="color:#000000" %){ (%%) 426 + 493 493 "id": "" , ~/~/ идентификатор пользователя 494 494 "lastName": "" , ~/~/ фамилия 495 495 "firstName": "" , ~/~/ имя ... ... @@ -503,6 +503,7 @@ 503 503 "sessionDuration":"", ~/~/ длительность сессии в минутах 504 504 "status": "1", ~/~/ статус пользователя 505 505 "lastLogged": "", ~/~/ дата/время последней авторизации 440 + 506 506 (% style="color:#000000" %)} 507 507 508 508 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -576,8 +576,10 @@ 576 576 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 577 577 578 578 (% lang="en-US" style="text-align:left" %) 579 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 580 - "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 пользователя 581 581 "lastName": "" , ~/~/ фамилия 582 582 "firstName": "" , ~/~/ имя 583 583 "position": "" , ~/~/ должность ... ... @@ -599,7 +599,9 @@ 599 599 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 600 600 }, 601 601 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 602 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 539 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 + 541 +(% lang="en-US" style="text-align:left" %) 603 603 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 604 604 605 605 (% lang="en-US" style="text-align:left" %) ... ... @@ -606,8 +606,10 @@ 606 606 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 607 607 608 608 (% lang="en-US" style="text-align:left" %) 609 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 610 - "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": "" , ~/~/ идентификатор пользователя 611 611 "lastName": "" , ~/~/ фамилия 612 612 "firstName": "" , ~/~/ имя 613 613 "position": "" , ~/~/ должность ... ... @@ -628,8 +628,10 @@ 628 628 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 629 629 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 630 630 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 631 -} 632 632 573 +(% lang="en-US" style="text-align:left" %) 574 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 + 633 633 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 634 634 635 635 (% class="box warningmessage" %) ... ... @@ -649,10 +649,12 @@ 649 649 650 650 (% style="color:#000000" %)Параметры в теле запроса (JSON): 651 651 652 -(% style="color:#000000" %){(%%) 595 +(% style="color:#000000" %){ 596 + 653 653 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 654 654 "description": "" , ~/~/ описание 655 655 "data": "" , ~/~/ данные, связанные со сменой статуса 600 + 656 656 (% style="color:#000000" %)} 657 657 658 658 (% style="text-align:left" %) ... ... @@ -674,7 +674,7 @@ 674 674 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 675 675 676 676 [ 677 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 622 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 678 678 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 679 679 ] 680 680 ... ... @@ -766,6 +766,7 @@ 766 766 "maxspeed": 0, 767 767 "width": 0, 768 768 "imbeddedtrailer": true, 714 + "fueloutlay": 0, 769 769 "hoppercapacity": 0, 770 770 "hopperdischargespeed": 0, 771 771 "modelType": 0, ... ... @@ -774,7 +774,7 @@ 774 774 "deleted": true 775 775 } 776 776 777 -| =(% style="width:; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width:; background-color: rgb(230, 230, 230);" %)**Описание**723 +|(% style="width:215px" %)Параметр|(% style="width:861px" %)Описание 778 778 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 779 779 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 780 780 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта ... ... @@ -782,8 +782,9 @@ 782 782 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 783 783 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 784 784 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 +|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 785 785 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 786 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость 2выгрузки из бункера, л/сек733 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 787 787 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 788 788 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 789 789 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -804,9 +804,10 @@ 804 804 805 805 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 806 806 807 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {754 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 808 808 809 -(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 756 +(% style="color:#000000" %){ 757 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 810 810 } 811 811 812 812 (% style="color:#000000" %)Ответ: ... ... @@ -821,13 +821,6 @@ 821 821 } 822 822 ] 823 823 824 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 825 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 826 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 827 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 828 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 829 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 830 - 831 831 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 832 832 833 833 (% class="box successmessage" %) ... ... @@ -875,25 +875,12 @@ 875 875 "maxspeed": 0, 876 876 "width": 0, 877 877 "imbeddedtrailer": true, 819 + "fueloutlay": 0, 878 878 "hoppercapacity": 0, 879 879 "hopperdischargespeed": 0, 880 880 "modelType": 0 881 881 } 882 882 883 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 884 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 885 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 886 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 887 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 888 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 889 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 890 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 891 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 892 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 893 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 894 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 895 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 896 - 897 897 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 898 898 899 899 (% class="box warningmessage" %) ... ... @@ -947,20 +947,6 @@ 947 947 "modelType": 0 948 948 } 949 949 950 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 951 -|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 952 -|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 953 -|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 954 -|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 955 -|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 956 -|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 957 -|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 958 -|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 959 -|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 960 -|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 961 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 962 -|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 963 - 964 964 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 965 965 966 966 (% class="box errormessage" %) ... ... @@ -980,7 +980,7 @@ 980 980 981 981 Ответ: В случае успеха **Success 200** 982 982 983 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =897 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 984 984 985 985 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 986 986 ... ... @@ -1016,15 +1016,19 @@ 1016 1016 "deviceTypeName": "", ~/~/ Название типа устройства 1017 1017 "sim1": "", ~/~/ Номер SIM1 1018 1018 "sim2": "", ~/~/ Номер SIM2 933 + 1019 1019 "parentId": "", ~/~/ ID клиента-родителя 1020 1020 "parentName": "", ~/~/ Наименование клиента-родителя 1021 1021 "modelId": "", ~/~/ ID модели объекта 1022 1022 "modelName": "", ~/~/ Имя модели объекта 938 + 1023 1023 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1024 1024 "unitName": "string", ~/~/ Наименование подразделения 1025 1025 "status": 0, ~/~/ Статус объекта 942 + 1026 1026 "createdAt": "", ~/~/ Дата создания объекта 1027 1027 }, 945 + 1028 1028 "customFields": [ ~/~/ Произвольные поля 1029 1029 { 1030 1030 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -1047,7 +1047,8 @@ 1047 1047 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1048 1048 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1049 1049 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1050 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 968 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 969 + 1051 1051 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1052 1052 "mileageCoeff": 0, ~/~/ коэффициент пробега 1053 1053 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1077,6 +1077,7 @@ 1077 1077 "retries": 0 ~/~/ Количество попыток 1078 1078 } 1079 1079 ], 999 + 1080 1080 "sensors": [ ~/~/ Датчики 1081 1081 { 1082 1082 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1117,19 +1117,31 @@ 1117 1117 }, 1118 1118 1119 1119 ~/~/ Характерные для произвольного: 1040 + 1120 1120 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1042 + 1121 1121 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1044 + 1122 1122 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1046 + 1123 1123 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1048 + 1124 1124 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1050 + 1125 1125 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1052 + 1126 1126 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1054 + 1127 1127 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1056 + 1128 1128 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1058 + 1129 1129 ~/~/ "ValueOn": "Вкл.", 1060 + 1130 1130 ~/~/ "ValueOff": "Выкл." 1131 1131 "summaryMaxValue": 0 ~/~/ Макс. значение 1132 1132 } 1064 + 1133 1133 "drivers": [ ~/~/ Водители 1134 1134 { 1135 1135 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1138,6 +1138,7 @@ 1138 1138 "isDefault": true ~/~/ По умолчанию 1139 1139 } 1140 1140 ], 1073 + 1141 1141 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1142 1142 { 1143 1143 "id": "", ~/~/ ID задания ... ... @@ -1154,7 +1154,8 @@ 1154 1154 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1155 1155 } 1156 1156 ], 1157 -"statusHistory": [ ~/~/ История статусов 1090 + 1091 + "statusHistory": [ ~/~/ История статусов 1158 1158 { 1159 1159 "status": 0, 1160 1160 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1162,6 +1162,7 @@ 1162 1162 "additionalInfo": "string" 1163 1163 } 1164 1164 ] 1099 + 1165 1165 } 1166 1166 ))) 1167 1167 ... ... @@ -1171,73 +1171,6 @@ 1171 1171 (% style="text-align:left" %) 1172 1172 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1173 1173 1174 - 1175 -== **Отправить команду на терминал** == 1176 - 1177 -(% class="box successmessage" %) 1178 -((( 1179 -(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1180 -))) 1181 - 1182 -Команда для отправки на тс. 1183 - 1184 -{ 1185 -"id": "", ~/~/идентификатор произвольного поля 1186 -"command": "", ~/~/ Текст команды 1187 -"retries": "", ~/~/ Количество попыток 1188 -"idTemplate": "" ~/~/ ID шаблона команды 1189 -} 1190 - 1191 - 1192 -== **Получить ответ на отправленную на ТС команду** == 1193 - 1194 -(% class="box infomessage" %) 1195 -((( 1196 -(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1197 -))) 1198 - 1199 -Идентификатор команды: cmdid 1200 - 1201 -Запрос от терминала на ответ команды 1202 - 1203 -Пример ответ от терминала: 1204 - 1205 -ID= "" ~/~/ идентификатор произвольного поля 1206 -Soft="" ~/~/ версия софта 1207 -GPS=4 ~/~/ тип трекера 1208 -Time=11:05:43 28.06.24 ~/~/ время запроса 1209 -Lat=45.056221 ~/~/ широта 1210 -Lon=39.035938 ~/~/ долгота 1211 -Speed=0.0 ~/~/ скорость 1212 -Course=181.4 ~/~/направление 1213 - 1214 -((( 1215 -== **Список отправленных объекту команд с ответами** == 1216 - 1217 -(% class="box infomessage" %) 1218 -((( 1219 -(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1220 -))) 1221 - 1222 -Идентификатор ТС: vehicleId 1223 - 1224 -В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1225 - 1226 -Пример ответа терминала 1227 - 1228 -[ 1229 -{ 1230 -"id": "", ~/~/ идентификатор пользователя 1231 -"commandText": "", ~/~/Текст команды. 1232 -"templateId": "", ~/~/Идентификатор шаблона 1233 -"updated": "", ~/~/ Время отправки 1234 -"tryCount": 0, ~/~/ Количество попыток отправки команды 1235 -"answer": "", ~/~/ Ответ терминала. 1236 -"status": "" ~/~/ Статус отправки 1237 -} 1238 -] 1239 -))) 1240 - 1241 1241 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1242 1242 1243 1243 (% class="box successmessage" %) ... ... @@ -1255,7 +1255,8 @@ 1255 1255 1256 1256 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1257 1257 1258 -(% style="color:#000000" %){(%%) 1126 +(% style="color:#000000" %){ 1127 + 1259 1259 "parentId": "" , ~/~/ ID клиента 1260 1260 "name": "" , ~/~/ имя ТС 1261 1261 "imei": "" , ~/~/ IMEI ... ... @@ -1276,6 +1276,7 @@ 1276 1276 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1277 1277 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1278 1278 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1148 + 1279 1279 "mileageCalcMethod": 0, 1280 1280 "mileageCoeff": 0, 1281 1281 "locationByCellId": true, ... ... @@ -1308,6 +1308,7 @@ 1308 1308 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1309 1309 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1310 1310 } 1181 + 1311 1311 "drivers": [ ~/~/ Водители 1312 1312 { 1313 1313 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1322,7 +1322,8 @@ 1322 1322 "retries": 0 1323 1323 } 1324 1324 ], 1325 -"sensors": [ ~/~/ Датчики 1196 + 1197 + "sensors": [ ~/~/ Датчики 1326 1326 { 1327 1327 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1328 1328 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1360,17 +1360,29 @@ 1360 1360 "additionalProp2": "string", 1361 1361 "additionalProp3": "string" 1362 1362 }, 1235 + 1363 1363 ~/~/ Характерные для произвольного: 1237 + 1364 1364 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1239 + 1365 1365 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1241 + 1366 1366 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1243 + 1367 1367 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1245 + 1368 1368 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1247 + 1369 1369 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1249 + 1370 1370 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1251 + 1371 1371 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1253 + 1372 1372 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1255 + 1373 1373 ~/~/ "ValueOn": "Вкл.", 1257 + 1374 1374 ~/~/ "ValueOff": "Выкл." 1375 1375 "summaryMaxValue": 0 ~/~/ Макс. значение 1376 1376 } ... ... @@ -1389,7 +1389,8 @@ 1389 1389 1390 1390 (% style="color:#000000" %)Ответ: 1391 1391 1392 -(% style="color:#000000" %){(%%) 1276 +(% style="color:#000000" %){ 1277 + 1393 1393 "vehicleId": "", ~/~/ID ТС 1394 1394 "parentId": "", ~/~/Guid владельца ТС 1395 1395 "name": "", ~/~/Имя объекта ... ... @@ -1427,6 +1427,8 @@ 1427 1427 "kind": "", ~/~/ Вид периодичности по времени 1428 1428 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1429 1429 } 1315 + 1316 +(% style="text-align:left" %) 1430 1430 (% style="color:#000000" %)} 1431 1431 1432 1432 **Валидация:** ... ... @@ -1434,7 +1434,7 @@ 1434 1434 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1435 1435 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1436 1436 1437 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектовс основными параметрами**(%%) ==1324 +== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1438 1438 1439 1439 (% class="box infomessage" %) 1440 1440 ((( ... ... @@ -1441,7 +1441,7 @@ 1441 1441 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1442 1442 ))) 1443 1443 1444 -(% style="color:#000000" %)Метод позволяет получить список доступныхобъектовмониторинга (транспортных средств)с их основнымипараметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1331 +(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1445 1445 1446 1446 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1447 1447 ... ... @@ -1485,7 +1485,8 @@ 1485 1485 (% style="color:#000000" %)Ответ: 1486 1486 1487 1487 (% style="color:#000000" %){ 1488 - "vehicleId": "" ~/~/ идентификатор объекта 1375 + 1376 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1489 1489 "name": "" ~/~/ наименование объекта 1490 1490 "imei": "" ~/~/ IMEI объекта 1491 1491 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1544,11 +1544,13 @@ 1544 1544 "data": "", ~/~/ Данные 1545 1545 "overwrite": false, ~/~/ Флаг перезаписи 1546 1546 "stage": "", ~/~/ Состояние, может быть null 1435 + 1547 1547 (% style="color:#000000" %)} 1548 1548 1549 1549 (% style="color:#000000" %)Ответ: 1550 1550 1551 -(% style="color:#000000" %){(%%) 1440 +(% style="color:#000000" %){ 1441 + 1552 1552 "status": "", ~/~/ значение статуса 1553 1553 "date": "", ~/~/ Дата смены статуса 1554 1554 "description": "", ~/~/ Описание ... ... @@ -1555,10 +1555,10 @@ 1555 1555 "data": "", ~/~/ Данные 1556 1556 "overwrite": false, ~/~/ Флаг перезаписи 1557 1557 "stage": "", ~/~/ Состояние 1448 + 1449 +(% style="text-align:left" %) 1558 1558 (% style="color:#000000" %) } 1559 1559 1560 -== == 1561 - 1562 1562 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1563 1563 1564 1564 (% class="box warningmessage" %) ... ... @@ -1646,7 +1646,8 @@ 1646 1646 "retries": 0 1647 1647 } 1648 1648 ], 1649 -"sensors": [ ~/~/ Датчики 1539 + 1540 + "sensors": [ ~/~/ Датчики 1650 1650 { 1651 1651 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1652 1652 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1684,17 +1684,29 @@ 1684 1684 "additionalProp2": "string", 1685 1685 "additionalProp3": "string" 1686 1686 }, 1578 + 1687 1687 ~/~/ Характерные для произвольного: 1580 + 1688 1688 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1582 + 1689 1689 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1584 + 1690 1690 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1586 + 1691 1691 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1588 + 1692 1692 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1590 + 1693 1693 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1592 + 1694 1694 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1594 + 1695 1695 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1596 + 1696 1696 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1598 + 1697 1697 ~/~/ "ValueOn": "Вкл.", 1600 + 1698 1698 ~/~/ "ValueOff": "Выкл." 1699 1699 "summaryMaxValue": 0 ~/~/ Макс. значение 1700 1700 } ... ... @@ -1714,7 +1714,9 @@ 1714 1714 (% style="color:#000000" %)Ответ: 1715 1715 1716 1716 (% lang="en-US" style="text-align:left" %) 1717 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ (%%) 1620 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1621 + 1622 +(% lang="en-US" style="text-align:left" %) 1718 1718 "vehicleId": "", ~/~/ ID ТС 1719 1719 "parentId": "", ~/~/ ID клиента 1720 1720 "name": "", ~/~/ имя ТС ... ... @@ -1755,6 +1755,8 @@ 1755 1755 "kind": "", ~/~/ Вид периодичности по времени 1756 1756 "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1757 1757 } 1663 + 1664 +(% lang="en-US" style="text-align:left" %) 1758 1758 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1759 1759 1760 1760 **Валидация:** ... ... @@ -1795,15 +1795,18 @@ 1795 1795 1796 1796 (% style="color:#000000" %)Метод запроса: **GET** 1797 1797 1798 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1705 +(% 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]] 1799 1799 1800 1800 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1801 1801 1802 1802 (% style="color:#000000" %)Ответ: 1803 1803 1804 -(% style="color:#000000" %){(%%) 1711 +(% style="color:#000000" %){ 1712 + 1805 1805 "deviceTypeId" : "", ~/~/ ID типа устройства 1806 1806 "deviceTypeName" : "" ~/~/ Название типа устройства 1715 + 1716 +(% style="text-align:left" %) 1807 1807 (% style="color:#000000" %)} 1808 1808 1809 1809 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1825,10 +1825,13 @@ 1825 1825 1826 1826 (% style="color:#000000" %)Ответ: 1827 1827 1828 -(% style="color:#000000" %){(%%) 1738 +(% style="color:#000000" %){ 1739 + 1829 1829 "id": "", ~/~/ ID типа датчика 1830 1830 "name": "", ~/~/ Название 1831 1831 "description": "", ~/~/ Описание 1743 + 1744 +(% style="text-align:left" %) 1832 1832 (% style="color:#000000" %)} 1833 1833 1834 1834 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1872,56 +1872,6 @@ 1872 1872 } 1873 1873 ] 1874 1874 1875 -== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 1876 - 1877 -(% class="box infomessage" style="text-align: left;" %) 1878 -((( 1879 -**POST /api/v3/terminalMessages/mapping** 1880 -))) 1881 - 1882 -Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 1883 - 1884 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 1885 - 1886 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1887 - 1888 -{ 1889 - "protocolType": 0, 1890 - "params": ["string"] 1891 -} 1892 - 1893 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1894 -|protocolType|ID типа протокола 1895 -|params|((( 1896 -Массив наименований параметров в сообщении 1897 -))) 1898 - 1899 -Ответ: 1900 - 1901 -{ 1902 - "protocolType": 0, 1903 - "mapping": { 1904 - "additionalProp1": { 1905 - "inputType": 0, 1906 - "inputNumber": 0 1907 - }, 1908 - "additionalProp2": { 1909 - "inputType": 0, 1910 - "inputNumber": 0 1911 - } 1912 - } 1913 -} 1914 - 1915 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1916 -|protocolType|Тип протокола 1917 -|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 1918 -|inputNumber|((( 1919 -Номер входа 1920 -))) 1921 - 1922 -(% class="wikigeneratedid" %) 1923 -Перечень 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/]] 1924 - 1925 1925 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1926 1926 1927 1927 (% class="box infomessage" %) ... ... @@ -1946,11 +1946,6 @@ 1946 1946 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1947 1947 } 1948 1948 1949 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1950 -|vehicleId|ID объекта 1951 -|from|Дата и время начала периода запроса 1952 -|to|Дата и время окончания периода запроса 1953 - 1954 1954 Ответ: 1955 1955 1956 1956 [ ... ... @@ -1957,43 +1957,80 @@ 1957 1957 { 1958 1958 "messages": [ 1959 1959 { 1960 - "deviceTime": "2023-11-29T07:40:44.052Z", 1961 - "serverTime": "2023-11-29T07:40:44.052Z", 1962 - "speed": 0, 1963 - "altitude": 0, 1964 - "latitude": 0, 1965 - "longitude": 0, 1966 - "satellites": 0, 1967 - "course": 0, 1968 - "voltage": 0, 1969 - "parameters": { 1818 + "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1819 + "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1820 + "speed": 0, ~/~/ Скорость, км/ч 1821 + "altitude": 0, ~/~/ Высота, м 1822 + "latitude": 0, ~/~/ Широта [-90°;90°] 1823 + "longitude": 0, ~/~/ Долгота [-180°;180°] 1824 + "satellites": 0, ~/~/ Кол-во спутников 1825 + "voltage": 0, ~/~/ Напряжение 1826 + "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 1970 1970 "additionalProp1": "string", 1971 1971 "additionalProp2": "string", 1972 1972 "additionalProp3": "string" 1973 1973 }, 1974 - "photoCount": 0, 1975 - "lbsCorrectedCoords": true, 1976 - "protocolType": 0 1831 + "photoCount": 0 ~/~/ Кол-во фото 1977 1977 } 1978 1978 ] 1979 1979 } 1980 1980 ] 1981 1981 1982 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 1983 -|deviceTime|Время сообщения терминала 1984 -|serverTime|Время когда сообщение поступило на сервер 1985 -|speed|Скорость 1986 -|altitude|Высота над уровнем моря 1987 -|latitude|Широта 1988 -|longitude|Долгота 1989 -|satellites|Кол-во спутников 1990 -|course|Курс 1991 -|voltage|Бортовое напряжение 1992 -|parameters|Список параметров и их значений 1993 -|photoCount|Количество фото 1994 -|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 1995 -|protocolType|ID типа протокола 1837 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 1996 1996 1839 +(% class="box infomessage" %) 1840 +((( 1841 +**POST /api/v3/vehicles/export/history** 1842 +))) 1843 + 1844 +Метод возвращает список сообщений терминала объекта за выбранный период. 1845 + 1846 +(% style="text-align: left;" %) 1847 +Метод запроса **POST** 1848 + 1849 +(% style="text-align: left;" %) 1850 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1851 + 1852 +(% style="text-align: left;" %) 1853 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1854 + 1855 +{ 1856 + "vehicleId": 0, ~/~/ ID объекта 1857 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1858 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1859 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1860 +} 1861 + 1862 +Ответ: 1863 + 1864 +Получаете файл. Сообщение: Code 200/Success 1865 + 1866 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1867 + 1868 +(% class="box infomessage" %) 1869 +((( 1870 +**GET /api/v3/vehicles/export/history/status** 1871 +))) 1872 + 1873 +Метод возвращает список сообщений терминала объекта за выбранный период. 1874 + 1875 +(% style="text-align: left;" %) 1876 +Метод запроса **GET** 1877 + 1878 +(% style="text-align: left;" %) 1879 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1880 + 1881 +(% style="text-align: left;" %) 1882 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1883 + 1884 +Ответ: 1885 + 1886 +{ 1887 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1888 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1889 + "message": "string" ~/~/ текст описывающий статус. 1890 +} 1891 + 1997 1997 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1998 1998 1999 1999 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2030,12 +2030,10 @@ 2030 2030 { 2031 2031 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2032 2032 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2033 - "mileage": 0, ~/~/ Пробег за период, километры 2034 - "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2035 - "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2036 - "motohours": 0, ~/~/ Моточасы за период, секунды 2037 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2038 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1928 + "mileageBegin": 0, ~/~/ Пробег на начало периода 1929 + "mileageEnd": 0, ~/~/ Пробег на окончание периода 1930 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1931 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2039 2039 } 2040 2040 ] 2041 2041 } ... ... @@ -2084,12 +2084,6 @@ 2084 2084 } 2085 2085 ] 2086 2086 2087 -(% class="box warningmessage" %) 2088 -((( 2089 -Максимальное кол-во периодов - 1440 (maxPeriodsCount = 1440) 2090 -\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2091 -))) 2092 - 2093 2093 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2094 2094 2095 2095 (% class="box infomessage" %) ... ... @@ -2135,96 +2135,6 @@ 2135 2135 } 2136 2136 ] 2137 2137 2138 - 2139 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2140 - 2141 -(% class="box infomessage" %) 2142 -((( 2143 -**POST /api/v3/vehicles/moveStop** 2144 -))) 2145 - 2146 -Метод запроса: **POST** 2147 - 2148 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2149 - 2150 -В заголовках запроса: X-Auth: Токен авторизации 2151 - 2152 - 2153 -Тело запроса: 2154 - 2155 -{ 2156 - "vehicleIds": [ ], ~/~/ Список ID объектов 2157 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2158 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2159 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2160 -} 2161 - 2162 -Ответ: 2163 - 2164 -[ 2165 - { 2166 - "vehicleId": 0, ~/~/ ID объекта 2167 - "vehicleName": "string", ~/~/ Имя объекта 2168 - "moves": [ ~/~/ Событие движения 2169 - { 2170 - "mileage": 0, ~/~/ Пробег, км 2171 - "eventId": 0, ~/~/ Идентификатор события 2172 - "eventName": "string", ~/~/ Название события 2173 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2174 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2175 - "duration": 0 ~/~/ Продолжительность события, секунд 2176 - } 2177 - ], 2178 - "stops": [ ~/~/ События стоянок 2179 - { 2180 - "address": "string", ~/~/ Адрес события 2181 - "eventId": 0, ~/~/ Идентификатор события 2182 - "eventName": "string", ~/~/ Название события 2183 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2184 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2185 - "duration": 0 ~/~/ Продолжительность события, секунд 2186 - } 2187 - ] 2188 - } 2189 -] 2190 - 2191 - 2192 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2193 - 2194 -(% class="box infomessage" %) 2195 -((( 2196 -**POST /api/v3/vehicles/getlastdata** 2197 -))) 2198 - 2199 -Метод запроса: **POST** 2200 - 2201 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2202 - 2203 -В заголовках запроса: X-Auth: Токен авторизации 2204 - 2205 - 2206 -В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2207 - 2208 -Ответ: 2209 - { 2210 - "vehicleId": 0, ~/~/Идентификатор объекта. 2211 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2212 - "vehicleNumber": "string",~/~/Номер объекта. 2213 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2214 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2215 - "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2216 - "speed": 0,~/~/Скорость объекта. 2217 - "course": 0,~/~/Курс движения [0;360] 2218 - "latitude": 0,~/~/Широта [-90°;90°]. 2219 - "longitude": 0,~/~/Долгота [-180°;180°]. 2220 - "address": "string",~/~/Адрес. 2221 - "geozones": [ ~/~/Сведения по геозонам. 2222 - { 2223 - "id": 0, 2224 - "name": "string" 2225 - } 2226 - 2227 - 2228 2228 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2229 2229 2230 2230 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2532,32 +2532,6 @@ 2532 2532 2533 2533 Success 2534 2534 2535 - 2536 -== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2537 - 2538 -(% class="box warningmessage" %) 2539 -((( 2540 -**PUT** /api/v3/notifications/prolongation 2541 -))) 2542 - 2543 -Метод позволяет продлить уведомления. 2544 - 2545 -Метод запроса **PUT** 2546 - 2547 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2548 - 2549 -В заголовках запроса: X-Auth: Токен авторизации. 2550 - 2551 -Тело запроса: 2552 - 2553 -[ 2554 - 2555 -0 2556 - 2557 -] 2558 - 2559 -где 0 идентификатор ids. 2560 - 2561 2561 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2562 2562 2563 2563 (% class="box errormessage" %) ... ... @@ -3149,83 +3149,6 @@ 3149 3149 Success 3150 3150 3151 3151 3152 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3153 - 3154 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3155 - 3156 -(% class="box infomessage" %) 3157 -((( 3158 -**POST /api/v3/Trailers** 3159 -))) 3160 - 3161 -Пример запроса: 3162 - 3163 -{ 3164 - "startDate": "2023-11-14T10:48:03.671Z", 3165 - "endDate": "2023-11-14T10:48:03.671Z", 3166 - "ids": [ 0 ], 3167 - "timezone": 0 3168 -} 3169 - 3170 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3171 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3172 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3173 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3174 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3175 - 3176 -Пример ответа: 3177 - 3178 -[ 3179 - { 3180 - "SD": "2023-11-14T10:48:03.717Z", 3181 - "ED": "2023-11-14T10:48:03.717Z", 3182 - "id": 0, 3183 - "SLat": 0, 3184 - "SLon": 0, 3185 - "ELat": 0, 3186 - "ELon": 0, 3187 - "mileage": 0 3188 - "Duration": 0 3189 - "Address": "string", 3190 - "Address2": "string", 3191 - "name": "string", 3192 - "rid": "string", 3193 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3194 - "trailer": { 3195 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3196 - "Number": "string", 3197 - "Description": "string", 3198 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3199 - "ExternalID": "string", 3200 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3201 - "CreateTime": "2023-11-14T10:48:03.717Z", 3202 - "UpdateTime": "2023-11-14T10:48:03.717Z", 3203 - "IsDeleted": true 3204 - }, 3205 - "filesCount": 0, 3206 - } 3207 -] 3208 - 3209 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3210 -|SD|Дата и время начала события 3211 -|ED|Дата и время окончания события 3212 -|id|ID объекта 3213 -|SLat|Широта начальной координаты 3214 -|SLon|Долгота начальной координаты 3215 -|ELat|Широта конечной координаты 3216 -|ELon|Долгота конечной координаты 3217 -|mileage|Пробег 3218 -|Duration|Продолжительность 3219 -|Address|Адрес начального местоположения 3220 -|Address2|Адрес конечного местоположения 3221 -|name|Имя радиометки 3222 -|rid|Номер радиометки 3223 -|rguid|ID радиометки 3224 -|trailer|Информация об агрегате 3225 -|ModelGuid|ID агрегата 3226 -|Number|Название/номер агрегата 3227 -|Description|Текст примечания агрегата 3228 - 3229 3229 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3230 3230 3231 3231 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -3247,18 +3247,13 @@ 3247 3247 { 3248 3248 "name": "string", 3249 3249 "number": 0, 3250 - "period": 0, 2944 + "period": 0, ~/~/ Частота трансляции радиометки 3251 3251 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3252 3252 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2947 + "deleted": true 3253 3253 } 3254 3254 ] 3255 3255 3256 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3257 -|parentId|ID клиента 3258 -|name|Название карты-метки 3259 -|number|Номер 3260 -|period|Период запросов в секундах (работает только для агрегатов) 3261 -|id|ID карты-метки 3262 3262 3263 3263 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3264 3264 ... ... @@ -3275,18 +3275,13 @@ 3275 3275 { 3276 3276 "name": "string", 3277 3277 "number": 0, 3278 - "period": 0, 2967 + "period": 0, ~/~/ Частота трансляции радиометки 3279 3279 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3280 3280 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2970 + "deleted": true 3281 3281 } 3282 3282 ] 3283 3283 3284 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3285 -|name|Название карты-метки 3286 -|number|Номер 3287 -|period|Период запросов в секундах (работает только для агрегатов) 3288 -|id|ID карты-метки 3289 -|parentId|ID клиента 3290 3290 3291 3291 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3292 3292 ... ... @@ -3302,6 +3302,7 @@ 3302 3302 "number": 0, 3303 3303 "period": 0, 3304 3304 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2989 + "deleted": true 3305 3305 } 3306 3306 3307 3307 Ответ: ... ... @@ -3312,14 +3312,9 @@ 3312 3312 "period": 0, 3313 3313 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3314 3314 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3000 + "deleted": true 3315 3315 } 3316 3316 3317 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3318 -|name|Название карты-метки 3319 -|number|Номер 3320 -|period|Период запросов в секундах (работает только для агрегатов) 3321 -|id|ID карты-метки 3322 -|parentId|ID клиента 3323 3323 3324 3324 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3325 3325 ... ... @@ -3336,6 +3336,7 @@ 3336 3336 "period": 0, 3337 3337 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3338 3338 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3019 + "deleted": true 3339 3339 } 3340 3340 3341 3341 Ответ: ... ... @@ -3346,14 +3346,9 @@ 3346 3346 "period": 0, 3347 3347 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3348 3348 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3030 + "deleted": true 3349 3349 } 3350 3350 3351 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3352 -|name|Название карты-метки 3353 -|number|Номер 3354 -|period|Период запросов в секундах (работает только для агрегатов) 3355 -|id|ID карты-метки 3356 -|parentId|ID клиента 3357 3357 3358 3358 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3359 3359 ... ... @@ -3362,7 +3362,7 @@ 3362 3362 **DELETE /api/v3/Rfids/{rfidGuid}** 3363 3363 ))) 3364 3364 3365 -Передаем параметр **rfidGuid**- идентификатор карты-метки3041 +Передаем параметр rfidGuid - идентификатор карты-метки 3366 3366 3367 3367 Ответ: 3368 3368 ... ... @@ -3369,1108 +3369,6 @@ 3369 3369 Success 3370 3370 3371 3371 3372 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3373 - 3374 -== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3375 - 3376 -(% class="box infomessage" %) 3377 -((( 3378 -**GET /api/v3/Billing/client/balance/{clientId}** 3379 -))) 3380 - 3381 -Параметр запроса: **clientId **- идентификатор клиента. 3382 - 3383 -Ответ: 3384 - 3385 -{ 3386 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3387 - "Balance": 0 3388 -} 3389 - 3390 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3391 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3392 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3393 - 3394 -== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3395 - 3396 -(% class="box infomessage" %) 3397 -((( 3398 -**GET /api/v3/Billing/client/constraint/{clientId}** 3399 -))) 3400 - 3401 -Параметр запроса: **clientId **- идентификатор клиента. 3402 - 3403 -Ответ: 3404 - 3405 -{ 3406 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3407 - "CalculationType": 0, 3408 - "PermissibleBalance": 0, 3409 - "DefermentDays": 0, 3410 - "SendUiNotifications": true, 3411 - "SendEmailNotifications": true, 3412 - "IsPrivate": true, 3413 -} 3414 - 3415 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3416 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3417 -|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3418 -|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3419 -|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3420 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3421 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3422 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3423 - 3424 -== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3425 - 3426 -(% class="box infomessage" %) 3427 -((( 3428 -**GET /api/v3/Billing/client/plan/{clientId}** 3429 -))) 3430 - 3431 -Параметры запроса: 3432 - 3433 -**clientId **- идентификатор клиента. 3434 - 3435 -**planId **- идентификатор тарифного плана. 3436 - 3437 -Ответ: 3438 - 3439 -{ 3440 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3441 - "Plan": { **~/~/ Описание тарифного плана** 3442 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3443 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3444 - "Name": "string", 3445 - "IsArchived": true, 3446 - "Constraint": { 3447 - "CalculationType": 0, 3448 - "PermissibleBalance": 0, 3449 - "DefermentDays": 0 3450 - }, 3451 - "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3452 - { 3453 - "Feature": "string", 3454 - "IsFactual": true, 3455 - "Limit": 0, 3456 - "Price": 0, 3457 - "PeriodValue": 0, 3458 - "PeriodType": 0 3459 - } 3460 - ] 3461 - }, 3462 - "DebitDate": "2023-10-18T12:46:24.213Z", 3463 - "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3464 - { 3465 - "Feature": "string", 3466 - "IsEnabled": true, 3467 - "IsPrivate": true, 3468 - "IsFactual": true, 3469 - "Limit": 0, 3470 - "Price": 0, 3471 - "DebitDate": "2023-10-18T12:46:24.213Z", 3472 - "PeriodValue": 0, 3473 - "PeriodType": 0 3474 - } 3475 - ] 3476 -} 3477 - 3478 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3479 -|ClientId|Идентификатор клиента 3480 -|Id|Идентификатор тарифного плана 3481 -|OwnerId|Идентификатор клиента-владельца 3482 -|Name|Наименование тарифного плана 3483 -|IsArchived|Признак, определяющий архивный тарифный план 3484 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3485 -|PermissibleBalance|Допустимый баланс 3486 -|DefermentDays|Отсрочка, количество дней 3487 -|Feature|Код услуги 3488 -|IsEnabled|Признак, определяющий активирована ли услуга 3489 -|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3490 -|IsFactual|Признак, определяющий расчёт по факту 3491 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3492 -|Price|Цена за единицу. 3493 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3494 -|PeriodValue|Значение периода. 3495 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3496 - 3497 -== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3498 - 3499 -(% class="box infomessage" %) 3500 -((( 3501 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3502 -))) 3503 - 3504 -Параметр запроса: **clientId **- идентификатор клиента. 3505 - 3506 -Ответ: 3507 - 3508 -[ 3509 - { 3510 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3511 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3512 - "Name": "string", 3513 - "IsArchived": true, 3514 - "Constraint": { 3515 - "CalculationType": 0, 3516 - "PermissibleBalance": 0, 3517 - "DefermentDays": 0 3518 - }, 3519 - "Features": [ 3520 - { 3521 - "Feature": "string", 3522 - "IsFactual": true, 3523 - "Limit": 0, 3524 - "Price": 0, 3525 - "PeriodValue": 0, 3526 - "PeriodType": 0 3527 - } 3528 - ] 3529 - } 3530 -] 3531 - 3532 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3533 -|ClientId|Идентификатор клиента 3534 -|Id|Идентификатор тарифного плана 3535 -|OwnerId|Идентификатор клиента-владельца 3536 -|Name|Наименование тарифного плана 3537 -|IsArchived|Признак, определяющий архивный тарифный план 3538 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3539 -|PermissibleBalance|Допустимый баланс 3540 -|DefermentDays|Отсрочка, количество дней 3541 -|Feature|Код услуги 3542 -|IsFactual|Признак, определяющий расчёт по факту 3543 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3544 -|Price|Цена за единицу. 3545 -|PeriodValue|Значение периода. 3546 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3547 - 3548 -== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3549 - 3550 -(% class="box infomessage" %) 3551 -((( 3552 -**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3553 -))) 3554 - 3555 -Параметр запроса: **clientId **- идентификатор клиента. 3556 - 3557 -Ответ: 3558 - 3559 -[ 3560 - { 3561 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3562 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3563 - "Name": "string", 3564 - "IsArchived": true, 3565 - "Constraint": { 3566 - "CalculationType": 0, 3567 - "PermissibleBalance": 0, 3568 - "DefermentDays": 0 3569 - }, 3570 - "Features": [ 3571 - { 3572 - "Feature": "string", 3573 - "IsFactual": true, 3574 - "Limit": 0, 3575 - "Price": 0, 3576 - "PeriodValue": 0, 3577 - "PeriodType": 0 3578 - } 3579 - ] 3580 - } 3581 -] 3582 - 3583 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3584 -|ClientId|Идентификатор клиента 3585 -|Id|Идентификатор тарифного плана 3586 -|OwnerId|Идентификатор клиента-владельца 3587 -|Name|Наименование тарифного плана 3588 -|IsArchived|Признак, определяющий архивный тарифный план 3589 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3590 -|PermissibleBalance|Допустимый баланс 3591 -|DefermentDays|Отсрочка, количество дней 3592 -|Feature|Код услуги 3593 -|IsFactual|Признак, определяющий расчёт по факту 3594 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3595 -|Price|Цена за единицу. 3596 -|PeriodValue|Значение периода. 3597 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3598 - 3599 -== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3600 - 3601 -(% class="box warningmessage" %) 3602 -((( 3603 -**PUT /api/v3/Billing/client/balance** 3604 -))) 3605 - 3606 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3607 - 3608 -Тело запроса: 3609 - 3610 -{ 3611 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3612 - "Balance": 0 3613 -} 3614 - 3615 -Ответ: Success 3616 - 3617 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3618 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3619 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3620 - 3621 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3622 - 3623 -(% class="box warningmessage" %) 3624 -((( 3625 -**PUT /api/v3/billing/client/balance/deposit** 3626 -))) 3627 - 3628 -Создает операцию **Пополнение **с указанной суммой 3629 - 3630 -Тело запроса: 3631 - 3632 -{ 3633 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3634 - "Balance": 0 3635 -} 3636 - 3637 -Ответ: Success 3638 - 3639 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3640 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3641 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3642 - 3643 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3644 - 3645 -Создает операцию **Списание **с указанной суммой 3646 - 3647 -(% class="box warningmessage" %) 3648 -((( 3649 -**PUT /api/v3/billing/client/balance/withdraw** 3650 -))) 3651 - 3652 -Тело запроса: 3653 - 3654 -{ 3655 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3656 - "Balance": 0 3657 -} 3658 - 3659 -Ответ: Success 3660 - 3661 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3662 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3663 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3664 - 3665 -== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3666 - 3667 -(% class="box warningmessage" %) 3668 -((( 3669 -**PUT /api/v3/Billing/client/constraint** 3670 -))) 3671 - 3672 -Тело запроса: 3673 - 3674 -{ 3675 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3676 - "CalculationType": 0, 3677 - "PermissibleBalance": 0, 3678 - "DefermentDays": 0, 3679 - "SendUiNotifications": true, 3680 - "SendEmailNotifications": true, 3681 - "IsPrivate": true, 3682 -} 3683 - 3684 -Ответ: Success 3685 - 3686 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3687 -|ClientId|Идентификатор клиента 3688 -|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3689 -|PermissibleBalance|Допустимый баланс 3690 -|DefermentDays|((( 3691 -Отсрочка, количество дней 3692 -))) 3693 -|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3694 -|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3695 -|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3696 - 3697 -== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 3698 - 3699 -(% class="box warningmessage" %) 3700 -((( 3701 -**PUT /api/v3/Billing/client/plan** 3702 -))) 3703 - 3704 -Тело запроса: 3705 - 3706 -{ 3707 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3708 - "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3709 - "Features": [ 3710 - { 3711 - "Feature": "string", 3712 - "IsEnabled": true, 3713 - "IsFactual": true, 3714 - "Limit": 0, 3715 - "Price": 0, 3716 - "DebitDate": "2023-10-18T13:26:58.987Z", 3717 - "PeriodValue": 0, 3718 - "PeriodType": 0 3719 - } 3720 - ] 3721 -} 3722 - 3723 -Ответ: Success 3724 - 3725 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3726 -|ClientId|Идентификатор клиента 3727 -|PlanId|Идентификатор тарифного плана 3728 -|Feature|Код услуги 3729 -|IsEnabled|Признак, определяющий активирована ли услуга 3730 -|IsFactual|Признак, определяющий расчёт по факту 3731 -|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3732 -|Price|Цена за единицу. 3733 -|DebitDate|Следующий момент времени списания с баланса за услугу. 3734 -|PeriodValue|Значение периода. 3735 -|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3736 - 3737 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3738 - 3739 -(% class="box warningmessage" %) 3740 -((( 3741 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 3742 -))) 3743 - 3744 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3745 - 3746 -(% class="box infomessage" %) 3747 -((( 3748 -**POST /api/v3/vehicles/import/{agentId}** 3749 -))) 3750 - 3751 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 3752 - 3753 -В пути указывается **agentId** - id клиента. 3754 - 3755 -**Заголовок** 3756 - 3757 -**X-Auth: [токен авторизации]** 3758 - 3759 -**Параметры** 3760 - 3761 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3762 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 3763 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 3764 - 3765 -В теле использовать тип **form-data,** тип значения** file** 3766 - 3767 -**Ключи** 3768 - 3769 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3770 -|data|В значении передаем файл объекта, формат **xml** или **wlp ** 3771 -|csv|В значении передаем файл датчиков, формат **csv** 3772 - 3773 -Ответ: 3774 - 3775 -{ 3776 - "vehicleId": 0, 3777 - "name": "string", 3778 - "errors": ["string"] 3779 -} 3780 - 3781 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3782 -|vehicleId|ID созданного объекта 3783 -|name|Имя созданного объекта 3784 -|errors|Ошибки и их описание 3785 - 3786 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3787 - 3788 -(% class="box infomessage" %) 3789 -((( 3790 -**POST** **/api/v3/vehicles/import/history/{vehicleId}** 3791 -))) 3792 - 3793 -(% class="wikigeneratedid" %) 3794 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 3795 - 3796 -(% class="wikigeneratedid" %) 3797 -В пути указывается **vehicleId **- id объекта. 3798 - 3799 -**Заголовок** 3800 - 3801 -**X-Auth: [токен авторизации]** 3802 - 3803 -В теле использовать тип **form-data.** 3804 - 3805 -Ключи: 3806 - 3807 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3808 -|**history**|В значении передавать файл с историей 3809 - 3810 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 3811 - 3812 -Ответ: 3813 - 3814 -{ 3815 - "results": [ 3816 - { 3817 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3818 - "vehicleId": 0, 3819 - "errors": [ 3820 - "string" 3821 - ], 3822 - "firstMessageDate": "2023-11-28T09:27:58.949Z", 3823 - "lastMessageDate": "2023-11-28T09:27:58.949Z", 3824 - "producedCount": 0, 3825 - "msgCount": 0 3826 - } 3827 - ] 3828 -} 3829 - 3830 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3831 -|results|Результаты импорта в разрезе ТС 3832 -|vehicleGuid|Guid ТС 3833 -|vehicleId|ID ТС 3834 -|errors|Список ошибок импорта истории (если пустой - нет ошибок) 3835 -|firstMessageDate|Дата первого импортированного сообщения (UTC) 3836 -|lastMessageDate|Дата последнего импортированного сообщения (UTC) 3837 -|producedCount|Кол-во успешно отправленных в шину данных сообщений 3838 -|msgCount|Кол-во обработанных сообщений всего 3839 - 3840 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3841 - 3842 -(% class="box infomessage" %) 3843 -((( 3844 -**GET /api/v3/vehicles/import/history/status** 3845 -))) 3846 - 3847 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 3848 - 3849 -Ответ: 3850 - 3851 -{ 3852 - "activity": true, 3853 - "progress": 0, 3854 - "message": "string" 3855 -} 3856 - 3857 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3858 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 3859 -|progress|Guid ТС 3860 - 3861 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3862 - 3863 -(% class="box infomessage" %) 3864 -((( 3865 -**POST /api/v3/vehicles/export** 3866 -))) 3867 - 3868 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3869 - 3870 -Тело запроса: 3871 - 3872 -[ 3873 - id 3874 -] 3875 - 3876 -Ответ: Success 200, получаете файлы с настройками. 3877 - 3878 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3879 - 3880 -(% class="box infomessage" %) 3881 -((( 3882 -**POST /api/v3/vehicles/export/history** 3883 -))) 3884 - 3885 -Метод возвращает список сообщений терминала объекта за выбранный период. 3886 - 3887 -Тело запроса: 3888 - 3889 -{ 3890 - "vehicleId": 0, 3891 - "asArchive": true, 3892 - "from": "2023-09-27T12:17:45.973Z", 3893 - "to": "2023-09-27T12:17:45.973Z" 3894 -} 3895 - 3896 -Ответ: 3897 - 3898 -Получаете файл. Сообщение: Code 200/Success 3899 - 3900 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3901 -|vehicleId|ID объекта 3902 -|asArchive|true - Архивировать файл, False - не архивировать 3903 -|from|Дата и время начала запроса 3904 -|to|Дата и время окончания запроса 3905 - 3906 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3907 - 3908 -(% class="box infomessage" %) 3909 -((( 3910 -**GET /api/v3/vehicles/export/history/status** 3911 -))) 3912 - 3913 -Метод возвращает список сообщений терминала объекта за выбранный период. 3914 - 3915 -Ответ: 3916 - 3917 -{ 3918 - "activity": true, 3919 - "progress": 0, 3920 - "message": "string" 3921 -} 3922 - 3923 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3924 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3925 -|progress|Прогресс экспорта, от 0 до 100% 3926 -|message|Текст описывающий статус 3927 - 3928 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3929 - 3930 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 3931 - 3932 -(% class="box infomessage" %) 3933 -((( 3934 -**POST /api/v3/EcoDriving/rating** 3935 -))) 3936 - 3937 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3938 - 3939 -Тело запроса: 3940 - 3941 -{ 3942 - "vehicleIds": [vehicleId], 3943 - "from": "2023-11-22T09:29:48.051Z", 3944 - "to": "2023-11-22T09:29:48.051Z" 3945 -} 3946 - 3947 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3948 -|vehicleIds|Массив ID объектов 3949 -|from|Дата начала запроса 3950 -|to|Дата окончания запроса 3951 - 3952 -Ответ: 3953 - 3954 -{ 3955 - "items": [ 3956 - { 3957 - "from": "2023-11-22T09:29:48.052Z", 3958 - "to": "2023-11-22T09:29:48.052Z", 3959 - "vehicleId": 0, 3960 - "vehicleName": "string", 3961 - "vehicleModel": "string", 3962 - "penalty": 0, 3963 - "score": 0, 3964 - "totalViolations": 0, 3965 - "violationsByType": { 3966 - "overspeedingViolations": 0, 3967 - "accelerationViolations": 0, 3968 - "brakingViolations": 0, 3969 - "turningViolations": 0, 3970 - "dangerousDrivingViolations": 0, 3971 - "sensorViolations": 0 3972 - }, 3973 - "moveTime": 0, 3974 - "mileage": 0, 3975 - "tripsCount": 0, 3976 - "trips": [ 3977 - { 3978 - "penalty": 0, 3979 - "score": 0, 3980 - "violationsCount": 0, 3981 - "violationsByType": { 3982 - "overspeedingViolations": 0, 3983 - "accelerationViolations": 0, 3984 - "brakingViolations": 0, 3985 - "turningViolations": 0, 3986 - "dangerousDrivingViolations": 0, 3987 - "sensorViolations": 0 3988 - }, 3989 - "moveTime": 0, 3990 - "mileage": 0, 3991 - "motohours": 0, 3992 - "maxSpeed": 0, 3993 - "startAddress": "string", 3994 - "endAddress": "string", 3995 - "drivers": [ 3996 - { 3997 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3998 - "driverName": "string", 3999 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4000 - } 4001 - ] 4002 - } 4003 - ] 4004 - } 4005 - ] 4006 -} 4007 - 4008 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4009 -|from|Дата начала запроса 4010 -|to|Дата окончания 4011 -|vehicleId|ID объекта 4012 -|vehicleName|Имя объекта 4013 -|vehicleModel|Модель объекта 4014 -|penalty|Сумма штрафных баллов 4015 -|score|Оценка 4016 -|totalViolations|Суммарное количество нарушений 4017 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4018 -|overspeedingViolations|Превышение скорости 4019 -|accelerationViolations|Ускорение 4020 -|brakingViolations|Торможение 4021 -|turningViolations|Резкий поворот 4022 -|dangerousDrivingViolations|Резкое вождение 4023 -|sensorViolations|Нарушение по датчику 4024 -|moveTime|Время в движении 4025 -|mileage|Пробег (км) 4026 -|tripsCount|Количество рейсов 4027 -|motohours|Моточасы 4028 -|maxSpeed|Максимальная скорость 4029 -|startAddress|Адрес начала рейса 4030 -|endAddress|Адрес окончания рейса 4031 -|drivers|Список водителей, которые были на объекте в течениии рейса 4032 -|driverGuid|Guid водителя 4033 -|driverName|Имя водителя 4034 -|driverRfid|Номер Карты-метки 4035 - 4036 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4037 - 4038 -== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4039 - 4040 -Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4041 - 4042 -(% class="box infomessage" %) 4043 -((( 4044 -POST /api/v3/fuelcards/transactions 4045 -))) 4046 - 4047 -Метод запроса: POST 4048 - 4049 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4050 -\\В заголовках запроса: X-Auth: Токен авторизации 4051 - 4052 -Параметры в теле запроса (JSON): 4053 - 4054 -{ 4055 - "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4056 - "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4057 - "ids": [ 4058 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4059 - ], 4060 - "timezone": 0 ~/~/Таймзона 4061 -} 4062 - 4063 - 4064 -Ответ: 4065 - { 4066 - "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4067 - "driver": "string", ~/~/Водители, привязанные к ТК 4068 - "object": "string", ~/~/Наименование ТС 4069 - "amount": 0, ~/~/Количество топлива 4070 - "amountDut": 0, ~/~/Количество по ДУТ 4071 - "amountDiff": 0, ~/~/Разница, л 4072 - "amountDiffPerc": 0, ~/~/Разница, % 4073 - "summa": 0, ~/~/Стоимость, руб 4074 - "serviceName": "string", ~/~/Тип топлива 4075 - "price": 0, ~/~/Цена за литр, руб 4076 - "cardName": "string", ~/~/Наименование ТК 4077 - "cardNum": "string", ~/~/Номер ТК 4078 - "operator": "string", ~/~/Оператор ТК 4079 - "address": "string" ~/~/Адрес АЗС 4080 - } 4081 - 4082 - 4083 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4084 - 4085 - 4086 -== **Получение полных данных о ретрансляторе** == 4087 - 4088 -(% class="box infomessage" %) 4089 -((( 4090 -**GET ** **/api/v3/retranslations/{id}** 4091 -))) 4092 - 4093 -Идентификатор запроса: ID 4094 - 4095 - 4096 -Пример ответа: 4097 - 4098 -{ 4099 -"description": "", ~/~/ Определяет описание 4100 -"subscriberId": "", ~/~/ Подписчик 4101 -"protocolType": 0, ~/~/ Тип протокола 4102 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4103 -"address": "string", ~/~/ Адрес события 4104 -"objects": [ ~/~/Объекты для ретрансляции 4105 -{ 4106 -"id": "", ~/~/ Идентификатор объекта ретрансляции 4107 -"name": "", ~/~/ Наименование объекта ретрансляции 4108 -"imei": "", ~/~/ IMEI объекта 4109 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4110 -} 4111 - ], 4112 -"id": "", ~/~/ идентификатор пользователя 4113 -"parentId": "", ~/~/Guid родителя 4114 -"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4115 -} 4116 - 4117 - 4118 -== **Удаление данных ретранслятора** == 4119 - 4120 -(% class="box infomessage" %) 4121 -((( 4122 -**DELETE** **/api/v3/retranslations/{id}** 4123 -))) 4124 - 4125 -Параметр запроса: ID 4126 - 4127 - 4128 -== **Создание ретранслятора** == 4129 - 4130 -(% class="box infomessage" %) 4131 -((( 4132 -**POST ** **/api/v3/retranslations/{id}** 4133 -))) 4134 - 4135 -Запрос: 4136 - 4137 -{ 4138 -"description": "", ~/~/ Описание 4139 -"subscriberId": "", ~/~/ Подписчик 4140 -"protocolType": 0, ~/~/ Тип протокола 4141 -"address": "", ~/~/ Адрес ретрансляции 4142 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4143 -"objects": [ ~/~/Объекты для ретрансляции 4144 -{ 4145 -"id": "", ~/~/ идентификатор пользователя 4146 -"imei": "", ~/~/IMEI объекта 4147 -"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4148 -} 4149 - ] 4150 -} 4151 - 4152 - 4153 -Ответ: 4154 - 4155 -{ 4156 -"description": "string", ~/~/ Определяет описание 4157 -"subscriberId": "", ~/~/ идентификатор запроса 4158 -"protocolType": 0, ~/~/ Тип протокола 4159 -"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4160 -"address": "", ~/~/ Адрес события 4161 -"objects": [ ~/~/Объекты для ретрансляции 4162 -{ 4163 -"id": "", ~/~/ идентификатор пользователя 4164 -"name": "string", ~/~/ Название уведомления 4165 -"imei": "string", ~/~/IMEI объекта 4166 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4167 -} 4168 - ], 4169 -"id": "", ~/~/ идентификатор пользователя 4170 -"parentId": "", ~/~/ Guid идентификатор родителя 4171 -"deleted": true ~/~/ Признак удаления 4172 -} 4173 - 4174 - 4175 -== **Редактирование ретранслятора** == 4176 - 4177 -(% class="box infomessage" %) 4178 -((( 4179 -**PUT** **/api/v3/retranslations** 4180 -))) 4181 - 4182 -Пример запроса: 4183 - 4184 -{ 4185 -"id": "", ~/~/ идентификатор пользователя 4186 -"description": "string", ~/~/ Определяет описание 4187 -"subscriberId": "", ~/~/ идентификатор запроса 4188 -"protocolType": 0, ~/~/ Тип протокола 4189 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4190 -"address": "string", ~/~/ Адрес события 4191 -"objects": ~/~/Объекты для ретрансляции 4192 -[ 4193 -{ 4194 -"id": "", ~/~/ идентификатор пользователя 4195 -"imei": "", ~/~/IMEI объекта 4196 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4197 -} 4198 - ] 4199 -} 4200 - 4201 - 4202 -Пример ответа: 4203 - 4204 -{ 4205 -"description": "", ~/~/ Определяет описание 4206 -"subscriberId": "", ~/~/ идентификатор запроса 4207 -"protocolType": 0, ~/~/ Тип протокола 4208 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4209 -"address": "string", ~/~/ Адрес события 4210 -"objects": [ ~/~/Объекты для ретрансляции 4211 -{ 4212 -"id": "", ~/~/ идентификатор пользователя 4213 -"name": "string", ~/~/ Название уведомления 4214 -"imei": "", ~/~/IMEI объекта 4215 -"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4216 -} 4217 - ], 4218 -"id": "", ~/~/ идентификатор пользователя 4219 -"parentId": "", ~/~/ Guid идентификатор родителя 4220 -"deleted": true ~/~/ Признак удаления 4221 -} 4222 - 4223 - 4224 -== **Получение списка ретранслятора клиента** == 4225 - 4226 -(% class="box infomessage" %) 4227 -((( 4228 -**POST /api/v3/retranslations/find** 4229 -))) 4230 - 4231 -Пример запроса: 4232 - 4233 -{ 4234 -"id": "", ~/~/ идентификатор пользователя 4235 -"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4236 -"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4237 -} 4238 - 4239 -Ответ: 4240 - 4241 -[ 4242 -{ 4243 -"description": "", ~/~/ Определяет описание 4244 -"subscriberId": "", ~/~/ идентификатор запроса 4245 -"protocolType": 0, ~/~/ Тип протокола 4246 -"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4247 -"address": "string", ~/~/ Адрес события 4248 -"id": "", ~/~/ идентификатор пользователя 4249 -"parentId": "", ~/~/ Guid идентификатор родителя 4250 -"deleted": true ~/~/ Признак удаления 4251 -} 4252 -] 4253 - 4254 - 4255 -= (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4256 - 4257 -== **API для отчета по выгрузке комбайнов** == 4258 - 4259 -(% class="box infomessage" %) 4260 -((( 4261 -POST **/api/v3/Reports/harvesterUnloading** 4262 -))) 4263 - 4264 -Пример запроса: 4265 - 4266 -{ 4267 - "byTime": 0, ~/~/ Объединение событий по времени 4268 - "byDist": 0, ~/~/ Объединение событий по расстоянию 4269 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4270 - "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4271 - "showNearestObjects": true, ~/~/Показывать объекты рядом? 4272 - "vehicleIds": [ ~/~/ Список id объектов для анализа 4273 - 0 4274 - ], 4275 - "from": "", ~/~/ Дата и время начало запроса 4276 - "to": "", ~/~/ Дата и время окончания запроса 4277 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4278 -} 4279 - 4280 -Пример ответа: 4281 - 4282 -[ 4283 - { 4284 - "harvesterName": "", ~/~/Комбайн, номер 4285 - "harvesterId": 0, ~/~/Комбайн, id 4286 -"harvesterModel": "", ~/~/ Модель комбайна 4287 -"hopperCapacity": 0, ~/~/ Объем бункера м3 4288 - "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4289 - "events": [ ~/~/Список событий в разрезе комбайна 4290 - { 4291 - "driverId": "", ~/~/Идентификатор водителя 4292 - "driverName": "", ~/~/Водитель комбайна, ФИО 4293 - "RFID": "", ~/~/ идентификатор карты-метки 4294 - "rfidName": "", ~/~/Водитель комбайна, имя метки 4295 - "vehicleId": 0, ~/~/идентификатор объекта 4296 - "vehicleName": "string", ~/~/ Имя объекта 4297 - "modelName": "string", ~/~/ Имя модели объекта 4298 - "nearestVehicles": [ ~/~/Объекты рядом 4299 - { 4300 - "vehicleId": 0, ~/~/идентификатор объекта 4301 - "vehicleName": "string" ~/~/ Имя объекта 4302 - } 4303 - ], 4304 - "fields": [ ~/~/Поля, где происходила выгрузка 4305 - { 4306 - "id": 0, ~/~/ идентификатор пользователя 4307 - "name": "string" ~/~/ имя пользователя 4308 - } 4309 - ], 4310 - "event": "string", ~/~/Событие 4311 - "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4312 - "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4313 - "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4314 - "cultureName": "string", ~/~/ название культуры 4315 - "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4316 - "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4317 - "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4318 - "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4319 - "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4320 - "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4321 - "issued": 0, ~/~/Выдано, бункеров 4322 - "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4323 - "latitude": 0, ~/~/Широта 4324 - "longitude": 0, ~/~/ Долгота 4325 - "litresAway": 0, ~/~/Отдано, л 4326 - "m3Away": 0 ~/~/Отдано, м3 4327 - } 4328 - ] 4329 - } 4330 -] 4331 - 4332 - 4333 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4334 - 4335 -== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4336 - 4337 - 4338 -(% class="box infomessage" %) 4339 -((( 4340 -GET api/v3/Vehicles/recyclebin/all 4341 -))) 4342 - 4343 -Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4344 - 4345 -Параметр запроса: {parentId} - идентификатор агента 4346 - 4347 -В заголовках запроса: X-Auth: Токен авторизации 4348 - 4349 -Ответ: 4350 - 4351 -[ 4352 - { 4353 - "recordTime": "", ~/~/Время записи 4354 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4355 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4356 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4357 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4358 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4359 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4360 - "items": [ ~/~/ 4361 -nullable: true ~/~/Детали 4362 - { 4363 - "name": "string", ~/~/наименование столбца 4364 - "value": "string" ~/~/содержание столбца 4365 - } 4366 - ] 4367 - }, 4368 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4369 - "string" 4370 - ] 4371 - } 4372 -] 4373 - 4374 - 4375 -(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4376 - 4377 -(% class="box infomessage" %) 4378 -((( 4379 -POST/api/v3/Vehicles/recyclebin/erase 4380 -))) 4381 - 4382 -В заголовках запроса: X-Auth: Токен авторизации 4383 - 4384 -Пример запроса: 4385 - 4386 -[ 4387 -0 4388 -] 4389 - 4390 - 4391 -Пример ответа: 4392 - 4393 -[ 4394 -{ 4395 - "recordTime": "", ~/~/Время записи 4396 - "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4397 - "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4398 - "objectId": 0, ~/~/ID объекта, помещённого в корзин 4399 - "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4400 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4401 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4402 - "items": [ ~/~/Детали 4403 - { 4404 - "name": "", ~/~/Имя свойства 4405 - "value": "" ~/~/Значение свойства 4406 - } 4407 - ] 4408 - }, 4409 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4410 - "" 4411 - ] 4412 - } 4413 -] 4414 - 4415 -Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4416 - 4417 -== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4418 - 4419 -(% class="box infomessage" %) 4420 -((( 4421 -POST/api/v3/Vehicles/recyclebin/restore 4422 -))) 4423 - 4424 -В заголовках запроса: X-Auth: Токен авторизации 4425 - 4426 -Параметры в теле запроса (JSON): 4427 - 4428 -Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4429 - 4430 -В заголовках запроса: X-Auth: Токен авторизации 4431 - 4432 - 4433 -Пример запроса: 4434 - 4435 -((( 4436 -[ 4437 -))) 4438 - 4439 -((( 4440 - 0 4441 -))) 4442 - 4443 -((( 4444 -] 4445 -))) 4446 - 4447 - 4448 -Пример ответа: 4449 - 4450 -[ 4451 -{ 4452 - "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4453 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4454 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4455 - "objectId": 0, ~/~/ID объекта, помещённого в корзину 4456 - "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4457 - "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4458 - "details": { ~/~/Список деталей объекта, помещённого в корзину 4459 - "items": [ ~/~/Детали 4460 - { 4461 - "name": "string", ~/~/Имя свойства 4462 - "value": "string" ~/~/Значение свойства 4463 - } 4464 - ] 4465 - }, 4466 - "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4467 - "string" 4468 - ] 4469 - } 4470 -] 4471 - 4472 - 4473 - 4474 4474 (% class="box" lang="en-US" style="text-align: center;" %) 4475 4475 ((( 4476 4476 (% 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