Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -14,13 +14,22 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!17 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 19 + 20 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 21 + 22 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 23 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 26 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 27 +((( 28 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 29 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 30 +))) 22 22 23 -(% class="box infomessage" %)32 +(% 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**__».43 +(% 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" %) 56 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 57 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 62 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 63 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 64 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 65 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 66 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 67 + 68 +(% class="wikigeneratedid" %) 69 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 70 + 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" ~/~/ Корр. счет110 + "agentId": "", (%%) 111 + "parentId": "", 112 + "parentName": "string", 113 + "name": "string", 114 + "fullName": "string", 115 + "agentInfoType": 0, 116 + "isForeign": true/false, 117 + "district": "string", 118 + "region": "string", 119 + "city": "string", 120 + "inn": "string", 121 + "kpp": "string", 122 + "address": "string", 123 + "addressFact": "string", 124 + "email": "string", 125 + "director": "string", 126 + "bankName": "string", 127 + "bankBIK": "string", 128 + "bankRS": "string", 129 + "bankKS": "string" 118 118 } 119 119 132 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 133 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 134 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 135 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 136 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 137 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 138 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 139 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 140 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 141 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 142 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 143 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 144 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 145 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 146 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 147 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 148 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 149 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 150 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 151 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 152 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 153 + 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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».167 +(% 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 - Отказ) 182 + "agentId": "",(% style="color:#000000" %) (%%) 183 + "parentId": "", 184 + "name": "string", 185 + "fullName": "string", 186 + "agentInfoType": 0, 187 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 190 + 191 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 192 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 193 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 194 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 195 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 196 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 197 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 198 + 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 - 217 + "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 261 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 262 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 263 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 264 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 265 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 266 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 267 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 268 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 269 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 270 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 271 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 272 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 273 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 274 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 275 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 276 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 277 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 278 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 279 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 280 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 281 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 282 + 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 364 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 365 + 366 +(% class="box warningmessage" %) 367 +((( 368 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 369 +))) 370 + 371 +Метод позволяет изменить статус клиента, указанного в запросе. 372 + 373 +В пути указывается GUID клиента и статус клиента. 374 + 375 +**status **- значение 0 - заблокирован, 1 - активен. 376 + 377 +Ответ: Code 204 378 + 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 пользователя 443 +{ 444 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 461 +} 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 - 483 +(% 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 пользователя 579 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 580 + "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" %) 602 + "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": "" , ~/~/ идентификатор пользователя 609 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 610 + "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» названия группы пользователя 631 +} 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 - 652 +(% 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 - 677 + "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, ... ... @@ -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" %)Скорость выгрузки из бункера, л/сек 786 +|(% 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 клиента, которому принадлежит модель объекта ... ... @@ -822,12 +822,24 @@ 822 822 "maxspeed": 0, 823 823 "width": 0, 824 824 "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 826 "hoppercapacity": 0, 827 827 "hopperdischargespeed": 0, 828 828 "modelType": 0 829 829 } 830 830 883 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 884 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 885 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 886 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 887 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 888 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 889 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 890 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 891 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 892 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 893 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 894 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 895 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 831 831 832 832 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 833 ... ... @@ -882,6 +882,20 @@ 882 882 "modelType": 0 883 883 } 884 884 950 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 951 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 952 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 953 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 954 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 955 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 956 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 957 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 958 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 959 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 960 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 961 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 962 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 963 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -901,7 +901,7 @@ 901 901 902 902 Ответ: В случае успеха **Success 200** 903 903 904 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 983 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 905 905 906 906 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 907 907 ... ... @@ -937,19 +937,15 @@ 937 937 "deviceTypeName": "", ~/~/ Название типа устройства 938 938 "sim1": "", ~/~/ Номер SIM1 939 939 "sim2": "", ~/~/ Номер SIM2 940 - 941 941 "parentId": "", ~/~/ ID клиента-родителя 942 942 "parentName": "", ~/~/ Наименование клиента-родителя 943 943 "modelId": "", ~/~/ ID модели объекта 944 944 "modelName": "", ~/~/ Имя модели объекта 945 - 946 946 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 947 947 "unitName": "string", ~/~/ Наименование подразделения 948 948 "status": 0, ~/~/ Статус объекта 949 - 950 950 "createdAt": "", ~/~/ Дата создания объекта 951 951 }, 952 - 953 953 "customFields": [ ~/~/ Произвольные поля 954 954 { 955 955 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -972,8 +972,7 @@ 972 972 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 973 973 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 974 974 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 975 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 - 1050 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 977 977 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 978 978 "mileageCoeff": 0, ~/~/ коэффициент пробега 979 979 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1003,7 +1003,6 @@ 1003 1003 "retries": 0 ~/~/ Количество попыток 1004 1004 } 1005 1005 ], 1006 - 1007 1007 "sensors": [ ~/~/ Датчики 1008 1008 { 1009 1009 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1044,31 +1044,19 @@ 1044 1044 }, 1045 1045 1046 1046 ~/~/ Характерные для произвольного: 1047 - 1048 1048 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 - 1050 1050 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 - 1052 1052 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 - 1054 1054 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 - 1056 1056 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 - 1058 1058 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 - 1060 1060 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 - 1062 1062 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 - 1064 1064 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 - 1066 1066 ~/~/ "ValueOn": "Вкл.", 1067 - 1068 1068 ~/~/ "ValueOff": "Выкл." 1069 1069 "summaryMaxValue": 0 ~/~/ Макс. значение 1070 1070 } 1071 - 1072 1072 "drivers": [ ~/~/ Водители 1073 1073 { 1074 1074 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1077,7 +1077,6 @@ 1077 1077 "isDefault": true ~/~/ По умолчанию 1078 1078 } 1079 1079 ], 1080 - 1081 1081 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1082 1082 { 1083 1083 "id": "", ~/~/ ID задания ... ... @@ -1094,8 +1094,7 @@ 1094 1094 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1095 1095 } 1096 1096 ], 1097 - 1098 - "statusHistory": [ ~/~/ История статусов 1157 +"statusHistory": [ ~/~/ История статусов 1099 1099 { 1100 1100 "status": 0, 1101 1101 "date": "2023-05-22T09:57:39.562Z", ... ... @@ -1103,7 +1103,6 @@ 1103 1103 "additionalInfo": "string" 1104 1104 } 1105 1105 ] 1106 - 1107 1107 } 1108 1108 ))) 1109 1109 ... ... @@ -1113,6 +1113,73 @@ 1113 1113 (% style="text-align:left" %) 1114 1114 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1115 1115 1174 + 1175 +== **Отправить команду на терминал** == 1176 + 1177 +(% class="box successmessage" %) 1178 +((( 1179 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1180 +))) 1181 + 1182 +Команда для отправки на тс. 1183 + 1184 +{ 1185 +"id": "", ~/~/идентификатор произвольного поля 1186 +"command": "", ~/~/ Текст команды 1187 +"retries": "", ~/~/ Количество попыток 1188 +"idTemplate": "" ~/~/ ID шаблона команды 1189 +} 1190 + 1191 + 1192 +== **Получить ответ на отправленную на ТС команду** == 1193 + 1194 +(% class="box infomessage" %) 1195 +((( 1196 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1197 +))) 1198 + 1199 +Идентификатор команды: cmdid 1200 + 1201 +Запрос от терминала на ответ команды 1202 + 1203 +Пример ответ от терминала: 1204 + 1205 +ID= "" ~/~/ идентификатор произвольного поля 1206 +Soft="" ~/~/ версия софта 1207 +GPS=4 ~/~/ тип трекера 1208 +Time=11:05:43 28.06.24 ~/~/ время запроса 1209 +Lat=45.056221 ~/~/ широта 1210 +Lon=39.035938 ~/~/ долгота 1211 +Speed=0.0 ~/~/ скорость 1212 +Course=181.4 ~/~/направление 1213 + 1214 +((( 1215 +== **Список отправленных объекту команд с ответами** == 1216 + 1217 +(% class="box infomessage" %) 1218 +((( 1219 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1220 +))) 1221 + 1222 +Идентификатор ТС: vehicleId 1223 + 1224 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1225 + 1226 +Пример ответа терминала 1227 + 1228 +[ 1229 +{ 1230 +"id": "", ~/~/ идентификатор пользователя 1231 +"commandText": "", ~/~/Текст команды. 1232 +"templateId": "", ~/~/Идентификатор шаблона 1233 +"updated": "", ~/~/ Время отправки 1234 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1235 +"answer": "", ~/~/ Ответ терминала. 1236 +"status": "" ~/~/ Статус отправки 1237 +} 1238 +] 1239 +))) 1240 + 1116 1116 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1117 1117 1118 1118 (% class="box successmessage" %) ... ... @@ -1130,8 +1130,7 @@ 1130 1130 1131 1131 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON 1132 1132 1133 -(% style="color:#000000" %){ 1134 - 1258 +(% style="color:#000000" %){(%%) 1135 1135 "parentId": "" , ~/~/ ID клиента 1136 1136 "name": "" , ~/~/ имя ТС 1137 1137 "imei": "" , ~/~/ IMEI ... ... @@ -1152,7 +1152,6 @@ 1152 1152 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1153 1153 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1154 1154 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 - 1156 1156 "mileageCalcMethod": 0, 1157 1157 "mileageCoeff": 0, 1158 1158 "locationByCellId": true, ... ... @@ -1185,7 +1185,6 @@ 1185 1185 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1186 1186 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1187 1187 } 1188 - 1189 1189 "drivers": [ ~/~/ Водители 1190 1190 { 1191 1191 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1200,8 +1200,7 @@ 1200 1200 "retries": 0 1201 1201 } 1202 1202 ], 1203 - 1204 - "sensors": [ ~/~/ Датчики 1325 +"sensors": [ ~/~/ Датчики 1205 1205 { 1206 1206 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1207 1207 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1239,41 +1239,43 @@ 1239 1239 "additionalProp2": "string", 1240 1240 "additionalProp3": "string" 1241 1241 }, 1242 - 1243 1243 ~/~/ Характерные для произвольного: 1244 - 1245 1245 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 - 1247 1247 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 - 1249 1249 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 - 1251 1251 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 - 1253 1253 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 - 1255 1255 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 - 1257 1257 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 - 1259 1259 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 - 1261 1261 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 - 1263 1263 ~/~/ "ValueOn": "Вкл.", 1264 - 1265 1265 ~/~/ "ValueOff": "Выкл." 1266 - "summaryMaxValue": 0 ~/~/ Макс. значение 1375 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1376 + 1377 +((( 1378 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1379 + { 1380 + "from": 0, ~/~/ С какого значения 1381 + "color": "string", ~/~/ Каким цветом 1382 + "text": "string" ~/~/ Текст подписи к этому интервалу 1383 + } 1384 + ] 1267 1267 } 1268 1268 ], 1387 +))) 1388 + 1389 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1390 + 1391 + 1269 1269 "customFields": [ ~/~/ Произвольные поля 1270 1270 { 1271 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1272 - "name": "string", 1273 - "value": "string", 1274 - "forClient": true, 1275 - "forTooltip": true, 1276 - "forReport": true 1394 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1395 + "name": "string", ~/~/ Наименование произвольного поля 1396 + "value": "string", ~/~/ Значение произвольного поля 1397 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1398 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1399 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1277 1277 } 1278 1278 ] 1279 1279 } ... ... @@ -1280,55 +1280,161 @@ 1280 1280 1281 1281 (% style="color:#000000" %)Ответ: 1282 1282 1283 -(% style="color:#000000" %){ 1284 1284 1285 - "vehicleId": "", ~/~/ID ТС 1286 - "parentId": "", ~/~/Guid владельца ТС 1287 - "name": "", ~/~/Имя объекта 1288 - "imei": "", ~/~/IMEI 1289 - "deviceTypeId": "", ~/~/ID типа устройства 1290 - "modelId": "", ~/~/ID модели 1291 - "unitId": "", ~/~/ID подразделения 1292 - "sim1": "", ~/~/SIM1 1293 - "sim2": "", ~/~/SIM2 1294 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1295 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1296 - "counters": { ~/~/Счётчики 1297 - "mileageEnabled": true, 1298 - "motohoursEnabled": true, 1299 - "mileage": "", 1300 - "motohours": 345.0 1301 - }, 1302 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1303 - "id": null, 1304 - "enabled": true, ~/~/флаг включения 1305 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1306 - "login": "", ~/~/ имя учетной записи 1307 - "password": "" ~/~/ пароль учетной записи 1308 - }, 1309 - "inspectionTasks": { ~/~/ задания на ТО 1310 - "id": "", ~/~/ ID задачи 1311 - "enabled": false, ~/~/ Признак включения 1312 - "name": "", ~/~/ Имя задания 1313 - "description": "", ~/~/ Описание задания 1314 - "mileageCondition": "", ~/~/ Условие по пробегу 1315 - "lastMileage": "", ~/~/ Пробег (в метрах) 1316 - "motohoursCondition": "", ~/~/ Условие по моточасам 1317 - "lastMotohours": "", ~/~/ Моточасы 1318 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1319 - "kind": "", ~/~/ Вид периодичности по времени 1320 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1407 +((( 1408 +((( 1409 +((( 1410 +{ 1411 + "vehicleId": 0, ~/~/ ID ТС 1412 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1413 + "name": "string", ~/~/ Имя объекта 1414 + "imei": "string", ~/~/ IMEI 1415 + "deviceTypeId": 0, ~/~/ ID типа устройства 1416 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1417 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1418 + "sim1": "string", ~/~/ SIM1 1419 + "sim2": "string", ~/~/ SIM2 1420 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1421 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1422 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1423 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1424 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1425 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1426 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1427 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1428 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1429 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1430 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1431 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1432 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1433 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1434 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1435 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1436 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1437 + "counters": { ~/~/ Dto для состояний счётчиков 1438 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1439 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1440 + "mileage": 0, ~/~/ Пробег 1441 + "motohours": 0 ~/~/ Моточасы 1442 + }, 1443 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1444 + "id": "string", ~/~/ CMSV6 Идентификатор 1445 + "enabled": true, ~/~/ Признак включения 1446 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1447 + "login": "string", ~/~/ CMSV6 имя учетной записи 1448 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1449 + }, 1450 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1451 + { 1452 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1453 + "enabled": true, ~/~/ Признак включения 1454 + "name": "string", ~/~/ Имя задания 1455 + "description": "string", ~/~/ Описание задания 1456 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1457 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1458 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1459 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1460 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1461 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1462 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1463 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1321 1321 } 1465 + ], 1466 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1467 + { 1468 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1469 + "inputNumber": 0, ~/~/ № входа. 1470 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1471 + "comment": "string", ~/~/ Комментарий 1472 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1473 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1474 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1475 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1476 + } 1477 + ], 1478 + "commandTemplates": [ ~/~/ Список шаблонов команд 1479 + { 1480 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1481 + "name": "string", ~/~/ Название шаблона команд 1482 + "command": "string", ~/~/ Команда на выполнение 1483 + "retries": 0 ~/~/ Лимит попыток отправки 1484 + } 1485 + ], 1486 + "sensors": [ ~/~/ Список датчиков 1487 + { 1488 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1489 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1490 + "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 1491 + "name": "string", ~/~/ Имя датчика 1492 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1493 + "inputNumber": 0, ~/~/ Номер входа 1494 + "pseudonym": "string", ~/~/ Псевдоним 1495 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1496 + "isInverted": true, ~/~/ Признак инверсии 1497 + "disabled": true, ~/~/ Датчик не участвует в обработке 1498 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1499 + "gradesTables": [ ~/~/ Тарировка 1500 + { 1501 + "grades": [ ~/~/ Таблицы тарировки 1502 + { 1503 + "input": 0, ~/~/ Вход 1504 + "output": 0 ~/~/ Выход 1505 + } 1506 + ], 1507 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1508 + } 1509 + ], 1510 + "showInTooltip": true, ~/~/ Отображение в подсказке 1511 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1512 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1513 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1514 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1515 + "expr": "string", ~/~/ Выражение 1516 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1517 + "string" 1518 + ], 1519 + "customParams": { 1520 + "additionalProp1": "string", 1521 + "additionalProp2": "string", 1522 + "additionalProp3": "string" 1523 + }, 1524 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1525 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1526 + { 1527 + "from": 0, ~/~/ С какого значения 1528 + "color": "string", ~/~/ Каким цветом 1529 +))) 1322 1322 1323 -(% style="text-align:left" %) 1324 -(% style="color:#000000" %)} 1531 +((( 1532 + "text": "string" ~/~/ Текст подписи к этому интервалу 1533 + } 1534 + ] 1535 + } 1536 + ], 1537 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1538 + "customFields": [ ~/~/ Список произвольных полей 1539 + { 1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1541 + "name": "string", ~/~/ Наименование произвольного поля 1542 + "value": "string", ~/~/ Значение произвольного поля 1543 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1544 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1545 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1546 + } 1547 + ], 1548 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 1549 +} 1550 +))) 1551 +))) 1552 +))) 1325 1325 1554 + 1326 1326 **Валидация:** 1327 1327 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1328 1328 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1329 1329 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1330 1330 1331 -== (% style="color:#000000; font-size:16px" %)**Получение па раметровобъектов**(%%) ==1560 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1332 1332 1333 1333 (% class="box infomessage" %) 1334 1334 ((( ... ... @@ -1335,7 +1335,7 @@ 1335 1335 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1336 1336 ))) 1337 1337 1338 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1567 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1339 1339 1340 1340 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1341 1341 ... ... @@ -1379,8 +1379,7 @@ 1379 1379 (% style="color:#000000" %)Ответ: 1380 1380 1381 1381 (% style="color:#000000" %){ 1382 - 1383 -(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1611 + "vehicleId": "" ~/~/ идентификатор объекта 1384 1384 "name": "" ~/~/ наименование объекта 1385 1385 "imei": "" ~/~/ IMEI объекта 1386 1386 "deviceTypeId": "" ~/~/ идентификатор типа устройства ... ... @@ -1439,13 +1439,11 @@ 1439 1439 "data": "", ~/~/ Данные 1440 1440 "overwrite": false, ~/~/ Флаг перезаписи 1441 1441 "stage": "", ~/~/ Состояние, может быть null 1442 - 1443 1443 (% style="color:#000000" %)} 1444 1444 1445 1445 (% style="color:#000000" %)Ответ: 1446 1446 1447 -(% style="color:#000000" %){ 1448 - 1674 +(% style="color:#000000" %){(%%) 1449 1449 "status": "", ~/~/ значение статуса 1450 1450 "date": "", ~/~/ Дата смены статуса 1451 1451 "description": "", ~/~/ Описание ... ... @@ -1452,10 +1452,10 @@ 1452 1452 "data": "", ~/~/ Данные 1453 1453 "overwrite": false, ~/~/ Флаг перезаписи 1454 1454 "stage": "", ~/~/ Состояние 1455 - 1456 -(% style="text-align:left" %) 1457 1457 (% style="color:#000000" %) } 1458 1458 1683 +== == 1684 + 1459 1459 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1460 1460 1461 1461 (% class="box warningmessage" %) ... ... @@ -1543,8 +1543,7 @@ 1543 1543 "retries": 0 1544 1544 } 1545 1545 ], 1546 - 1547 - "sensors": [ ~/~/ Датчики 1772 +"sensors": [ ~/~/ Датчики 1548 1548 { 1549 1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1550 1550 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1582,95 +1582,215 @@ 1582 1582 "additionalProp2": "string", 1583 1583 "additionalProp3": "string" 1584 1584 }, 1585 - 1586 1586 ~/~/ Характерные для произвольного: 1587 - 1588 1588 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 - 1590 1590 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 - 1592 1592 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 - 1594 1594 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 - 1596 1596 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 - 1598 1598 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 - 1600 1600 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 - 1602 1602 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 - 1604 1604 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 - 1606 1606 ~/~/ "ValueOn": "Вкл.", 1607 - 1608 1608 ~/~/ "ValueOff": "Выкл." 1609 1609 "summaryMaxValue": 0 ~/~/ Макс. значение 1823 + 1824 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1825 + { 1826 + "from": 0, ~/~/ С какого значения 1827 + "color": "string", ~/~/ Каким цветом 1828 + "text": "string" ~/~/ Текст подписи к этому интервалу 1829 + } 1830 + ] 1610 1610 } 1611 1611 ], 1833 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1834 + 1612 1612 "customFields": [ ~/~/ Произвольные поля 1613 - { 1614 - 1615 - "name": "string", 1616 - "value": "string", 1617 - "forClient": true, 1618 - "forTooltip": true, 1619 - "forReport": true 1836 + { 1837 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1838 + "name": "string", ~/~/ Наименование произвольного поля 1839 + "value": "string", ~/~/ Значение произвольного поля 1840 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1841 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1842 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1620 1620 } 1621 1621 ] 1622 1622 } 1623 1623 1847 + 1624 1624 (% style="color:#000000" %)Ответ: 1625 1625 1626 -(% lang="en-US" style="text-align:left" %) 1627 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1850 +((( 1851 +{ 1852 + "vehicleId": 0, ~/~/ ID ТС 1853 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1854 + "name": "string", ~/~/ Имя объекта 1855 + "imei": "string", ~/~/ IMEI 1856 + "deviceTypeId": 0, ~/~/ ID типа устройства 1857 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1858 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1859 + "sim1": "string", ~/~/ SIM1 1860 + "sim2": "string", ~/~/ SIM2 1861 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1862 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1863 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1864 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1865 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1866 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1867 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1868 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1869 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1870 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1871 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1872 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1873 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1874 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1875 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1876 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1877 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1878 + "counters": { ~/~/ состояний счётчиков 1879 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1880 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1881 + "mileage": 0, ~/~/ Пробег 1882 + "motohours": 0 ~/~/ Моточасы 1883 + }, 1884 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1885 + "id": "string", ~/~/ CMSV6 Идентификатор 1886 + "enabled": true, ~/~/ Признак включения 1887 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1888 +))) 1628 1628 1629 -(% lang="en-US" style="text-align:left" %) 1630 - "vehicleId": "", ~/~/ ID ТС 1631 - "parentId": "", ~/~/ ID клиента 1632 - "name": "", ~/~/ имя ТС 1633 - "imei": "", ~/~/ IMEI 1634 - "deviceTypeId": "", ~/~/ типа устройства 1635 - "modelId": "", ~/~/ ID модели 1636 - "unitId": "", ~/~/ ID подразделения 1637 - "sim1": "", ~/~/ SIM 1 1638 - "sim2": "", ~/~/ SIM2 1639 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1640 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1641 - "counters": 1642 - { 1643 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1644 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1645 - "mileage": "", ~/~/ пробег 1646 - "motohours": "", ~/~/ моточасы 1647 - } 1648 - "cmsv6Parameters": ~/~/ параметры CMSv6 1890 + 1891 +((( 1892 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1893 + "login": "string", ~/~/ CMSV6 имя учетной записи 1894 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1895 + }, 1896 + "inspectionTasks": [ ~/~/ Задания на ТО 1897 + { 1898 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1899 + "enabled": true, ~/~/ Признак включения 1900 + "name": "string", ~/~/ Имя задания 1901 + "description": "string", ~/~/ Описание задания 1902 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1903 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1904 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1905 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1906 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1907 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 1908 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 1909 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1910 + } 1911 + ], 1912 + "drivers": [ ~/~/ Список водителей 1913 + { 1914 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1915 + "inputNumber": 0, ~/~/ № входа. 1916 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 1917 + "comment": "string", ~/~/ Комментарий. 1918 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1919 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1920 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 1921 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 1922 + } 1923 + ], 1924 + "commandTemplates": [ ~/~/ Список шаблонов команд 1925 + { 1926 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1927 + "name": "string", ~/~/ Название шаблона команд 1928 + "command": "string", ~/~/ Команда на выполнение 1929 + "retries": 0 ~/~/ Лимит попыток отправки 1930 + } 1931 + ], 1932 + "sensors": [ ~/~/ Список датчиков 1933 + { 1934 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1935 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1936 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 1937 +))) 1938 + 1939 +((( 1940 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 1941 +))) 1942 + 1943 +((( 1944 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 1945 +))) 1946 + 1947 +((( 1948 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 1949 +))) 1950 + 1951 +((( 1952 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 1953 +))) 1954 + 1955 +((( 1956 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1957 + "name": "string", ~/~/ Имя датчика 1958 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 1959 +))) 1960 + 1961 +((( 1962 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1963 + "inputNumber": 0, ~/~/ Номер входа 1964 + "pseudonym": "string", ~/~/ Псевдоним 1965 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1966 + "isInverted": true, ~/~/ Признак инверсии 1967 + "disabled": true, ~/~/ Датчик не участвует в обработке 1968 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1969 + "gradesTables": [ ~/~/ Тарировка 1649 1649 { 1650 - "id": ~/~/ идентификатор 1651 - "enabled": true, ~/~/ флаг включения 1652 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1653 - "login": "", ~/~/ имя учетной записи 1654 - "password": "", ~/~/ пароль учетной записи 1655 - } 1656 - "inspectionTasks": ~/~/ задания на ТО 1971 + "grades": [ ~/~/ Таблицы тарировки 1972 + { 1973 + "input": 0, ~/~/ Вход 1974 + "output": 0 ~/~/ Выход 1975 + } 1976 + ], 1977 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1978 + } 1979 + ], 1980 + "showInTooltip": true, ~/~/ Отображение в подсказке 1981 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1982 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1983 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1984 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1985 + "expr": "string", ~/~/ Выражение 1986 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1987 + "string" 1988 + ], 1989 + "customParams": { ~/~/ Дополнительные настройки 1990 + "additionalProp1": "string", 1991 + "additionalProp2": "string", 1992 + "additionalProp3": "string" 1993 + }, 1994 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1995 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1657 1657 { 1658 - "id": "", ~/~/ ID задания 1659 - "enabled": false, ~/~/ Признак включения 1660 - "name": "", ~/~/ Имя задания 1661 - "description": "", ~/~/ Описание задания 1662 - "mileageCondition": "", ~/~/ Условие по пробегу 1663 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1664 - "motohoursCondition": "", ~/~/ Условие по моточасам 1665 - "lastMotohours": "", ~/~/ Моточасы 1666 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1667 - "kind": "", ~/~/ Вид периодичности по времени 1668 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1997 + "from": 0, ~/~/ С какого значения 1998 + "color": "string", ~/~/ Каким цветом 1999 + "text": "string" ~/~/ Текст подписи к этому интервалу 1669 1669 } 2001 + ] 2002 + } 2003 + ], 2004 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2005 + "customFields": [ ~/~/ Список произвольных полей 2006 + { 2007 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2008 + "name": "string", ~/~/ Наименование произвольного поля 2009 + "value": "string", ~/~/ Значение произвольного поля 2010 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2011 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2012 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2013 + } 2014 + ], 2015 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2016 +} 2017 +))) 1670 1670 1671 -(% lang="en-US" style="text-align:left" %) 1672 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 1673 - 1674 1674 **Валидация:** 1675 1675 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1676 1676 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1709,18 +1709,15 @@ 1709 1709 1710 1710 (% style="color:#000000" %)Метод запроса: **GET** 1711 1711 1712 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2057 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1713 1713 1714 1714 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1715 1715 1716 1716 (% style="color:#000000" %)Ответ: 1717 1717 1718 -(% style="color:#000000" %){ 1719 - 2063 +(% style="color:#000000" %){(%%) 1720 1720 "deviceTypeId" : "", ~/~/ ID типа устройства 1721 1721 "deviceTypeName" : "" ~/~/ Название типа устройства 1722 - 1723 -(% style="text-align:left" %) 1724 1724 (% style="color:#000000" %)} 1725 1725 1726 1726 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1742,13 +1742,10 @@ 1742 1742 1743 1743 (% style="color:#000000" %)Ответ: 1744 1744 1745 -(% style="color:#000000" %){ 1746 - 2087 +(% style="color:#000000" %){(%%) 1747 1747 "id": "", ~/~/ ID типа датчика 1748 1748 "name": "", ~/~/ Название 1749 1749 "description": "", ~/~/ Описание 1750 - 1751 -(% style="text-align:left" %) 1752 1752 (% style="color:#000000" %)} 1753 1753 1754 1754 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1792,6 +1792,56 @@ 1792 1792 } 1793 1793 ] 1794 1794 2134 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2135 + 2136 +(% class="box infomessage" style="text-align: left;" %) 2137 +((( 2138 +**POST /api/v3/terminalMessages/mapping** 2139 +))) 2140 + 2141 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2142 + 2143 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2144 + 2145 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2146 + 2147 +{ 2148 + "protocolType": 0, 2149 + "params": ["string"] 2150 +} 2151 + 2152 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2153 +|protocolType|ID типа протокола 2154 +|params|((( 2155 +Массив наименований параметров в сообщении 2156 +))) 2157 + 2158 +Ответ: 2159 + 2160 +{ 2161 + "protocolType": 0, 2162 + "mapping": { 2163 + "additionalProp1": { 2164 + "inputType": 0, 2165 + "inputNumber": 0 2166 + }, 2167 + "additionalProp2": { 2168 + "inputType": 0, 2169 + "inputNumber": 0 2170 + } 2171 + } 2172 +} 2173 + 2174 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2175 +|protocolType|Тип протокола 2176 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2177 +|inputNumber|((( 2178 +Номер входа 2179 +))) 2180 + 2181 +(% class="wikigeneratedid" %) 2182 +Перечень 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/]] 2183 + 1795 1795 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 1796 1797 1797 (% class="box infomessage" %) ... ... @@ -1816,6 +1816,11 @@ 1816 1816 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 1817 } 1818 1818 2208 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2209 +|vehicleId|ID объекта 2210 +|from|Дата и время начала периода запроса 2211 +|to|Дата и время окончания периода запроса 2212 + 1819 1819 Ответ: 1820 1820 1821 1821 [ ... ... @@ -1822,80 +1822,43 @@ 1822 1822 { 1823 1823 "messages": [ 1824 1824 { 1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 - "speed": 0, ~/~/ Скорость, км/ч 1828 - "altitude": 0, ~/~/ Высота, м 1829 - "latitude": 0, ~/~/ Широта [-90°;90°] 1830 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 - "satellites": 0, ~/~/ Кол-во спутников 1832 - "voltage": 0, ~/~/ Напряжение 1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2219 + "deviceTime": "2023-11-29T07:40:44.052Z", 2220 + "serverTime": "2023-11-29T07:40:44.052Z", 2221 + "speed": 0, 2222 + "altitude": 0, 2223 + "latitude": 0, 2224 + "longitude": 0, 2225 + "satellites": 0, 2226 + "course": 0, 2227 + "voltage": 0, 2228 + "parameters": { 1834 1834 "additionalProp1": "string", 1835 1835 "additionalProp2": "string", 1836 1836 "additionalProp3": "string" 1837 1837 }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 2233 + "photoCount": 0, 2234 + "lbsCorrectedCoords": true, 2235 + "protocolType": 0 1839 1839 } 1840 1840 ] 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2241 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2242 +|deviceTime|Время сообщения терминала 2243 +|serverTime|Время когда сообщение поступило на сервер 2244 +|speed|Скорость 2245 +|altitude|Высота над уровнем моря 2246 +|latitude|Широта 2247 +|longitude|Долгота 2248 +|satellites|Кол-во спутников 2249 +|course|Курс 2250 +|voltage|Бортовое напряжение 2251 +|parameters|Список параметров и их значений 2252 +|photoCount|Количество фото 2253 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2254 +|protocolType|ID типа протокола 1845 1845 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 1899 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 1900 1901 1901 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1932,10 +1932,12 @@ 1932 1932 { 1933 1933 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1934 1934 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1935 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1936 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1937 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1938 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2292 + "mileage": 0, ~/~/ Пробег за период, километры 2293 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2294 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2295 + "motohours": 0, ~/~/ Моточасы за период, секунды 2296 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2297 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1939 1939 } 1940 1940 ] 1941 1941 } ... ... @@ -1984,6 +1984,12 @@ 1984 1984 } 1985 1985 ] 1986 1986 2346 +(% class="box warningmessage" %) 2347 +((( 2348 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2349 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2350 +))) 2351 + 1987 1987 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1988 1988 1989 1989 (% class="box infomessage" %) ... ... @@ -2029,6 +2029,96 @@ 2029 2029 } 2030 2030 ] 2031 2031 2397 + 2398 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2399 + 2400 +(% class="box infomessage" %) 2401 +((( 2402 +**POST /api/v3/vehicles/moveStop** 2403 +))) 2404 + 2405 +Метод запроса: **POST** 2406 + 2407 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2408 + 2409 +В заголовках запроса: X-Auth: Токен авторизации 2410 + 2411 + 2412 +Тело запроса: 2413 + 2414 +{ 2415 + "vehicleIds": [ ], ~/~/ Список ID объектов 2416 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2417 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2418 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2419 +} 2420 + 2421 +Ответ: 2422 + 2423 +[ 2424 + { 2425 + "vehicleId": 0, ~/~/ ID объекта 2426 + "vehicleName": "string", ~/~/ Имя объекта 2427 + "moves": [ ~/~/ Событие движения 2428 + { 2429 + "mileage": 0, ~/~/ Пробег, км 2430 + "eventId": 0, ~/~/ Идентификатор события 2431 + "eventName": "string", ~/~/ Название события 2432 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2433 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2434 + "duration": 0 ~/~/ Продолжительность события, секунд 2435 + } 2436 + ], 2437 + "stops": [ ~/~/ События стоянок 2438 + { 2439 + "address": "string", ~/~/ Адрес события 2440 + "eventId": 0, ~/~/ Идентификатор события 2441 + "eventName": "string", ~/~/ Название события 2442 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2443 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2444 + "duration": 0 ~/~/ Продолжительность события, секунд 2445 + } 2446 + ] 2447 + } 2448 +] 2449 + 2450 + 2451 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2452 + 2453 +(% class="box infomessage" %) 2454 +((( 2455 +**POST /api/v3/vehicles/getlastdata** 2456 +))) 2457 + 2458 +Метод запроса: **POST** 2459 + 2460 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2461 + 2462 +В заголовках запроса: X-Auth: Токен авторизации 2463 + 2464 + 2465 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2466 + 2467 +Ответ: 2468 + { 2469 + "vehicleId": 0, ~/~/Идентификатор объекта. 2470 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2471 + "vehicleNumber": "string",~/~/Номер объекта. 2472 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2473 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2474 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2475 + "speed": 0,~/~/Скорость объекта. 2476 + "course": 0,~/~/Курс движения [0;360] 2477 + "latitude": 0,~/~/Широта [-90°;90°]. 2478 + "longitude": 0,~/~/Долгота [-180°;180°]. 2479 + "address": "string",~/~/Адрес. 2480 + "geozones": [ ~/~/Сведения по геозонам. 2481 + { 2482 + "id": 0, 2483 + "name": "string" 2484 + } 2485 + 2486 + 2032 2032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 2033 2034 2034 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2336,6 +2336,32 @@ 2336 2336 2337 2337 Success 2338 2338 2794 + 2795 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2796 + 2797 +(% class="box warningmessage" %) 2798 +((( 2799 +**PUT** /api/v3/notifications/prolongation 2800 +))) 2801 + 2802 +Метод позволяет продлить уведомления. 2803 + 2804 +Метод запроса **PUT** 2805 + 2806 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2807 + 2808 +В заголовках запроса: X-Auth: Токен авторизации. 2809 + 2810 +Тело запроса: 2811 + 2812 +[ 2813 + 2814 +0 2815 + 2816 +] 2817 + 2818 +где 0 идентификатор ids. 2819 + 2339 2339 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2340 2340 2341 2341 (% class="box errormessage" %) ... ... @@ -2927,6 +2927,83 @@ 2927 2927 Success 2928 2928 2929 2929 3411 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3412 + 3413 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3414 + 3415 +(% class="box infomessage" %) 3416 +((( 3417 +**POST /api/v3/Trailers** 3418 +))) 3419 + 3420 +Пример запроса: 3421 + 3422 +{ 3423 + "startDate": "2023-11-14T10:48:03.671Z", 3424 + "endDate": "2023-11-14T10:48:03.671Z", 3425 + "ids": [ 0 ], 3426 + "timezone": 0 3427 +} 3428 + 3429 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3430 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3431 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3432 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3433 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3434 + 3435 +Пример ответа: 3436 + 3437 +[ 3438 + { 3439 + "SD": "2023-11-14T10:48:03.717Z", 3440 + "ED": "2023-11-14T10:48:03.717Z", 3441 + "id": 0, 3442 + "SLat": 0, 3443 + "SLon": 0, 3444 + "ELat": 0, 3445 + "ELon": 0, 3446 + "mileage": 0 3447 + "Duration": 0 3448 + "Address": "string", 3449 + "Address2": "string", 3450 + "name": "string", 3451 + "rid": "string", 3452 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3453 + "trailer": { 3454 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3455 + "Number": "string", 3456 + "Description": "string", 3457 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3458 + "ExternalID": "string", 3459 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3460 + "CreateTime": "2023-11-14T10:48:03.717Z", 3461 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3462 + "IsDeleted": true 3463 + }, 3464 + "filesCount": 0, 3465 + } 3466 +] 3467 + 3468 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3469 +|SD|Дата и время начала события 3470 +|ED|Дата и время окончания события 3471 +|id|ID объекта 3472 +|SLat|Широта начальной координаты 3473 +|SLon|Долгота начальной координаты 3474 +|ELat|Широта конечной координаты 3475 +|ELon|Долгота конечной координаты 3476 +|mileage|Пробег 3477 +|Duration|Продолжительность 3478 +|Address|Адрес начального местоположения 3479 +|Address2|Адрес конечного местоположения 3480 +|name|Имя радиометки 3481 +|rid|Номер радиометки 3482 +|rguid|ID радиометки 3483 +|trailer|Информация об агрегате 3484 +|ModelGuid|ID агрегата 3485 +|Number|Название/номер агрегата 3486 +|Description|Текст примечания агрегата 3487 + 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2948,13 +2948,19 @@ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки3509 + "period": 0, 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "deleted": true 2955 2955 } 2956 2956 ] 2957 2957 3515 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3516 +|parentId|ID клиента 3517 +|name|Название карты-метки 3518 +|number|Номер 3519 +|period|Период запросов в секундах (работает только для агрегатов) 3520 +|id|ID карты-метки 3521 + 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 2960 (% class="box infomessage" %) ... ... @@ -2970,13 +2970,18 @@ 2970 2970 { 2971 2971 "name": "string", 2972 2972 "number": 0, 2973 - "period": 0, ~/~/ Частота трансляции радиометки3537 + "period": 0, 2974 2974 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 2975 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 - "deleted": true 2977 2977 } 2978 2978 ] 2979 2979 3543 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3544 +|name|Название карты-метки 3545 +|number|Номер 3546 +|period|Период запросов в секундах (работает только для агрегатов) 3547 +|id|ID карты-метки 3548 +|parentId|ID клиента 2980 2980 2981 2981 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2982 2982 ... ... @@ -2992,7 +2992,6 @@ 2992 2992 "number": 0, 2993 2993 "period": 0, 2994 2994 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 - "deleted": true 2996 2996 } 2997 2997 2998 2998 Ответ: ... ... @@ -3003,9 +3003,15 @@ 3003 3003 "period": 0, 3004 3004 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3005 3005 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 - "deleted": true 3007 3007 } 3008 3008 3576 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3577 +|name|Название карты-метки 3578 +|number|Номер 3579 +|period|Период запросов в секундах (работает только для агрегатов) 3580 +|id|ID карты-метки 3581 +|parentId|ID клиента 3582 + 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 3011 (% class="box warningmessage" %) ... ... @@ -3021,7 +3021,6 @@ 3021 3021 "period": 0, 3022 3022 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 3023 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 - "deleted": true 3025 3025 } 3026 3026 3027 3027 Ответ: ... ... @@ -3032,9 +3032,15 @@ 3032 3032 "period": 0, 3033 3033 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 3034 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 - "deleted": true 3036 3036 } 3037 3037 3610 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3611 +|name|Название карты-метки 3612 +|number|Номер 3613 +|period|Период запросов в секундах (работает только для агрегатов) 3614 +|id|ID карты-метки 3615 +|parentId|ID клиента 3616 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 3040 (% class="box errormessage" %) ... ... @@ -3042,7 +3042,7 @@ 3042 3042 **DELETE /api/v3/Rfids/{rfidGuid}** 3043 3043 ))) 3044 3044 3045 -Передаем параметр rfidGuid - идентификатор карты-метки 3624 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3046 3046 3047 3047 Ответ: 3048 3048 ... ... @@ -3283,6 +3283,8 @@ 3283 3283 **PUT /api/v3/Billing/client/balance** 3284 3284 ))) 3285 3285 3865 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 3866 + 3286 3286 Тело запроса: 3287 3287 3288 3288 { ... ... @@ -3296,6 +3296,50 @@ 3296 3296 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3297 3297 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3298 3298 3880 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 3881 + 3882 +(% class="box warningmessage" %) 3883 +((( 3884 +**PUT /api/v3/billing/client/balance/deposit** 3885 +))) 3886 + 3887 +Создает операцию **Пополнение **с указанной суммой 3888 + 3889 +Тело запроса: 3890 + 3891 +{ 3892 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3893 + "Balance": 0 3894 +} 3895 + 3896 +Ответ: Success 3897 + 3898 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3899 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3900 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3901 + 3902 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 3903 + 3904 +Создает операцию **Списание **с указанной суммой 3905 + 3906 +(% class="box warningmessage" %) 3907 +((( 3908 +**PUT /api/v3/billing/client/balance/withdraw** 3909 +))) 3910 + 3911 +Тело запроса: 3912 + 3913 +{ 3914 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3915 + "Balance": 0 3916 +} 3917 + 3918 +Ответ: Success 3919 + 3920 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3921 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3922 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3923 + 3299 3299 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 3300 3301 3301 (% class="box warningmessage" %) ... ... @@ -3368,6 +3368,743 @@ 3368 3368 |PeriodValue|Значение периода. 3369 3369 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3370 3370 3996 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3997 + 3998 +(% class="box warningmessage" %) 3999 +((( 4000 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4001 +))) 4002 + 4003 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4004 + 4005 +(% class="box infomessage" %) 4006 +((( 4007 +**POST /api/v3/vehicles/import/{agentId}** 4008 +))) 4009 + 4010 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4011 + 4012 +В пути указывается **agentId** - id клиента. 4013 + 4014 +**Заголовок** 4015 + 4016 +**X-Auth: [токен авторизации]** 4017 + 4018 +**Параметры** 4019 + 4020 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4021 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4022 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4023 + 4024 +В теле использовать тип **form-data,** тип значения** file** 4025 + 4026 +**Ключи** 4027 + 4028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4029 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4030 +|csv|В значении передаем файл датчиков, формат **csv** 4031 + 4032 +Ответ: 4033 + 4034 +{ 4035 + "vehicleId": 0, 4036 + "name": "string", 4037 + "errors": ["string"] 4038 +} 4039 + 4040 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4041 +|vehicleId|ID созданного объекта 4042 +|name|Имя созданного объекта 4043 +|errors|Ошибки и их описание 4044 + 4045 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4046 + 4047 +(% class="box infomessage" %) 4048 +((( 4049 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4050 +))) 4051 + 4052 +(% class="wikigeneratedid" %) 4053 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4054 + 4055 +(% class="wikigeneratedid" %) 4056 +В пути указывается **vehicleId **- id объекта. 4057 + 4058 +**Заголовок** 4059 + 4060 +**X-Auth: [токен авторизации]** 4061 + 4062 +В теле использовать тип **form-data.** 4063 + 4064 +Ключи: 4065 + 4066 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4067 +|**history**|В значении передавать файл с историей 4068 + 4069 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4070 + 4071 +Ответ: 4072 + 4073 +{ 4074 + "results": [ 4075 + { 4076 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4077 + "vehicleId": 0, 4078 + "errors": [ 4079 + "string" 4080 + ], 4081 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4082 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4083 + "producedCount": 0, 4084 + "msgCount": 0 4085 + } 4086 + ] 4087 +} 4088 + 4089 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4090 +|results|Результаты импорта в разрезе ТС 4091 +|vehicleGuid|Guid ТС 4092 +|vehicleId|ID ТС 4093 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4094 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4095 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4096 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4097 +|msgCount|Кол-во обработанных сообщений всего 4098 + 4099 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4100 + 4101 +(% class="box infomessage" %) 4102 +((( 4103 +**GET /api/v3/vehicles/import/history/status** 4104 +))) 4105 + 4106 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4107 + 4108 +Ответ: 4109 + 4110 +{ 4111 + "activity": true, 4112 + "progress": 0, 4113 + "message": "string" 4114 +} 4115 + 4116 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4117 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4118 +|progress|Guid ТС 4119 + 4120 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4121 + 4122 +(% class="box infomessage" %) 4123 +((( 4124 +**POST /api/v3/vehicles/export** 4125 +))) 4126 + 4127 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4128 + 4129 +Тело запроса: 4130 + 4131 +[ 4132 + id 4133 +] 4134 + 4135 +Ответ: Success 200, получаете файлы с настройками. 4136 + 4137 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4138 + 4139 +(% class="box infomessage" %) 4140 +((( 4141 +**POST /api/v3/vehicles/export/history** 4142 +))) 4143 + 4144 +Метод возвращает список сообщений терминала объекта за выбранный период. 4145 + 4146 +Тело запроса: 4147 + 4148 +{ 4149 + "vehicleId": 0, 4150 + "asArchive": true, 4151 + "from": "2023-09-27T12:17:45.973Z", 4152 + "to": "2023-09-27T12:17:45.973Z" 4153 +} 4154 + 4155 +Ответ: 4156 + 4157 +Получаете файл. Сообщение: Code 200/Success 4158 + 4159 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4160 +|vehicleId|ID объекта 4161 +|asArchive|true - Архивировать файл, False - не архивировать 4162 +|from|Дата и время начала запроса 4163 +|to|Дата и время окончания запроса 4164 + 4165 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4166 + 4167 +(% class="box infomessage" %) 4168 +((( 4169 +**GET /api/v3/vehicles/export/history/status** 4170 +))) 4171 + 4172 +Метод возвращает список сообщений терминала объекта за выбранный период. 4173 + 4174 +Ответ: 4175 + 4176 +{ 4177 + "activity": true, 4178 + "progress": 0, 4179 + "message": "string" 4180 +} 4181 + 4182 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4183 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4184 +|progress|Прогресс экспорта, от 0 до 100% 4185 +|message|Текст описывающий статус 4186 + 4187 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4188 + 4189 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4190 + 4191 +(% class="box infomessage" %) 4192 +((( 4193 +**POST /api/v3/EcoDriving/rating** 4194 +))) 4195 + 4196 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4197 + 4198 +Тело запроса: 4199 + 4200 +{ 4201 + "vehicleIds": [vehicleId], 4202 + "from": "2023-11-22T09:29:48.051Z", 4203 + "to": "2023-11-22T09:29:48.051Z" 4204 +} 4205 + 4206 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4207 +|vehicleIds|Массив ID объектов 4208 +|from|Дата начала запроса 4209 +|to|Дата окончания запроса 4210 + 4211 +Ответ: 4212 + 4213 +{ 4214 + "items": [ 4215 + { 4216 + "from": "2023-11-22T09:29:48.052Z", 4217 + "to": "2023-11-22T09:29:48.052Z", 4218 + "vehicleId": 0, 4219 + "vehicleName": "string", 4220 + "vehicleModel": "string", 4221 + "penalty": 0, 4222 + "score": 0, 4223 + "totalViolations": 0, 4224 + "violationsByType": { 4225 + "overspeedingViolations": 0, 4226 + "accelerationViolations": 0, 4227 + "brakingViolations": 0, 4228 + "turningViolations": 0, 4229 + "dangerousDrivingViolations": 0, 4230 + "sensorViolations": 0 4231 + }, 4232 + "moveTime": 0, 4233 + "mileage": 0, 4234 + "tripsCount": 0, 4235 + "trips": [ 4236 + { 4237 + "penalty": 0, 4238 + "score": 0, 4239 + "violationsCount": 0, 4240 + "violationsByType": { 4241 + "overspeedingViolations": 0, 4242 + "accelerationViolations": 0, 4243 + "brakingViolations": 0, 4244 + "turningViolations": 0, 4245 + "dangerousDrivingViolations": 0, 4246 + "sensorViolations": 0 4247 + }, 4248 + "moveTime": 0, 4249 + "mileage": 0, 4250 + "motohours": 0, 4251 + "maxSpeed": 0, 4252 + "startAddress": "string", 4253 + "endAddress": "string", 4254 + "drivers": [ 4255 + { 4256 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4257 + "driverName": "string", 4258 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 4259 + } 4260 + ] 4261 + } 4262 + ] 4263 + } 4264 + ] 4265 +} 4266 + 4267 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4268 +|from|Дата начала запроса 4269 +|to|Дата окончания 4270 +|vehicleId|ID объекта 4271 +|vehicleName|Имя объекта 4272 +|vehicleModel|Модель объекта 4273 +|penalty|Сумма штрафных баллов 4274 +|score|Оценка 4275 +|totalViolations|Суммарное количество нарушений 4276 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 4277 +|overspeedingViolations|Превышение скорости 4278 +|accelerationViolations|Ускорение 4279 +|brakingViolations|Торможение 4280 +|turningViolations|Резкий поворот 4281 +|dangerousDrivingViolations|Резкое вождение 4282 +|sensorViolations|Нарушение по датчику 4283 +|moveTime|Время в движении 4284 +|mileage|Пробег (км) 4285 +|tripsCount|Количество рейсов 4286 +|motohours|Моточасы 4287 +|maxSpeed|Максимальная скорость 4288 +|startAddress|Адрес начала рейса 4289 +|endAddress|Адрес окончания рейса 4290 +|drivers|Список водителей, которые были на объекте в течениии рейса 4291 +|driverGuid|Guid водителя 4292 +|driverName|Имя водителя 4293 +|driverRfid|Номер Карты-метки 4294 + 4295 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4296 + 4297 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4298 + 4299 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4300 + 4301 +(% class="box infomessage" %) 4302 +((( 4303 +POST /api/v3/fuelcards/transactions 4304 +))) 4305 + 4306 +Метод запроса: POST 4307 + 4308 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4309 +\\В заголовках запроса: X-Auth: Токен авторизации 4310 + 4311 +Параметры в теле запроса (JSON): 4312 + 4313 +{ 4314 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода 4315 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода 4316 + "ids": [ 4317 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт 4318 + ], 4319 + "timezone": 0 ~/~/Таймзона 4320 +} 4321 + 4322 + 4323 +Ответ: 4324 + { 4325 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции 4326 + "driver": "string", ~/~/Водители, привязанные к ТК 4327 + "object": "string", ~/~/Наименование ТС 4328 + "amount": 0, ~/~/Количество топлива 4329 + "amountDut": 0, ~/~/Количество по ДУТ 4330 + "amountDiff": 0, ~/~/Разница, л 4331 + "amountDiffPerc": 0, ~/~/Разница, % 4332 + "summa": 0, ~/~/Стоимость, руб 4333 + "serviceName": "string", ~/~/Тип топлива 4334 + "price": 0, ~/~/Цена за литр, руб 4335 + "cardName": "string", ~/~/Наименование ТК 4336 + "cardNum": "string", ~/~/Номер ТК 4337 + "operator": "string", ~/~/Оператор ТК 4338 + "address": "string" ~/~/Адрес АЗС 4339 + } 4340 + 4341 + 4342 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4343 + 4344 + 4345 +== **Получение полных данных о ретрансляторе** == 4346 + 4347 +(% class="box infomessage" %) 4348 +((( 4349 +**GET ** **/api/v3/retranslations/{id}** 4350 +))) 4351 + 4352 +Идентификатор запроса: ID 4353 + 4354 + 4355 +Пример ответа: 4356 + 4357 +{ 4358 +"description": "", ~/~/ Определяет описание 4359 +"subscriberId": "", ~/~/ Подписчик 4360 +"protocolType": 0, ~/~/ Тип протокола 4361 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4362 +"address": "string", ~/~/ Адрес события 4363 +"objects": [ ~/~/Объекты для ретрансляции 4364 +{ 4365 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4366 +"name": "", ~/~/ Наименование объекта ретрансляции 4367 +"imei": "", ~/~/ IMEI объекта 4368 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4369 +} 4370 + ], 4371 +"id": "", ~/~/ идентификатор пользователя 4372 +"parentId": "", ~/~/Guid родителя 4373 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен 4374 +} 4375 + 4376 + 4377 +== **Удаление данных ретранслятора** == 4378 + 4379 +(% class="box infomessage" %) 4380 +((( 4381 +**DELETE** **/api/v3/retranslations/{id}** 4382 +))) 4383 + 4384 +Параметр запроса: ID 4385 + 4386 + 4387 +== **Создание ретранслятора** == 4388 + 4389 +(% class="box infomessage" %) 4390 +((( 4391 +**POST ** **/api/v3/retranslations/{id}** 4392 +))) 4393 + 4394 +Запрос: 4395 + 4396 +{ 4397 +"description": "", ~/~/ Описание 4398 +"subscriberId": "", ~/~/ Подписчик 4399 +"protocolType": 0, ~/~/ Тип протокола 4400 +"address": "", ~/~/ Адрес ретрансляции 4401 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4402 +"objects": [ ~/~/Объекты для ретрансляции 4403 +{ 4404 +"id": "", ~/~/ идентификатор пользователя 4405 +"imei": "", ~/~/IMEI объекта 4406 +"isEnabled": "" ~/~/ признак включения, Включен, true - включен, false - отключен 4407 +} 4408 + ] 4409 +} 4410 + 4411 + 4412 +Ответ: 4413 + 4414 +{ 4415 +"description": "string", ~/~/ Определяет описание 4416 +"subscriberId": "", ~/~/ идентификатор запроса 4417 +"protocolType": 0, ~/~/ Тип протокола 4418 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен 4419 +"address": "", ~/~/ Адрес события 4420 +"objects": [ ~/~/Объекты для ретрансляции 4421 +{ 4422 +"id": "", ~/~/ идентификатор пользователя 4423 +"name": "string", ~/~/ Название уведомления 4424 +"imei": "string", ~/~/IMEI объекта 4425 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4426 +} 4427 + ], 4428 +"id": "", ~/~/ идентификатор пользователя 4429 +"parentId": "", ~/~/ Guid идентификатор родителя 4430 +"deleted": true ~/~/ Признак удаления 4431 +} 4432 + 4433 + 4434 +== **Редактирование ретранслятора** == 4435 + 4436 +(% class="box infomessage" %) 4437 +((( 4438 +**PUT** **/api/v3/retranslations** 4439 +))) 4440 + 4441 +Пример запроса: 4442 + 4443 +{ 4444 +"id": "", ~/~/ идентификатор пользователя 4445 +"description": "string", ~/~/ Определяет описание 4446 +"subscriberId": "", ~/~/ идентификатор запроса 4447 +"protocolType": 0, ~/~/ Тип протокола 4448 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4449 +"address": "string", ~/~/ Адрес события 4450 +"objects": ~/~/Объекты для ретрансляции 4451 +[ 4452 +{ 4453 +"id": "", ~/~/ идентификатор пользователя 4454 +"imei": "", ~/~/IMEI объекта 4455 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4456 +} 4457 + ] 4458 +} 4459 + 4460 + 4461 +Пример ответа: 4462 + 4463 +{ 4464 +"description": "", ~/~/ Определяет описание 4465 +"subscriberId": "", ~/~/ идентификатор запроса 4466 +"protocolType": 0, ~/~/ Тип протокола 4467 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4468 +"address": "string", ~/~/ Адрес события 4469 +"objects": [ ~/~/Объекты для ретрансляции 4470 +{ 4471 +"id": "", ~/~/ идентификатор пользователя 4472 +"name": "string", ~/~/ Название уведомления 4473 +"imei": "", ~/~/IMEI объекта 4474 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен 4475 +} 4476 + ], 4477 +"id": "", ~/~/ идентификатор пользователя 4478 +"parentId": "", ~/~/ Guid идентификатор родителя 4479 +"deleted": true ~/~/ Признак удаления 4480 +} 4481 + 4482 + 4483 +== **Получение списка ретранслятора клиента** == 4484 + 4485 +(% class="box infomessage" %) 4486 +((( 4487 +**POST /api/v3/retranslations/find** 4488 +))) 4489 + 4490 +Пример запроса: 4491 + 4492 +{ 4493 +"id": "", ~/~/ идентификатор пользователя 4494 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4495 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные. 4496 +} 4497 + 4498 +Ответ: 4499 + 4500 +[ 4501 +{ 4502 +"description": "", ~/~/ Определяет описание 4503 +"subscriberId": "", ~/~/ идентификатор запроса 4504 +"protocolType": 0, ~/~/ Тип протокола 4505 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен 4506 +"address": "string", ~/~/ Адрес события 4507 +"id": "", ~/~/ идентификатор пользователя 4508 +"parentId": "", ~/~/ Guid идентификатор родителя 4509 +"deleted": true ~/~/ Признак удаления 4510 +} 4511 +] 4512 + 4513 + 4514 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4515 + 4516 +== **API для отчета по выгрузке комбайнов** == 4517 + 4518 +(% class="box infomessage" %) 4519 +((( 4520 +POST **/api/v3/Reports/harvesterUnloading** 4521 +))) 4522 + 4523 +Пример запроса: 4524 + 4525 +{ 4526 + "byTime": 0, ~/~/ Объединение событий по времени 4527 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4528 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4529 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4530 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4531 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4532 + 0 4533 + ], 4534 + "from": "", ~/~/ Дата и время начало запроса 4535 + "to": "", ~/~/ Дата и время окончания запроса 4536 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4537 +} 4538 + 4539 +Пример ответа: 4540 + 4541 +[ 4542 + { 4543 + "harvesterName": "", ~/~/Комбайн, номер 4544 + "harvesterId": 0, ~/~/Комбайн, id 4545 +"harvesterModel": "", ~/~/ Модель комбайна 4546 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4547 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4548 + "events": [ ~/~/Список событий в разрезе комбайна 4549 + { 4550 + "driverId": "", ~/~/Идентификатор водителя 4551 + "driverName": "", ~/~/Водитель комбайна, ФИО 4552 + "RFID": "", ~/~/ идентификатор карты-метки 4553 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4554 + "vehicleId": 0, ~/~/идентификатор объекта 4555 + "vehicleName": "string", ~/~/ Имя объекта 4556 + "modelName": "string", ~/~/ Имя модели объекта 4557 + "nearestVehicles": [ ~/~/Объекты рядом 4558 + { 4559 + "vehicleId": 0, ~/~/идентификатор объекта 4560 + "vehicleName": "string" ~/~/ Имя объекта 4561 + } 4562 + ], 4563 + "fields": [ ~/~/Поля, где происходила выгрузка 4564 + { 4565 + "id": 0, ~/~/ идентификатор пользователя 4566 + "name": "string" ~/~/ имя пользователя 4567 + } 4568 + ], 4569 + "event": "string", ~/~/Событие 4570 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4571 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4572 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4573 + "cultureName": "string", ~/~/ название культуры 4574 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4575 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4576 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4577 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4578 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4579 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4580 + "issued": 0, ~/~/Выдано, бункеров 4581 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4582 + "latitude": 0, ~/~/Широта 4583 + "longitude": 0, ~/~/ Долгота 4584 + "litresAway": 0, ~/~/Отдано, л 4585 + "m3Away": 0 ~/~/Отдано, м3 4586 + } 4587 + ] 4588 + } 4589 +] 4590 + 4591 + 4592 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 4593 + 4594 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 4595 + 4596 + 4597 +(% class="box infomessage" %) 4598 +((( 4599 +GET api/v3/Vehicles/recyclebin/all 4600 +))) 4601 + 4602 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 4603 + 4604 +Параметр запроса: {parentId} - идентификатор агента 4605 + 4606 +В заголовках запроса: X-Auth: Токен авторизации 4607 + 4608 +Ответ: 4609 + 4610 +[ 4611 + { 4612 + "recordTime": "", ~/~/Время записи 4613 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4614 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4615 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4616 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4617 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4618 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4619 + "items": [ ~/~/ 4620 +nullable: true ~/~/Детали 4621 + { 4622 + "name": "string", ~/~/наименование столбца 4623 + "value": "string" ~/~/содержание столбца 4624 + } 4625 + ] 4626 + }, 4627 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4628 + "string" 4629 + ] 4630 + } 4631 +] 4632 + 4633 + 4634 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 4635 + 4636 +(% class="box infomessage" %) 4637 +((( 4638 +POST/api/v3/Vehicles/recyclebin/erase 4639 +))) 4640 + 4641 +В заголовках запроса: X-Auth: Токен авторизации 4642 + 4643 +Пример запроса: 4644 + 4645 +[ 4646 +0 4647 +] 4648 + 4649 + 4650 +Пример ответа: 4651 + 4652 +[ 4653 +{ 4654 + "recordTime": "", ~/~/Время записи 4655 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 4656 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 4657 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 4658 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 4659 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4660 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4661 + "items": [ ~/~/Детали 4662 + { 4663 + "name": "", ~/~/Имя свойства 4664 + "value": "" ~/~/Значение свойства 4665 + } 4666 + ] 4667 + }, 4668 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4669 + "" 4670 + ] 4671 + } 4672 +] 4673 + 4674 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 4675 + 4676 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 4677 + 4678 +(% class="box infomessage" %) 4679 +((( 4680 +POST/api/v3/Vehicles/recyclebin/restore 4681 +))) 4682 + 4683 +В заголовках запроса: X-Auth: Токен авторизации 4684 + 4685 +Параметры в теле запроса (JSON): 4686 + 4687 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 4688 + 4689 +В заголовках запроса: X-Auth: Токен авторизации 4690 + 4691 + 4692 +Пример запроса: 4693 + 4694 +((( 4695 +[ 4696 +))) 4697 + 4698 +((( 4699 + 0 4700 +))) 4701 + 4702 +((( 4703 +] 4704 +))) 4705 + 4706 + 4707 +Пример ответа: 4708 + 4709 +[ 4710 +{ 4711 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 4712 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 4713 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 4714 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 4715 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 4716 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 4717 + "details": { ~/~/Список деталей объекта, помещённого в корзину 4718 + "items": [ ~/~/Детали 4719 + { 4720 + "name": "string", ~/~/Имя свойства 4721 + "value": "string" ~/~/Значение свойства 4722 + } 4723 + ] 4724 + }, 4725 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 4726 + "string" 4727 + ] 4728 + } 4729 +] 4730 + 4731 + 4732 + 3371 3371 (% class="box" lang="en-US" style="text-align: center;" %) 3372 3372 ((( 3373 3373 (% 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]] **