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.SupportZhuchkov - Content
-
... ... @@ -1,5 +1,17 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 8 + 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 11 + 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить работу команд. 13 + 14 + 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" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!29 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 31 + 32 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 33 + 34 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 35 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 38 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 39 +((( 40 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 41 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 42 +))) 22 22 23 -(% class="box infomessage" %)44 +(% 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**__».55 +(% 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" %) 68 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 69 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 74 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 75 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 76 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 77 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 78 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 79 + 80 +(% class="wikigeneratedid" %) 81 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 82 + 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" ~/~/ Корр. счет122 + "agentId": "", (%%) 123 + "parentId": "", 124 + "parentName": "string", 125 + "name": "string", 126 + "fullName": "string", 127 + "agentInfoType": 0, 128 + "isForeign": true/false, 129 + "district": "string", 130 + "region": "string", 131 + "city": "string", 132 + "inn": "string", 133 + "kpp": "string", 134 + "address": "string", 135 + "addressFact": "string", 136 + "email": "string", 137 + "director": "string", 138 + "bankName": "string", 139 + "bankBIK": "string", 140 + "bankRS": "string", 141 + "bankKS": "string" 118 118 } 119 119 144 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 145 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 146 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 147 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 148 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 149 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 150 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 151 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 152 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 153 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 154 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 155 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 156 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 157 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 158 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 159 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 160 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 161 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 162 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 163 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 164 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 165 + 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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».179 +(% 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 - Отказ) 194 + "agentId": "",(% style="color:#000000" %) (%%) 195 + "parentId": "", 196 + "name": "string", 197 + "fullName": "string", 198 + "agentInfoType": 0, 199 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 202 + 203 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 204 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 205 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 206 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 207 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 208 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 209 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 210 + 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 - 229 + "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 273 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 274 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 275 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 276 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 277 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 278 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 279 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 280 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 281 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 282 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 283 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 284 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 285 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 286 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 287 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 288 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 289 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 290 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 291 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 292 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 293 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 294 + 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 376 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 377 + 378 +(% class="box warningmessage" %) 379 +((( 380 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 381 +))) 382 + 383 +Метод позволяет изменить статус клиента, указанного в запросе. 384 + 385 +В пути указывается GUID клиента и статус клиента. 386 + 387 +**status **- значение 0 - заблокирован, 1 - активен. 388 + 389 +Ответ: Code 204 390 + 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 пользователя 455 +{ 456 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 473 +} 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 - 495 +(% 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 пользователя 591 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 592 + "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" %) 614 + "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": "" , ~/~/ идентификатор пользователя 621 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 622 + "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» названия группы пользователя 643 +} 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 - 664 +(% 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 - 689 + "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" %)Описание 789 +|=(% 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" %)Скорость выгрузки из бункера, л/сек 798 +|(% 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): 819 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 755 755 756 -(% style="color:#000000" %){ 757 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 821 +(% 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 836 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 837 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 838 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 839 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 840 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 841 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 842 + 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 895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 896 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 897 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 898 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 899 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 900 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 901 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 902 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 903 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 904 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 905 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 906 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 907 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 908 + 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 962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 963 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 964 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 965 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 966 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 967 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 968 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 969 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 970 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 971 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 972 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 973 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 974 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 975 + 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" %)Раздел: **Транспортные средства**(%%) = 995 += (% 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 - 1062 + "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": [ ~/~/ История статусов 1169 +"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,75 @@ 1106 1106 (% style="text-align:left" %) 1107 1107 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1108 1108 1186 + 1187 +== **Отправить команду на терминал** == 1188 + 1189 +(% class="box successmessage" %) 1190 +((( 1191 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1192 +))) 1193 + 1194 +Команда для отправки на тс. 1195 + 1196 +{ 1197 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1198 +"command": "", ~/~/ Текст отправляемой команды 1199 +"retries": "", ~/~/ Количество попыток отправки на терминал 1200 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1201 +} 1202 + 1203 +В ответ получаем cmdid 1204 + 1205 + 1206 +== **Получить ответ на отправленную на ТС команду** == 1207 + 1208 +(% class="box infomessage" %) 1209 +((( 1210 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1211 +))) 1212 + 1213 +Идентификатор команды: cmdId 1214 + 1215 +Запрос от терминала на ответ команды 1216 + 1217 +Пример ответ от терминала: 1218 + 1219 +ID= "" ~/~/ идентификатор объекта 1220 +Soft="" ~/~/ версия софта 1221 +GPS=4 ~/~/ тип трекера 1222 +Time=11:05:43 28.06.24 ~/~/ время запроса 1223 +Lat=45.056221 ~/~/ широта 1224 +Lon=39.035938 ~/~/ долгота 1225 +Speed=0.0 ~/~/ скорость 1226 +Course=181.4 ~/~/направление 1227 + 1228 +((( 1229 +== **Список отправленных объекту команд с ответами** == 1230 + 1231 +(% class="box infomessage" %) 1232 +((( 1233 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1234 +))) 1235 + 1236 +Идентификатор ТС: vehicleId 1237 + 1238 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1239 + 1240 +Пример ответа терминала 1241 + 1242 +[ 1243 +{ 1244 +"id": "", ~/~/ идентификатор пользователя 1245 +"commandText": "", ~/~/Текст команды. 1246 +"templateId": "", ~/~/Идентификатор шаблона 1247 +"updated": "", ~/~/ Время отправки 1248 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1249 +"answer": "", ~/~/ Ответ терминала. 1250 +"status": "" ~/~/ Статус отправки 1251 +} 1252 +] 1253 +))) 1254 + 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 - 1272 +(% 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": [ ~/~/ Датчики 1339 +"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 ~/~/ Макс. значение 1389 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1390 + 1391 +((( 1392 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1393 + { 1394 + "from": 0, ~/~/ С какого значения 1395 + "color": "string", ~/~/ Каким цветом 1396 + "text": "string" ~/~/ Текст подписи к этому интервалу 1397 + } 1398 + ] 1260 1260 } 1261 1261 ], 1401 +))) 1402 + 1403 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1404 + 1405 + 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 1408 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1409 + "name": "string", ~/~/ Наименование произвольного поля 1410 + "value": "string", ~/~/ Значение произвольного поля 1411 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1412 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1413 + "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 - однократно) 1421 +((( 1422 +((( 1423 +((( 1424 +{ 1425 + "vehicleId": 0, ~/~/ ID ТС 1426 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1427 + "name": "string", ~/~/ Имя объекта 1428 + "imei": "string", ~/~/ IMEI 1429 + "deviceTypeId": 0, ~/~/ ID типа устройства 1430 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1431 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1432 + "sim1": "string", ~/~/ SIM1 1433 + "sim2": "string", ~/~/ SIM2 1434 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1435 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1436 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1437 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1438 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1439 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1440 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1441 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1442 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1443 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1444 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1445 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1446 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1447 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1448 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1449 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1450 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1451 + "counters": { ~/~/ Dto для состояний счётчиков 1452 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1453 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1454 + "mileage": 0, ~/~/ Пробег 1455 + "motohours": 0 ~/~/ Моточасы 1456 + }, 1457 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1458 + "id": "string", ~/~/ CMSV6 Идентификатор 1459 + "enabled": true, ~/~/ Признак включения 1460 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1461 + "login": "string", ~/~/ CMSV6 имя учетной записи 1462 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1463 + }, 1464 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1465 + { 1466 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1467 + "enabled": true, ~/~/ Признак включения 1468 + "name": "string", ~/~/ Имя задания 1469 + "description": "string", ~/~/ Описание задания 1470 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1471 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1472 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1473 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1474 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1475 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1476 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1477 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1314 1314 } 1479 + ], 1480 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1481 + { 1482 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1483 + "inputNumber": 0, ~/~/ № входа. 1484 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1485 + "comment": "string", ~/~/ Комментарий 1486 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1487 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1488 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1489 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1490 + } 1491 + ], 1492 + "commandTemplates": [ ~/~/ Список шаблонов команд 1493 + { 1494 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1495 + "name": "string", ~/~/ Название шаблона команд 1496 + "command": "string", ~/~/ Команда на выполнение 1497 + "retries": 0 ~/~/ Лимит попыток отправки 1498 + } 1499 + ], 1500 + "sensors": [ ~/~/ Список датчиков 1501 + { 1502 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1503 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1504 + "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 1505 + "name": "string", ~/~/ Имя датчика 1506 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1507 + "inputNumber": 0, ~/~/ Номер входа 1508 + "pseudonym": "string", ~/~/ Псевдоним 1509 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1510 + "isInverted": true, ~/~/ Признак инверсии 1511 + "disabled": true, ~/~/ Датчик не участвует в обработке 1512 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1513 + "gradesTables": [ ~/~/ Тарировка 1514 + { 1515 + "grades": [ ~/~/ Таблицы тарировки 1516 + { 1517 + "input": 0, ~/~/ Вход 1518 + "output": 0 ~/~/ Выход 1519 + } 1520 + ], 1521 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1522 + } 1523 + ], 1524 + "showInTooltip": true, ~/~/ Отображение в подсказке 1525 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1526 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1527 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1528 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1529 + "expr": "string", ~/~/ Выражение 1530 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1531 + "string" 1532 + ], 1533 + "customParams": { 1534 + "additionalProp1": "string", 1535 + "additionalProp2": "string", 1536 + "additionalProp3": "string" 1537 + }, 1538 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1539 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1540 + { 1541 + "from": 0, ~/~/ С какого значения 1542 + "color": "string", ~/~/ Каким цветом 1543 +))) 1315 1315 1316 -(% style="text-align:left" %) 1317 -(% style="color:#000000" %)} 1545 +((( 1546 + "text": "string" ~/~/ Текст подписи к этому интервалу 1547 + } 1548 + ] 1549 + } 1550 + ], 1551 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1552 + "customFields": [ ~/~/ Список произвольных полей 1553 + { 1554 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1555 + "name": "string", ~/~/ Наименование произвольного поля 1556 + "value": "string", ~/~/ Значение произвольного поля 1557 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1558 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1559 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1560 + } 1561 + ], 1562 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1563 +} 1564 +))) 1565 +))) 1566 +))) 1318 1318 1568 + 1319 1319 **Валидация:** 1320 1320 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1321 1321 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1322 1322 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1323 1323 1324 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1325 1325 1575 +== **Импортировать историю ТС (Асинхронный запрос)** == 1576 + 1577 +(% class="box successmessage" %) 1578 +((( 1579 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1580 +))) 1581 + 1582 +Метод запроса: **POST** 1583 + 1584 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1585 + 1586 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1587 + 1588 + 1589 +Ответ: 1590 + 1591 +{ 1592 + 1593 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1594 + 1595 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1596 + 1597 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1598 + 1599 + "Message": "string", ~/~/ Информация о выполнении запроса 1600 + 1601 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1602 + 1603 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1604 + 1605 + "Data": "string" ~/~/ Данные 1606 + 1607 +} 1608 + 1609 + 1610 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1611 + 1326 1326 (% class="box infomessage" %) 1327 1327 ((( 1614 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1615 +))) 1616 + 1617 +Метод запроса: **GET** 1618 + 1619 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1620 + 1621 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1622 + 1623 + 1624 +Ответ: 1625 + 1626 +{ 1627 + 1628 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1629 + 1630 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1631 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1632 + 1633 + "Message": "string", ~/~/ Информация о выполнении запроса 1634 + 1635 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1636 + 1637 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1638 + 1639 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1640 + 1641 + "Data": "string" ~/~/ Данные 1642 + 1643 +} 1644 + 1645 + 1646 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1647 + 1648 +(% class="box infomessage" %) 1649 +((( 1328 1328 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1329 1329 ))) 1330 1330 1331 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1653 +(% 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 ~/~/ значение любого из произвольных полей ТС 1687 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1688 + "unitName": "string", ~/~/ Название подразделения (опционально) 1689 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1690 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1691 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1692 + "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" %){ 1699 +(% style="color:#000000" %)[ 1700 +{ 1375 1375 1702 +((( 1703 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1704 +))) 1705 + 1706 +((( 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" %)} 1732 +))) 1403 1403 1734 +((( 1735 + } 1736 + ], 1737 + "vehicleGroups": [ ~/~/ Группы ТС 1738 + { 1739 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1740 + "name": "string" ~/~/ Наименование группы ТС 1741 + } 1742 + ] 1743 + } 1744 +] 1745 +))) 1746 + 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 - 1782 +(% 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 1791 +== == 1792 + 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": [ ~/~/ Датчики 1880 +"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 ~/~/ Макс. значение 1931 + 1932 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1933 + { 1934 + "from": 0, ~/~/ С какого значения 1935 + "color": "string", ~/~/ Каким цветом 1936 + "text": "string" ~/~/ Текст подписи к этому интервалу 1937 + } 1938 + ] 1603 1603 } 1604 1604 ], 1941 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1942 + 1605 1605 "customFields": [ ~/~/ Произвольные поля 1606 - { 1607 - 1608 - "name": "string", 1609 - "value": "string", 1610 - "forClient": true, 1611 - "forTooltip": true, 1612 - "forReport": true 1944 + { 1945 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1946 + "name": "string", ~/~/ Наименование произвольного поля 1947 + "value": "string", ~/~/ Значение произвольного поля 1948 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1949 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1950 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1613 1613 } 1614 1614 ] 1615 1615 } 1616 1616 1955 + 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" %){ 1958 +((( 1959 +{ 1960 + "vehicleId": 0, ~/~/ ID ТС 1961 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1962 + "name": "string", ~/~/ Имя объекта 1963 + "imei": "string", ~/~/ IMEI 1964 + "deviceTypeId": 0, ~/~/ ID типа устройства 1965 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1966 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1967 + "sim1": "string", ~/~/ SIM1 1968 + "sim2": "string", ~/~/ SIM2 1969 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1970 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1971 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1972 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1973 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1974 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1975 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1976 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1977 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1978 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1979 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1980 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1981 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1982 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1983 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1984 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1985 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1986 + "counters": { ~/~/ состояний счётчиков 1987 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1988 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1989 + "mileage": 0, ~/~/ Пробег 1990 + "motohours": 0 ~/~/ Моточасы 1991 + }, 1992 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1993 + "id": "string", ~/~/ CMSV6 Идентификатор 1994 + "enabled": true, ~/~/ Признак включения 1995 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1996 +))) 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 1998 + 1999 +((( 2000 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2001 + "login": "string", ~/~/ CMSV6 имя учетной записи 2002 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2003 + }, 2004 + "inspectionTasks": [ ~/~/ Задания на ТО 2005 + { 2006 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2007 + "enabled": true, ~/~/ Признак включения 2008 + "name": "string", ~/~/ Имя задания 2009 + "description": "string", ~/~/ Описание задания 2010 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2011 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2012 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2013 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2014 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2015 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2016 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2017 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2018 + } 2019 + ], 2020 + "drivers": [ ~/~/ Список водителей 2021 + { 2022 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2023 + "inputNumber": 0, ~/~/ № входа. 2024 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2025 + "comment": "string", ~/~/ Комментарий. 2026 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2027 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2028 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2029 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2030 + } 2031 + ], 2032 + "commandTemplates": [ ~/~/ Список шаблонов команд 2033 + { 2034 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2035 + "name": "string", ~/~/ Название шаблона команд 2036 + "command": "string", ~/~/ Команда на выполнение 2037 + "retries": 0 ~/~/ Лимит попыток отправки 2038 + } 2039 + ], 2040 + "sensors": [ ~/~/ Список датчиков 2041 + { 2042 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2043 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2044 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2045 +))) 2046 + 2047 +((( 2048 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2049 +))) 2050 + 2051 +((( 2052 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2053 +))) 2054 + 2055 +((( 2056 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2057 +))) 2058 + 2059 +((( 2060 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2061 +))) 2062 + 2063 +((( 2064 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2065 + "name": "string", ~/~/ Имя датчика 2066 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2067 +))) 2068 + 2069 +((( 2070 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2071 + "inputNumber": 0, ~/~/ Номер входа 2072 + "pseudonym": "string", ~/~/ Псевдоним 2073 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2074 + "isInverted": true, ~/~/ Признак инверсии 2075 + "disabled": true, ~/~/ Датчик не участвует в обработке 2076 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2077 + "gradesTables": [ ~/~/ Тарировка 1642 1642 { 1643 - "id": ~/~/ идентификатор 1644 - "enabled": true, ~/~/ флаг включения 1645 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1646 - "login": "", ~/~/ имя учетной записи 1647 - "password": "", ~/~/ пароль учетной записи 1648 - } 1649 - "inspectionTasks": ~/~/ задания на ТО 2079 + "grades": [ ~/~/ Таблицы тарировки 2080 + { 2081 + "input": 0, ~/~/ Вход 2082 + "output": 0 ~/~/ Выход 2083 + } 2084 + ], 2085 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 2086 + } 2087 + ], 2088 + "showInTooltip": true, ~/~/ Отображение в подсказке 2089 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 2090 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2091 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2092 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2093 + "expr": "string", ~/~/ Выражение 2094 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2095 + "string" 2096 + ], 2097 + "customParams": { ~/~/ Дополнительные настройки 2098 + "additionalProp1": "string", 2099 + "additionalProp2": "string", 2100 + "additionalProp3": "string" 2101 + }, 2102 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2103 + "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": "", ~/~/ Сколько раз выполнить задание 2105 + "from": 0, ~/~/ С какого значения 2106 + "color": "string", ~/~/ Каким цветом 2107 + "text": "string" ~/~/ Текст подписи к этому интервалу 1662 1662 } 2109 + ] 2110 + } 2111 + ], 2112 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2113 + "customFields": [ ~/~/ Список произвольных полей 2114 + { 2115 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2116 + "name": "string", ~/~/ Наименование произвольного поля 2117 + "value": "string", ~/~/ Значение произвольного поля 2118 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2119 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2120 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2121 + } 2122 + ], 2123 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2124 +} 2125 +))) 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]]2165 +(% 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 - 2171 +(% 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 - 2195 +(% 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 2242 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2243 + 2244 +(% class="box infomessage" style="text-align: left;" %) 2245 +((( 2246 +**POST /api/v3/terminalMessages/mapping** 2247 +))) 2248 + 2249 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2250 + 2251 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2252 + 2253 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2254 + 2255 +{ 2256 + "protocolType": 0, 2257 + "params": ["string"] 2258 +} 2259 + 2260 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2261 +|protocolType|ID типа протокола 2262 +|params|((( 2263 +Массив наименований параметров в сообщении 2264 +))) 2265 + 2266 +Ответ: 2267 + 2268 +{ 2269 + "protocolType": 0, 2270 + "mapping": { 2271 + "additionalProp1": { 2272 + "inputType": 0, 2273 + "inputNumber": 0 2274 + }, 2275 + "additionalProp2": { 2276 + "inputType": 0, 2277 + "inputNumber": 0 2278 + } 2279 + } 2280 +} 2281 + 2282 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2283 +|protocolType|Тип протокола 2284 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2285 +|inputNumber|((( 2286 +Номер входа 2287 +))) 2288 + 2289 +(% class="wikigeneratedid" %) 2290 +Перечень 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/]] 2291 + 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 2316 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2317 +|vehicleId|ID объекта 2318 +|from|Дата и время начала периода запроса 2319 +|to|Дата и время окончания периода запроса 2320 + 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": { ~/~/ список параметров датчиков передаваемых терминалом 2327 + "deviceTime": "2023-11-29T07:40:44.052Z", 2328 + "serverTime": "2023-11-29T07:40:44.052Z", 2329 + "speed": 0, 2330 + "altitude": 0, 2331 + "latitude": 0, 2332 + "longitude": 0, 2333 + "satellites": 0, 2334 + "course": 0, 2335 + "voltage": 0, 2336 + "parameters": { 1827 1827 "additionalProp1": "string", 1828 1828 "additionalProp2": "string", 1829 1829 "additionalProp3": "string" 1830 1830 }, 1831 - "photoCount": 0 ~/~/ Кол-во фото 2341 + "photoCount": 0, 2342 + "lbsCorrectedCoords": true, 2343 + "protocolType": 0 1832 1832 } 1833 1833 ] 1834 1834 } 1835 1835 ] 1836 1836 1837 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2349 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2350 +|deviceTime|Время сообщения терминала 2351 +|serverTime|Время когда сообщение поступило на сервер 2352 +|speed|Скорость 2353 +|altitude|Высота над уровнем моря 2354 +|latitude|Широта 2355 +|longitude|Долгота 2356 +|satellites|Кол-во спутников 2357 +|course|Курс 2358 +|voltage|Бортовое напряжение 2359 +|parameters|Список параметров и их значений 2360 +|photoCount|Количество фото 2361 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2362 +|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 ~/~/ Моточасы на окончание периода 2400 + "mileage": 0, ~/~/ Пробег за период, километры 2401 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2402 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2403 + "motohours": 0, ~/~/ Моточасы за период, секунды 2404 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2405 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1932 1932 } 1933 1933 ] 1934 1934 } ... ... @@ -1977,6 +1977,12 @@ 1977 1977 } 1978 1978 ] 1979 1979 2454 +(% class="box warningmessage" %) 2455 +((( 2456 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2457 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2458 +))) 2459 + 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 2505 + 2506 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2507 + 2508 +(% class="box infomessage" %) 2509 +((( 2510 +**POST /api/v3/vehicles/moveStop** 2511 +))) 2512 + 2513 +Метод запроса: **POST** 2514 + 2515 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2516 + 2517 +В заголовках запроса: X-Auth: Токен авторизации 2518 + 2519 + 2520 +Тело запроса: 2521 + 2522 +{ 2523 + "vehicleIds": [ ], ~/~/ Список ID объектов 2524 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2525 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2526 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2527 +} 2528 + 2529 +Ответ: 2530 + 2531 +[ 2532 + { 2533 + "vehicleId": 0, ~/~/ ID объекта 2534 + "vehicleName": "string", ~/~/ Имя объекта 2535 + "moves": [ ~/~/ Событие движения 2536 + { 2537 + "mileage": 0, ~/~/ Пробег, км 2538 + "eventId": 0, ~/~/ Идентификатор события 2539 + "eventName": "string", ~/~/ Название события 2540 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2541 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2542 + "duration": 0 ~/~/ Продолжительность события, секунд 2543 + } 2544 + ], 2545 + "stops": [ ~/~/ События стоянок 2546 + { 2547 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2548 + "eventId": 0, ~/~/ Идентификатор события 2549 + "eventName": "string", ~/~/ Название события 2550 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2551 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2552 + "duration": 0 ~/~/ Продолжительность события, секунд 2553 + } 2554 + ] 2555 + } 2556 +] 2557 + 2558 + 2559 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2560 + 2561 +(% class="box infomessage" %) 2562 +((( 2563 +**POST /api/v3/vehicles/getlastdata** 2564 +))) 2565 + 2566 +Метод запроса: **POST** 2567 + 2568 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2569 + 2570 +В заголовках запроса: X-Auth: Токен авторизации 2571 + 2572 + 2573 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2574 + 2575 +Ответ: 2576 + { 2577 + "vehicleId": 0, ~/~/Идентификатор объекта. 2578 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2579 + "vehicleNumber": "string",~/~/Номер объекта. 2580 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2581 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2582 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2583 + "speed": 0,~/~/Скорость объекта. 2584 + "course": 0,~/~/Курс движения [0;360] 2585 + "latitude": 0,~/~/Широта [-90°;90°]. 2586 + "longitude": 0,~/~/Долгота [-180°;180°]. 2587 + "address": "string",~/~/Адрес. 2588 + "geozones": [ ~/~/Сведения по геозонам. 2589 + { 2590 + "id": 0, 2591 + "name": "string" 2592 + } 2593 + 2594 + 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 2902 + 2903 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2904 + 2905 +(% class="box warningmessage" %) 2906 +((( 2907 +**PUT** /api/v3/notifications/prolongation 2908 +))) 2909 + 2910 +Метод позволяет продлить уведомления. 2911 + 2912 +Метод запроса **PUT** 2913 + 2914 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2915 + 2916 +В заголовках запроса: X-Auth: Токен авторизации. 2917 + 2918 +Тело запроса: 2919 + 2920 +[ 2921 + 2922 +0 2923 + 2924 +] 2925 + 2926 +где 0 идентификатор ids. 2927 + 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 3519 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3520 + 3521 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3522 + 3523 +(% class="box infomessage" %) 3524 +((( 3525 +**POST /api/v3/Trailers** 3526 +))) 3527 + 3528 +Пример запроса: 3529 + 3530 +{ 3531 + "startDate": "2023-11-14T10:48:03.671Z", 3532 + "endDate": "2023-11-14T10:48:03.671Z", 3533 + "ids": [ 0 ], 3534 + "timezone": 0 3535 +} 3536 + 3537 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3538 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3539 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3540 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3541 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3542 + 3543 +Пример ответа: 3544 + 3545 +[ 3546 + { 3547 + "SD": "2023-11-14T10:48:03.717Z", 3548 + "ED": "2023-11-14T10:48:03.717Z", 3549 + "id": 0, 3550 + "SLat": 0, 3551 + "SLon": 0, 3552 + "ELat": 0, 3553 + "ELon": 0, 3554 + "mileage": 0 3555 + "Duration": 0 3556 + "Address": "string", 3557 + "Address2": "string", 3558 + "name": "string", 3559 + "rid": "string", 3560 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3561 + "trailer": { 3562 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3563 + "Number": "string", 3564 + "Description": "string", 3565 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3566 + "ExternalID": "string", 3567 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3568 + "CreateTime": "2023-11-14T10:48:03.717Z", 3569 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3570 + "IsDeleted": true 3571 + }, 3572 + "filesCount": 0, 3573 + } 3574 +] 3575 + 3576 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3577 +|SD|Дата и время начала события 3578 +|ED|Дата и время окончания события 3579 +|id|ID объекта 3580 +|SLat|Широта начальной координаты 3581 +|SLon|Долгота начальной координаты 3582 +|ELat|Широта конечной координаты 3583 +|ELon|Долгота конечной координаты 3584 +|mileage|Пробег 3585 +|Duration|Продолжительность 3586 +|Address|Адрес начального местоположения 3587 +|Address2|Адрес конечного местоположения 3588 +|name|Имя радиометки 3589 +|rid|Номер радиометки 3590 +|rguid|ID радиометки 3591 +|trailer|Информация об агрегате 3592 +|ModelGuid|ID агрегата 3593 +|Number|Название/номер агрегата 3594 +|Description|Текст примечания агрегата 3595 + 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, ~/~/ Частота трансляции радиометки3617 + "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 3623 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3624 +|parentId|ID клиента 3625 +|name|Название карты-метки 3626 +|number|Номер 3627 +|period|Период запросов в секундах (работает только для агрегатов) 3628 +|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, ~/~/ Частота трансляции радиометки3645 + "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 3651 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3652 +|name|Название карты-метки 3653 +|number|Номер 3654 +|period|Период запросов в секундах (работает только для агрегатов) 3655 +|id|ID карты-метки 3656 +|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 3684 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3685 +|name|Название карты-метки 3686 +|number|Номер 3687 +|period|Период запросов в секундах (работает только для агрегатов) 3688 +|id|ID карты-метки 3689 +|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 3718 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3719 +|name|Название карты-метки 3720 +|number|Номер 3721 +|period|Период запросов в секундах (работает только для агрегатов) 3722 +|id|ID карты-метки 3723 +|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 - идентификатор карты-метки 3732 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3042 3042 3043 3043 Ответ: 3044 3044 ... ... @@ -3045,6 +3045,1083 @@ 3045 3045 Success 3046 3046 3047 3047 3739 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3740 + 3741 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3742 + 3743 +(% class="box infomessage" %) 3744 +((( 3745 +**GET /api/v3/Billing/client/balance/{clientId}** 3746 +))) 3747 + 3748 +Параметр запроса: **clientId **- идентификатор клиента. 3749 + 3750 +Ответ: 3751 + 3752 +{ 3753 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3754 + "Balance": 0 3755 +} 3756 + 3757 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3758 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3759 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3760 + 3761 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3762 + 3763 +(% class="box infomessage" %) 3764 +((( 3765 +**GET /api/v3/Billing/client/constraint/{clientId}** 3766 +))) 3767 + 3768 +Параметр запроса: **clientId **- идентификатор клиента. 3769 + 3770 +Ответ: 3771 + 3772 +{ 3773 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3774 + "CalculationType": 0, 3775 + "PermissibleBalance": 0, 3776 + "DefermentDays": 0, 3777 + "SendUiNotifications": true, 3778 + "SendEmailNotifications": true, 3779 + "IsPrivate": true, 3780 +} 3781 + 3782 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3783 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3784 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3785 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3786 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3787 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3788 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3789 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3790 + 3791 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3792 + 3793 +(% class="box infomessage" %) 3794 +((( 3795 +**GET /api/v3/Billing/client/plan/{clientId}** 3796 +))) 3797 + 3798 +Параметры запроса: 3799 + 3800 +**clientId **- идентификатор клиента. 3801 + 3802 +**planId **- идентификатор тарифного плана. 3803 + 3804 +Ответ: 3805 + 3806 +{ 3807 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3808 + "Plan": { **~/~/ Описание тарифного плана** 3809 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3810 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3811 + "Name": "string", 3812 + "IsArchived": true, 3813 + "Constraint": { 3814 + "CalculationType": 0, 3815 + "PermissibleBalance": 0, 3816 + "DefermentDays": 0 3817 + }, 3818 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3819 + { 3820 + "Feature": "string", 3821 + "IsFactual": true, 3822 + "Limit": 0, 3823 + "Price": 0, 3824 + "PeriodValue": 0, 3825 + "PeriodType": 0 3826 + } 3827 + ] 3828 + }, 3829 + "DebitDate": "2023-10-18T12:46:24.213Z", 3830 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3831 + { 3832 + "Feature": "string", 3833 + "IsEnabled": true, 3834 + "IsPrivate": true, 3835 + "IsFactual": true, 3836 + "Limit": 0, 3837 + "Price": 0, 3838 + "DebitDate": "2023-10-18T12:46:24.213Z", 3839 + "PeriodValue": 0, 3840 + "PeriodType": 0 3841 + } 3842 + ] 3843 +} 3844 + 3845 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3846 +|ClientId|Идентификатор клиента 3847 +|Id|Идентификатор тарифного плана 3848 +|OwnerId|Идентификатор клиента-владельца 3849 +|Name|Наименование тарифного плана 3850 +|IsArchived|Признак, определяющий архивный тарифный план 3851 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3852 +|PermissibleBalance|Допустимый баланс 3853 +|DefermentDays|Отсрочка, количество дней 3854 +|Feature|Код услуги 3855 +|IsEnabled|Признак, определяющий активирована ли услуга 3856 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3857 +|IsFactual|Признак, определяющий расчёт по факту 3858 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3859 +|Price|Цена за единицу. 3860 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3861 +|PeriodValue|Значение периода. 3862 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3863 + 3864 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3865 + 3866 +(% class="box infomessage" %) 3867 +((( 3868 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3869 +))) 3870 + 3871 +Параметр запроса: **clientId **- идентификатор клиента. 3872 + 3873 +Ответ: 3874 + 3875 +[ 3876 + { 3877 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3878 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3879 + "Name": "string", 3880 + "IsArchived": true, 3881 + "Constraint": { 3882 + "CalculationType": 0, 3883 + "PermissibleBalance": 0, 3884 + "DefermentDays": 0 3885 + }, 3886 + "Features": [ 3887 + { 3888 + "Feature": "string", 3889 + "IsFactual": true, 3890 + "Limit": 0, 3891 + "Price": 0, 3892 + "PeriodValue": 0, 3893 + "PeriodType": 0 3894 + } 3895 + ] 3896 + } 3897 +] 3898 + 3899 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3900 +|ClientId|Идентификатор клиента 3901 +|Id|Идентификатор тарифного плана 3902 +|OwnerId|Идентификатор клиента-владельца 3903 +|Name|Наименование тарифного плана 3904 +|IsArchived|Признак, определяющий архивный тарифный план 3905 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3906 +|PermissibleBalance|Допустимый баланс 3907 +|DefermentDays|Отсрочка, количество дней 3908 +|Feature|Код услуги 3909 +|IsFactual|Признак, определяющий расчёт по факту 3910 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3911 +|Price|Цена за единицу. 3912 +|PeriodValue|Значение периода. 3913 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3914 + 3915 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3916 + 3917 +(% class="box infomessage" %) 3918 +((( 3919 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3920 +))) 3921 + 3922 +Параметр запроса: **clientId **- идентификатор клиента. 3923 + 3924 +Ответ: 3925 + 3926 +[ 3927 + { 3928 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3929 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3930 + "Name": "string", 3931 + "IsArchived": true, 3932 + "Constraint": { 3933 + "CalculationType": 0, 3934 + "PermissibleBalance": 0, 3935 + "DefermentDays": 0 3936 + }, 3937 + "Features": [ 3938 + { 3939 + "Feature": "string", 3940 + "IsFactual": true, 3941 + "Limit": 0, 3942 + "Price": 0, 3943 + "PeriodValue": 0, 3944 + "PeriodType": 0 3945 + } 3946 + ] 3947 + } 3948 +] 3949 + 3950 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3951 +|ClientId|Идентификатор клиента 3952 +|Id|Идентификатор тарифного плана 3953 +|OwnerId|Идентификатор клиента-владельца 3954 +|Name|Наименование тарифного плана 3955 +|IsArchived|Признак, определяющий архивный тарифный план 3956 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3957 +|PermissibleBalance|Допустимый баланс 3958 +|DefermentDays|Отсрочка, количество дней 3959 +|Feature|Код услуги 3960 +|IsFactual|Признак, определяющий расчёт по факту 3961 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3962 +|Price|Цена за единицу. 3963 +|PeriodValue|Значение периода. 3964 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3965 + 3966 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 3967 + 3968 +(% class="box warningmessage" %) 3969 +((( 3970 +**PUT /api/v3/Billing/client/balance** 3971 +))) 3972 + 3973 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3974 + 3975 +Тело запроса: 3976 + 3977 +{ 3978 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3979 + "Balance": 0 3980 +} 3981 + 3982 +Ответ: Success 3983 + 3984 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3985 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3986 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3987 + 3988 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3989 + 3990 +(% class="box warningmessage" %) 3991 +((( 3992 +**PUT /api/v3/billing/client/balance/deposit** 3993 +))) 3994 + 3995 +Создает операцию **Пополнение **с указанной суммой 3996 + 3997 +Тело запроса: 3998 + 3999 +{ 4000 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4001 + "Balance": 0 4002 +} 4003 + 4004 +Ответ: Success 4005 + 4006 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4007 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4008 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4009 + 4010 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4011 + 4012 +Создает операцию **Списание **с указанной суммой 4013 + 4014 +(% class="box warningmessage" %) 4015 +((( 4016 +**PUT /api/v3/billing/client/balance/withdraw** 4017 +))) 4018 + 4019 +Тело запроса: 4020 + 4021 +{ 4022 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4023 + "Balance": 0 4024 +} 4025 + 4026 +Ответ: Success 4027 + 4028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4029 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4030 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4031 + 4032 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4033 + 4034 +(% class="box warningmessage" %) 4035 +((( 4036 +**PUT /api/v3/Billing/client/constraint** 4037 +))) 4038 + 4039 +Тело запроса: 4040 + 4041 +{ 4042 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4043 + "CalculationType": 0, 4044 + "PermissibleBalance": 0, 4045 + "DefermentDays": 0, 4046 + "SendUiNotifications": true, 4047 + "SendEmailNotifications": true, 4048 + "IsPrivate": true, 4049 +} 4050 + 4051 +Ответ: Success 4052 + 4053 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4054 +|ClientId|Идентификатор клиента 4055 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4056 +|PermissibleBalance|Допустимый баланс 4057 +|DefermentDays|((( 4058 +Отсрочка, количество дней 4059 +))) 4060 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4061 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4062 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4063 + 4064 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4065 + 4066 +(% class="box warningmessage" %) 4067 +((( 4068 +**PUT /api/v3/Billing/client/plan** 4069 +))) 4070 + 4071 +Тело запроса: 4072 + 4073 +{ 4074 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4075 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4076 + "Features": [ 4077 + { 4078 + "Feature": "string", 4079 + "IsEnabled": true, 4080 + "IsFactual": true, 4081 + "Limit": 0, 4082 + "Price": 0, 4083 + "DebitDate": "2023-10-18T13:26:58.987Z", 4084 + "PeriodValue": 0, 4085 + "PeriodType": 0 4086 + } 4087 + ] 4088 +} 4089 + 4090 +Ответ: Success 4091 + 4092 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4093 +|ClientId|Идентификатор клиента 4094 +|PlanId|Идентификатор тарифного плана 4095 +|Feature|Код услуги 4096 +|IsEnabled|Признак, определяющий активирована ли услуга 4097 +|IsFactual|Признак, определяющий расчёт по факту 4098 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4099 +|Price|Цена за единицу. 4100 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4101 +|PeriodValue|Значение периода. 4102 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4103 + 4104 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4105 + 4106 +(% class="box warningmessage" %) 4107 +((( 4108 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4109 +))) 4110 + 4111 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4112 + 4113 +(% class="box infomessage" %) 4114 +((( 4115 +**POST /api/v3/vehicles/import/{agentId}** 4116 +))) 4117 + 4118 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4119 + 4120 +В пути указывается **agentId** - id клиента. 4121 + 4122 +**Заголовок** 4123 + 4124 +**X-Auth: [токен авторизации]** 4125 + 4126 +**Параметры** 4127 + 4128 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4129 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4130 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4131 + 4132 +В теле использовать тип **form-data,** тип значения** file** 4133 + 4134 +**Ключи** 4135 + 4136 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4137 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4138 +|csv|В значении передаем файл датчиков, формат **csv** 4139 + 4140 +Ответ: 4141 + 4142 +{ 4143 + "vehicleId": 0, 4144 + "name": "string", 4145 + "errors": ["string"] 4146 +} 4147 + 4148 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4149 +|vehicleId|ID созданного объекта 4150 +|name|Имя созданного объекта 4151 +|errors|Ошибки и их описание 4152 + 4153 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4154 + 4155 +(% class="box infomessage" %) 4156 +((( 4157 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4158 +))) 4159 + 4160 +(% class="wikigeneratedid" %) 4161 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4162 + 4163 +(% class="wikigeneratedid" %) 4164 +В пути указывается **vehicleId **- id объекта. 4165 + 4166 +**Заголовок** 4167 + 4168 +**X-Auth: [токен авторизации]** 4169 + 4170 +В теле использовать тип **form-data.** 4171 + 4172 +Ключи: 4173 + 4174 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4175 +|**history**|В значении передавать файл с историей 4176 + 4177 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4178 + 4179 +Ответ: 4180 + 4181 +{ 4182 + "results": [ 4183 + { 4184 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4185 + "vehicleId": 0, 4186 + "errors": [ 4187 + "string" 4188 + ], 4189 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4190 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4191 + "producedCount": 0, 4192 + "msgCount": 0 4193 + } 4194 + ] 4195 +} 4196 + 4197 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4198 +|results|Результаты импорта в разрезе ТС 4199 +|vehicleGuid|Guid ТС 4200 +|vehicleId|ID ТС 4201 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4202 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4203 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4204 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4205 +|msgCount|Кол-во обработанных сообщений всего 4206 + 4207 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4208 + 4209 +(% class="box infomessage" %) 4210 +((( 4211 +**GET /api/v3/vehicles/import/history/status** 4212 +))) 4213 + 4214 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4215 + 4216 +Ответ: 4217 + 4218 +{ 4219 + "activity": true, 4220 + "progress": 0, 4221 + "message": "string" 4222 +} 4223 + 4224 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4225 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4226 +|progress|Guid ТС 4227 + 4228 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4229 + 4230 +(% class="box infomessage" %) 4231 +((( 4232 +**POST /api/v3/vehicles/export** 4233 +))) 4234 + 4235 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4236 + 4237 +Тело запроса: 4238 + 4239 +[ 4240 + id 4241 +] 4242 + 4243 +Ответ: Success 200, получаете файлы с настройками. 4244 + 4245 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4246 + 4247 +(% class="box infomessage" %) 4248 +((( 4249 +**POST /api/v3/vehicles/export/history** 4250 +))) 4251 + 4252 +Метод возвращает список сообщений терминала объекта за выбранный период. 4253 + 4254 +Тело запроса: 4255 + 4256 +{ 4257 + "vehicleId": 0, 4258 + "asArchive": true, 4259 + "from": "2023-09-27T12:17:45.973Z", 4260 + "to": "2023-09-27T12:17:45.973Z" 4261 +} 4262 + 4263 +Ответ: 4264 + 4265 +Получаете файл. Сообщение: Code 200/Success 4266 + 4267 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4268 +|vehicleId|ID объекта 4269 +|asArchive|true - Архивировать файл, False - не архивировать 4270 +|from|Дата и время начала запроса 4271 +|to|Дата и время окончания запроса 4272 + 4273 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4274 + 4275 +(% class="box infomessage" %) 4276 +((( 4277 +**GET /api/v3/vehicles/export/history/status** 4278 +))) 4279 + 4280 +Метод возвращает список сообщений терминала объекта за выбранный период. 4281 + 4282 +Ответ: 4283 + 4284 +{ 4285 + "activity": true, 4286 + "progress": 0, 4287 + "message": "string" 4288 +} 4289 + 4290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4291 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4292 +|progress|Прогресс экспорта, от 0 до 100% 4293 +|message|Текст описывающий статус 4294 + 4295 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4296 + 4297 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4298 + 4299 +(% class="box infomessage" %) 4300 +((( 4301 +**POST /api/v3/EcoDriving/rating** 4302 +))) 4303 + 4304 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4305 + 4306 +Тело запроса: 4307 + 4308 +{ 4309 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4310 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4311 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4312 +} 4313 + 4314 +Ответ: 4315 + 4316 +{ 4317 + "items": [ ~/~/ Список в разрезе ТС 4318 + { 4319 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4320 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4321 + "vehicleId": 0, ~/~/ ID ТС 4322 + "vehicleName": "string", ~/~/ Название ТС 4323 + "vehicleModel": "string", ~/~/ Модель ТС 4324 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4325 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4326 + "totalViolations": 0, ~/~/ Нарушений всего 4327 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4328 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4329 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4330 + "brakingViolations": 0, ~/~/ Нарушений торможения 4331 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4332 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4333 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4334 + }, 4335 + 4336 +((( 4337 + 4338 +))) 4339 + 4340 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4341 + "mileage": 0, ~/~/ Пробег, м 4342 + "tripsCount": 0, ~/~/ Кол-во рейсов 4343 + "trips": [ ~/~/ Информация по рейсу 4344 + { 4345 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4346 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4347 + "violationsCount": 0, ~/~/ Всего нарушений 4348 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4349 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4350 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4351 + "brakingViolations": 0, ~/~/ Нарушений торможения 4352 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4353 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4354 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4355 + }, 4356 + 4357 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4358 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4359 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4360 + "mileage": 0, ~/~/ Пробег, м 4361 + "motohours": 0, ~/~/ Моточасы, секунды 4362 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4363 + "startAddress": "string", ~/~/ Адрес начала рейса 4364 + "endAddress": "string", ~/~/ Адрес конца рейса 4365 + "drivers": [ ~/~/ Список водителей 4366 + { 4367 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4368 + "driverName": "string", ~/~/ФИО водителя 4369 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4370 + } 4371 + ] 4372 + } 4373 + ] 4374 + } 4375 + ] 4376 +} 4377 + 4378 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4379 + 4380 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4381 + 4382 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4383 + 4384 +(% class="box infomessage" %) 4385 +((( 4386 +POST /api/v3/fuelcards/transactions 4387 +))) 4388 + 4389 +Метод запроса: POST 4390 + 4391 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4392 +\\В заголовках запроса: X-Auth: Токен авторизации 4393 + 4394 +Параметры в теле запроса (JSON): 4395 + 4396 +{ 4397 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4398 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4399 + "ids": [ 4400 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4401 + ], 4402 + "timezone": 0 ~/~/Таймзона 4403 +} 4404 + 4405 + 4406 +Ответ: 4407 + { 4408 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4409 + "driver": "string", ~/~/Водители, привязанные к ТК 4410 + "object": "string", ~/~/Наименование ТС 4411 + "amount": 0, ~/~/Количество топлива 4412 + "amountDut": 0, ~/~/Количество по ДУТ 4413 + "amountDiff": 0, ~/~/Разница, л 4414 + "amountDiffPerc": 0, ~/~/Разница, % 4415 + "summa": 0, ~/~/Стоимость, руб 4416 + "serviceName": "string", ~/~/Тип топлива 4417 + "price": 0, ~/~/Цена за литр, руб 4418 + "cardName": "string", ~/~/Наименование ТК 4419 + "cardNum": "string", ~/~/Номер ТК 4420 + "operator": "string", ~/~/Оператор ТК 4421 + "address": "string" ~/~/Адрес АЗС 4422 + } 4423 + 4424 + 4425 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4426 + 4427 + 4428 +== **Получение полных данных о ретрансляторе** == 4429 + 4430 +(% class="box infomessage" %) 4431 +((( 4432 +**GET ** **/api/v3/retranslations/{id}** 4433 +))) 4434 + 4435 +Идентификатор запроса: ID 4436 + 4437 + 4438 +Пример ответа: 4439 + 4440 +{ 4441 +"description": "", ~/~/ Определяет описание 4442 +"subscriberId": "", ~/~/ Подписчик 4443 +"protocolType": 0, ~/~/ Тип протокола 4444 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4445 +"address": "string", ~/~/ Адрес события 4446 +"objects": [ ~/~/Объекты для ретрансляции 4447 +{ 4448 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4449 +"name": "", ~/~/ Наименование объекта ретрансляции 4450 +"imei": "", ~/~/ IMEI объекта 4451 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4452 +} 4453 + ], 4454 +"id": "", ~/~/ идентификатор пользователя 4455 +"parentId": "", ~/~/Guid родителя 4456 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4457 +} 4458 + 4459 + 4460 +== **Удаление данных ретранслятора** == 4461 + 4462 +(% class="box infomessage" %) 4463 +((( 4464 +**DELETE** **/api/v3/retranslations/{id}** 4465 +))) 4466 + 4467 +Параметр запроса: ID 4468 + 4469 + 4470 +== **Создание ретранслятора** == 4471 + 4472 +(% class="box infomessage" %) 4473 +((( 4474 +**POST ** **/api/v3/retranslations/{id}** 4475 +))) 4476 + 4477 +Запрос: 4478 + 4479 +{ 4480 +"description": "", ~/~/ Описание 4481 +"subscriberId": "", ~/~/ Подписчик 4482 +"protocolType": 0, ~/~/ Тип протокола 4483 +"address": "", ~/~/ Адрес ретрансляции 4484 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4485 +"objects": [ ~/~/Объекты для ретрансляции 4486 +{ 4487 +"id": "", ~/~/ идентификатор пользователя 4488 +"imei": "", ~/~/IMEI объекта 4489 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4490 +} 4491 + ] 4492 +} 4493 + 4494 + 4495 +Ответ: 4496 + 4497 +{ 4498 +"description": "string", ~/~/ Определяет описание 4499 +"subscriberId": "", ~/~/ идентификатор запроса 4500 +"protocolType": 0, ~/~/ Тип протокола 4501 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4502 +"address": "", ~/~/ Адрес события 4503 +"objects": [ ~/~/Объекты для ретрансляции 4504 +{ 4505 +"id": "", ~/~/ идентификатор пользователя 4506 +"name": "string", ~/~/ Название уведомления 4507 +"imei": "string", ~/~/IMEI объекта 4508 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4509 +} 4510 + ], 4511 +"id": "", ~/~/ идентификатор пользователя 4512 +"parentId": "", ~/~/ Guid идентификатор родителя 4513 +"deleted": true ~/~/ Признак удаления 4514 +} 4515 + 4516 + 4517 +== **Редактирование ретранслятора** == 4518 + 4519 +(% class="box infomessage" %) 4520 +((( 4521 +**PUT** **/api/v3/retranslations** 4522 +))) 4523 + 4524 +Пример запроса: 4525 + 4526 +{ 4527 +"id": "", ~/~/ идентификатор пользователя 4528 +"description": "string", ~/~/ Определяет описание 4529 +"subscriberId": "", ~/~/ идентификатор запроса 4530 +"protocolType": 0, ~/~/ Тип протокола 4531 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4532 +"address": "string", ~/~/ Адрес события 4533 +"objects": ~/~/Объекты для ретрансляции 4534 +[ 4535 +{ 4536 +"id": "", ~/~/ идентификатор пользователя 4537 +"imei": "", ~/~/IMEI объекта 4538 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4539 +} 4540 + ] 4541 +} 4542 + 4543 + 4544 +Пример ответа: 4545 + 4546 +{ 4547 +"description": "", ~/~/ Определяет описание 4548 +"subscriberId": "", ~/~/ идентификатор запроса 4549 +"protocolType": 0, ~/~/ Тип протокола 4550 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4551 +"address": "string", ~/~/ Адрес события 4552 +"objects": [ ~/~/Объекты для ретрансляции 4553 +{ 4554 +"id": "", ~/~/ идентификатор пользователя 4555 +"name": "string", ~/~/ Название уведомления 4556 +"imei": "", ~/~/IMEI объекта 4557 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4558 +} 4559 + ], 4560 +"id": "", ~/~/ идентификатор пользователя 4561 +"parentId": "", ~/~/ Guid идентификатор родителя 4562 +"deleted": true ~/~/ Признак удаления 4563 +} 4564 + 4565 + 4566 +== **Получение списка ретранслятора клиента** == 4567 + 4568 +(% class="box infomessage" %) 4569 +((( 4570 +**POST /api/v3/retranslations/find** 4571 +))) 4572 + 4573 +Пример запроса: 4574 + 4575 +{ 4576 +"id": "", ~/~/ идентификатор пользователя 4577 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4578 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4579 +} 4580 + 4581 +Ответ: 4582 + 4583 +[ 4584 +{ 4585 +"description": "", ~/~/ Определяет описание 4586 +"subscriberId": "", ~/~/ идентификатор запроса 4587 +"protocolType": 0, ~/~/ Тип протокола 4588 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4589 +"address": "string", ~/~/ Адрес события 4590 +"id": "", ~/~/ идентификатор пользователя 4591 +"parentId": "", ~/~/ Guid идентификатор родителя 4592 +"deleted": true ~/~/ Признак удаления 4593 +} 4594 +] 4595 + 4596 + 4597 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4598 + 4599 +== **API для отчета по выгрузке комбайнов** == 4600 + 4601 +(% class="box infomessage" %) 4602 +((( 4603 +POST **/api/v3/Reports/harvesterUnloading** 4604 +))) 4605 + 4606 +Пример запроса: 4607 + 4608 +{ 4609 + "byTime": 0, ~/~/ Объединение событий по времени 4610 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4611 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4612 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4613 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4614 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4615 + 0 4616 + ], 4617 + "from": "", ~/~/ Дата и время начало запроса 4618 + "to": "", ~/~/ Дата и время окончания запроса 4619 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4620 +} 4621 + 4622 +Пример ответа: 4623 + 4624 +[ 4625 + { 4626 + "harvesterName": "", ~/~/Комбайн, номер 4627 + "harvesterId": 0, ~/~/Комбайн, id 4628 +"harvesterModel": "", ~/~/ Модель комбайна 4629 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4630 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4631 + "events": [ ~/~/Список событий в разрезе комбайна 4632 + { 4633 + "driverId": "", ~/~/Идентификатор водителя 4634 + "driverName": "", ~/~/Водитель комбайна, ФИО 4635 + "RFID": "", ~/~/ идентификатор карты-метки 4636 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4637 + "vehicleId": 0, ~/~/идентификатор объекта 4638 + "vehicleName": "string", ~/~/ Имя объекта 4639 + "modelName": "string", ~/~/ Имя модели объекта 4640 + "nearestVehicles": [ ~/~/Объекты рядом 4641 + { 4642 + "vehicleId": 0, ~/~/идентификатор объекта 4643 + "vehicleName": "string" ~/~/ Имя объекта 4644 + } 4645 + ], 4646 + "fields": [ ~/~/Поля, где происходила выгрузка 4647 + { 4648 + "id": 0, ~/~/ идентификатор пользователя 4649 + "name": "string" ~/~/ имя пользователя 4650 + } 4651 + ], 4652 + "event": "string", ~/~/Событие 4653 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4654 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4655 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4656 + "cultureName": "string", ~/~/ название культуры 4657 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4658 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4659 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4660 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4661 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4662 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4663 + "issued": 0, ~/~/Выдано, бункеров 4664 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4665 + "latitude": 0, ~/~/Широта 4666 + "longitude": 0, ~/~/ Долгота 4667 + "litresAway": 0, ~/~/Отдано, л 4668 + "m3Away": 0 ~/~/Отдано, м3 4669 + } 4670 + ] 4671 + } 4672 +] 4673 + 4674 + 4675 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4676 + 4677 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4678 + 4679 + 4680 +(% class="box infomessage" %) 4681 +((( 4682 +GET api/v3/Vehicles/recyclebin/all 4683 +))) 4684 + 4685 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4686 + 4687 +Параметр запроса: {parentId} - идентификатор агента 4688 + 4689 +В заголовках запроса: X-Auth: Токен авторизации 4690 + 4691 +Ответ: 4692 + 4693 +[ 4694 + { 4695 + "recordTime": "", ~/~/Время записи 4696 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4697 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4698 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4699 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4700 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4701 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4702 + "items": [ ~/~/ 4703 +nullable: true ~/~/Детали 4704 + { 4705 + "name": "string", ~/~/наименование столбца 4706 + "value": "string" ~/~/содержание столбца 4707 + } 4708 + ] 4709 + }, 4710 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4711 + "string" 4712 + ] 4713 + } 4714 +] 4715 + 4716 + 4717 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4718 + 4719 +(% class="box infomessage" %) 4720 +((( 4721 +POST/api/v3/Vehicles/recyclebin/erase 4722 +))) 4723 + 4724 +В заголовках запроса: X-Auth: Токен авторизации 4725 + 4726 +Пример запроса: 4727 + 4728 +[ 4729 +0 4730 +] 4731 + 4732 + 4733 +Пример ответа: 4734 + 4735 +[ 4736 +{ 4737 + "recordTime": "", ~/~/Время записи 4738 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4739 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4740 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4741 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4742 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4743 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4744 + "items": [ ~/~/Детали 4745 + { 4746 + "name": "", ~/~/Имя свойства 4747 + "value": "" ~/~/Значение свойства 4748 + } 4749 + ] 4750 + }, 4751 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4752 + "" 4753 + ] 4754 + } 4755 +] 4756 + 4757 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4758 + 4759 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4760 + 4761 +(% class="box infomessage" %) 4762 +((( 4763 +POST/api/v3/Vehicles/recyclebin/restore 4764 +))) 4765 + 4766 +В заголовках запроса: X-Auth: Токен авторизации 4767 + 4768 +Параметры в теле запроса (JSON): 4769 + 4770 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4771 + 4772 +В заголовках запроса: X-Auth: Токен авторизации 4773 + 4774 + 4775 +Пример запроса: 4776 + 4777 +((( 4778 +[ 4779 +))) 4780 + 4781 +((( 4782 + 0 4783 +))) 4784 + 4785 +((( 4786 +] 4787 +))) 4788 + 4789 + 4790 +Пример ответа: 4791 + 4792 +[ 4793 +{ 4794 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4795 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4796 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4797 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4798 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4799 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4800 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4801 + "items": [ ~/~/Детали 4802 + { 4803 + "name": "string", ~/~/Имя свойства 4804 + "value": "string" ~/~/Значение свойства 4805 + } 4806 + ] 4807 + }, 4808 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4809 + "string" 4810 + ] 4811 + } 4812 +] 4813 + 4814 + 4815 + 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