Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,5 +1,16 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно просим вас соблюдать несколько простых правил при использовании API-команд:## 6 +))) 7 + 8 +* Формировать не более 3 отчётов одновременно. 9 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 10 + 11 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить работу команд. 12 + 13 + 3 3 **Содержание страницы:** 4 4 ))) 5 5 ... ... @@ -14,13 +14,22 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!28 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 30 + 31 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 32 + 33 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 34 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 37 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 38 +((( 39 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 40 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 41 +))) 22 22 23 -(% class="box infomessage" %)43 +(% class="box successmessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».54 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,21 +40,25 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) 47 47 (% style="color:#000000" %){ 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" %) 67 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 68 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 73 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 74 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 75 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 76 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 77 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 78 + 79 +(% class="wikigeneratedid" %) 80 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 81 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,51 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 97 97 { 98 - "agentId": "", ~/~/идентификатор клиента(%%)99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%)102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)104 - "isForeign": true/false, ~/~/ Иностранный контрагент105 - "district": "string", ~/~/ округ106 - "region": "string", ~/~/ регион107 - "city": "string", ~/~/ город108 - "inn": "string", ~/~/ ИНН клиента109 - "kpp": "string", ~/~/ КПП клиента110 - "address": "string", ~/~/ юридический адрес111 - "addressFact": "string", ~/~/ фактический адрес112 - "email": "string", ~/~/ почта113 - "director": "string", ~/~/ ФИО руководителя114 - "bankName": "string", ~/~/ Банк115 - "bankBIK": "string", ~/~/ БИК116 - "bankRS": "string", ~/~/ Номер счета117 - "bankKS": "string" ~/~/ Корр. счет121 + "agentId": "", (%%) 122 + "parentId": "", 123 + "parentName": "string", 124 + "name": "string", 125 + "fullName": "string", 126 + "agentInfoType": 0, 127 + "isForeign": true/false, 128 + "district": "string", 129 + "region": "string", 130 + "city": "string", 131 + "inn": "string", 132 + "kpp": "string", 133 + "address": "string", 134 + "addressFact": "string", 135 + "email": "string", 136 + "director": "string", 137 + "bankName": "string", 138 + "bankBIK": "string", 139 + "bankRS": "string", 140 + "bankKS": "string" 118 118 } 119 119 143 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 144 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 145 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 146 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 147 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 148 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 149 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 150 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 151 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 152 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 153 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 154 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 155 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 156 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 157 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 158 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 159 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 160 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 161 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 162 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 163 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 164 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».178 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,23 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 193 + "agentId": "",(% style="color:#000000" %) (%%) 194 + "parentId": "", 195 + "name": "string", 196 + "fullName": "string", 197 + "agentInfoType": 0, 198 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 201 + 202 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 203 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 204 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 205 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 206 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 207 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 208 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 209 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 228 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -192,7 +192,6 @@ 192 192 "bankKS": "string" ~/~/ корр. счёт 193 193 } 194 194 195 - 196 196 Ответ: 197 197 198 198 { ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 272 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 273 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 274 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 275 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 276 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 277 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 278 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 279 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 280 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 281 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 282 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 283 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 284 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 285 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 286 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 287 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 288 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 289 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 290 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 291 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 292 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 293 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 375 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 376 + 377 +(% class="box warningmessage" %) 378 +((( 379 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 380 +))) 381 + 382 +Метод позволяет изменить статус клиента, указанного в запросе. 383 + 384 +В пути указывается GUID клиента и статус клиента. 385 + 386 +**status **- значение 0 - заблокирован, 1 - активен. 387 + 388 +Ответ: Code 204 389 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -351,7 +351,6 @@ 351 351 ], 352 352 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 - 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 пользователя 454 +{ 455 + "id": "" , ~/~/ ID пользователя 375 375 "lastName": "" , ~/~/ Фамилия , 376 376 "firstName": "" , ~/~/ Имя 377 377 "position": "" , ~/~/ Должность ... ... @@ -388,9 +388,8 @@ 388 388 "kind": "" , ~/~/ тип аутентификации 389 389 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 390 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 472 +} 391 391 392 -(% style="text-align:left" %) 393 -(% style="color:#000000; font-weight:normal" %)} 394 394 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 ... ... @@ -411,19 +411,16 @@ 411 411 412 412 (% style="color:#000000" %)Параметры в теле запроса (JSON): 413 413 414 -(% style="color:#000000" %){ 415 - 494 +(% style="color:#000000" %){(%%) 416 416 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 417 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 418 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 419 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 423 (% style="color:#000000" %)Ответ: 424 424 425 425 (% style="color:#000000" %){ (%%) 426 - 427 427 "id": "" , ~/~/ идентификатор пользователя 428 428 "lastName": "" , ~/~/ фамилия 429 429 "firstName": "" , ~/~/ имя ... ... @@ -437,7 +437,6 @@ 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 439 "lastLogged": "", ~/~/ дата/время последней авторизации 440 - 441 441 (% style="color:#000000" %)} 442 442 443 443 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -511,10 +511,8 @@ 511 511 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 512 512 513 513 (% lang="en-US" style="text-align:left" %) 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 пользователя 590 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 591 + "id": "" , ~/~/ ID пользователя 518 518 "lastName": "" , ~/~/ фамилия 519 519 "firstName": "" , ~/~/ имя 520 520 "position": "" , ~/~/ должность ... ... @@ -536,9 +536,7 @@ 536 536 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 537 }, 538 538 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 - 541 -(% lang="en-US" style="text-align:left" %) 613 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 542 542 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 543 543 544 544 (% lang="en-US" style="text-align:left" %) ... ... @@ -545,10 +545,8 @@ 545 545 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 546 546 547 547 (% lang="en-US" style="text-align:left" %) 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": "" , ~/~/ идентификатор пользователя 620 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 621 + "id": "" , ~/~/ идентификатор пользователя 552 552 "lastName": "" , ~/~/ фамилия 553 553 "firstName": "" , ~/~/ имя 554 554 "position": "" , ~/~/ должность ... ... @@ -569,10 +569,8 @@ 569 569 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 570 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 571 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 642 +} 572 572 573 -(% lang="en-US" style="text-align:left" %) 574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 - 576 576 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 577 577 578 578 (% class="box warningmessage" %) ... ... @@ -592,12 +592,10 @@ 592 592 593 593 (% style="color:#000000" %)Параметры в теле запроса (JSON): 594 594 595 -(% style="color:#000000" %){ 596 - 663 +(% style="color:#000000" %){(%%) 597 597 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 598 "description": "" , ~/~/ описание 599 599 "data": "" , ~/~/ данные, связанные со сменой статуса 600 - 601 601 (% style="color:#000000" %)} 602 602 603 603 (% style="text-align:left" %) ... ... @@ -619,7 +619,7 @@ 619 619 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 620 621 621 [ 622 - 688 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -711,7 +711,6 @@ 711 711 "maxspeed": 0, 712 712 "width": 0, 713 713 "imbeddedtrailer": true, 714 - "fueloutlay": 0, 715 715 "hoppercapacity": 0, 716 716 "hopperdischargespeed": 0, 717 717 "modelType": 0, ... ... @@ -720,7 +720,7 @@ 720 720 "deleted": true 721 721 } 722 722 723 -|(% style="width:215px" %)Параметр|(% style="width:861px" %)Описание 788 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 724 724 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 725 725 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 726 726 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта ... ... @@ -728,9 +728,8 @@ 728 728 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 729 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 730 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 732 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 797 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 734 734 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 735 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 736 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -751,10 +751,9 @@ 751 751 752 752 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 753 753 754 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 818 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 755 755 756 -(% style="color:#000000" %){ 757 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 820 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 758 758 } 759 759 760 760 (% style="color:#000000" %)Ответ: ... ... @@ -769,6 +769,13 @@ 769 769 } 770 770 ] 771 771 835 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 836 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 837 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 838 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 839 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 840 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 841 + 772 772 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 773 773 774 774 (% class="box successmessage" %) ... ... @@ -816,12 +816,25 @@ 816 816 "maxspeed": 0, 817 817 "width": 0, 818 818 "imbeddedtrailer": true, 819 - "fueloutlay": 0, 820 820 "hoppercapacity": 0, 821 821 "hopperdischargespeed": 0, 822 822 "modelType": 0 823 823 } 824 824 894 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 895 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 896 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 897 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 898 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 899 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 900 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 901 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 902 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 903 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 904 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 905 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 906 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 907 + 825 825 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 826 826 827 827 (% class="box warningmessage" %) ... ... @@ -875,6 +875,20 @@ 875 875 "modelType": 0 876 876 } 877 877 961 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 962 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 963 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 964 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 965 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 966 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 967 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 968 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 969 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 970 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 971 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 972 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 973 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 974 + 878 878 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 879 879 880 880 (% class="box errormessage" %) ... ... @@ -894,7 +894,7 @@ 894 894 895 895 Ответ: В случае успеха **Success 200** 896 896 897 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 994 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 898 898 899 899 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 900 900 ... ... @@ -930,19 +930,15 @@ 930 930 "deviceTypeName": "", ~/~/ Название типа устройства 931 931 "sim1": "", ~/~/ Номер SIM1 932 932 "sim2": "", ~/~/ Номер SIM2 933 - 934 934 "parentId": "", ~/~/ ID клиента-родителя 935 935 "parentName": "", ~/~/ Наименование клиента-родителя 936 936 "modelId": "", ~/~/ ID модели объекта 937 937 "modelName": "", ~/~/ Имя модели объекта 938 - 939 939 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 940 940 "unitName": "string", ~/~/ Наименование подразделения 941 941 "status": 0, ~/~/ Статус объекта 942 - 943 943 "createdAt": "", ~/~/ Дата создания объекта 944 944 }, 945 - 946 946 "customFields": [ ~/~/ Произвольные поля 947 947 { 948 948 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -965,8 +965,7 @@ 965 965 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 966 966 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 967 967 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 968 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 969 - 1061 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 970 970 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 971 971 "mileageCoeff": 0, ~/~/ коэффициент пробега 972 972 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -996,7 +996,6 @@ 996 996 "retries": 0 ~/~/ Количество попыток 997 997 } 998 998 ], 999 - 1000 1000 "sensors": [ ~/~/ Датчики 1001 1001 { 1002 1002 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1037,31 +1037,19 @@ 1037 1037 }, 1038 1038 1039 1039 ~/~/ Характерные для произвольного: 1040 - 1041 1041 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1042 - 1043 1043 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1044 - 1045 1045 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1046 - 1047 1047 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1048 - 1049 1049 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1050 - 1051 1051 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1052 - 1053 1053 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1054 - 1055 1055 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1056 - 1057 1057 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1058 - 1059 1059 ~/~/ "ValueOn": "Вкл.", 1060 - 1061 1061 ~/~/ "ValueOff": "Выкл." 1062 1062 "summaryMaxValue": 0 ~/~/ Макс. значение 1063 1063 } 1064 - 1065 1065 "drivers": [ ~/~/ Водители 1066 1066 { 1067 1067 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1070,7 +1070,6 @@ 1070 1070 "isDefault": true ~/~/ По умолчанию 1071 1071 } 1072 1072 ], 1073 - 1074 1074 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1075 1075 { 1076 1076 "id": "", ~/~/ ID задания ... ... @@ -1087,8 +1087,7 @@ 1087 1087 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1088 1088 } 1089 1089 ], 1090 - 1091 - "statusHistory": [ ~/~/ История статусов 1168 +"statusHistory": [ ~/~/ История статусов 1092 1092 { 1093 1093 "status": 0, 1094 1094 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1096,7 +1096,6 @@ 1096 1096 "additionalInfo": "string" 1097 1097 } 1098 1098 ] 1099 - 1100 1100 } 1101 1101 ))) 1102 1102 ... ... @@ -1106,6 +1106,73 @@ 1106 1106 (% style="text-align:left" %) 1107 1107 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1108 1108 1185 + 1186 +== **Отправить команду на терминал** == 1187 + 1188 +(% class="box successmessage" %) 1189 +((( 1190 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1191 +))) 1192 + 1193 +Команда для отправки на тс. 1194 + 1195 +{ 1196 +"id": "", ~/~/идентификатор произвольного поля 1197 +"command": "", ~/~/ Текст команды 1198 +"retries": "", ~/~/ Количество попыток 1199 +"idTemplate": "" ~/~/ ID шаблона команды 1200 +} 1201 + 1202 + 1203 +== **Получить ответ на отправленную на ТС команду** == 1204 + 1205 +(% class="box infomessage" %) 1206 +((( 1207 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1208 +))) 1209 + 1210 +Идентификатор команды: cmdid 1211 + 1212 +Запрос от терминала на ответ команды 1213 + 1214 +Пример ответ от терминала: 1215 + 1216 +ID= "" ~/~/ идентификатор произвольного поля 1217 +Soft="" ~/~/ версия софта 1218 +GPS=4 ~/~/ тип трекера 1219 +Time=11:05:43 28.06.24 ~/~/ время запроса 1220 +Lat=45.056221 ~/~/ широта 1221 +Lon=39.035938 ~/~/ долгота 1222 +Speed=0.0 ~/~/ скорость 1223 +Course=181.4 ~/~/направление 1224 + 1225 +((( 1226 +== **Список отправленных объекту команд с ответами** == 1227 + 1228 +(% class="box infomessage" %) 1229 +((( 1230 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1231 +))) 1232 + 1233 +Идентификатор ТС: vehicleId 1234 + 1235 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1236 + 1237 +Пример ответа терминала 1238 + 1239 +[ 1240 +{ 1241 +"id": "", ~/~/ идентификатор пользователя 1242 +"commandText": "", ~/~/Текст команды. 1243 +"templateId": "", ~/~/Идентификатор шаблона 1244 +"updated": "", ~/~/ Время отправки 1245 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1246 +"answer": "", ~/~/ Ответ терминала. 1247 +"status": "" ~/~/ Статус отправки 1248 +} 1249 +] 1250 +))) 1251 + 1109 1109 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1110 1110 1111 1111 (% class="box successmessage" %) ... ... @@ -1123,8 +1123,7 @@ 1123 1123 1124 1124 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1125 1125 1126 -(% style="color:#000000" %){ 1127 - 1269 +(% style="color:#000000" %){(%%) 1128 1128 "parentId": "" , ~/~/ ID клиента 1129 1129 "name": "" , ~/~/ имя ТС 1130 1130 "imei": "" , ~/~/ IMEI ... ... @@ -1145,7 +1145,6 @@ 1145 1145 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1146 1146 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1147 1147 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1148 - 1149 1149 "mileageCalcMethod": 0, 1150 1150 "mileageCoeff": 0, 1151 1151 "locationByCellId": true, ... ... @@ -1178,7 +1178,6 @@ 1178 1178 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1179 1179 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1180 1180 } 1181 - 1182 1182 "drivers": [ ~/~/ Водители 1183 1183 { 1184 1184 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1193,8 +1193,7 @@ 1193 1193 "retries": 0 1194 1194 } 1195 1195 ], 1196 - 1197 - "sensors": [ ~/~/ Датчики 1336 +"sensors": [ ~/~/ Датчики 1198 1198 { 1199 1199 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1200 1200 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1232,41 +1232,43 @@ 1232 1232 "additionalProp2": "string", 1233 1233 "additionalProp3": "string" 1234 1234 }, 1235 - 1236 1236 ~/~/ Характерные для произвольного: 1237 - 1238 1238 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1239 - 1240 1240 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1241 - 1242 1242 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1243 - 1244 1244 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1245 - 1246 1246 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1247 - 1248 1248 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1249 - 1250 1250 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1251 - 1252 1252 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1253 - 1254 1254 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1255 - 1256 1256 ~/~/ "ValueOn": "Вкл.", 1257 - 1258 1258 ~/~/ "ValueOff": "Выкл." 1259 - "summaryMaxValue": 0 ~/~/ Макс. значение 1386 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1387 + 1388 +((( 1389 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1390 + { 1391 + "from": 0, ~/~/ С какого значения 1392 + "color": "string", ~/~/ Каким цветом 1393 + "text": "string" ~/~/ Текст подписи к этому интервалу 1394 + } 1395 + ] 1260 1260 } 1261 1261 ], 1398 +))) 1399 + 1400 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1401 + 1402 + 1262 1262 "customFields": [ ~/~/ Произвольные поля 1263 1263 { 1264 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1265 - "name": "string", 1266 - "value": "string", 1267 - "forClient": true, 1268 - "forTooltip": true, 1269 - "forReport": true 1405 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1406 + "name": "string", ~/~/ Наименование произвольного поля 1407 + "value": "string", ~/~/ Значение произвольного поля 1408 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1409 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1410 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1270 1270 } 1271 1271 ] 1272 1272 } ... ... @@ -1273,62 +1273,240 @@ 1273 1273 1274 1274 (% style="color:#000000" %)Ответ: 1275 1275 1276 -(% style="color:#000000" %){ 1277 1277 1278 - "vehicleId": "", ~/~/ID ТС 1279 - "parentId": "", ~/~/Guid владельца ТС 1280 - "name": "", ~/~/Имя объекта 1281 - "imei": "", ~/~/IMEI 1282 - "deviceTypeId": "", ~/~/ID типа устройства 1283 - "modelId": "", ~/~/ID модели 1284 - "unitId": "", ~/~/ID подразделения 1285 - "sim1": "", ~/~/SIM1 1286 - "sim2": "", ~/~/SIM2 1287 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1288 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1289 - "counters": { ~/~/Счётчики 1290 - "mileageEnabled": true, 1291 - "motohoursEnabled": true, 1292 - "mileage": "", 1293 - "motohours": 345.0 1294 - }, 1295 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1296 - "id": null, 1297 - "enabled": true, ~/~/флаг включения 1298 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1299 - "login": "", ~/~/ имя учетной записи 1300 - "password": "" ~/~/ пароль учетной записи 1301 - }, 1302 - "inspectionTasks": { ~/~/ задания на ТО 1303 - "id": "", ~/~/ ID задачи 1304 - "enabled": false, ~/~/ Признак включения 1305 - "name": "", ~/~/ Имя задания 1306 - "description": "", ~/~/ Описание задания 1307 - "mileageCondition": "", ~/~/ Условие по пробегу 1308 - "lastMileage": "", ~/~/ Пробег (в метрах) 1309 - "motohoursCondition": "", ~/~/ Условие по моточасам 1310 - "lastMotohours": "", ~/~/ Моточасы 1311 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1312 - "kind": "", ~/~/ Вид периодичности по времени 1313 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1418 +((( 1419 +((( 1420 +((( 1421 +{ 1422 + "vehicleId": 0, ~/~/ ID ТС 1423 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1424 + "name": "string", ~/~/ Имя объекта 1425 + "imei": "string", ~/~/ IMEI 1426 + "deviceTypeId": 0, ~/~/ ID типа устройства 1427 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1428 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1429 + "sim1": "string", ~/~/ SIM1 1430 + "sim2": "string", ~/~/ SIM2 1431 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1432 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1433 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1434 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1435 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1436 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1437 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1438 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1439 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1440 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1441 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1442 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1443 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1444 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1445 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1446 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1447 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1448 + "counters": { ~/~/ Dto для состояний счётчиков 1449 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1450 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1451 + "mileage": 0, ~/~/ Пробег 1452 + "motohours": 0 ~/~/ Моточасы 1453 + }, 1454 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1455 + "id": "string", ~/~/ CMSV6 Идентификатор 1456 + "enabled": true, ~/~/ Признак включения 1457 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1458 + "login": "string", ~/~/ CMSV6 имя учетной записи 1459 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1460 + }, 1461 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1462 + { 1463 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1464 + "enabled": true, ~/~/ Признак включения 1465 + "name": "string", ~/~/ Имя задания 1466 + "description": "string", ~/~/ Описание задания 1467 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1468 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1469 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1470 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1471 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1472 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1473 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1474 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1314 1314 } 1476 + ], 1477 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1478 + { 1479 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1480 + "inputNumber": 0, ~/~/ № входа. 1481 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1482 + "comment": "string", ~/~/ Комментарий 1483 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1484 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1485 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1486 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1487 + } 1488 + ], 1489 + "commandTemplates": [ ~/~/ Список шаблонов команд 1490 + { 1491 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1492 + "name": "string", ~/~/ Название шаблона команд 1493 + "command": "string", ~/~/ Команда на выполнение 1494 + "retries": 0 ~/~/ Лимит попыток отправки 1495 + } 1496 + ], 1497 + "sensors": [ ~/~/ Список датчиков 1498 + { 1499 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1500 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1501 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1502 + "name": "string", ~/~/ Имя датчика 1503 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1504 + "inputNumber": 0, ~/~/ Номер входа 1505 + "pseudonym": "string", ~/~/ Псевдоним 1506 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1507 + "isInverted": true, ~/~/ Признак инверсии 1508 + "disabled": true, ~/~/ Датчик не участвует в обработке 1509 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1510 + "gradesTables": [ ~/~/ Тарировка 1511 + { 1512 + "grades": [ ~/~/ Таблицы тарировки 1513 + { 1514 + "input": 0, ~/~/ Вход 1515 + "output": 0 ~/~/ Выход 1516 + } 1517 + ], 1518 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1519 + } 1520 + ], 1521 + "showInTooltip": true, ~/~/ Отображение в подсказке 1522 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1523 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1524 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1525 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1526 + "expr": "string", ~/~/ Выражение 1527 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1528 + "string" 1529 + ], 1530 + "customParams": { 1531 + "additionalProp1": "string", 1532 + "additionalProp2": "string", 1533 + "additionalProp3": "string" 1534 + }, 1535 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1536 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1537 + { 1538 + "from": 0, ~/~/ С какого значения 1539 + "color": "string", ~/~/ Каким цветом 1540 +))) 1315 1315 1316 -(% style="text-align:left" %) 1317 -(% style="color:#000000" %)} 1542 +((( 1543 + "text": "string" ~/~/ Текст подписи к этому интервалу 1544 + } 1545 + ] 1546 + } 1547 + ], 1548 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1549 + "customFields": [ ~/~/ Список произвольных полей 1550 + { 1551 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1552 + "name": "string", ~/~/ Наименование произвольного поля 1553 + "value": "string", ~/~/ Значение произвольного поля 1554 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1555 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1556 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1557 + } 1558 + ], 1559 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1560 +} 1561 +))) 1562 +))) 1563 +))) 1318 1318 1565 + 1319 1319 **Валидация:** 1320 1320 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1321 1321 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1322 1322 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1323 1323 1324 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1325 1325 1572 +== **Импортировать историю ТС (Асинхронный запрос)** == 1573 + 1574 +(% class="box successmessage" %) 1575 +((( 1576 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1577 +))) 1578 + 1579 +Метод запроса: **POST** 1580 + 1581 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1582 + 1583 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1584 + 1585 + 1586 +Ответ: 1587 + 1588 +{ 1589 + 1590 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1591 + 1592 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1593 + 1594 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1595 + 1596 + "Message": "string", ~/~/ Информация о выполнении запроса 1597 + 1598 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1599 + 1600 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1601 + 1602 + "Data": "string" ~/~/ Данные 1603 + 1604 +} 1605 + 1606 + 1607 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1608 + 1326 1326 (% class="box infomessage" %) 1327 1327 ((( 1611 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1612 +))) 1613 + 1614 +Метод запроса: **GET** 1615 + 1616 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1617 + 1618 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1619 + 1620 + 1621 +Ответ: 1622 + 1623 +{ 1624 + 1625 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1626 + 1627 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1628 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1629 + 1630 + "Message": "string", ~/~/ Информация о выполнении запроса 1631 + 1632 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1633 + 1634 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1635 + 1636 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1637 + 1638 + "Data": "string" ~/~/ Данные 1639 + 1640 +} 1641 + 1642 + 1643 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1644 + 1645 +(% class="box infomessage" %) 1646 +((( 1328 1328 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1329 1329 ))) 1330 1330 1331 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1650 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1332 1332 1333 1333 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1334 1334 ... ... @@ -1362,9 +1362,12 @@ 1362 1362 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1363 1363 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1364 1364 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1365 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1366 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1367 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1684 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1685 + "unitName": "string", ~/~/ Название подразделения (опционально) 1686 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1687 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1688 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1689 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1368 1368 } 1369 1369 1370 1370 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1371,8 +1371,14 @@ 1371 1371 1372 1372 (% style="color:#000000" %)Ответ: 1373 1373 1374 -(% style="color:#000000" %){ 1696 +(% style="color:#000000" %)[ 1697 +{ 1375 1375 1699 +((( 1700 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1701 +))) 1702 + 1703 +((( 1376 1376 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1377 1377 "name": "" ~/~/ наименование объекта 1378 1378 "imei": "" ~/~/ IMEI объекта ... ... @@ -1398,9 +1398,21 @@ 1398 1398 "forClient": true, ~/~/ право на отображение у клиента 1399 1399 "forTooltip": false, ~/~/ право на отображение в подсказке 1400 1400 "forReport": false ~/~/ право на отображение в отчетах 1401 - }(%%) 1402 -(% style="color:#000000" %)} 1729 +))) 1403 1403 1731 +((( 1732 + } 1733 + ], 1734 + "vehicleGroups": [ ~/~/ Группы ТС 1735 + { 1736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1737 + "name": "string" ~/~/ Наименование группы ТС 1738 + } 1739 + ] 1740 + } 1741 +] 1742 +))) 1743 + 1404 1404 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1405 1405 1406 1406 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1432,13 +1432,11 @@ 1432 1432 "data": "", ~/~/ Данные 1433 1433 "overwrite": false, ~/~/ Флаг перезаписи 1434 1434 "stage": "", ~/~/ Состояние, может быть null 1435 - 1436 1436 (% style="color:#000000" %)} 1437 1437 1438 1438 (% style="color:#000000" %)Ответ: 1439 1439 1440 -(% style="color:#000000" %){ 1441 - 1779 +(% style="color:#000000" %){(%%) 1442 1442 "status": "", ~/~/ значение статуса 1443 1443 "date": "", ~/~/ Дата смены статуса 1444 1444 "description": "", ~/~/ Описание ... ... @@ -1445,10 +1445,10 @@ 1445 1445 "data": "", ~/~/ Данные 1446 1446 "overwrite": false, ~/~/ Флаг перезаписи 1447 1447 "stage": "", ~/~/ Состояние 1448 - 1449 -(% style="text-align:left" %) 1450 1450 (% style="color:#000000" %) } 1451 1451 1788 +== == 1789 + 1452 1452 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1453 1453 1454 1454 (% class="box warningmessage" %) ... ... @@ -1536,8 +1536,7 @@ 1536 1536 "retries": 0 1537 1537 } 1538 1538 ], 1539 - 1540 - "sensors": [ ~/~/ Датчики 1877 +"sensors": [ ~/~/ Датчики 1541 1541 { 1542 1542 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1543 1543 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1575,95 +1575,215 @@ 1575 1575 "additionalProp2": "string", 1576 1576 "additionalProp3": "string" 1577 1577 }, 1578 - 1579 1579 ~/~/ Характерные для произвольного: 1580 - 1581 1581 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1582 - 1583 1583 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1584 - 1585 1585 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1586 - 1587 1587 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1588 - 1589 1589 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1590 - 1591 1591 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1592 - 1593 1593 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1594 - 1595 1595 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1596 - 1597 1597 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1598 - 1599 1599 ~/~/ "ValueOn": "Вкл.", 1600 - 1601 1601 ~/~/ "ValueOff": "Выкл." 1602 1602 "summaryMaxValue": 0 ~/~/ Макс. значение 1928 + 1929 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1930 + { 1931 + "from": 0, ~/~/ С какого значения 1932 + "color": "string", ~/~/ Каким цветом 1933 + "text": "string" ~/~/ Текст подписи к этому интервалу 1934 + } 1935 + ] 1603 1603 } 1604 1604 ], 1938 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1939 + 1605 1605 "customFields": [ ~/~/ Произвольные поля 1606 - { 1607 - 1608 - "name": "string", 1609 - "value": "string", 1610 - "forClient": true, 1611 - "forTooltip": true, 1612 - "forReport": true 1941 + { 1942 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1943 + "name": "string", ~/~/ Наименование произвольного поля 1944 + "value": "string", ~/~/ Значение произвольного поля 1945 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1946 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1947 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1613 1613 } 1614 1614 ] 1615 1615 } 1616 1616 1952 + 1617 1617 (% style="color:#000000" %)Ответ: 1618 1618 1619 -(% lang="en-US" style="text-align:left" %) 1620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1955 +((( 1956 +{ 1957 + "vehicleId": 0, ~/~/ ID ТС 1958 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1959 + "name": "string", ~/~/ Имя объекта 1960 + "imei": "string", ~/~/ IMEI 1961 + "deviceTypeId": 0, ~/~/ ID типа устройства 1962 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1963 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1964 + "sim1": "string", ~/~/ SIM1 1965 + "sim2": "string", ~/~/ SIM2 1966 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1967 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1968 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1969 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1970 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1971 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1972 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1973 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1974 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1975 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1976 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1977 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1978 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1979 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1980 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1981 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1982 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1983 + "counters": { ~/~/ состояний счётчиков 1984 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1985 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1986 + "mileage": 0, ~/~/ Пробег 1987 + "motohours": 0 ~/~/ Моточасы 1988 + }, 1989 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1990 + "id": "string", ~/~/ CMSV6 Идентификатор 1991 + "enabled": true, ~/~/ Признак включения 1992 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1993 +))) 1621 1621 1622 -(% lang="en-US" style="text-align:left" %) 1623 - "vehicleId": "", ~/~/ ID ТС 1624 - "parentId": "", ~/~/ ID клиента 1625 - "name": "", ~/~/ имя ТС 1626 - "imei": "", ~/~/ IMEI 1627 - "deviceTypeId": "", ~/~/ типа устройства 1628 - "modelId": "", ~/~/ ID модели 1629 - "unitId": "", ~/~/ ID подразделения 1630 - "sim1": "", ~/~/ SIM 1 1631 - "sim2": "", ~/~/ SIM2 1632 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1633 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1634 - "counters": 1635 - { 1636 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1637 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1638 - "mileage": "", ~/~/ пробег 1639 - "motohours": "", ~/~/ моточасы 1640 - } 1641 - "cmsv6Parameters": ~/~/ параметры CMSv6 1995 + 1996 +((( 1997 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1998 + "login": "string", ~/~/ CMSV6 имя учетной записи 1999 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2000 + }, 2001 + "inspectionTasks": [ ~/~/ Задания на ТО 2002 + { 2003 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2004 + "enabled": true, ~/~/ Признак включения 2005 + "name": "string", ~/~/ Имя задания 2006 + "description": "string", ~/~/ Описание задания 2007 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2008 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2009 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2010 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2011 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2012 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2013 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2014 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2015 + } 2016 + ], 2017 + "drivers": [ ~/~/ Список водителей 2018 + { 2019 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2020 + "inputNumber": 0, ~/~/ № входа. 2021 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2022 + "comment": "string", ~/~/ Комментарий. 2023 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2024 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2025 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2026 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2027 + } 2028 + ], 2029 + "commandTemplates": [ ~/~/ Список шаблонов команд 2030 + { 2031 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2032 + "name": "string", ~/~/ Название шаблона команд 2033 + "command": "string", ~/~/ Команда на выполнение 2034 + "retries": 0 ~/~/ Лимит попыток отправки 2035 + } 2036 + ], 2037 + "sensors": [ ~/~/ Список датчиков 2038 + { 2039 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2040 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2041 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2042 +))) 2043 + 2044 +((( 2045 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2046 +))) 2047 + 2048 +((( 2049 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2050 +))) 2051 + 2052 +((( 2053 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2054 +))) 2055 + 2056 +((( 2057 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2058 +))) 2059 + 2060 +((( 2061 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2062 + "name": "string", ~/~/ Имя датчика 2063 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2064 +))) 2065 + 2066 +((( 2067 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2068 + "inputNumber": 0, ~/~/ Номер входа 2069 + "pseudonym": "string", ~/~/ Псевдоним 2070 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2071 + "isInverted": true, ~/~/ Признак инверсии 2072 + "disabled": true, ~/~/ Датчик не участвует в обработке 2073 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2074 + "gradesTables": [ ~/~/ Тарировка 1642 1642 { 1643 - "id": ~/~/ идентификатор 1644 - "enabled": true, ~/~/ флаг включения 1645 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1646 - "login": "", ~/~/ имя учетной записи 1647 - "password": "", ~/~/ пароль учетной записи 1648 - } 1649 - "inspectionTasks": ~/~/ задания на ТО 2076 + "grades": [ ~/~/ Таблицы тарировки 2077 + { 2078 + "input": 0, ~/~/ Вход 2079 + "output": 0 ~/~/ Выход 2080 + } 2081 + ], 2082 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 2083 + } 2084 + ], 2085 + "showInTooltip": true, ~/~/ Отображение в подсказке 2086 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 2087 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2088 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2089 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2090 + "expr": "string", ~/~/ Выражение 2091 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2092 + "string" 2093 + ], 2094 + "customParams": { ~/~/ Дополнительные настройки 2095 + "additionalProp1": "string", 2096 + "additionalProp2": "string", 2097 + "additionalProp3": "string" 2098 + }, 2099 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2100 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1650 1650 { 1651 - "id": "", ~/~/ ID задания 1652 - "enabled": false, ~/~/ Признак включения 1653 - "name": "", ~/~/ Имя задания 1654 - "description": "", ~/~/ Описание задания 1655 - "mileageCondition": "", ~/~/ Условие по пробегу 1656 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1657 - "motohoursCondition": "", ~/~/ Условие по моточасам 1658 - "lastMotohours": "", ~/~/ Моточасы 1659 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1660 - "kind": "", ~/~/ Вид периодичности по времени 1661 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2102 + "from": 0, ~/~/ С какого значения 2103 + "color": "string", ~/~/ Каким цветом 2104 + "text": "string" ~/~/ Текст подписи к этому интервалу 1662 1662 } 2106 + ] 2107 + } 2108 + ], 2109 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2110 + "customFields": [ ~/~/ Список произвольных полей 2111 + { 2112 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2113 + "name": "string", ~/~/ Наименование произвольного поля 2114 + "value": "string", ~/~/ Значение произвольного поля 2115 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2116 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2117 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2118 + } 2119 + ], 2120 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2121 +} 2122 +))) 1663 1663 1664 -(% lang="en-US" style="text-align:left" %) 1665 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1666 - 1667 1667 **Валидация:** 1668 1668 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1669 1669 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1702,18 +1702,15 @@ 1702 1702 1703 1703 (% style="color:#000000" %)Метод запроса: **GET** 1704 1704 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]]2162 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1706 1706 1707 1707 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1708 1708 1709 1709 (% style="color:#000000" %)Ответ: 1710 1710 1711 -(% style="color:#000000" %){ 1712 - 2168 +(% style="color:#000000" %){(%%) 1713 1713 "deviceTypeId" : "", ~/~/ ID типа устройства 1714 1714 "deviceTypeName" : "" ~/~/ Название типа устройства 1715 - 1716 -(% style="text-align:left" %) 1717 1717 (% style="color:#000000" %)} 1718 1718 1719 1719 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1735,13 +1735,10 @@ 1735 1735 1736 1736 (% style="color:#000000" %)Ответ: 1737 1737 1738 -(% style="color:#000000" %){ 1739 - 2192 +(% style="color:#000000" %){(%%) 1740 1740 "id": "", ~/~/ ID типа датчика 1741 1741 "name": "", ~/~/ Название 1742 1742 "description": "", ~/~/ Описание 1743 - 1744 -(% style="text-align:left" %) 1745 1745 (% style="color:#000000" %)} 1746 1746 1747 1747 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1785,6 +1785,56 @@ 1785 1785 } 1786 1786 ] 1787 1787 2239 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2240 + 2241 +(% class="box infomessage" style="text-align: left;" %) 2242 +((( 2243 +**POST /api/v3/terminalMessages/mapping** 2244 +))) 2245 + 2246 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2247 + 2248 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2249 + 2250 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2251 + 2252 +{ 2253 + "protocolType": 0, 2254 + "params": ["string"] 2255 +} 2256 + 2257 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2258 +|protocolType|ID типа протокола 2259 +|params|((( 2260 +Массив наименований параметров в сообщении 2261 +))) 2262 + 2263 +Ответ: 2264 + 2265 +{ 2266 + "protocolType": 0, 2267 + "mapping": { 2268 + "additionalProp1": { 2269 + "inputType": 0, 2270 + "inputNumber": 0 2271 + }, 2272 + "additionalProp2": { 2273 + "inputType": 0, 2274 + "inputNumber": 0 2275 + } 2276 + } 2277 +} 2278 + 2279 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2280 +|protocolType|Тип протокола 2281 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2282 +|inputNumber|((( 2283 +Номер входа 2284 +))) 2285 + 2286 +(% class="wikigeneratedid" %) 2287 +Перечень 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/]] 2288 + 1788 1788 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1789 1789 1790 1790 (% class="box infomessage" %) ... ... @@ -1809,6 +1809,11 @@ 1809 1809 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1810 1810 } 1811 1811 2313 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2314 +|vehicleId|ID объекта 2315 +|from|Дата и время начала периода запроса 2316 +|to|Дата и время окончания периода запроса 2317 + 1812 1812 Ответ: 1813 1813 1814 1814 [ ... ... @@ -1815,80 +1815,43 @@ 1815 1815 { 1816 1816 "messages": [ 1817 1817 { 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": { ~/~/ список параметров датчиков передаваемых терминалом 2324 + "deviceTime": "2023-11-29T07:40:44.052Z", 2325 + "serverTime": "2023-11-29T07:40:44.052Z", 2326 + "speed": 0, 2327 + "altitude": 0, 2328 + "latitude": 0, 2329 + "longitude": 0, 2330 + "satellites": 0, 2331 + "course": 0, 2332 + "voltage": 0, 2333 + "parameters": { 1827 1827 "additionalProp1": "string", 1828 1828 "additionalProp2": "string", 1829 1829 "additionalProp3": "string" 1830 1830 }, 1831 - "photoCount": 0 ~/~/ Кол-во фото 2338 + "photoCount": 0, 2339 + "lbsCorrectedCoords": true, 2340 + "protocolType": 0 1832 1832 } 1833 1833 ] 1834 1834 } 1835 1835 ] 1836 1836 1837 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2346 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2347 +|deviceTime|Время сообщения терминала 2348 +|serverTime|Время когда сообщение поступило на сервер 2349 +|speed|Скорость 2350 +|altitude|Высота над уровнем моря 2351 +|latitude|Широта 2352 +|longitude|Долгота 2353 +|satellites|Кол-во спутников 2354 +|course|Курс 2355 +|voltage|Бортовое напряжение 2356 +|parameters|Список параметров и их значений 2357 +|photoCount|Количество фото 2358 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2359 +|protocolType|ID типа протокола 1838 1838 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 - 1892 1892 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1893 1893 1894 1894 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1925,10 +1925,12 @@ 1925 1925 { 1926 1926 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1927 1927 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1928 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1929 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1930 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1931 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2397 + "mileage": 0, ~/~/ Пробег за период, километры 2398 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2399 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2400 + "motohours": 0, ~/~/ Моточасы за период, секунды 2401 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2402 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1932 1932 } 1933 1933 ] 1934 1934 } ... ... @@ -1977,6 +1977,12 @@ 1977 1977 } 1978 1978 ] 1979 1979 2451 +(% class="box warningmessage" %) 2452 +((( 2453 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2454 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2455 +))) 2456 + 1980 1980 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1981 1981 1982 1982 (% class="box infomessage" %) ... ... @@ -2022,6 +2022,96 @@ 2022 2022 } 2023 2023 ] 2024 2024 2502 + 2503 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2504 + 2505 +(% class="box infomessage" %) 2506 +((( 2507 +**POST /api/v3/vehicles/moveStop** 2508 +))) 2509 + 2510 +Метод запроса: **POST** 2511 + 2512 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2513 + 2514 +В заголовках запроса: X-Auth: Токен авторизации 2515 + 2516 + 2517 +Тело запроса: 2518 + 2519 +{ 2520 + "vehicleIds": [ ], ~/~/ Список ID объектов 2521 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2522 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2523 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2524 +} 2525 + 2526 +Ответ: 2527 + 2528 +[ 2529 + { 2530 + "vehicleId": 0, ~/~/ ID объекта 2531 + "vehicleName": "string", ~/~/ Имя объекта 2532 + "moves": [ ~/~/ Событие движения 2533 + { 2534 + "mileage": 0, ~/~/ Пробег, км 2535 + "eventId": 0, ~/~/ Идентификатор события 2536 + "eventName": "string", ~/~/ Название события 2537 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2538 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2539 + "duration": 0 ~/~/ Продолжительность события, секунд 2540 + } 2541 + ], 2542 + "stops": [ ~/~/ События стоянок 2543 + { 2544 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2545 + "eventId": 0, ~/~/ Идентификатор события 2546 + "eventName": "string", ~/~/ Название события 2547 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2548 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2549 + "duration": 0 ~/~/ Продолжительность события, секунд 2550 + } 2551 + ] 2552 + } 2553 +] 2554 + 2555 + 2556 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2557 + 2558 +(% class="box infomessage" %) 2559 +((( 2560 +**POST /api/v3/vehicles/getlastdata** 2561 +))) 2562 + 2563 +Метод запроса: **POST** 2564 + 2565 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2566 + 2567 +В заголовках запроса: X-Auth: Токен авторизации 2568 + 2569 + 2570 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2571 + 2572 +Ответ: 2573 + { 2574 + "vehicleId": 0, ~/~/Идентификатор объекта. 2575 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2576 + "vehicleNumber": "string",~/~/Номер объекта. 2577 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2578 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2579 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2580 + "speed": 0,~/~/Скорость объекта. 2581 + "course": 0,~/~/Курс движения [0;360] 2582 + "latitude": 0,~/~/Широта [-90°;90°]. 2583 + "longitude": 0,~/~/Долгота [-180°;180°]. 2584 + "address": "string",~/~/Адрес. 2585 + "geozones": [ ~/~/Сведения по геозонам. 2586 + { 2587 + "id": 0, 2588 + "name": "string" 2589 + } 2590 + 2591 + 2025 2025 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2026 2026 2027 2027 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2329,6 +2329,32 @@ 2329 2329 2330 2330 Success 2331 2331 2899 + 2900 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2901 + 2902 +(% class="box warningmessage" %) 2903 +((( 2904 +**PUT** /api/v3/notifications/prolongation 2905 +))) 2906 + 2907 +Метод позволяет продлить уведомления. 2908 + 2909 +Метод запроса **PUT** 2910 + 2911 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2912 + 2913 +В заголовках запроса: X-Auth: Токен авторизации. 2914 + 2915 +Тело запроса: 2916 + 2917 +[ 2918 + 2919 +0 2920 + 2921 +] 2922 + 2923 +где 0 идентификатор ids. 2924 + 2332 2332 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2333 2333 2334 2334 (% class="box errormessage" %) ... ... @@ -2920,6 +2920,83 @@ 2920 2920 Success 2921 2921 2922 2922 3516 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3517 + 3518 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3519 + 3520 +(% class="box infomessage" %) 3521 +((( 3522 +**POST /api/v3/Trailers** 3523 +))) 3524 + 3525 +Пример запроса: 3526 + 3527 +{ 3528 + "startDate": "2023-11-14T10:48:03.671Z", 3529 + "endDate": "2023-11-14T10:48:03.671Z", 3530 + "ids": [ 0 ], 3531 + "timezone": 0 3532 +} 3533 + 3534 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3535 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3536 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3537 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3538 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3539 + 3540 +Пример ответа: 3541 + 3542 +[ 3543 + { 3544 + "SD": "2023-11-14T10:48:03.717Z", 3545 + "ED": "2023-11-14T10:48:03.717Z", 3546 + "id": 0, 3547 + "SLat": 0, 3548 + "SLon": 0, 3549 + "ELat": 0, 3550 + "ELon": 0, 3551 + "mileage": 0 3552 + "Duration": 0 3553 + "Address": "string", 3554 + "Address2": "string", 3555 + "name": "string", 3556 + "rid": "string", 3557 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3558 + "trailer": { 3559 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3560 + "Number": "string", 3561 + "Description": "string", 3562 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3563 + "ExternalID": "string", 3564 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3565 + "CreateTime": "2023-11-14T10:48:03.717Z", 3566 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3567 + "IsDeleted": true 3568 + }, 3569 + "filesCount": 0, 3570 + } 3571 +] 3572 + 3573 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3574 +|SD|Дата и время начала события 3575 +|ED|Дата и время окончания события 3576 +|id|ID объекта 3577 +|SLat|Широта начальной координаты 3578 +|SLon|Долгота начальной координаты 3579 +|ELat|Широта конечной координаты 3580 +|ELon|Долгота конечной координаты 3581 +|mileage|Пробег 3582 +|Duration|Продолжительность 3583 +|Address|Адрес начального местоположения 3584 +|Address2|Адрес конечного местоположения 3585 +|name|Имя радиометки 3586 +|rid|Номер радиометки 3587 +|rguid|ID радиометки 3588 +|trailer|Информация об агрегате 3589 +|ModelGuid|ID агрегата 3590 +|Number|Название/номер агрегата 3591 +|Description|Текст примечания агрегата 3592 + 2923 2923 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2924 2924 2925 2925 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2941,13 +2941,18 @@ 2941 2941 { 2942 2942 "name": "string", 2943 2943 "number": 0, 2944 - "period": 0, ~/~/ Частота трансляции радиометки3614 + "period": 0, 2945 2945 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2946 2946 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2947 - "deleted": true 2948 2948 } 2949 2949 ] 2950 2950 3620 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3621 +|parentId|ID клиента 3622 +|name|Название карты-метки 3623 +|number|Номер 3624 +|period|Период запросов в секундах (работает только для агрегатов) 3625 +|id|ID карты-метки 2951 2951 2952 2952 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2953 2953 ... ... @@ -2964,13 +2964,18 @@ 2964 2964 { 2965 2965 "name": "string", 2966 2966 "number": 0, 2967 - "period": 0, ~/~/ Частота трансляции радиометки3642 + "period": 0, 2968 2968 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2969 2969 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2970 - "deleted": true 2971 2971 } 2972 2972 ] 2973 2973 3648 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3649 +|name|Название карты-метки 3650 +|number|Номер 3651 +|period|Период запросов в секундах (работает только для агрегатов) 3652 +|id|ID карты-метки 3653 +|parentId|ID клиента 2974 2974 2975 2975 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2976 2976 ... ... @@ -2986,7 +2986,6 @@ 2986 2986 "number": 0, 2987 2987 "period": 0, 2988 2988 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2989 - "deleted": true 2990 2990 } 2991 2991 2992 2992 Ответ: ... ... @@ -2997,9 +2997,14 @@ 2997 2997 "period": 0, 2998 2998 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2999 2999 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3000 - "deleted": true 3001 3001 } 3002 3002 3681 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3682 +|name|Название карты-метки 3683 +|number|Номер 3684 +|period|Период запросов в секундах (работает только для агрегатов) 3685 +|id|ID карты-метки 3686 +|parentId|ID клиента 3003 3003 3004 3004 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3005 3005 ... ... @@ -3016,7 +3016,6 @@ 3016 3016 "period": 0, 3017 3017 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3018 3018 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3019 - "deleted": true 3020 3020 } 3021 3021 3022 3022 Ответ: ... ... @@ -3027,9 +3027,14 @@ 3027 3027 "period": 0, 3028 3028 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3029 3029 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3030 - "deleted": true 3031 3031 } 3032 3032 3715 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3716 +|name|Название карты-метки 3717 +|number|Номер 3718 +|period|Период запросов в секундах (работает только для агрегатов) 3719 +|id|ID карты-метки 3720 +|parentId|ID клиента 3033 3033 3034 3034 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3035 3035 ... ... @@ -3038,7 +3038,7 @@ 3038 3038 **DELETE /api/v3/Rfids/{rfidGuid}** 3039 3039 ))) 3040 3040 3041 -Передаем параметр rfidGuid - идентификатор карты-метки 3729 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3042 3042 3043 3043 Ответ: 3044 3044 ... ... @@ -3045,6 +3045,1083 @@ 3045 3045 Success 3046 3046 3047 3047 3736 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3737 + 3738 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3739 + 3740 +(% class="box infomessage" %) 3741 +((( 3742 +**GET /api/v3/Billing/client/balance/{clientId}** 3743 +))) 3744 + 3745 +Параметр запроса: **clientId **- идентификатор клиента. 3746 + 3747 +Ответ: 3748 + 3749 +{ 3750 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3751 + "Balance": 0 3752 +} 3753 + 3754 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3755 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3756 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3757 + 3758 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3759 + 3760 +(% class="box infomessage" %) 3761 +((( 3762 +**GET /api/v3/Billing/client/constraint/{clientId}** 3763 +))) 3764 + 3765 +Параметр запроса: **clientId **- идентификатор клиента. 3766 + 3767 +Ответ: 3768 + 3769 +{ 3770 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3771 + "CalculationType": 0, 3772 + "PermissibleBalance": 0, 3773 + "DefermentDays": 0, 3774 + "SendUiNotifications": true, 3775 + "SendEmailNotifications": true, 3776 + "IsPrivate": true, 3777 +} 3778 + 3779 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3780 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3781 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3782 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3783 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3784 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3785 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3786 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3787 + 3788 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3789 + 3790 +(% class="box infomessage" %) 3791 +((( 3792 +**GET /api/v3/Billing/client/plan/{clientId}** 3793 +))) 3794 + 3795 +Параметры запроса: 3796 + 3797 +**clientId **- идентификатор клиента. 3798 + 3799 +**planId **- идентификатор тарифного плана. 3800 + 3801 +Ответ: 3802 + 3803 +{ 3804 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3805 + "Plan": { **~/~/ Описание тарифного плана** 3806 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3807 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3808 + "Name": "string", 3809 + "IsArchived": true, 3810 + "Constraint": { 3811 + "CalculationType": 0, 3812 + "PermissibleBalance": 0, 3813 + "DefermentDays": 0 3814 + }, 3815 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3816 + { 3817 + "Feature": "string", 3818 + "IsFactual": true, 3819 + "Limit": 0, 3820 + "Price": 0, 3821 + "PeriodValue": 0, 3822 + "PeriodType": 0 3823 + } 3824 + ] 3825 + }, 3826 + "DebitDate": "2023-10-18T12:46:24.213Z", 3827 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3828 + { 3829 + "Feature": "string", 3830 + "IsEnabled": true, 3831 + "IsPrivate": true, 3832 + "IsFactual": true, 3833 + "Limit": 0, 3834 + "Price": 0, 3835 + "DebitDate": "2023-10-18T12:46:24.213Z", 3836 + "PeriodValue": 0, 3837 + "PeriodType": 0 3838 + } 3839 + ] 3840 +} 3841 + 3842 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3843 +|ClientId|Идентификатор клиента 3844 +|Id|Идентификатор тарифного плана 3845 +|OwnerId|Идентификатор клиента-владельца 3846 +|Name|Наименование тарифного плана 3847 +|IsArchived|Признак, определяющий архивный тарифный план 3848 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3849 +|PermissibleBalance|Допустимый баланс 3850 +|DefermentDays|Отсрочка, количество дней 3851 +|Feature|Код услуги 3852 +|IsEnabled|Признак, определяющий активирована ли услуга 3853 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3854 +|IsFactual|Признак, определяющий расчёт по факту 3855 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3856 +|Price|Цена за единицу. 3857 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3858 +|PeriodValue|Значение периода. 3859 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3860 + 3861 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3862 + 3863 +(% class="box infomessage" %) 3864 +((( 3865 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3866 +))) 3867 + 3868 +Параметр запроса: **clientId **- идентификатор клиента. 3869 + 3870 +Ответ: 3871 + 3872 +[ 3873 + { 3874 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3875 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3876 + "Name": "string", 3877 + "IsArchived": true, 3878 + "Constraint": { 3879 + "CalculationType": 0, 3880 + "PermissibleBalance": 0, 3881 + "DefermentDays": 0 3882 + }, 3883 + "Features": [ 3884 + { 3885 + "Feature": "string", 3886 + "IsFactual": true, 3887 + "Limit": 0, 3888 + "Price": 0, 3889 + "PeriodValue": 0, 3890 + "PeriodType": 0 3891 + } 3892 + ] 3893 + } 3894 +] 3895 + 3896 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3897 +|ClientId|Идентификатор клиента 3898 +|Id|Идентификатор тарифного плана 3899 +|OwnerId|Идентификатор клиента-владельца 3900 +|Name|Наименование тарифного плана 3901 +|IsArchived|Признак, определяющий архивный тарифный план 3902 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3903 +|PermissibleBalance|Допустимый баланс 3904 +|DefermentDays|Отсрочка, количество дней 3905 +|Feature|Код услуги 3906 +|IsFactual|Признак, определяющий расчёт по факту 3907 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3908 +|Price|Цена за единицу. 3909 +|PeriodValue|Значение периода. 3910 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3911 + 3912 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3913 + 3914 +(% class="box infomessage" %) 3915 +((( 3916 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3917 +))) 3918 + 3919 +Параметр запроса: **clientId **- идентификатор клиента. 3920 + 3921 +Ответ: 3922 + 3923 +[ 3924 + { 3925 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3926 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3927 + "Name": "string", 3928 + "IsArchived": true, 3929 + "Constraint": { 3930 + "CalculationType": 0, 3931 + "PermissibleBalance": 0, 3932 + "DefermentDays": 0 3933 + }, 3934 + "Features": [ 3935 + { 3936 + "Feature": "string", 3937 + "IsFactual": true, 3938 + "Limit": 0, 3939 + "Price": 0, 3940 + "PeriodValue": 0, 3941 + "PeriodType": 0 3942 + } 3943 + ] 3944 + } 3945 +] 3946 + 3947 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3948 +|ClientId|Идентификатор клиента 3949 +|Id|Идентификатор тарифного плана 3950 +|OwnerId|Идентификатор клиента-владельца 3951 +|Name|Наименование тарифного плана 3952 +|IsArchived|Признак, определяющий архивный тарифный план 3953 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3954 +|PermissibleBalance|Допустимый баланс 3955 +|DefermentDays|Отсрочка, количество дней 3956 +|Feature|Код услуги 3957 +|IsFactual|Признак, определяющий расчёт по факту 3958 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3959 +|Price|Цена за единицу. 3960 +|PeriodValue|Значение периода. 3961 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3962 + 3963 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3964 + 3965 +(% class="box warningmessage" %) 3966 +((( 3967 +**PUT /api/v3/Billing/client/balance** 3968 +))) 3969 + 3970 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3971 + 3972 +Тело запроса: 3973 + 3974 +{ 3975 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3976 + "Balance": 0 3977 +} 3978 + 3979 +Ответ: Success 3980 + 3981 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3982 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3983 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3984 + 3985 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3986 + 3987 +(% class="box warningmessage" %) 3988 +((( 3989 +**PUT /api/v3/billing/client/balance/deposit** 3990 +))) 3991 + 3992 +Создает операцию **Пополнение **с указанной суммой 3993 + 3994 +Тело запроса: 3995 + 3996 +{ 3997 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3998 + "Balance": 0 3999 +} 4000 + 4001 +Ответ: Success 4002 + 4003 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4004 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4005 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4006 + 4007 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4008 + 4009 +Создает операцию **Списание **с указанной суммой 4010 + 4011 +(% class="box warningmessage" %) 4012 +((( 4013 +**PUT /api/v3/billing/client/balance/withdraw** 4014 +))) 4015 + 4016 +Тело запроса: 4017 + 4018 +{ 4019 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4020 + "Balance": 0 4021 +} 4022 + 4023 +Ответ: Success 4024 + 4025 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4026 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4027 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4028 + 4029 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4030 + 4031 +(% class="box warningmessage" %) 4032 +((( 4033 +**PUT /api/v3/Billing/client/constraint** 4034 +))) 4035 + 4036 +Тело запроса: 4037 + 4038 +{ 4039 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4040 + "CalculationType": 0, 4041 + "PermissibleBalance": 0, 4042 + "DefermentDays": 0, 4043 + "SendUiNotifications": true, 4044 + "SendEmailNotifications": true, 4045 + "IsPrivate": true, 4046 +} 4047 + 4048 +Ответ: Success 4049 + 4050 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4051 +|ClientId|Идентификатор клиента 4052 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4053 +|PermissibleBalance|Допустимый баланс 4054 +|DefermentDays|((( 4055 +Отсрочка, количество дней 4056 +))) 4057 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4058 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4059 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4060 + 4061 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4062 + 4063 +(% class="box warningmessage" %) 4064 +((( 4065 +**PUT /api/v3/Billing/client/plan** 4066 +))) 4067 + 4068 +Тело запроса: 4069 + 4070 +{ 4071 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4072 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4073 + "Features": [ 4074 + { 4075 + "Feature": "string", 4076 + "IsEnabled": true, 4077 + "IsFactual": true, 4078 + "Limit": 0, 4079 + "Price": 0, 4080 + "DebitDate": "2023-10-18T13:26:58.987Z", 4081 + "PeriodValue": 0, 4082 + "PeriodType": 0 4083 + } 4084 + ] 4085 +} 4086 + 4087 +Ответ: Success 4088 + 4089 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4090 +|ClientId|Идентификатор клиента 4091 +|PlanId|Идентификатор тарифного плана 4092 +|Feature|Код услуги 4093 +|IsEnabled|Признак, определяющий активирована ли услуга 4094 +|IsFactual|Признак, определяющий расчёт по факту 4095 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4096 +|Price|Цена за единицу. 4097 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4098 +|PeriodValue|Значение периода. 4099 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4100 + 4101 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4102 + 4103 +(% class="box warningmessage" %) 4104 +((( 4105 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4106 +))) 4107 + 4108 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4109 + 4110 +(% class="box infomessage" %) 4111 +((( 4112 +**POST /api/v3/vehicles/import/{agentId}** 4113 +))) 4114 + 4115 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4116 + 4117 +В пути указывается **agentId** - id клиента. 4118 + 4119 +**Заголовок** 4120 + 4121 +**X-Auth: [токен авторизации]** 4122 + 4123 +**Параметры** 4124 + 4125 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4126 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4127 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4128 + 4129 +В теле использовать тип **form-data,** тип значения** file** 4130 + 4131 +**Ключи** 4132 + 4133 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4134 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4135 +|csv|В значении передаем файл датчиков, формат **csv** 4136 + 4137 +Ответ: 4138 + 4139 +{ 4140 + "vehicleId": 0, 4141 + "name": "string", 4142 + "errors": ["string"] 4143 +} 4144 + 4145 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4146 +|vehicleId|ID созданного объекта 4147 +|name|Имя созданного объекта 4148 +|errors|Ошибки и их описание 4149 + 4150 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4151 + 4152 +(% class="box infomessage" %) 4153 +((( 4154 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4155 +))) 4156 + 4157 +(% class="wikigeneratedid" %) 4158 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4159 + 4160 +(% class="wikigeneratedid" %) 4161 +В пути указывается **vehicleId **- id объекта. 4162 + 4163 +**Заголовок** 4164 + 4165 +**X-Auth: [токен авторизации]** 4166 + 4167 +В теле использовать тип **form-data.** 4168 + 4169 +Ключи: 4170 + 4171 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4172 +|**history**|В значении передавать файл с историей 4173 + 4174 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4175 + 4176 +Ответ: 4177 + 4178 +{ 4179 + "results": [ 4180 + { 4181 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4182 + "vehicleId": 0, 4183 + "errors": [ 4184 + "string" 4185 + ], 4186 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4187 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4188 + "producedCount": 0, 4189 + "msgCount": 0 4190 + } 4191 + ] 4192 +} 4193 + 4194 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4195 +|results|Результаты импорта в разрезе ТС 4196 +|vehicleGuid|Guid ТС 4197 +|vehicleId|ID ТС 4198 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4199 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4200 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4201 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4202 +|msgCount|Кол-во обработанных сообщений всего 4203 + 4204 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4205 + 4206 +(% class="box infomessage" %) 4207 +((( 4208 +**GET /api/v3/vehicles/import/history/status** 4209 +))) 4210 + 4211 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4212 + 4213 +Ответ: 4214 + 4215 +{ 4216 + "activity": true, 4217 + "progress": 0, 4218 + "message": "string" 4219 +} 4220 + 4221 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4222 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4223 +|progress|Guid ТС 4224 + 4225 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4226 + 4227 +(% class="box infomessage" %) 4228 +((( 4229 +**POST /api/v3/vehicles/export** 4230 +))) 4231 + 4232 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4233 + 4234 +Тело запроса: 4235 + 4236 +[ 4237 + id 4238 +] 4239 + 4240 +Ответ: Success 200, получаете файлы с настройками. 4241 + 4242 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4243 + 4244 +(% class="box infomessage" %) 4245 +((( 4246 +**POST /api/v3/vehicles/export/history** 4247 +))) 4248 + 4249 +Метод возвращает список сообщений терминала объекта за выбранный период. 4250 + 4251 +Тело запроса: 4252 + 4253 +{ 4254 + "vehicleId": 0, 4255 + "asArchive": true, 4256 + "from": "2023-09-27T12:17:45.973Z", 4257 + "to": "2023-09-27T12:17:45.973Z" 4258 +} 4259 + 4260 +Ответ: 4261 + 4262 +Получаете файл. Сообщение: Code 200/Success 4263 + 4264 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4265 +|vehicleId|ID объекта 4266 +|asArchive|true - Архивировать файл, False - не архивировать 4267 +|from|Дата и время начала запроса 4268 +|to|Дата и время окончания запроса 4269 + 4270 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4271 + 4272 +(% class="box infomessage" %) 4273 +((( 4274 +**GET /api/v3/vehicles/export/history/status** 4275 +))) 4276 + 4277 +Метод возвращает список сообщений терминала объекта за выбранный период. 4278 + 4279 +Ответ: 4280 + 4281 +{ 4282 + "activity": true, 4283 + "progress": 0, 4284 + "message": "string" 4285 +} 4286 + 4287 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4288 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4289 +|progress|Прогресс экспорта, от 0 до 100% 4290 +|message|Текст описывающий статус 4291 + 4292 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4293 + 4294 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4295 + 4296 +(% class="box infomessage" %) 4297 +((( 4298 +**POST /api/v3/EcoDriving/rating** 4299 +))) 4300 + 4301 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4302 + 4303 +Тело запроса: 4304 + 4305 +{ 4306 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4307 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4308 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4309 +} 4310 + 4311 +Ответ: 4312 + 4313 +{ 4314 + "items": [ ~/~/ Список в разрезе ТС 4315 + { 4316 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4317 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4318 + "vehicleId": 0, ~/~/ ID ТС 4319 + "vehicleName": "string", ~/~/ Название ТС 4320 + "vehicleModel": "string", ~/~/ Модель ТС 4321 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4322 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4323 + "totalViolations": 0, ~/~/ Нарушений всего 4324 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4325 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4326 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4327 + "brakingViolations": 0, ~/~/ Нарушений торможения 4328 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4329 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4330 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4331 + }, 4332 + 4333 +((( 4334 + 4335 +))) 4336 + 4337 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4338 + "mileage": 0, ~/~/ Пробег, м 4339 + "tripsCount": 0, ~/~/ Кол-во рейсов 4340 + "trips": [ ~/~/ Информация по рейсу 4341 + { 4342 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4343 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4344 + "violationsCount": 0, ~/~/ Всего нарушений 4345 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4346 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4347 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4348 + "brakingViolations": 0, ~/~/ Нарушений торможения 4349 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4350 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4351 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4352 + }, 4353 + 4354 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4355 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4356 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4357 + "mileage": 0, ~/~/ Пробег, м 4358 + "motohours": 0, ~/~/ Моточасы, секунды 4359 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4360 + "startAddress": "string", ~/~/ Адрес начала рейса 4361 + "endAddress": "string", ~/~/ Адрес конца рейса 4362 + "drivers": [ ~/~/ Список водителей 4363 + { 4364 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4365 + "driverName": "string", ~/~/ФИО водителя 4366 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4367 + } 4368 + ] 4369 + } 4370 + ] 4371 + } 4372 + ] 4373 +} 4374 + 4375 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4376 + 4377 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4378 + 4379 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4380 + 4381 +(% class="box infomessage" %) 4382 +((( 4383 +POST /api/v3/fuelcards/transactions 4384 +))) 4385 + 4386 +Метод запроса: POST 4387 + 4388 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4389 +\\В заголовках запроса: X-Auth: Токен авторизации 4390 + 4391 +Параметры в теле запроса (JSON): 4392 + 4393 +{ 4394 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4395 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4396 + "ids": [ 4397 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4398 + ], 4399 + "timezone": 0 ~/~/Таймзона 4400 +} 4401 + 4402 + 4403 +Ответ: 4404 + { 4405 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4406 + "driver": "string", ~/~/Водители, привязанные к ТК 4407 + "object": "string", ~/~/Наименование ТС 4408 + "amount": 0, ~/~/Количество топлива 4409 + "amountDut": 0, ~/~/Количество по ДУТ 4410 + "amountDiff": 0, ~/~/Разница, л 4411 + "amountDiffPerc": 0, ~/~/Разница, % 4412 + "summa": 0, ~/~/Стоимость, руб 4413 + "serviceName": "string", ~/~/Тип топлива 4414 + "price": 0, ~/~/Цена за литр, руб 4415 + "cardName": "string", ~/~/Наименование ТК 4416 + "cardNum": "string", ~/~/Номер ТК 4417 + "operator": "string", ~/~/Оператор ТК 4418 + "address": "string" ~/~/Адрес АЗС 4419 + } 4420 + 4421 + 4422 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4423 + 4424 + 4425 +== **Получение полных данных о ретрансляторе** == 4426 + 4427 +(% class="box infomessage" %) 4428 +((( 4429 +**GET ** **/api/v3/retranslations/{id}** 4430 +))) 4431 + 4432 +Идентификатор запроса: ID 4433 + 4434 + 4435 +Пример ответа: 4436 + 4437 +{ 4438 +"description": "", ~/~/ Определяет описание 4439 +"subscriberId": "", ~/~/ Подписчик 4440 +"protocolType": 0, ~/~/ Тип протокола 4441 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4442 +"address": "string", ~/~/ Адрес события 4443 +"objects": [ ~/~/Объекты для ретрансляции 4444 +{ 4445 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4446 +"name": "", ~/~/ Наименование объекта ретрансляции 4447 +"imei": "", ~/~/ IMEI объекта 4448 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4449 +} 4450 + ], 4451 +"id": "", ~/~/ идентификатор пользователя 4452 +"parentId": "", ~/~/Guid родителя 4453 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4454 +} 4455 + 4456 + 4457 +== **Удаление данных ретранслятора** == 4458 + 4459 +(% class="box infomessage" %) 4460 +((( 4461 +**DELETE** **/api/v3/retranslations/{id}** 4462 +))) 4463 + 4464 +Параметр запроса: ID 4465 + 4466 + 4467 +== **Создание ретранслятора** == 4468 + 4469 +(% class="box infomessage" %) 4470 +((( 4471 +**POST ** **/api/v3/retranslations/{id}** 4472 +))) 4473 + 4474 +Запрос: 4475 + 4476 +{ 4477 +"description": "", ~/~/ Описание 4478 +"subscriberId": "", ~/~/ Подписчик 4479 +"protocolType": 0, ~/~/ Тип протокола 4480 +"address": "", ~/~/ Адрес ретрансляции 4481 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4482 +"objects": [ ~/~/Объекты для ретрансляции 4483 +{ 4484 +"id": "", ~/~/ идентификатор пользователя 4485 +"imei": "", ~/~/IMEI объекта 4486 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4487 +} 4488 + ] 4489 +} 4490 + 4491 + 4492 +Ответ: 4493 + 4494 +{ 4495 +"description": "string", ~/~/ Определяет описание 4496 +"subscriberId": "", ~/~/ идентификатор запроса 4497 +"protocolType": 0, ~/~/ Тип протокола 4498 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4499 +"address": "", ~/~/ Адрес события 4500 +"objects": [ ~/~/Объекты для ретрансляции 4501 +{ 4502 +"id": "", ~/~/ идентификатор пользователя 4503 +"name": "string", ~/~/ Название уведомления 4504 +"imei": "string", ~/~/IMEI объекта 4505 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4506 +} 4507 + ], 4508 +"id": "", ~/~/ идентификатор пользователя 4509 +"parentId": "", ~/~/ Guid идентификатор родителя 4510 +"deleted": true ~/~/ Признак удаления 4511 +} 4512 + 4513 + 4514 +== **Редактирование ретранслятора** == 4515 + 4516 +(% class="box infomessage" %) 4517 +((( 4518 +**PUT** **/api/v3/retranslations** 4519 +))) 4520 + 4521 +Пример запроса: 4522 + 4523 +{ 4524 +"id": "", ~/~/ идентификатор пользователя 4525 +"description": "string", ~/~/ Определяет описание 4526 +"subscriberId": "", ~/~/ идентификатор запроса 4527 +"protocolType": 0, ~/~/ Тип протокола 4528 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4529 +"address": "string", ~/~/ Адрес события 4530 +"objects": ~/~/Объекты для ретрансляции 4531 +[ 4532 +{ 4533 +"id": "", ~/~/ идентификатор пользователя 4534 +"imei": "", ~/~/IMEI объекта 4535 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4536 +} 4537 + ] 4538 +} 4539 + 4540 + 4541 +Пример ответа: 4542 + 4543 +{ 4544 +"description": "", ~/~/ Определяет описание 4545 +"subscriberId": "", ~/~/ идентификатор запроса 4546 +"protocolType": 0, ~/~/ Тип протокола 4547 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4548 +"address": "string", ~/~/ Адрес события 4549 +"objects": [ ~/~/Объекты для ретрансляции 4550 +{ 4551 +"id": "", ~/~/ идентификатор пользователя 4552 +"name": "string", ~/~/ Название уведомления 4553 +"imei": "", ~/~/IMEI объекта 4554 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4555 +} 4556 + ], 4557 +"id": "", ~/~/ идентификатор пользователя 4558 +"parentId": "", ~/~/ Guid идентификатор родителя 4559 +"deleted": true ~/~/ Признак удаления 4560 +} 4561 + 4562 + 4563 +== **Получение списка ретранслятора клиента** == 4564 + 4565 +(% class="box infomessage" %) 4566 +((( 4567 +**POST /api/v3/retranslations/find** 4568 +))) 4569 + 4570 +Пример запроса: 4571 + 4572 +{ 4573 +"id": "", ~/~/ идентификатор пользователя 4574 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4575 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4576 +} 4577 + 4578 +Ответ: 4579 + 4580 +[ 4581 +{ 4582 +"description": "", ~/~/ Определяет описание 4583 +"subscriberId": "", ~/~/ идентификатор запроса 4584 +"protocolType": 0, ~/~/ Тип протокола 4585 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4586 +"address": "string", ~/~/ Адрес события 4587 +"id": "", ~/~/ идентификатор пользователя 4588 +"parentId": "", ~/~/ Guid идентификатор родителя 4589 +"deleted": true ~/~/ Признак удаления 4590 +} 4591 +] 4592 + 4593 + 4594 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4595 + 4596 +== **API для отчета по выгрузке комбайнов** == 4597 + 4598 +(% class="box infomessage" %) 4599 +((( 4600 +POST **/api/v3/Reports/harvesterUnloading** 4601 +))) 4602 + 4603 +Пример запроса: 4604 + 4605 +{ 4606 + "byTime": 0, ~/~/ Объединение событий по времени 4607 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4608 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4609 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4610 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4611 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4612 + 0 4613 + ], 4614 + "from": "", ~/~/ Дата и время начало запроса 4615 + "to": "", ~/~/ Дата и время окончания запроса 4616 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4617 +} 4618 + 4619 +Пример ответа: 4620 + 4621 +[ 4622 + { 4623 + "harvesterName": "", ~/~/Комбайн, номер 4624 + "harvesterId": 0, ~/~/Комбайн, id 4625 +"harvesterModel": "", ~/~/ Модель комбайна 4626 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4627 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4628 + "events": [ ~/~/Список событий в разрезе комбайна 4629 + { 4630 + "driverId": "", ~/~/Идентификатор водителя 4631 + "driverName": "", ~/~/Водитель комбайна, ФИО 4632 + "RFID": "", ~/~/ идентификатор карты-метки 4633 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4634 + "vehicleId": 0, ~/~/идентификатор объекта 4635 + "vehicleName": "string", ~/~/ Имя объекта 4636 + "modelName": "string", ~/~/ Имя модели объекта 4637 + "nearestVehicles": [ ~/~/Объекты рядом 4638 + { 4639 + "vehicleId": 0, ~/~/идентификатор объекта 4640 + "vehicleName": "string" ~/~/ Имя объекта 4641 + } 4642 + ], 4643 + "fields": [ ~/~/Поля, где происходила выгрузка 4644 + { 4645 + "id": 0, ~/~/ идентификатор пользователя 4646 + "name": "string" ~/~/ имя пользователя 4647 + } 4648 + ], 4649 + "event": "string", ~/~/Событие 4650 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4651 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4652 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4653 + "cultureName": "string", ~/~/ название культуры 4654 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4655 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4656 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4657 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4658 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4659 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4660 + "issued": 0, ~/~/Выдано, бункеров 4661 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4662 + "latitude": 0, ~/~/Широта 4663 + "longitude": 0, ~/~/ Долгота 4664 + "litresAway": 0, ~/~/Отдано, л 4665 + "m3Away": 0 ~/~/Отдано, м3 4666 + } 4667 + ] 4668 + } 4669 +] 4670 + 4671 + 4672 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4673 + 4674 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4675 + 4676 + 4677 +(% class="box infomessage" %) 4678 +((( 4679 +GET api/v3/Vehicles/recyclebin/all 4680 +))) 4681 + 4682 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4683 + 4684 +Параметр запроса: {parentId} - идентификатор агента 4685 + 4686 +В заголовках запроса: X-Auth: Токен авторизации 4687 + 4688 +Ответ: 4689 + 4690 +[ 4691 + { 4692 + "recordTime": "", ~/~/Время записи 4693 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4694 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4695 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4696 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4697 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4698 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4699 + "items": [ ~/~/ 4700 +nullable: true ~/~/Детали 4701 + { 4702 + "name": "string", ~/~/наименование столбца 4703 + "value": "string" ~/~/содержание столбца 4704 + } 4705 + ] 4706 + }, 4707 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4708 + "string" 4709 + ] 4710 + } 4711 +] 4712 + 4713 + 4714 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4715 + 4716 +(% class="box infomessage" %) 4717 +((( 4718 +POST/api/v3/Vehicles/recyclebin/erase 4719 +))) 4720 + 4721 +В заголовках запроса: X-Auth: Токен авторизации 4722 + 4723 +Пример запроса: 4724 + 4725 +[ 4726 +0 4727 +] 4728 + 4729 + 4730 +Пример ответа: 4731 + 4732 +[ 4733 +{ 4734 + "recordTime": "", ~/~/Время записи 4735 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4736 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4737 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4738 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4739 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4740 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4741 + "items": [ ~/~/Детали 4742 + { 4743 + "name": "", ~/~/Имя свойства 4744 + "value": "" ~/~/Значение свойства 4745 + } 4746 + ] 4747 + }, 4748 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4749 + "" 4750 + ] 4751 + } 4752 +] 4753 + 4754 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4755 + 4756 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4757 + 4758 +(% class="box infomessage" %) 4759 +((( 4760 +POST/api/v3/Vehicles/recyclebin/restore 4761 +))) 4762 + 4763 +В заголовках запроса: X-Auth: Токен авторизации 4764 + 4765 +Параметры в теле запроса (JSON): 4766 + 4767 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4768 + 4769 +В заголовках запроса: X-Auth: Токен авторизации 4770 + 4771 + 4772 +Пример запроса: 4773 + 4774 +((( 4775 +[ 4776 +))) 4777 + 4778 +((( 4779 + 0 4780 +))) 4781 + 4782 +((( 4783 +] 4784 +))) 4785 + 4786 + 4787 +Пример ответа: 4788 + 4789 +[ 4790 +{ 4791 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4792 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4793 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4794 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4795 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4796 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4797 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4798 + "items": [ ~/~/Детали 4799 + { 4800 + "name": "string", ~/~/Имя свойства 4801 + "value": "string" ~/~/Значение свойства 4802 + } 4803 + ] 4804 + }, 4805 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4806 + "string" 4807 + ] 4808 + } 4809 +] 4810 + 4811 + 4812 + 3048 3048 (% class="box" lang="en-US" style="text-align: center;" %) 3049 3049 ((( 3050 3050 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content