Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/09/16 11:13
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,5 +1,22 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 8 + 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 11 + 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 + 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 19 + 3 3 **Содержание страницы:** 4 4 ))) 5 5 ... ... @@ -14,13 +14,22 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!34 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 36 + 37 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 38 + 39 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 40 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 43 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 44 +((( 45 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 46 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 47 +))) 22 22 23 -(% class="box infomessage" %)49 +(% 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**__».60 +(% 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" %) 73 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 74 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 79 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 80 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 81 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 82 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 83 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 84 + 85 +(% class="wikigeneratedid" %) 86 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 87 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,63 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 126 + 127 +((( 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" ~/~/ Корр. счет 118 - } 129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента 130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя 131 + "parentName": "string", ~/~/ Наименование агента 132 + "name": "string", ~/~/ Имя клиента 133 + "fullName": "string", ~/~/ ФИО клиента 134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%)) 135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент" 136 + "district": "string", ~/~/ Район 137 + "region": "string", ~/~/ Область 138 + "city": "string", ~/~/ Город 139 + "email": "string", ~/~/ Email 140 + "director": "string", ~/~/ Руководитель 141 + "RegionalData": [ ~/~/ Определяет региональные сведения. 142 + { 143 + "Country": 0, ~/~/ Страна 144 + "groups": [ ~/~/ Список групп 145 + { 146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 147 + "fields": [ ~/~/ Список значений полей 148 + { 149 + "name": "string", ~/~/ Имя поля формы 150 + "value": "string" ~/~/ Значение поля формы 151 + } 152 + ] 153 + } 154 + ] 155 + } 156 + ] 157 +} 158 +))) 119 119 160 + 161 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 162 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 163 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 164 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 165 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 166 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 167 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 168 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 169 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 170 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 171 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 172 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 173 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 174 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 175 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 176 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 177 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 178 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 179 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 180 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 181 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 182 + 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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».196 +(% 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 - Отказ) 211 + "agentId": "",(% style="color:#000000" %) (%%) 212 + "parentId": "", 213 + "name": "string", 214 + "fullName": "string", 215 + "agentInfoType": 0, 216 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 219 + 220 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 221 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 222 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 223 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 224 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 225 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 226 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 227 + 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 - 246 + "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 { ... ... @@ -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 371 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 372 + 373 +(% class="box warningmessage" %) 374 +((( 375 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 376 +))) 377 + 378 +Метод позволяет изменить статус клиента, указанного в запросе. 379 + 380 +В пути указывается GUID клиента и статус клиента. 381 + 382 +**status **- значение 0 - заблокирован, 1 - активен. 383 + 384 +Ответ: Code 204 385 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -349,9 +349,8 @@ 349 349 [ 350 350 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 351 351 ], 352 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский435 + "language": 1 ~/~/ Язык интерфейса пользователя 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 пользователя 450 +{ 451 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 468 +} 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 - 490 +(% 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": "" , ~/~/ имя ... ... @@ -436,8 +436,7 @@ 436 436 "email": "" , ~/~/ E-mail 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 - "astLogged": "", ~/~/ дата/время последней авторизации 440 - 512 + "lastLogged": "", ~/~/ дата/время последней авторизации 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 пользователя 586 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 587 + "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" %) 609 + "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": "" , ~/~/ идентификатор пользователя 616 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 617 + "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» названия группы пользователя 638 +} 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 - 659 +(% 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 - 684 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -682,8 +682,256 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 747 +(% class="wikigeneratedid" id="H" %) 748 +((( 749 + 750 +))) 686 686 752 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 753 + 754 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 755 + 756 +(% class="box infomessage" %) 757 +((( 758 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 759 +))) 760 + 761 +Метод возвращает полную информацию о модели объекта. 762 + 763 +(% style="color:#000000" %)Метод запроса: **GET** 764 + 765 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 766 + 767 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 768 + 769 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 770 + 771 +(% style="color:#000000" %)Ответ: 772 + 773 +(% style="color:#000000" %){ 774 + "parentName": "string", 775 + "name": "string", 776 + "picture": "string", 777 + "minspeed": 0, 778 + "maxspeed": 0, 779 + "width": 0, 780 + "imbeddedtrailer": true, 781 + "hoppercapacity": 0, 782 + "hopperdischargespeed": 0, 783 + "modelType": 0, 784 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 785 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 786 + "deleted": true 787 +} 788 + 789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 790 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 791 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 792 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 793 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 794 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 795 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 796 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 797 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 798 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 799 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 800 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 801 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 802 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 803 + 804 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 805 + 806 +(% class="box successmessage" %) 807 +((( 808 +(% lang="en-US" %)**POST /api/v3/models/find** 809 +))) 810 + 811 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 812 + 813 +(% style="color:#000000" %)Метод запроса: **POST** 814 + 815 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 816 + 817 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 818 + 819 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 820 + 821 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 822 +} 823 + 824 +(% style="color:#000000" %)Ответ: 825 + 826 +(% style="color:#000000" %)[ 827 + { 828 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 829 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 830 + "parentName": "string", 831 + "name": "string", 832 + "modelType": 0 833 + } 834 +] 835 + 836 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 837 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 838 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 839 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 840 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 841 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 842 + 843 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 844 + 845 +(% class="box successmessage" %) 846 +((( 847 +(% lang="en-US" %)**POST /api/v3/models** 848 +))) 849 + 850 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 851 + 852 +(% style="color:#000000" %)Метод запроса: **POST** 853 + 854 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 855 + 856 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 857 + 858 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 859 + 860 +{ 861 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 862 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 863 + "deleted": false, 864 + "extId": "string", 865 + "name": "string", 866 + "picture": "string", 867 + "minspeed": 0, 868 + "maxspeed": 0, 869 + "width": 0, 870 + "imbeddedtrailer": true, 871 + "fueloutlay": 0, 872 + "hoppercapacity": 0, 873 + "hopperdischargespeed": 0, 874 + "modelType": 0 875 +} 876 + 877 +Ответ: 878 + 879 +{ 880 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 881 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 882 + "deleted": false, 883 + "extId": "string", 884 + "name": "string", 885 + "picture": "string", 886 + "minspeed": 0, 887 + "maxspeed": 0, 888 + "width": 0, 889 + "imbeddedtrailer": true, 890 + "hoppercapacity": 0, 891 + "hopperdischargespeed": 0, 892 + "modelType": 0 893 +} 894 + 895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 896 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 897 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 898 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 899 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 900 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 901 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 902 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 903 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 904 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 905 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 906 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 907 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 908 + 909 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 910 + 911 +(% class="box warningmessage" %) 912 +((( 913 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 914 +))) 915 + 916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 917 + 918 +(% style="color:#000000" %)Метод запроса: **PUT** 919 + 920 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 921 + 922 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 923 + 924 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 925 + 926 +{ 927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 928 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 929 + "deleted": true, 930 + "extId": "string", 931 + "name": "string", 932 + "picture": "string", 933 + "minspeed": 0, 934 + "maxspeed": 0, 935 + "width": 0, 936 + "imbeddedtrailer": true, 937 + "fueloutlay": 0, 938 + "hoppercapacity": 0, 939 + "hopperdischargespeed": 0, 940 + "modelType": 0 941 +} 942 + 943 +Ответ: 944 + 945 +{ 946 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 947 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 948 + "deleted": true, 949 + "extId": "string", 950 + "name": "string", 951 + "picture": "string", 952 + "minspeed": 0, 953 + "maxspeed": 0, 954 + "width": 0, 955 + "imbeddedtrailer": true, 956 + "fueloutlay": 0, 957 + "hoppercapacity": 0, 958 + "hopperdischargespeed": 0, 959 + "modelType": 0 960 +} 961 + 962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 963 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 964 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 965 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 966 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 967 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 968 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 969 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 970 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 971 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 972 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 973 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 974 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 975 + 976 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 977 + 978 +(% class="box errormessage" %) 979 +((( 980 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 981 +))) 982 + 983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 984 + 985 +(% style="color:#000000" %)Метод запроса: **DELETE** 986 + 987 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 988 + 989 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 990 + 991 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 992 + 993 +Ответ: В случае успеха **Success 200** 994 + 995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 996 + 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 688 688 689 689 (% class="box infomessage" %) ... ... @@ -701,9 +701,9 @@ 701 701 702 702 (% style="color:#000000" %)Метод запроса: **GET** 703 703 704 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %) <(% lang="en-US" %)v(%%)ehicleID>1014 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID} 705 705 706 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__>- идентификатор объекта (опционально)1016 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 707 707 708 708 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 709 709 ... ... @@ -711,6 +711,17 @@ 711 711 712 712 ((( 713 713 { 1024 + 1025 +((( 1026 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1027 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1028 +))) 1029 + 1030 +((( 1031 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1032 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1033 +))) 1034 + 714 714 "vehicleId": "", ~/~/ ID объекта 715 715 "name": "", ~/~/ Имя объекта 716 716 "imei": "", ~/~/ IMEI объекта ... ... @@ -717,20 +717,130 @@ 717 717 "deviceTypeId": , ~/~/ ID типа устройства 718 718 "deviceTypeName": "", ~/~/ Название типа устройства 719 719 "sim1": "", ~/~/ Номер SIM1 720 - "parentId": "", Номер SIM2 721 - "parentName": "", Наименование клиента-родителя 722 - "modelId": "", ID модели объекта 723 - "modelName": "", Имя модели объекта 724 - "createdAt": "", Дата создания объекта 725 - "mileageCalcMethod": "", Выбранный метод расчета пробега 726 - "counters": { ~/~/ Нормы 727 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 728 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 729 - "mileage": "", ~/~/ Пробег по нормам в метрах 730 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 731 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 732 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 1041 + "sim2": "", ~/~/ Номер SIM2 1042 + "parentId": "", ~/~/ ID клиента-родителя 1043 + "parentName": "", ~/~/ Наименование клиента-родителя 1044 + "modelId": "", ~/~/ ID модели объекта 1045 + "modelName": "", ~/~/ Имя модели объекта 1046 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1047 + "unitName": "string", ~/~/ Наименование подразделения 1048 + "status": 0, ~/~/ Статус объекта 1049 + "createdAt": "", ~/~/ Дата создания объекта 733 733 }, 1051 +"customFields": [ ~/~/ Произвольные поля 1052 + { 1053 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1054 + "name": "string", ~/~/ Имя поля 1055 + "value": "string", ~/~/ Значение поля 1056 + "forClient": true, ~/~/ Не используемая функция 1057 + "forTooltip": true, ~/~/ Отображать в подсказке 1058 + "forReport": true ~/~/ Отображать в отчете 1059 + } 1060 + 1061 +], ~/~/ Данные с вкладки нормы 1062 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1063 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1064 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1065 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1066 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1067 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1068 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1069 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1070 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1071 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1072 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1073 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1074 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1075 + "mileageCoeff": 0, ~/~/ коэффициент пробега 1076 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1077 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1078 + "counters": { ~/~/ Счетчики 1079 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1080 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1081 + "mileage": 0, ~/~/ Текущий пробег 1082 + "motohours": 0, ~/~/ Текущие моточасы 1083 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1084 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 1085 + }, 1086 + 1087 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1088 + "id": "string", ~/~/ ID объекта 1089 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 1090 + "host": "string", ~/~/ CMSV6 Web Host 1091 + "login": "string", ~/~/ CMSV6 Account 1092 + "password": "string" ~/~/ CMSV6 Password 1093 + }, 1094 + 1095 +"commandTemplates": [ ~/~/ Шаблоны команд 1096 + { 1097 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1098 + "name": "string", ~/~/ Наименование команды 1099 + "command": "string", ~/~/ Текст команды 1100 + "retries": 0 ~/~/ Количество попыток 1101 + } 1102 + ], 1103 + "sensors": [ ~/~/ Датчики 1104 + { 1105 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1106 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1107 + "type": 0, ~/~/ Тип датчика 1108 + "name": "string", ~/~/ Имя датчика 1109 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1110 + "inputNumber": 0, ~/~/ Номер входа 1111 + "pseudonym": "string", ~/~/ Псевдоним 1112 + "medianDegree": 0, ~/~/ Медианная фильтрация 1113 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1114 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1115 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1116 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1117 + { 1118 + "grades": [ ~/~/ Таблица тарировки 1 1119 + { 1120 + "input": 0, ~/~/ Входящее значение 1121 + "output": 0 ~/~/ Выходящее значение 1122 + } 1123 + ], 1124 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1125 + } 1126 + ], 1127 + "showInTooltip": true, ~/~/ Отображать в подсказке 1128 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1129 + "color": "string", ~/~/ Код цвета датчиков 1130 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1131 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1132 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1133 + "expr": "string", ~/~/ Формула 1134 + "children": [ ~/~/ массив дочерних датчиков 1135 + "string" 1136 + ], 1137 + "customParams": { ~/~/ прочие произвольные параметры 1138 + "additionalProp1": "string", 1139 + "additionalProp2": "string", 1140 + "additionalProp3": "string" 1141 + }, 1142 + 1143 +~/~/ Характерные для произвольного: 1144 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1145 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1146 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1147 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1148 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1149 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1150 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1151 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1152 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1153 +~/~/ "ValueOn": "Вкл.", 1154 +~/~/ "ValueOff": "Выкл." 1155 + "summaryMaxValue": 0 ~/~/ Макс. значение 1156 + } 1157 + "drivers": [ ~/~/ Водители 1158 + { 1159 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1160 + "name": "string", ~/~/ Наименование 1161 + "description": "string", 1162 + "isDefault": true ~/~/ По умолчанию 1163 + } 1164 + ], 734 734 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 735 735 { 736 736 "id": "", ~/~/ ID задания ... ... @@ -746,10 +746,28 @@ 746 746 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 747 747 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 748 748 } 749 - ] 1180 + ], 1181 +"statusHistory": [ ~/~/ История статусов 1182 + { 1183 + "status": 0, 1184 + "date": "2023-05-22T09:57:39.562Z", 1185 + "description": "string", 1186 + "additionalInfo": "string" 1187 + 1188 +((( 750 750 } 1190 + ], 1191 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1192 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 751 751 ))) 752 752 1195 +((( 1196 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1197 +} 1198 + 1199 +))) 1200 +))) 1201 + 753 753 (% style="text-align:left" %) 754 754 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 755 755 ... ... @@ -756,6 +756,75 @@ 756 756 (% style="text-align:left" %) 757 757 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 758 758 1208 + 1209 +== **Отправить команду на терминал** == 1210 + 1211 +(% class="box successmessage" %) 1212 +((( 1213 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1214 +))) 1215 + 1216 +Команда для отправки на тс. 1217 + 1218 +{ 1219 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1220 +"command": "", ~/~/ Текст отправляемой команды 1221 +"retries": "", ~/~/ Количество попыток отправки на терминал 1222 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1223 +} 1224 + 1225 +В ответ получаем cmdid 1226 + 1227 + 1228 +== **Получить ответ на отправленную на ТС команду** == 1229 + 1230 +(% class="box infomessage" %) 1231 +((( 1232 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1233 +))) 1234 + 1235 +Идентификатор команды: cmdId 1236 + 1237 +Запрос от терминала на ответ команды 1238 + 1239 +Пример ответ от терминала: 1240 + 1241 +ID= "" ~/~/ идентификатор объекта 1242 +Soft="" ~/~/ версия софта 1243 +GPS=4 ~/~/ тип трекера 1244 +Time=11:05:43 28.06.24 ~/~/ время запроса 1245 +Lat=45.056221 ~/~/ широта 1246 +Lon=39.035938 ~/~/ долгота 1247 +Speed=0.0 ~/~/ скорость 1248 +Course=181.4 ~/~/направление 1249 + 1250 +((( 1251 +== **Список отправленных объекту команд с ответами** == 1252 + 1253 +(% class="box infomessage" %) 1254 +((( 1255 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1256 +))) 1257 + 1258 +Идентификатор ТС: vehicleId 1259 + 1260 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1261 + 1262 +Пример ответа терминала 1263 + 1264 +[ 1265 +{ 1266 +"id": "", ~/~/ идентификатор пользователя 1267 +"commandText": "", ~/~/Текст команды. 1268 +"templateId": "", ~/~/Идентификатор шаблона 1269 +"updated": "", ~/~/ Время отправки 1270 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1271 +"answer": "", ~/~/ Ответ терминала. 1272 +"status": "" ~/~/ Статус отправки 1273 +} 1274 +] 1275 +))) 1276 + 759 759 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 760 760 761 761 (% class="box successmessage" %) ... ... @@ -763,7 +763,7 @@ 763 763 (% lang="en-US" %)**POST /api/v3/vehicles** 764 764 ))) 765 765 766 -(% style="color:#000000" %)Метод позволяет добавить объект . Метод позволяет добавить объект, указанный в запросе.1284 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 767 767 768 768 (% style="color:#000000" %)Метод запроса: **POST** 769 769 ... ... @@ -775,6 +775,11 @@ 775 775 776 776 (% style="color:#000000" %){ 777 777 1296 + 1297 +((( 1298 + "vehicleId": 0, ~/~/ ID ТС 1299 +))) 1300 + 778 778 "parentId": "" , ~/~/ ID клиента 779 779 "name": "" , ~/~/ имя ТС 780 780 "imei": "" , ~/~/ IMEI ... ... @@ -795,6 +795,10 @@ 795 795 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 796 796 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 797 797 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1321 + "mileageCalcMethod": 0, 1322 + "mileageCoeff": 0, 1323 + "locationByCellId": true, 1324 + "dottedLineTrackWhenNoCoords": true, 798 798 "counters": ~/~/ счетчики 799 799 { 800 800 "mileage": "" , ~/~/ пробег ... ... @@ -823,67 +823,275 @@ 823 823 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 824 824 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 825 825 } 1353 +"drivers": [ ~/~/ Водители 1354 + { 1355 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1356 + "isDefault": true 1357 + } 1358 + ], 1359 + "commandTemplates": [ ~/~/ Шаблон команды 1360 + { 1361 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1362 + "name": "string", 1363 + "command": "string", 1364 + "retries": 0 1365 + } 1366 + ], 1367 +"sensors": [ ~/~/ Датчики 1368 + { 1369 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1370 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1371 + "type": 0, ~/~/ Тип датчика 1372 + "name": "string", ~/~/ Имя датчика 1373 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1374 + "inputNumber": 0, ~/~/ Номер входа 1375 + "pseudonym": "string", ~/~/ Псевдоним 1376 + "medianDegree": 0, ~/~/ Медианная фильтрация 1377 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1378 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1379 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1380 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1381 + { 1382 + "grades": [ ~/~/ Таблица тарировки 1 1383 + { 1384 + "input": 0, ~/~/ Входящее значение 1385 + "output": 0 ~/~/ Выходящее значение 1386 + } 1387 + ], 1388 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1389 + } 1390 + ], 1391 + "showInTooltip": true, ~/~/ Отображать в подсказке 1392 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1393 + "color": "string", ~/~/ код цвета датчиков 1394 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1395 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1396 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1397 + "expr": "string", ~/~/ Формула 1398 + "children": [ ~/~/ массив дочерних датчиков 1399 + "string" 1400 + ], 1401 + "customParams": { ~/~/ прочие произвольные параметры 1402 + "additionalProp1": "string", 1403 + "additionalProp2": "string", 1404 + "additionalProp3": "string" 1405 + }, 1406 +~/~/ Характерные для произвольного: 1407 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1408 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1409 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1410 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1411 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1412 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1413 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1414 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1415 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1416 +~/~/ "ValueOn": "Вкл.", 1417 +~/~/ "ValueOff": "Выкл." 1418 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 826 826 827 -(% style="color:#000000" %) } 1420 +((( 1421 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1422 + { 1423 + "from": 0, ~/~/ С какого значения 1424 + "color": "string", ~/~/ Каким цветом 1425 + "text": "string" ~/~/ Текст подписи к этому интервалу 1426 + } 1427 + ] 1428 + } 1429 + ], 1430 +))) 828 828 1432 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1433 + 1434 + 1435 + "customFields": [ ~/~/ Произвольные поля 1436 + { 1437 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1438 + "name": "string", ~/~/ Наименование произвольного поля 1439 + "value": "string", ~/~/ Значение произвольного поля 1440 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1441 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1442 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1443 + 1444 +((( 1445 + } 1446 + ], 1447 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1448 +))) 1449 + 1450 +((( 1451 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1452 +} 1453 +))) 1454 + 1455 + 829 829 (% style="color:#000000" %)Ответ: 830 830 831 -(% style="color:#000000" %){ 832 832 833 - "vehicleId": "", ~/~/ID ТС 834 - "parentId": "", ~/~/Guid владельца ТС 835 - "name": "", ~/~/Имя объекта 836 - "imei": "", ~/~/IMEI 837 - "deviceTypeId": "", ~/~/ID типа устройства 838 - "modelId": "", ~/~/ID модели 839 - "unitId": "", ~/~/ID подразделения 840 - "sim1": "", ~/~/SIM1 841 - "sim2": "", ~/~/SIM2 842 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 843 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 844 - "counters": { ~/~/Счётчики 845 - "mileageEnabled": true, 846 - "motohoursEnabled": true, 847 - "mileage": "", 848 - "motohours": 345.0 849 - }, 850 - "cmsv6Parameters": { ~/~/Параметры CmsV6 851 - "id": null, 852 - "enabled": true, ~/~/флаг включения 853 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 854 - "login": "", ~/~/ имя учетной записи 855 - "password": "" ~/~/ пароль учетной записи 856 - }, 857 - "inspectionTasks": { ~/~/ задания на ТО 858 - "id": "", ~/~/ ID задачи 859 - "enabled": false, ~/~/ Признак включения 860 - "name": "", ~/~/ Имя задания 861 - "description": "", ~/~/ Описание задания 862 - "mileageCondition": "", ~/~/ Условие по пробегу 863 - "lastMileage": "", ~/~/ Пробег (в метрах) 864 - "motohoursCondition": "", ~/~/ Условие по моточасам 865 - "lastMotohours": "", ~/~/ Моточасы 866 - "periodicCondition": "", ~/~/ Условие периодичности по времени 867 - "kind": "", ~/~/ Вид периодичности по времени 868 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1459 +((( 1460 +((( 1461 +((( 1462 +{ 1463 + "vehicleId": 0, ~/~/ ID ТС 1464 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1465 + "name": "string", ~/~/ Имя объекта 1466 + "imei": "string", ~/~/ IMEI 1467 + "deviceTypeId": 0, ~/~/ ID типа устройства 1468 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1469 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1470 + "sim1": "string", ~/~/ SIM1 1471 + "sim2": "string", ~/~/ SIM2 1472 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1473 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1474 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1475 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1476 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1477 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1478 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1479 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1480 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1481 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1482 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1483 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1484 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1485 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1486 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1487 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1488 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1489 + "counters": { ~/~/ Dto для состояний счётчиков 1490 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1491 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1492 + "mileage": 0, ~/~/ Пробег 1493 + "motohours": 0 ~/~/ Моточасы 1494 + }, 1495 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1496 + "id": "string", ~/~/ CMSV6 Идентификатор 1497 + "enabled": true, ~/~/ Признак включения 1498 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1499 + "login": "string", ~/~/ CMSV6 имя учетной записи 1500 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1501 + }, 1502 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1503 + { 1504 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1505 + "enabled": true, ~/~/ Признак включения 1506 + "name": "string", ~/~/ Имя задания 1507 + "description": "string", ~/~/ Описание задания 1508 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1509 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1510 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1511 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1512 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1513 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1514 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1515 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 869 869 } 1517 + ], 1518 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1519 + { 1520 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1521 + "inputNumber": 0, ~/~/ № входа. 1522 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1523 + "comment": "string", ~/~/ Комментарий 1524 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1525 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1526 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1527 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1528 + } 1529 + ], 1530 + "commandTemplates": [ ~/~/ Список шаблонов команд 1531 + { 1532 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1533 + "name": "string", ~/~/ Название шаблона команд 1534 + "command": "string", ~/~/ Команда на выполнение 1535 + "retries": 0 ~/~/ Лимит попыток отправки 1536 + } 1537 + ], 1538 + "sensors": [ ~/~/ Список датчиков 1539 + { 1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1541 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1542 + "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 1543 + "name": "string", ~/~/ Имя датчика 1544 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1545 + "inputNumber": 0, ~/~/ Номер входа 1546 + "pseudonym": "string", ~/~/ Псевдоним 1547 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1548 + "isInverted": true, ~/~/ Признак инверсии 1549 + "disabled": true, ~/~/ Датчик не участвует в обработке 1550 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1551 + "gradesTables": [ ~/~/ Тарировка 1552 + { 1553 + "grades": [ ~/~/ Таблицы тарировки 1554 + { 1555 + "input": 0, ~/~/ Вход 1556 + "output": 0 ~/~/ Выход 1557 + } 1558 + ], 1559 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1560 + } 1561 + ], 1562 + "showInTooltip": true, ~/~/ Отображение в подсказке 1563 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1564 + "color": "string", ~/~/ код цвета датчиков 1565 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1566 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1567 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1568 + "expr": "string", ~/~/ Выражение 1569 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1570 + "string" 1571 + ], 1572 + "customParams": { 1573 + "additionalProp1": "string", 1574 + "additionalProp2": "string", 1575 + "additionalProp3": "string" 1576 + }, 1577 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1578 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1579 + { 1580 + "from": 0, ~/~/ С какого значения 1581 + "color": "string", ~/~/ Каким цветом 1582 +))) 870 870 871 -(% style="text-align:left" %) 872 -(% style="color:#000000" %)} 1584 +((( 1585 + "text": "string" ~/~/ Текст подписи к этому интервалу 1586 + } 1587 + ] 1588 + } 1589 + ], 1590 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1591 + "customFields": [ ~/~/ Список произвольных полей 1592 + { 1593 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1594 + "name": "string", ~/~/ Наименование произвольного поля 1595 + "value": "string", ~/~/ Значение произвольного поля 1596 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1597 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1598 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1599 + } 1600 + ], 1601 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1602 +} 1603 +))) 1604 +))) 1605 +))) 873 873 1607 + 874 874 **Валидация:** 875 875 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 876 876 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 877 877 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 878 878 879 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 880 880 1614 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1615 + 881 881 (% class="box infomessage" %) 882 882 ((( 883 883 (% lang="en-US" %)**POST /api/v3/vehicles/find** 884 884 ))) 885 885 886 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1621 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 887 887 888 888 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 889 889 ... ... @@ -917,9 +917,12 @@ 917 917 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 918 918 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 919 919 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 920 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 921 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 922 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1655 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1656 + "unitName": "string", ~/~/ Название подразделения (опционально) 1657 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1658 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1659 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1660 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 923 923 } 924 924 925 925 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -926,8 +926,14 @@ 926 926 927 927 (% style="color:#000000" %)Ответ: 928 928 929 -(% style="color:#000000" %){ 1667 +(% style="color:#000000" %)[ 1668 +{ 930 930 1670 +((( 1671 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1672 +))) 1673 + 1674 +((( 931 931 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 932 932 "name": "" ~/~/ наименование объекта 933 933 "imei": "" ~/~/ IMEI объекта ... ... @@ -953,9 +953,21 @@ 953 953 "forClient": true, ~/~/ право на отображение у клиента 954 954 "forTooltip": false, ~/~/ право на отображение в подсказке 955 955 "forReport": false ~/~/ право на отображение в отчетах 956 - }(%%) 957 -(% style="color:#000000" %)} 1700 +))) 958 958 1702 +((( 1703 + } 1704 + ], 1705 + "vehicleGroups": [ ~/~/ Группы ТС 1706 + { 1707 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1708 + "name": "string" ~/~/ Наименование группы ТС 1709 + } 1710 + ] 1711 + } 1712 +] 1713 +))) 1714 + 959 959 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 960 960 961 961 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -987,13 +987,11 @@ 987 987 "data": "", ~/~/ Данные 988 988 "overwrite": false, ~/~/ Флаг перезаписи 989 989 "stage": "", ~/~/ Состояние, может быть null 990 - 991 991 (% style="color:#000000" %)} 992 992 993 993 (% style="color:#000000" %)Ответ: 994 994 995 -(% style="color:#000000" %){ 996 - 1750 +(% style="color:#000000" %){(%%) 997 997 "status": "", ~/~/ значение статуса 998 998 "date": "", ~/~/ Дата смены статуса 999 999 "description": "", ~/~/ Описание ... ... @@ -1000,10 +1000,9 @@ 1000 1000 "data": "", ~/~/ Данные 1001 1001 "overwrite": false, ~/~/ Флаг перезаписи 1002 1002 "stage": "", ~/~/ Состояние 1003 - 1004 -(% style="text-align:left" %) 1005 1005 (% style="color:#000000" %) } 1006 1006 1759 + 1007 1007 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1008 1008 1009 1009 (% class="box warningmessage" %) ... ... @@ -1011,7 +1011,7 @@ 1011 1011 (% lang="en-US" %)**PUT /api/v3/vehicles** 1012 1012 ))) 1013 1013 1014 -(% style="color:#000000" %)Метод позволяет отредактировать объект . Метод позволяет отредактировать объект, указанный в запросе.1767 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 1015 1015 1016 1016 (% style="color:#000000" %)Метод запроса: **PUT** 1017 1017 ... ... @@ -1021,18 +1021,16 @@ 1021 1021 1022 1022 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1023 1023 1024 -(% style="color:#000000" %){ 1025 - 1026 -((( 1027 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 1028 - "parentId": "", ~/~/ ID клиента 1029 - "name": "", ~/~/ имя ТС 1030 - "imei": "", ~/~/ IMEI 1031 - "deviceTypeId": "", ~/~/ ID типа устройства 1032 - "modelId": "", ~/~/ , ID модели 1033 - "unitId": "", ~/~/ подразделения 1034 - "sim1": "", ~/~/ SIM 1 1035 - "sim2": "", ~/~/ SIM2 (%%) 1777 +(% style="color:#000000" %){ 1778 + "vehicleId": , ~/~/ ID объекта 1779 + "parentId": "" , ~/~/ ID клиента 1780 + "name": "" , ~/~/ имя ТС 1781 + "imei": "" , ~/~/ IMEI 1782 + "deviceTypeId": "" , ~/~/ ID типа устройства 1783 + "modelId": "" , ~/~/ ID модели 1784 + "unitId": "" , ~/~/ ID подразделения 1785 + "sim1": "" , ~/~/ Номер SIM 1 1786 + "sim2": "" , ~/~/ Номер SIM2 1036 1036 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1037 1037 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1038 1038 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -1045,89 +1045,326 @@ 1045 1045 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1046 1046 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1047 1047 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1048 -(% style="color:#000000" %) "counters": 1049 - { 1050 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1051 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1052 - "mileage": "", ~/~/ пробег, в метрах 1053 - "motohours": "" ~/~/ моточасы, в секундах 1054 - } 1055 - "cmsv6Parameters": ~/~/ параметры CMSv6 1056 - { 1057 - "id": "", ~/~/ идентификатор 1058 - "enabled": true, ~/~/ флаг включения 1059 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1060 - "login": "", ~/~/ имя учетной записи 1061 - "password": "", ~/~/ пароль учетной записи 1062 - } 1063 - "inspectionTasks": ~/~/ задания на ТО 1064 - { 1065 - "id": "", ~/~/ ID задания 1066 - "enabled": false, ~/~/ Признак включения 1067 - "name": "", ~/~/ Имя задания 1068 - "description": "", ~/~/ Описание задания 1069 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1070 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1071 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1072 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1073 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1074 - "kind": "", ~/~/ Вид периодичности по времени 1075 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1076 - } 1799 + 1800 + "mileageCalcMethod": 0, 1801 + "mileageCoeff": 0, 1802 + "locationByCellId": true, 1803 + "dottedLineTrackWhenNoCoords": true, 1804 + "counters": ~/~/ счетчики 1805 + { 1806 + "mileage": "" , ~/~/ пробег 1807 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1808 + "motohours": "" , ~/~/ моточасы 1809 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1810 + }, 1811 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1812 + "enabled": true, ~/~/ флаг включения 1813 + "id": "" , ~/~/ идентификатор 1814 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1815 + "login": "" , ~/~/ имя учетной записи 1816 + "password": "" ~/~/ пароль учетной записи 1817 + }, 1818 + "inspectionTasks": ~/~/ задания на ТО 1819 + { 1820 + "enabled": "" , ~/~/ Признак включения 1821 + "name": "" , ~/~/ Имя задания 1822 + "description": "" , ~/~/ Описание задания 1823 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1824 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1825 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1826 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1827 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1828 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1829 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1830 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1831 + } 1832 + 1833 +"drivers": [ ~/~/ Водители 1834 + { 1835 + 1836 +((( 1837 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1838 + "inputNumber": 0, ~/~/ № входа. 1839 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1840 + "comment": "string", ~/~/ Комментарий. 1841 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1842 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1843 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1844 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1077 1077 ))) 1078 1078 1079 -(% style="color:#000000" %)} 1847 + } 1848 + ], 1849 + "commandTemplates": [ ~/~/ Шаблон команды 1850 + { 1851 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1852 + "name": "string", 1853 + "command": "string", 1854 + "retries": 0 1855 + } 1856 + ], 1857 +"sensors": [ ~/~/ Датчики 1858 + { 1859 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1860 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1861 + "type": 0, ~/~/ Тип датчика 1862 + "name": "string", ~/~/ Имя датчика 1863 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1864 + "inputNumber": 0, ~/~/ Номер входа 1865 + "pseudonym": "string", ~/~/ Псевдоним 1866 + "medianDegree": 0, ~/~/ Медианная фильтрация 1867 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1868 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1869 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1870 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1871 + { 1872 + "grades": [ ~/~/ Таблица тарировки 1 1873 + { 1874 + "input": 0, ~/~/ Входящее значение 1875 + "output": 0 ~/~/ Выходящее значение 1876 + } 1877 + ], 1878 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1879 + } 1880 + ], 1881 + "showInTooltip": true, ~/~/ Отображать в подсказке 1882 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1080 1080 1884 +((( 1885 + "color": "string",** ~/~/ **Цвет датчика 1886 +))) 1887 + 1888 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1889 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1890 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1891 + "expr": "string", ~/~/ Формула 1892 + "children": [ ~/~/ массив дочерних датчиков 1893 + "string" 1894 + ], 1895 + "customParams": { ~/~/ прочие произвольные параметры 1896 + "additionalProp1": "string", 1897 + "additionalProp2": "string", 1898 + "additionalProp3": "string" 1899 + }, 1900 +~/~/ Характерные для произвольного: 1901 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1902 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1903 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1904 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1905 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1906 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1907 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1908 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1909 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1910 +~/~/ "ValueOn": "Вкл.", 1911 +~/~/ "ValueOff": "Выкл." 1912 + "summaryMaxValue": 0 ~/~/ Макс. значение 1913 + 1914 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1915 + { 1916 + "from": 0, ~/~/ С какого значения 1917 + "color": "string", ~/~/ Каким цветом 1918 + "text": "string" ~/~/ Текст подписи к этому интервалу 1919 + } 1920 + ] 1921 + } 1922 + ], 1923 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1924 + 1925 + "customFields": [ ~/~/ Произвольные поля 1926 + { 1927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1928 + "name": "string", ~/~/ Наименование произвольного поля 1929 + "value": "string", ~/~/ Значение произвольного поля 1930 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1931 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1932 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1933 + } 1934 + 1935 +((( 1936 + ], 1937 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1938 +))) 1939 + 1940 +} 1941 + 1942 + 1081 1081 (% style="color:#000000" %)Ответ: 1082 1082 1083 -(% lang="en-US" style="text-align:left" %) 1084 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1945 +((( 1946 +{ 1947 + "vehicleId": 0, ~/~/ ID ТС 1948 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1949 + "name": "string", ~/~/ Имя объекта 1950 + "imei": "string", ~/~/ IMEI 1951 + "deviceTypeId": 0, ~/~/ ID типа устройства 1952 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1953 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1954 + "sim1": "string", ~/~/ SIM1 1955 + "sim2": "string", ~/~/ SIM2 1956 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1957 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1958 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1959 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1960 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1961 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1962 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1963 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1964 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1965 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1966 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1967 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1968 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1969 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1970 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1971 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1972 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1973 + "counters": { ~/~/ состояний счётчиков 1974 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1975 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1976 + "mileage": 0, ~/~/ Пробег 1977 + "motohours": 0 ~/~/ Моточасы 1978 + }, 1979 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1980 + "id": "string", ~/~/ CMSV6 Идентификатор 1981 + "enabled": true, ~/~/ Признак включения 1982 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1983 +))) 1085 1085 1086 -(% lang="en-US" style="text-align:left" %) 1087 - "vehicleId": "", ~/~/ ID ТС 1088 - "parentId": "", ~/~/ ID клиента 1089 - "name": "", ~/~/ имя ТС 1090 - "imei": "", ~/~/ IMEI 1091 - "deviceTypeId": "", ~/~/ типа устройства 1092 - "modelId": "", ~/~/ ID модели 1093 - "unitId": "", ~/~/ ID подразделения 1094 - "sim1": "", ~/~/ SIM 1 1095 - "sim2": "", ~/~/ SIM2 1096 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1097 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1098 - "counters": 1099 - { 1100 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1101 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1102 - "mileage": "", ~/~/ пробег 1103 - "motohours": "", ~/~/ моточасы 1104 - } 1105 - "cmsv6Parameters": ~/~/ параметры CMSv6 1985 + 1986 +((( 1987 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1988 + "login": "string", ~/~/ CMSV6 имя учетной записи 1989 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1990 + }, 1991 + "inspectionTasks": [ ~/~/ Задания на ТО 1992 + { 1993 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1994 + "enabled": true, ~/~/ Признак включения 1995 + "name": "string", ~/~/ Имя задания 1996 + "description": "string", ~/~/ Описание задания 1997 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1998 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1999 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2000 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2001 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2002 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2003 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2004 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2005 + } 2006 + ], 2007 + "drivers": [ ~/~/ Список водителей 2008 + { 2009 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2010 + "inputNumber": 0, ~/~/ № входа. 2011 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2012 + "comment": "string", ~/~/ Комментарий. 2013 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2014 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2015 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2016 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2017 + } 2018 + ], 2019 + "commandTemplates": [ ~/~/ Список шаблонов команд 2020 + { 2021 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2022 + "name": "string", ~/~/ Название шаблона команд 2023 + "command": "string", ~/~/ Команда на выполнение 2024 + "retries": 0 ~/~/ Лимит попыток отправки 2025 + } 2026 + ], 2027 + "sensors": [ ~/~/ Список датчиков 2028 + { 2029 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2030 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2031 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2032 +))) 2033 + 2034 +((( 2035 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2036 +))) 2037 + 2038 +((( 2039 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2040 +))) 2041 + 2042 +((( 2043 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2044 +))) 2045 + 2046 +((( 2047 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2048 +))) 2049 + 2050 +((( 2051 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2052 + "name": "string", ~/~/ Имя датчика 2053 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2054 +))) 2055 + 2056 +((( 2057 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2058 + "inputNumber": 0, ~/~/ Номер входа 2059 + "pseudonym": "string", ~/~/ Псевдоним 2060 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2061 + "isInverted": true, ~/~/ Признак инверсии 2062 + "disabled": true, ~/~/ Датчик не участвует в обработке 2063 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2064 + "gradesTables": [ ~/~/ Тарировка 1106 1106 { 1107 - "id": ~/~/ идентификатор 1108 - "enabled": true, ~/~/ флаг включения 1109 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1110 - "login": "", ~/~/ имя учетной записи 1111 - "password": "", ~/~/ пароль учетной записи 1112 - } 1113 - "inspectionTasks": ~/~/ задания на ТО 1114 - { 1115 - "id": "", ~/~/ ID задания 1116 - "enabled": false, ~/~/ Признак включения 1117 - "name": "", ~/~/ Имя задания 1118 - "description": "", ~/~/ Описание задания 1119 - "mileageCondition": "", ~/~/ Условие по пробегу 1120 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1121 - "motohoursCondition": "", ~/~/ Условие по моточасам 1122 - "lastMotohours": "", ~/~/ Моточасы 1123 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1124 - "kind": "", ~/~/ Вид периодичности по времени 1125 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2066 + "grades": [ ~/~/ Таблицы тарировки 2067 + { 2068 + "input": 0, ~/~/ Вход 2069 + "output": 0 ~/~/ Выход 2070 + } 2071 + ], 2072 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1126 1126 } 2074 + ], 2075 + "showInTooltip": true, ~/~/ Отображение в подсказке 2076 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1127 1127 1128 -(% lang="en-US" style="text-align:left" %) 1129 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2078 +((( 2079 + "color": "string", ~/~/ цвет уведомлений 2080 +))) 1130 1130 2082 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2083 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2084 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2085 + "expr": "string", ~/~/ Выражение 2086 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2087 + "string" 2088 + ], 2089 + "customParams": { ~/~/ Дополнительные настройки 2090 + "additionalProp1": "string", 2091 + "additionalProp2": "string", 2092 + "additionalProp3": "string" 2093 + }, 2094 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2095 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2096 + { 2097 + "from": 0, ~/~/ С какого значения 2098 + "color": "string", ~/~/ Каким цветом 2099 + "text": "string" ~/~/ Текст подписи к этому интервалу 2100 + } 2101 + ] 2102 + } 2103 + ], 2104 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2105 + "customFields": [ ~/~/ Список произвольных полей 2106 + { 2107 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2108 + "name": "string", ~/~/ Наименование произвольного поля 2109 + "value": "string", ~/~/ Значение произвольного поля 2110 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2111 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2112 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2113 + } 2114 + ], 2115 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2116 +} 2117 +))) 2118 + 1131 1131 **Валидация:** 1132 1132 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1133 1133 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1140,7 +1140,7 @@ 1140 1140 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1141 1141 ))) 1142 1142 1143 -(% style="color:#000000" %)Метод позволяет удалить объект . Метод позволяет удалить объект, указанный в строке запроса.2131 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 1144 1144 1145 1145 (% style="color:#000000" %)Метод запроса: **DELETE** 1146 1146 ... ... @@ -1166,18 +1166,15 @@ 1166 1166 1167 1167 (% style="color:#000000" %)Метод запроса: **GET** 1168 1168 1169 -(% 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]]2157 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1170 1170 1171 1171 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1172 1172 1173 1173 (% style="color:#000000" %)Ответ: 1174 1174 1175 -(% style="color:#000000" %){ 1176 - 2163 +(% style="color:#000000" %){(%%) 1177 1177 "deviceTypeId" : "", ~/~/ ID типа устройства 1178 1178 "deviceTypeName" : "" ~/~/ Название типа устройства 1179 - 1180 -(% style="text-align:left" %) 1181 1181 (% style="color:#000000" %)} 1182 1182 1183 1183 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1199,13 +1199,10 @@ 1199 1199 1200 1200 (% style="color:#000000" %)Ответ: 1201 1201 1202 -(% style="color:#000000" %){ 1203 - 2187 +(% style="color:#000000" %){(%%) 1204 1204 "id": "", ~/~/ ID типа датчика 1205 1205 "name": "", ~/~/ Название 1206 1206 "description": "", ~/~/ Описание 1207 - 1208 -(% style="text-align:left" %) 1209 1209 (% style="color:#000000" %)} 1210 1210 1211 1211 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1249,6 +1249,56 @@ 1249 1249 } 1250 1250 ] 1251 1251 2234 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2235 + 2236 +(% class="box infomessage" style="text-align: left;" %) 2237 +((( 2238 +**POST /api/v3/terminalMessages/mapping** 2239 +))) 2240 + 2241 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2242 + 2243 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2244 + 2245 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2246 + 2247 +{ 2248 + "protocolType": 0, 2249 + "params": ["string"] 2250 +} 2251 + 2252 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2253 +|protocolType|ID типа протокола 2254 +|params|((( 2255 +Массив наименований параметров в сообщении 2256 +))) 2257 + 2258 +Ответ: 2259 + 2260 +{ 2261 + "protocolType": 0, 2262 + "mapping": { 2263 + "additionalProp1": { 2264 + "inputType": 0, 2265 + "inputNumber": 0 2266 + }, 2267 + "additionalProp2": { 2268 + "inputType": 0, 2269 + "inputNumber": 0 2270 + } 2271 + } 2272 +} 2273 + 2274 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2275 +|protocolType|Тип протокола 2276 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2277 +|inputNumber|((( 2278 +Номер входа 2279 +))) 2280 + 2281 +(% class="wikigeneratedid" %) 2282 +Перечень 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/]] 2283 + 1252 1252 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1253 1253 1254 1254 (% class="box infomessage" %) ... ... @@ -1273,6 +1273,11 @@ 1273 1273 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1274 1274 } 1275 1275 2308 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2309 +|vehicleId|ID объекта 2310 +|from|Дата и время начала периода запроса 2311 +|to|Дата и время окончания периода запроса 2312 + 1276 1276 Ответ: 1277 1277 1278 1278 [ ... ... @@ -1279,25 +1279,307 @@ 1279 1279 { 1280 1280 "messages": [ 1281 1281 { 1282 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1283 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1284 - "speed": 0, ~/~/ Скорость, км/ч 1285 - "altitude": 0, ~/~/ Высота, м 1286 - "latitude": 0, ~/~/ Широта [-90°;90°] 1287 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1288 - "satellites": 0, ~/~/ Кол-во спутников 1289 - "voltage": 0, ~/~/ Напряжение 1290 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2319 + "deviceTime": "2023-11-29T07:40:44.052Z", 2320 + "serverTime": "2023-11-29T07:40:44.052Z", 2321 + "speed": 0, 2322 + "altitude": 0, 2323 + "latitude": 0, 2324 + "longitude": 0, 2325 + "satellites": 0, 2326 + "course": 0, 2327 + "voltage": 0, 2328 + "parameters": { 1291 1291 "additionalProp1": "string", 1292 1292 "additionalProp2": "string", 1293 1293 "additionalProp3": "string" 1294 1294 }, 1295 - "photoCount": 0 ~/~/ Кол-во фото 2333 + "photoCount": 0, 2334 + "lbsCorrectedCoords": true, 2335 + "protocolType": 0 1296 1296 } 1297 1297 ] 1298 1298 } 1299 1299 ] 1300 1300 2341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2342 +|deviceTime|Время сообщения терминала 2343 +|serverTime|Время когда сообщение поступило на сервер 2344 +|speed|Скорость 2345 +|altitude|Высота над уровнем моря 2346 +|latitude|Широта 2347 +|longitude|Долгота 2348 +|satellites|Кол-во спутников 2349 +|course|Курс 2350 +|voltage|Бортовое напряжение 2351 +|parameters|Список параметров и их значений 2352 +|photoCount|Количество фото 2353 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2354 +|protocolType|ID типа протокола 2355 + 2356 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2357 + 2358 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2359 + 2360 +(% class="box infomessage" %) 2361 +((( 2362 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2363 +))) 2364 + 2365 +(% style="color:#000000" %)Метод запроса: **POST** 2366 + 2367 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2368 + 2369 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2370 + 2371 +(% style="text-align:left" %) 2372 +Тело запроса: 2373 + 2374 +{ 2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2376 + "vehicleIds": [0], ~/~/ Список ID объектов 2377 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2378 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2379 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2380 +} 2381 + 2382 +Ответ: 2383 + 2384 +[ 2385 + { 2386 + "vehicleId": 0, ~/~/ ID объекта 2387 + "name": "string", ~/~/ Имя ТС 2388 + "periods": [ ~/~/ Периоды 2389 + { 2390 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2391 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2392 + "mileage": 0, ~/~/ Пробег за период, километры 2393 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2394 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2395 + "motohours": 0, ~/~/ Моточасы за период, секунды 2396 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2397 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2398 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2399 + 2400 + } 2401 + ] 2402 + } 2403 +] 2404 + 2405 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2406 + 2407 +(% class="box infomessage" %) 2408 +((( 2409 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2410 +))) 2411 + 2412 +(% style="color:#000000" %)Метод запроса: **POST** 2413 + 2414 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2415 + 2416 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2417 + 2418 +(% style="text-align:left" %) 2419 +Тело запроса: 2420 + 2421 +{ 2422 + "sampling": 86400, ~/~/ Частота дискретизации, секунд, минимум - 60 (если передано, то весь период бъётся на подпериоды с указанной частотой) 2423 + "vehicleIds": [0], ~/~/ Список ID объектов 2424 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2425 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2426 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2427 +} 2428 + 2429 +Ответ: 2430 + 2431 +[ 2432 + { 2433 + "vehicleId": 0, ~/~/ ID объекта 2434 + "name": "string", ~/~/ Имя ТС 2435 + "periods": [ ~/~/ Периоды 2436 + { 2437 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2438 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2439 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2440 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2441 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2442 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2443 + "fuelConsumption": 0, ~/~/ Расход топлива 2444 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2445 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2446 + 2447 + } 2448 + ] 2449 + } 2450 +] 2451 + 2452 +(% class="box warningmessage" %) 2453 +((( 2454 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2455 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2456 +))) 2457 + 2458 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2459 + 2460 +(% class="box infomessage" %) 2461 +((( 2462 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2463 +))) 2464 + 2465 +(% style="color:#000000" %)Метод запроса: **POST** 2466 + 2467 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2468 + 2469 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2470 + 2471 +(% style="text-align:left" %) 2472 +Тело запроса: 2473 + 2474 +{ 2475 + "vehicleIds": [0], ~/~/ Список ID объектов 2476 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2477 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2478 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2479 +} 2480 + 2481 +Ответ: 2482 + 2483 +[ 2484 + { 2485 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2486 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2487 + "vehicleId": 0, ~/~/ ID объекта 2488 + "name": "string", ~/~/ Имя объекта 2489 + "model": "string", ~/~/ Модель объекта 2490 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2491 + { 2492 + "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling 2493 + 2494 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2495 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2496 + "valueFuel": 0, ~/~/ Количество 2497 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2498 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2499 + } 2500 + ] 2501 + } 2502 +] 2503 + 2504 + 2505 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2506 + 2507 +(% class="box infomessage" %) 2508 +((( 2509 +**POST /api/v3/vehicles/moveStop** 2510 +))) 2511 + 2512 +Метод запроса: **POST** 2513 + 2514 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2515 + 2516 +В заголовках запроса: X-Auth: Токен авторизации 2517 + 2518 + 2519 +Тело запроса: 2520 + 2521 +{ 2522 + "vehicleIds": [ ], ~/~/ Список ID объектов 2523 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2524 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2525 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2526 +} 2527 + 2528 +Ответ: 2529 + 2530 +[ 2531 + { 2532 + "vehicleId": 0, ~/~/ ID объекта 2533 + "vehicleName": "string", ~/~/ Имя объекта 2534 + "moves": [ ~/~/ Событие движения 2535 + { 2536 + "mileage": 0, ~/~/ Пробег, км 2537 + "eventId": 0, ~/~/ Идентификатор события 2538 + "eventName": "string", ~/~/ Название события 2539 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2540 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2541 + "duration": 0 ~/~/ Продолжительность события, секунд 2542 + } 2543 + ], 2544 + "stops": [ ~/~/ События стоянок 2545 + { 2546 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2547 + "eventId": 0, ~/~/ Идентификатор события 2548 + "eventName": "string", ~/~/ Название события 2549 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2550 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2551 + "duration": 0 ~/~/ Продолжительность события, секунд 2552 + } 2553 + ] 2554 + } 2555 +] 2556 + 2557 + 2558 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2559 + 2560 +(% class="box infomessage" %) 2561 +((( 2562 +**POST /api/v3/vehicles/getlastdata** 2563 +))) 2564 + 2565 +Метод запроса: **POST** 2566 + 2567 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2568 + 2569 +В заголовках запроса: X-Auth: Токен авторизации 2570 + 2571 + 2572 +В массиве указываем id объектов через запятую 2573 + 2574 +Ответ: 2575 + 2576 +[ 2577 + { 2578 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2579 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2580 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2581 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2582 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2583 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2584 + "speed": 31, ~/~/ Скорость объекта 2585 + "course": 116, ~/~/ Курс движения [0;360] 2586 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2587 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2588 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2589 + "geozones": [ ~/~/ Сведения по геозонам. 2590 + { 2591 + "id": 10225647, ~/~/ ID Геозоны 2592 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2593 + }, 2594 + { 2595 + "id": 10282875, ~/~/ ID Геозоны 2596 + "name": "Ё2" ~/~/ Наименование геозоны 2597 + }, 2598 + { 2599 + "id": 10226240, ~/~/ ID Геозоны 2600 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2601 + }, 2602 + { 2603 + "id": 9747869, ~/~/ ID Геозоны 2604 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2605 + }, 2606 + { 2607 + "id": 10221123, ~/~/ ID Геозоны 2608 + "name": "53r" ~/~/ Наименование геозоны 2609 + }, 2610 + { 2611 + "id": 10197638, ~/~/ ID Геозоны 2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2613 + } 2614 + ] 2615 + } 2616 + 2617 + 2618 += = 2619 + 1301 1301 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1302 1302 1303 1303 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -1329,7 +1329,7 @@ 1329 1329 "id": 0, ~/~/ ID уведомления 1330 1330 "name": "string", ~/~/ Название уведомления 1331 1331 "active": true, ~/~/ Состояние true - активен, false - деактивирован 1332 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2651 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 1333 1333 "userId": "", ~/~/ Пользователь, создавший уведомление 1334 1334 "parentId": "", ~/~/ Идентификатор клиента 1335 1335 "parentName": "string" ~/~/ Имя клиента ... ... @@ -1336,6 +1336,155 @@ 1336 1336 } 1337 1337 ] 1338 1338 2658 + 2659 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2660 + 2661 +(% class="box infomessage" %) 2662 +((( 2663 +**POST /api/v3/notifications** 2664 +))) 2665 + 2666 +Метод запроса **POST** 2667 + 2668 +(% style="text-align: left;" %) 2669 +(% style="color:#000000" %)Пример запроса 2670 + 2671 +((( 2672 +{ 2673 + "id": 0, ~/~/ ID правила 2674 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2675 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2676 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2677 + "name": "string", ~/~/ Имя правила 2678 + "active": true, ~/~/ Активность правила 2679 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2680 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2681 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2682 + ], 2683 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2684 + 0 2685 + ], 2686 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2687 + 0 2688 + ], 2689 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2690 + 0 2691 + ], 2692 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2693 + "additionalProp1": "string", 2694 + "additionalProp2": "string", 2695 + "additionalProp3": "string" 2696 + }, 2697 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2698 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2699 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2700 + ], 2701 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2702 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2703 + "string" 2704 + ], 2705 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2706 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2707 + { 2708 + "id": 0, ~/~/ Идентификатор участника чата. 2709 + "info": "string" ~/~/ Дополнительные сведения. 2710 + } 2711 + ], 2712 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2713 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2714 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2715 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2716 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2717 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2718 + "timezone": 0, ~/~/ часовой пояс 2719 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2720 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2721 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2722 + { 2723 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2724 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2725 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2726 + "additionalProp1": "string", 2727 + "additionalProp2": "string", 2728 + "additionalProp3": "string" 2729 + } 2730 + } 2731 + ] 2732 +} 2733 +))) 2734 + 2735 +((( 2736 + 2737 +))) 2738 + 2739 +((( 2740 + 2741 +))) 2742 + 2743 +Ответ: 2744 + 2745 +{ 2746 + "id": 0, ~/~/ ID правила 2747 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2748 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2749 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2750 + "name": "string", ~/~/ Имя правила 2751 + "active": true, ~/~/ Активность правила 2752 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2753 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2754 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2755 + ], 2756 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2757 + 0 2758 + ], 2759 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2760 + 0 2761 + ], 2762 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2763 + 0 2764 + ], 2765 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2766 + "additionalProp1": "string", 2767 + "additionalProp2": "string", 2768 + "additionalProp3": "string" 2769 + }, 2770 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2771 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2772 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2773 + ], 2774 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2775 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2776 + "string" 2777 + ], 2778 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2779 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2780 + { 2781 + "id": 0, ~/~/ Идентификатор участника чата. 2782 + "info": "string" ~/~/ Дополнительные сведения. 2783 + } 2784 + ], 2785 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2786 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2787 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2788 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2789 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2790 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2791 + "timezone": 0, ~/~/ часовой пояс 2792 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2793 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2794 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2795 + { 2796 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2797 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2798 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2799 + "additionalProp1": "string", 2800 + "additionalProp2": "string", 2801 + "additionalProp3": "string" 2802 + } 2803 + } 2804 + ] 2805 +} 2806 + 1339 1339 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1340 1340 1341 1341 (% class="box infomessage" %) ... ... @@ -1349,7 +1349,7 @@ 1349 1349 Метод запроса **GET** 1350 1350 1351 1351 (% style="text-align: left;" %) 1352 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]2820 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1353 1353 1354 1354 (% style="text-align: left;" %) 1355 1355 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления ... ... @@ -1409,7 +1409,3668 @@ 1409 1409 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1410 1410 (% style="color:#000000" %)} 1411 1411 2880 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 1412 1412 2882 +(% class="box warningmessage" %) 2883 +((( 2884 +**PUT /api/v3/notifications/** 2885 +))) 2886 + 2887 +Метод позволяет отредактировать уведомление. 2888 + 2889 +Метод запроса **PUT** 2890 + 2891 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2892 + 2893 +В заголовках запроса: X-Auth: Токен авторизации 2894 + 2895 +Тело запроса: 2896 +{ 2897 + "id": 0, ~/~/ id уведомления 2898 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2899 + "userId": "", ~/~/ Пользователь, создавший уведомление 2900 + "parentId": "", ~/~/ Идентификатор клиента 2901 + "parentName": "string", ~/~/ Имя клиента 2902 + "name": "string", ~/~/ Название уведомления 2903 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2904 + "vehicleIds": [ ~/~/ Список id объектов для анализа 2905 + 0 2906 + ], 2907 + "geoids": [ ~/~/ Список id геообъектов для анализа 2908 + 0 2909 + ], 2910 + "fieldids": [ ~/~/ Список id полей для анализа 2911 + 0 2912 + ], 2913 + "settings": { ~/~/ Список параметров уведомления 2914 + "additionalProp1": "string", 2915 + "additionalProp2": "string", 2916 + "additionalProp3": "string" 2917 + }, 2918 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2919 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2920 + "" 2921 + ], 2922 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2923 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2924 + "string" 2925 + ], 2926 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2927 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2928 + { 2929 + "id": 0, ~/~/ Идентификатор участника чата 2930 + "info": "string" ~/~/ Дополнительные сведения 2931 + } 2932 + ], 2933 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2934 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2935 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2936 + "kind": 0, ~/~/ Определяет вид уведомления 2937 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2938 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2939 + "timezone": 0, ~/~/ Сдвиг часового пояса 2940 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2941 + "autoProlongation": true ~/~/ Автопродление срока действия 2942 +} 2943 + 2944 +Ответ: 2945 + 2946 +Success 2947 + 2948 + 2949 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2950 + 2951 +(% class="box warningmessage" %) 2952 +((( 2953 +**PUT** /api/v3/notifications/prolongation 2954 +))) 2955 + 2956 +Метод позволяет продлить уведомления. 2957 + 2958 +Метод запроса **PUT** 2959 + 2960 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2961 + 2962 +В заголовках запроса: X-Auth: Токен авторизации. 2963 + 2964 +Тело запроса: 2965 + 2966 +[ 2967 + 2968 +0 2969 + 2970 +] 2971 + 2972 +где 0 идентификатор ids. 2973 + 2974 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2975 + 2976 +(% class="box errormessage" %) 2977 +((( 2978 +**DELETE /api/v3/notifications/{id}** 2979 +))) 2980 + 2981 +Метод позволяет удалить выбранное уведомление. 2982 + 2983 +Метод запроса **DELETE** 2984 + 2985 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2986 + 2987 +Передаваемый параметр: {id} - id уведомления 2988 + 2989 +В заголовках запроса: X-Auth: Токен авторизации 2990 + 2991 +Ответ: 2992 + 2993 +Success 2994 + 2995 + 2996 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 2997 + 2998 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 2999 + 3000 +(% class="box infomessage" %) 3001 +((( 3002 +**POST /api/v3/Drivers/find** 3003 +))) 3004 + 3005 +Передается параметр: parentId - ID клиента-родителя 3006 + 3007 +Ответ: 3008 + 3009 +[ 3010 + { 3011 + "name": "string", ~/~/ Определяет наименование 3012 + "description": "string", ~/~/ Определяет описание 3013 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 3014 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 3015 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3016 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3017 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3018 + "deleted": true ~/~/ Признак удаления 3019 + } 3020 +] 3021 + 3022 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 3023 + 3024 +(% class="box infomessage" %) 3025 +((( 3026 +**GET /api/v3/Drivers/{driverGuid}** 3027 +))) 3028 + 3029 +Передается параметр: ID водителя 3030 + 3031 +Ответ: 3032 + 3033 +{ 3034 + "name": "string", ~/~/ Определяет наименование 3035 + "description": "string", ~/~/ Определяет описание 3036 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 3037 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 3038 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3039 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3040 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3041 + "deleted": true ~/~/ Признак удаления 3042 +} 3043 + 3044 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 3045 + 3046 +(% class="box successmessage" %) 3047 +((( 3048 +**POST /api/v3/Drivers** 3049 +))) 3050 + 3051 +Запрос: 3052 + 3053 +{ 3054 + "name": "string", 3055 + "description": "string", 3056 + "hiredate": "2023-06-30T12:50:54.020Z", 3057 + "chopdate": "2023-06-30T12:50:54.020Z", 3058 + "exclusive": true, 3059 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3060 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3061 + "deleted": true 3062 +} 3063 + 3064 +Ответ: 3065 + 3066 +{ 3067 + "name": "string", 3068 + "description": "string", 3069 + "hiredate": "2023-06-30T12:50:54.051Z", 3070 + "chopdate": "2023-06-30T12:50:54.051Z", 3071 + "exclusive": true, 3072 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3073 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3074 + "deleted": true 3075 +} 3076 + 3077 + 3078 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 3079 + 3080 +(% class="box warningmessage" %) 3081 +((( 3082 +**PUT /api/v3/Drivers** 3083 +))) 3084 + 3085 +Запрос: 3086 + 3087 +{ 3088 + "name": "string", 3089 + "description": "string", 3090 + "hiredate": "2023-06-30T12:50:27.910Z", 3091 + "chopdate": "2023-06-30T12:50:27.910Z", 3092 + "exclusive": true, 3093 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3094 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3095 + "deleted": true 3096 +} 3097 + 3098 +Ответ: 3099 + 3100 +{ 3101 + "name": "string", 3102 + "description": "string", 3103 + "hiredate": "2023-06-30T12:50:27.929Z", 3104 + "chopdate": "2023-06-30T12:50:27.929Z", 3105 + "exclusive": true, 3106 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3107 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3108 + "deleted": true 3109 +} 3110 + 3111 + 3112 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 3113 + 3114 +(% class="box errormessage" %) 3115 +((( 3116 +**DELETE /api/v3/Drivers/{driverGuid}** 3117 +))) 3118 + 3119 +Передается параметр: ID водителя 3120 + 3121 +Ответ: 3122 + 3123 +Success 3124 + 3125 + 3126 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 3127 + 3128 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 3129 + 3130 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 3131 + 3132 +(% class="box infomessage" %) 3133 +((( 3134 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3135 +))) 3136 + 3137 +Запрос: 3138 + 3139 +{ 3140 + "Ids": [ 3141 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3142 + ], 3143 + "BeginTime": "2023-06-30T12:49:04.365Z", 3144 + "EndTime": "2023-06-30T12:49:04.365Z" 3145 +} 3146 + 3147 +Ответ: 3148 + 3149 +[ 3150 + { 3151 + "VehicleId": 0, 3152 + "CreateTime": "2023-06-30T09:52:31.240Z", 3153 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3154 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3155 + "BeginTime": "2023-06-30T09:52:31.240Z", 3156 + "EndTime": "2023-06-30T09:52:31.240Z" 3157 + } 3158 +] 3159 + 3160 + 3161 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 3162 + 3163 +(% class="box infomessage" %) 3164 +((( 3165 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3166 +))) 3167 + 3168 +Запрос: 3169 + 3170 +{ 3171 + "Ids": [ 3172 + 0 3173 + ], 3174 + "BeginTime": "2023-06-30T12:48:39.419Z", 3175 + "EndTime": "2023-06-30T12:48:39.419Z" 3176 +} 3177 + 3178 +Ответ: 3179 + 3180 +[ 3181 + { 3182 + "VehicleId": 0, 3183 + "CreateTime": "2023-06-30T09:54:01.631Z", 3184 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3185 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3186 + "BeginTime": "2023-06-30T09:54:01.631Z", 3187 + "EndTime": "2023-06-30T09:54:01.631Z" 3188 + } 3189 +] 3190 + 3191 + 3192 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 3193 + 3194 +(% class="box successmessage" %) 3195 +((( 3196 +**POST /api/v3/DriversVehiclesAssignments** 3197 +))) 3198 + 3199 +Передается массив назначений 3200 + 3201 +Запрос: 3202 + 3203 +[ 3204 + { 3205 + "VehicleId": 0, ~/~/ Идентификатор объекта 3206 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3207 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3208 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3209 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 3210 + } 3211 +] 3212 + 3213 +Ответ: 3214 + 3215 +[ 3216 + { 3217 + "VehicleId": 0, 3218 + "CreateTime": "2023-06-30T11:04:46.903Z", 3219 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3220 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3221 + "BeginTime": "2023-06-30T11:04:46.903Z", 3222 + "EndTime": "2023-06-30T11:04:46.903Z" 3223 + } 3224 +] 3225 + 3226 + 3227 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 3228 + 3229 +(% class="box warningmessage" %) 3230 +((( 3231 +**PUT /api/v3/DriversVehiclesAssignments** 3232 +))) 3233 + 3234 +Запрос: 3235 + 3236 +[ 3237 + { 3238 + "VehicleId": 0, 3239 + "CreateTime": "2023-06-30T11:14:08.117Z", 3240 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3241 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3242 + "BeginTime": "2023-06-30T11:14:08.117Z", 3243 + "EndTime": "2023-06-30T11:14:08.117Z" 3244 + } 3245 +] 3246 + 3247 +Ответ: 3248 + 3249 +[ 3250 + { 3251 + "VehicleId": 0, 3252 + "CreateTime": "2023-06-30T11:14:53.349Z", 3253 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3254 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3255 + "BeginTime": "2023-06-30T11:14:53.349Z", 3256 + "EndTime": "2023-06-30T11:14:53.349Z" 3257 + } 3258 +] 3259 + 3260 + 3261 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 3262 + 3263 +(% class="box errormessage" %) 3264 +((( 3265 +**DELETE /api/v3/DriversVehiclesAssignments** 3266 +))) 3267 + 3268 +Запрос: 3269 + 3270 +[ 3271 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3272 +] 3273 + 3274 +Ответ: 3275 + 3276 +Success 3277 + 3278 + 3279 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 3280 + 3281 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 3282 + 3283 +(% class="box infomessage" %) 3284 +((( 3285 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3286 +))) 3287 + 3288 +Запрос: 3289 + 3290 +{ 3291 + "Ids": [ 3292 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3293 + ], 3294 + "BeginTime": "2023-06-30T12:47:12.162Z", 3295 + "EndTime": "2023-06-30T12:47:12.162Z" 3296 +} 3297 + 3298 +Ответ: 3299 + 3300 +[ 3301 + { 3302 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3303 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3304 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3305 + "BeginTime": "2023-06-30T11:19:40.703Z", 3306 + "EndTime": "2023-06-30T11:19:40.703Z" 3307 + } 3308 +] 3309 + 3310 + 3311 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 3312 + 3313 +(% class="box infomessage" %) 3314 +((( 3315 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3316 +))) 3317 + 3318 +Запрос: 3319 + 3320 +{ 3321 + "Ids": [ 3322 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3323 + ], 3324 + "BeginTime": "2023-06-30T12:47:12.162Z", 3325 + "EndTime": "2023-06-30T12:47:12.162Z" 3326 +} 3327 + 3328 +Ответ: 3329 + 3330 +[ 3331 + { 3332 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3333 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3334 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3335 + "BeginTime": "2023-06-30T11:19:40.703Z", 3336 + "EndTime": "2023-06-30T11:19:40.703Z" 3337 + } 3338 +] 3339 + 3340 + 3341 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 3342 + 3343 +(% class="box successmessage" %) 3344 +((( 3345 +**POST /api/v3/DriversRfidsAssignments** 3346 +))) 3347 + 3348 +Запрос: 3349 + 3350 +[ 3351 + { 3352 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3353 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3354 + "BeginTime": "2023-06-30T11:27:08.635Z", 3355 + "EndTime": "2023-06-30T11:27:08.635Z" 3356 + } 3357 +] 3358 + 3359 +Ответ: 3360 + 3361 +[ 3362 + { 3363 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3364 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3365 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3366 + "BeginTime": "2023-06-30T11:27:08.677Z", 3367 + "EndTime": "2023-06-30T11:27:08.677Z" 3368 + } 3369 +] 3370 + 3371 + 3372 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 3373 + 3374 +(% class="box warningmessage" %) 3375 +((( 3376 +**PUT /api/v3/DriversRfidsAssignments** 3377 +))) 3378 + 3379 +Запрос: 3380 + 3381 +[ 3382 + { 3383 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3384 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3385 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3386 + "BeginTime": "2023-06-30T11:28:43.330Z", 3387 + "EndTime": "2023-06-30T11:28:43.330Z" 3388 + } 3389 +] 3390 + 3391 +Ответ: 3392 + 3393 +[ 3394 + { 3395 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3396 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3397 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3398 + "BeginTime": "2023-06-30T11:28:43.331Z", 3399 + "EndTime": "2023-06-30T11:28:43.331Z" 3400 + } 3401 +] 3402 + 3403 + 3404 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3405 + 3406 +(% class="box errormessage" %) 3407 +((( 3408 +**DELETE /api/v3/DriversRfidsAssignments** 3409 +))) 3410 + 3411 +Запрос: 3412 + 3413 +[ 3414 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3415 +] 3416 + 3417 +Ответ: 3418 + 3419 +Success 3420 + 3421 + 3422 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3423 + 3424 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3425 + 3426 +(% class="box infomessage" %) 3427 +((( 3428 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3429 +))) 3430 + 3431 +Запрос: 3432 + 3433 +{ 3434 + "Ids": [ 3435 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3436 + ], 3437 + "BeginTime": "2023-06-30T12:45:10.852Z", 3438 + "EndTime": "2023-06-30T12:45:10.852Z" 3439 +} 3440 + 3441 +Ответ: 3442 + 3443 +[ 3444 + { 3445 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3446 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3447 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3448 + "BeginTime": "2023-06-30T11:58:04.695Z", 3449 + "EndTime": "2023-06-30T11:58:04.695Z" 3450 + } 3451 +] 3452 + 3453 + 3454 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3455 + 3456 +(% class="box infomessage" %) 3457 +((( 3458 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3459 +))) 3460 + 3461 +Запрос: 3462 + 3463 +{ 3464 + "Ids": [ 3465 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3466 + ], 3467 + "BeginTime": "2023-06-30T12:45:10.852Z", 3468 + "EndTime": "2023-06-30T12:45:10.852Z" 3469 +} 3470 + 3471 +Ответ: 3472 + 3473 +[ 3474 + { 3475 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3476 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3477 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3478 + "BeginTime": "2023-06-30T11:58:04.695Z", 3479 + "EndTime": "2023-06-30T11:58:04.695Z" 3480 + } 3481 +] 3482 + 3483 + 3484 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3485 + 3486 +(% class="box successmessage" %) 3487 +((( 3488 +**POST /api/v3/DriversFuelCardsAssignments** 3489 +))) 3490 + 3491 +Запрос: 3492 + 3493 +[ 3494 + { 3495 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3496 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3497 + "BeginTime": "2023-06-30T12:09:53.175Z", 3498 + "EndTime": "2023-06-30T12:09:53.175Z" 3499 + } 3500 +] 3501 + 3502 +Ответ: 3503 + 3504 +[ 3505 + { 3506 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3507 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3508 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3509 + "BeginTime": "2023-06-30T12:09:53.201Z", 3510 + "EndTime": "2023-06-30T12:09:53.201Z" 3511 + } 3512 +] 3513 + 3514 + 3515 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3516 + 3517 +(% class="box warningmessage" %) 3518 +((( 3519 +**PUT /api/v3/DriversFuelCardsAssignments** 3520 +))) 3521 + 3522 +Запрос: 3523 + 3524 +[ 3525 + { 3526 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3527 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3528 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3529 + "BeginTime": "2023-06-30T12:09:53.201Z", 3530 + "EndTime": "2023-06-30T12:09:53.201Z" 3531 + } 3532 +] 3533 + 3534 +Ответ: 3535 + 3536 +[ 3537 + { 3538 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3539 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3540 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3541 + "BeginTime": "2023-06-30T12:09:53.201Z", 3542 + "EndTime": "2023-06-30T12:09:53.201Z" 3543 + } 3544 +] 3545 + 3546 + 3547 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3548 + 3549 +(% class="box errormessage" %) 3550 +((( 3551 +**DELETE /api/v3/DriversFuelCardsAssignments** 3552 +))) 3553 + 3554 +Запрос: 3555 + 3556 +[ 3557 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3558 +] 3559 + 3560 +Ответ: 3561 + 3562 +Success 3563 + 3564 + 3565 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3566 + 3567 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3568 + 3569 +(% class="box infomessage" %) 3570 +((( 3571 +**POST /api/v3/Trailers** 3572 +))) 3573 + 3574 +Пример запроса: 3575 + 3576 +{ 3577 + "startDate": "2023-11-14T10:48:03.671Z", 3578 + "endDate": "2023-11-14T10:48:03.671Z", 3579 + "ids": [ 0 ], 3580 + "timezone": 0 3581 +} 3582 + 3583 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3584 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3585 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3586 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3587 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3588 + 3589 +Пример ответа: 3590 + 3591 +[ 3592 + { 3593 + "SD": "2023-11-14T10:48:03.717Z", 3594 + "ED": "2023-11-14T10:48:03.717Z", 3595 + "id": 0, 3596 + "SLat": 0, 3597 + "SLon": 0, 3598 + "ELat": 0, 3599 + "ELon": 0, 3600 + "mileage": 0 3601 + "Duration": 0 3602 + "Address": "string", 3603 + "Address2": "string", 3604 + "name": "string", 3605 + "rid": "string", 3606 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3607 + "trailer": { 3608 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3609 + "Number": "string", 3610 + "Description": "string", 3611 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3612 + "ExternalID": "string", 3613 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3614 + "CreateTime": "2023-11-14T10:48:03.717Z", 3615 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3616 + "IsDeleted": true 3617 + }, 3618 + "filesCount": 0, 3619 + } 3620 +] 3621 + 3622 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3623 +|SD|Дата и время начала события 3624 +|ED|Дата и время окончания события 3625 +|id|ID объекта 3626 +|SLat|Широта начальной координаты 3627 +|SLon|Долгота начальной координаты 3628 +|ELat|Широта конечной координаты 3629 +|ELon|Долгота конечной координаты 3630 +|mileage|Пробег 3631 +|Duration|Продолжительность 3632 +|Address|Адрес начального местоположения 3633 +|Address2|Адрес конечного местоположения 3634 +|name|Имя радиометки 3635 +|rid|Номер радиометки 3636 +|rguid|ID радиометки 3637 +|trailer|Информация об агрегате 3638 +|ModelGuid|ID агрегата 3639 +|Number|Название/номер агрегата 3640 +|Description|Текст примечания агрегата 3641 + 3642 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3643 + 3644 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3645 + 3646 +(% class="box infomessage" %) 3647 +((( 3648 +**POST /api/v3/Rfids/find** 3649 +))) 3650 + 3651 +Запрос: 3652 + 3653 +{ 3654 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3655 +} 3656 + 3657 +Ответ: 3658 + 3659 +[ 3660 + { 3661 + "name": "string", 3662 + "number": 0, 3663 + "period": 0, 3664 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3665 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3666 + } 3667 +] 3668 + 3669 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3670 +|parentId|ID клиента 3671 +|name|Название карты-метки 3672 +|number|Номер 3673 +|period|Период запросов в секундах (работает только для агрегатов) 3674 +|id|ID карты-метки 3675 + 3676 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3677 + 3678 +(% class="box infomessage" %) 3679 +((( 3680 +**GET /api/v3/Rfids/{rfidGuid}** 3681 +))) 3682 + 3683 +Передаем параметр rfidGuid - идентификатор карты-метки 3684 + 3685 +Ответ: 3686 + 3687 +[ 3688 + { 3689 + "name": "string", 3690 + "number": 0, 3691 + "period": 0, 3692 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3693 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3694 + } 3695 +] 3696 + 3697 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3698 +|name|Название карты-метки 3699 +|number|Номер 3700 +|period|Период запросов в секундах (работает только для агрегатов) 3701 +|id|ID карты-метки 3702 +|parentId|ID клиента 3703 + 3704 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3705 + 3706 +(% class="box successmessage" %) 3707 +((( 3708 +**POST /api/v3/Rfids** 3709 +))) 3710 + 3711 +Запрос: 3712 + 3713 +{ 3714 + "name": "string", 3715 + "number": 0, 3716 + "period": 0, 3717 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3718 +} 3719 + 3720 +Ответ: 3721 + 3722 +{ 3723 + "name": "string", 3724 + "number": 0, 3725 + "period": 0, 3726 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3727 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3728 +} 3729 + 3730 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3731 +|name|Название карты-метки 3732 +|number|Номер 3733 +|period|Период запросов в секундах (работает только для агрегатов) 3734 +|id|ID карты-метки 3735 +|parentId|ID клиента 3736 + 3737 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3738 + 3739 +(% class="box warningmessage" %) 3740 +((( 3741 +**PUT /api/v3/Rfids** 3742 +))) 3743 + 3744 +Запрос: 3745 + 3746 +{ 3747 + "name": "string", 3748 + "number": 0, 3749 + "period": 0, 3750 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3751 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3752 +} 3753 + 3754 +Ответ: 3755 + 3756 +{ 3757 + "name": "string", 3758 + "number": 0, 3759 + "period": 0, 3760 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3761 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3762 +} 3763 + 3764 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3765 +|name|Название карты-метки 3766 +|number|Номер 3767 +|period|Период запросов в секундах (работает только для агрегатов) 3768 +|id|ID карты-метки 3769 +|parentId|ID клиента 3770 + 3771 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3772 + 3773 +(% class="box errormessage" %) 3774 +((( 3775 +**DELETE /api/v3/Rfids/{rfidGuid}** 3776 +))) 3777 + 3778 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3779 + 3780 +Ответ: 3781 + 3782 +Success 3783 + 3784 + 3785 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3786 + 3787 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3788 + 3789 +(% class="box infomessage" %) 3790 +((( 3791 +**GET /api/v3/Billing/client/balance/{clientId}** 3792 +))) 3793 + 3794 +Параметр запроса: **clientId **- идентификатор клиента. 3795 + 3796 +Ответ: 3797 + 3798 +{ 3799 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3800 + "Balance": 0 3801 +} 3802 + 3803 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3804 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3805 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3806 + 3807 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3808 + 3809 +(% class="box infomessage" %) 3810 +((( 3811 +**GET /api/v3/Billing/client/constraint/{clientId}** 3812 +))) 3813 + 3814 +Параметр запроса: **clientId **- идентификатор клиента. 3815 + 3816 +Ответ: 3817 + 3818 +{ 3819 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3820 + "CalculationType": 0, 3821 + "PermissibleBalance": 0, 3822 + "DefermentDays": 0, 3823 + "SendUiNotifications": true, 3824 + "SendEmailNotifications": true, 3825 + "IsPrivate": true, 3826 +} 3827 + 3828 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3829 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3830 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3831 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3832 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3833 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3834 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3835 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3836 + 3837 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3838 + 3839 +(% class="box infomessage" %) 3840 +((( 3841 +**GET /api/v3/Billing/client/plan/{clientId}** 3842 +))) 3843 + 3844 +Параметры запроса: 3845 + 3846 +**clientId **- идентификатор клиента. 3847 + 3848 +**planId **- идентификатор тарифного плана. 3849 + 3850 +Ответ: 3851 + 3852 +{ 3853 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3854 + "Plan": { **~/~/ Описание тарифного плана** 3855 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3856 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3857 + "Name": "string", 3858 + "IsArchived": true, 3859 + "Constraint": { 3860 + "CalculationType": 0, 3861 + "PermissibleBalance": 0, 3862 + "DefermentDays": 0 3863 + }, 3864 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3865 + { 3866 + "Feature": "string", 3867 + "IsFactual": true, 3868 + "Limit": 0, 3869 + "Price": 0, 3870 + "PeriodValue": 0, 3871 + "PeriodType": 0 3872 + } 3873 + ] 3874 + }, 3875 + "DebitDate": "2023-10-18T12:46:24.213Z", 3876 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3877 + { 3878 + "Feature": "string", 3879 + "IsEnabled": true, 3880 + "IsPrivate": true, 3881 + "IsFactual": true, 3882 + "Limit": 0, 3883 + "Price": 0, 3884 + "DebitDate": "2023-10-18T12:46:24.213Z", 3885 + "PeriodValue": 0, 3886 + "PeriodType": 0 3887 + } 3888 + ] 3889 +} 3890 + 3891 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3892 +|ClientId|Идентификатор клиента 3893 +|Id|Идентификатор тарифного плана 3894 +|OwnerId|Идентификатор клиента-владельца 3895 +|Name|Наименование тарифного плана 3896 +|IsArchived|Признак, определяющий архивный тарифный план 3897 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3898 +|PermissibleBalance|Допустимый баланс 3899 +|DefermentDays|Отсрочка, количество дней 3900 +|Feature|Код услуги 3901 +|IsEnabled|Признак, определяющий активирована ли услуга 3902 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3903 +|IsFactual|Признак, определяющий расчёт по факту 3904 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3905 +|Price|Цена за единицу. 3906 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3907 +|PeriodValue|Значение периода. 3908 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3909 + 3910 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3911 + 3912 +(% class="box infomessage" %) 3913 +((( 3914 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3915 +))) 3916 + 3917 +Параметр запроса: **clientId **- идентификатор клиента. 3918 + 3919 +Ответ: 3920 + 3921 +[ 3922 + { 3923 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3924 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3925 + "Name": "string", 3926 + "IsArchived": true, 3927 + "Constraint": { 3928 + "CalculationType": 0, 3929 + "PermissibleBalance": 0, 3930 + "DefermentDays": 0 3931 + }, 3932 + "Features": [ 3933 + { 3934 + "Feature": "string", 3935 + "IsFactual": true, 3936 + "Limit": 0, 3937 + "Price": 0, 3938 + "PeriodValue": 0, 3939 + "PeriodType": 0 3940 + } 3941 + ] 3942 + } 3943 +] 3944 + 3945 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3946 +|ClientId|Идентификатор клиента 3947 +|Id|Идентификатор тарифного плана 3948 +|OwnerId|Идентификатор клиента-владельца 3949 +|Name|Наименование тарифного плана 3950 +|IsArchived|Признак, определяющий архивный тарифный план 3951 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3952 +|PermissibleBalance|Допустимый баланс 3953 +|DefermentDays|Отсрочка, количество дней 3954 +|Feature|Код услуги 3955 +|IsFactual|Признак, определяющий расчёт по факту 3956 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3957 +|Price|Цена за единицу. 3958 +|PeriodValue|Значение периода. 3959 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3960 + 3961 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3962 + 3963 +(% class="box infomessage" %) 3964 +((( 3965 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3966 +))) 3967 + 3968 +Параметр запроса: **clientId **- идентификатор клиента. 3969 + 3970 +Ответ: 3971 + 3972 +[ 3973 + { 3974 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3975 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3976 + "Name": "string", 3977 + "IsArchived": true, 3978 + "Constraint": { 3979 + "CalculationType": 0, 3980 + "PermissibleBalance": 0, 3981 + "DefermentDays": 0 3982 + }, 3983 + "Features": [ 3984 + { 3985 + "Feature": "string", 3986 + "IsFactual": true, 3987 + "Limit": 0, 3988 + "Price": 0, 3989 + "PeriodValue": 0, 3990 + "PeriodType": 0 3991 + } 3992 + ] 3993 + } 3994 +] 3995 + 3996 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3997 +|ClientId|Идентификатор клиента 3998 +|Id|Идентификатор тарифного плана 3999 +|OwnerId|Идентификатор клиента-владельца 4000 +|Name|Наименование тарифного плана 4001 +|IsArchived|Признак, определяющий архивный тарифный план 4002 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4003 +|PermissibleBalance|Допустимый баланс 4004 +|DefermentDays|Отсрочка, количество дней 4005 +|Feature|Код услуги 4006 +|IsFactual|Признак, определяющий расчёт по факту 4007 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4008 +|Price|Цена за единицу. 4009 +|PeriodValue|Значение периода. 4010 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4011 + 4012 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4013 + 4014 +(% class="box warningmessage" %) 4015 +((( 4016 +**PUT /api/v3/Billing/client/balance** 4017 +))) 4018 + 4019 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4020 + 4021 +Тело запроса: 4022 + 4023 +{ 4024 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4025 + "Balance": 0 ~/~/ Значение баланса. 4026 +} 4027 + 4028 +Ответ: Success 4029 + 4030 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4031 + 4032 +(% class="box warningmessage" %) 4033 +((( 4034 +**PUT /api/v3/billing/client/balance/deposit** 4035 +))) 4036 + 4037 +Создает операцию **Пополнение **с указанной суммой 4038 + 4039 +Тело запроса: 4040 + 4041 +((( 4042 +{ 4043 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4044 + "amount": 0 ~/~/ Сумма пополнения баланса 4045 +} 4046 +))) 4047 + 4048 +((( 4049 + 4050 +))) 4051 + 4052 +Ответ: Success 4053 + 4054 +((( 4055 +{ 4056 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4057 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4058 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4059 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4060 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4061 + "Description": "string" ~/~/ Описание корректировки. 4062 +} 4063 +))) 4064 + 4065 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4066 + 4067 +Создает операцию **Списание **с указанной суммой 4068 + 4069 +(% class="box warningmessage" %) 4070 +((( 4071 +**PUT /api/v3/billing/client/balance/withdraw** 4072 +))) 4073 + 4074 +Тело запроса: 4075 + 4076 +((( 4077 +{ 4078 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4079 + "amount": 0 ~/~/ Сумма списания с баланса 4080 +} 4081 +))) 4082 + 4083 +Ответ: Success 4084 + 4085 +((( 4086 +{ 4087 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4088 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4089 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4090 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4091 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4092 + "Description": "string" ~/~/ Описание корректировки 4093 +} 4094 +))) 4095 + 4096 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4097 + 4098 +(% class="box warningmessage" %) 4099 +((( 4100 +**PUT /api/v3/Billing/client/constraint** 4101 +))) 4102 + 4103 +Тело запроса: 4104 + 4105 +((( 4106 +{ 4107 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4108 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4109 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4110 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4111 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4112 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4113 +} 4114 +))) 4115 + 4116 +((( 4117 + 4118 +))) 4119 + 4120 +Ответ: Success 4121 + 4122 +((( 4123 +{ 4124 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4125 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4126 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4127 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4128 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4129 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4130 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4131 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4132 +} 4133 +))) 4134 + 4135 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4136 + 4137 +(% class="box warningmessage" %) 4138 +((( 4139 +**PUT /api/v3/Billing/client/plan** 4140 +))) 4141 + 4142 +Тело запроса: 4143 + 4144 +{ 4145 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4146 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4147 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4148 + { 4149 + "Feature": "string", ~/~/ Код услуги. 4150 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4151 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4152 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4153 + "Price": 0, ~/~/ Цена за единицу. 4154 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4155 + "PeriodValue": 0, ~/~/ Значение периода. 4156 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4157 + } 4158 + ] 4159 +} 4160 + 4161 + 4162 +Ответ: Success 4163 + 4164 +((( 4165 +{ 4166 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4167 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4168 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4169 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4170 + "Name": "string", ~/~/ Наименование. 4171 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4172 + "Constraint": { ~/~/ Ограничения по тарифу 4173 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4174 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4175 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4176 + }, 4177 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4178 + { 4179 + "Feature": "string", ~/~/Код услуги. 4180 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4181 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4182 + "Price": 0, ~/~/ Цена за единицу. 4183 + "PeriodValue": 0, ~/~/ Значение периода. 4184 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4185 + } 4186 + ], 4187 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4188 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4189 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4190 + }, 4191 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4192 + { 4193 + "Feature": "string", ~/~/ Код услуги. 4194 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4195 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4196 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4197 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4198 + "Price": 0, ~/~/ Цена за единицу. 4199 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4200 + "PeriodValue": 0, ~/~/ Значение периода. 4201 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4202 + "Quantity": 0 ~/~/ Количество использования услуги. 4203 + } 4204 + ] 4205 +} 4206 +))) 4207 + 4208 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4209 + 4210 +(% class="box warningmessage" %) 4211 +((( 4212 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4213 +))) 4214 + 4215 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4216 + 4217 +(% class="box infomessage" %) 4218 +((( 4219 +**POST /api/v3/vehicles/import/{agentId}** 4220 +))) 4221 + 4222 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4223 + 4224 +В пути указывается **agentId** - id клиента. 4225 + 4226 +**Заголовок** 4227 + 4228 +**X-Auth: [токен авторизации]** 4229 + 4230 +**Параметры** 4231 + 4232 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4233 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4234 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4235 + 4236 +В теле использовать тип **form-data,** тип значения** file** 4237 + 4238 +**Ключи** 4239 + 4240 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4241 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4242 +|csv|В значении передаем файл датчиков, формат **csv** 4243 + 4244 +Ответ: 4245 + 4246 +{ 4247 + "vehicleId": 0, 4248 + "name": "string", 4249 + "errors": ["string"] 4250 +} 4251 + 4252 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4253 +|vehicleId|ID созданного объекта 4254 +|name|Имя созданного объекта 4255 +|errors|Ошибки и их описание 4256 + 4257 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4258 + 4259 +(% class="box infomessage" %) 4260 +((( 4261 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4262 +))) 4263 + 4264 +(% class="wikigeneratedid" %) 4265 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4266 + 4267 +(% class="wikigeneratedid" %) 4268 +В пути указывается **vehicleId **- id объекта. 4269 + 4270 +**Заголовок** 4271 + 4272 +**X-Auth: [токен авторизации]** 4273 + 4274 +В теле использовать тип **form-data.** 4275 + 4276 +Ключи: 4277 + 4278 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4279 +|**history**|В значении передавать файл с историей 4280 + 4281 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4282 + 4283 +Ответ: 4284 + 4285 +{ 4286 + "results": [ 4287 + { 4288 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4289 + "vehicleId": 0, 4290 + "errors": [ 4291 + "string" 4292 + ], 4293 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4294 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4295 + "producedCount": 0, 4296 + "msgCount": 0 4297 + } 4298 + ] 4299 +} 4300 + 4301 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4302 +|results|Результаты импорта в разрезе ТС 4303 +|vehicleGuid|Guid ТС 4304 +|vehicleId|ID ТС 4305 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4306 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4307 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4308 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4309 +|msgCount|Кол-во обработанных сообщений всего 4310 + 4311 +== **Импортировать историю ТС (Асинхронный запрос)** == 4312 + 4313 +(% class="box successmessage" %) 4314 +((( 4315 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4316 +))) 4317 + 4318 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4319 + 4320 +Метод запроса: **POST** 4321 + 4322 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4323 + 4324 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4325 + 4326 + 4327 +Ответ: 4328 + 4329 +{ 4330 + 4331 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4332 + 4333 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4334 + 4335 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4336 + 4337 + "Message": "string", ~/~/ Информация о выполнении запроса 4338 + 4339 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4340 + 4341 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4342 + 4343 + "Data": "string" ~/~/ Данные 4344 + 4345 +} 4346 + 4347 + 4348 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4349 + 4350 +(% class="box infomessage" %) 4351 +((( 4352 +**GET /api/v3/vehicles/import/history/status** 4353 +))) 4354 + 4355 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4356 + 4357 +Ответ: 4358 + 4359 +{ 4360 + "activity": true, 4361 + "progress": 0, 4362 + "message": "string" 4363 +} 4364 + 4365 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4366 +**Параметр** 4367 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4368 +**Описание** 4369 +))) 4370 +|((( 4371 +activity 4372 +)))|((( 4373 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4374 +))) 4375 +|((( 4376 +progress 4377 +)))|((( 4378 +Guid ТС 4379 +))) 4380 + 4381 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4382 + 4383 +(% class="box infomessage" %) 4384 +((( 4385 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4386 +))) 4387 + 4388 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4389 + 4390 +Метод запроса: **GET** 4391 + 4392 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4393 + 4394 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4395 + 4396 + 4397 +Ответ: 4398 + 4399 +{ 4400 + 4401 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4402 + 4403 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4404 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4405 + 4406 + "Message": "string", ~/~/ Информация о выполнении запроса 4407 + 4408 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4409 + 4410 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4411 + 4412 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4413 + 4414 + "Data": "string" ~/~/ Данные 4415 + 4416 +} 4417 + 4418 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4419 + 4420 +(% class="box infomessage" %) 4421 +((( 4422 +**POST /api/v3/vehicles/export** 4423 +))) 4424 + 4425 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4426 + 4427 +Тело запроса: 4428 + 4429 +[ 4430 + id 4431 +] 4432 + 4433 +Ответ: Success 200, получаете файлы с настройками. 4434 + 4435 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4436 + 4437 +(% class="box infomessage" %) 4438 +((( 4439 +**POST /api/v3/vehicles/export/history** 4440 +))) 4441 + 4442 +Метод возвращает список сообщений терминала объекта за выбранный период. 4443 + 4444 +Тело запроса: 4445 + 4446 +{ 4447 + "vehicleId": 0, 4448 + "asArchive": true, 4449 + "from": "2023-09-27T12:17:45.973Z", 4450 + "to": "2023-09-27T12:17:45.973Z" 4451 +} 4452 + 4453 +Ответ: 4454 + 4455 +Получаете файл. Сообщение: Code 200/Success 4456 + 4457 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4458 +|vehicleId|ID объекта 4459 +|asArchive|true - Архивировать файл, False - не архивировать 4460 +|from|Дата и время начала запроса 4461 +|to|Дата и время окончания запроса 4462 + 4463 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4464 + 4465 +(% class="box infomessage" %) 4466 +((( 4467 +**GET /api/v3/vehicles/export/history/status** 4468 +))) 4469 + 4470 +Метод возвращает список сообщений терминала объекта за выбранный период. 4471 + 4472 +Ответ: 4473 + 4474 +{ 4475 + "activity": true, 4476 + "progress": 0, 4477 + "message": "string" 4478 +} 4479 + 4480 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4481 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4482 +|progress|Прогресс экспорта, от 0 до 100% 4483 +|message|Текст описывающий статус 4484 + 4485 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4486 + 4487 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4488 + 4489 +(% class="box infomessage" %) 4490 +((( 4491 +**POST /api/v3/EcoDriving/rating** 4492 +))) 4493 + 4494 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4495 + 4496 +Тело запроса: 4497 + 4498 +{ 4499 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4500 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4501 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4502 +} 4503 + 4504 +Ответ: 4505 + 4506 +{ 4507 + "items": [ ~/~/ Список в разрезе ТС 4508 + { 4509 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4510 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4511 + "vehicleId": 0, ~/~/ ID ТС 4512 + "vehicleName": "string", ~/~/ Название ТС 4513 + "vehicleModel": "string", ~/~/ Модель ТС 4514 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4515 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4516 + "totalViolations": 0, ~/~/ Нарушений всего 4517 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4518 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4519 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4520 + "brakingViolations": 0, ~/~/ Нарушений торможения 4521 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4522 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4523 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4524 + }, 4525 + 4526 +((( 4527 + 4528 +))) 4529 + 4530 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4531 + "mileage": 0, ~/~/ Пробег, м 4532 + "tripsCount": 0, ~/~/ Кол-во рейсов 4533 + "trips": [ ~/~/ Информация по рейсу 4534 + { 4535 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4536 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4537 + "violationsCount": 0, ~/~/ Всего нарушений 4538 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4539 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4540 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4541 + "brakingViolations": 0, ~/~/ Нарушений торможения 4542 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4543 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4544 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4545 + }, 4546 + 4547 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4548 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4549 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4550 + "mileage": 0, ~/~/ Пробег, м 4551 + "motohours": 0, ~/~/ Моточасы, секунды 4552 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4553 + "startAddress": "string", ~/~/ Адрес начала рейса 4554 + "endAddress": "string", ~/~/ Адрес конца рейса 4555 + "drivers": [ ~/~/ Список водителей 4556 + { 4557 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4558 + "driverName": "string", ~/~/ФИО водителя 4559 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4560 + } 4561 + ] 4562 + } 4563 + ] 4564 + } 4565 + ] 4566 +} 4567 + 4568 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4569 + 4570 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4571 + 4572 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4573 + 4574 +(% class="box infomessage" %) 4575 +((( 4576 +**POST /api/v3/fuelcards/transactions** 4577 +))) 4578 + 4579 +Метод запроса: POST 4580 + 4581 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4582 +\\В заголовках запроса: X-Auth: Токен авторизации 4583 + 4584 +Параметры в теле запроса (JSON): 4585 + 4586 +{ 4587 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4588 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4589 + "ids": [ 4590 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4591 + ], 4592 + "timezone": 0 ~/~/ Часовой пояс 4593 +} 4594 + 4595 + 4596 +Ответ: 4597 + { 4598 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4599 + "driver": "string", ~/~/ Водители, привязанные к ТК 4600 + "object": "string", ~/~/ Наименование ТС 4601 + "amount": 0, ~/~/ Количество топлива 4602 + "amountDut": 0, ~/~/ Количество по ДУТ 4603 + "amountDiff": 0, ~/~/ Разница, л 4604 + "amountDiffPerc": 0, ~/~/ Разница, % 4605 + "summa": 0, ~/~/ Стоимость, руб 4606 + "serviceName": "string", ~/~/ Тип топлива 4607 + "price": 0, ~/~/ Цена за литр, руб 4608 + "cardName": "string", ~/~/ Наименование ТК 4609 + "cardNum": "string", ~/~/ Номер ТК 4610 + "operator": "string", ~/~/ Оператор ТК 4611 + "address": "string" ~/~/ Адрес АЗС 4612 + } 4613 + 4614 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4615 + 4616 +(% class="box infomessage" %) 4617 +((( 4618 +**GET /api/v3/fuelcards** 4619 +))) 4620 + 4621 +Метод запроса: GET 4622 + 4623 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4624 + 4625 +Ответ: 4626 + 4627 +[ 4628 + { 4629 + "Name": "string", ~/~/ Определяет наименование карты. 4630 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4631 + "Number": "string", ~/~/ Определяет № карты. 4632 + "Enabled": true, ~/~/ Определяет признак активности карты. 4633 + "Description": "string", ~/~/ Определяет описание карты. 4634 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4635 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4636 + "deleted": true ~/~/ Признак удаления 4637 + } 4638 +] 4639 + 4640 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4641 + 4642 + 4643 +== **Получение полных данных о ретрансляторе** == 4644 + 4645 +(% class="box infomessage" %) 4646 +((( 4647 +**GET ** **/api/v3/retranslations/{id}** 4648 +))) 4649 + 4650 +id - Идентификатор ретранслятора 4651 + 4652 + 4653 +Пример ответа: 4654 + 4655 +{ 4656 +"description": "", ~/~/ Поле описания ретранслятора 4657 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4658 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4659 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4660 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4661 +"objects": [ ~/~/ Объекты для ретрансляции 4662 +{ 4663 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4664 +"name": "", ~/~/ Наименование объекта ретрансляции 4665 +"imei": "", ~/~/ IMEI объекта ретрансляции 4666 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4667 +} 4668 + ], 4669 +"id": "", ~/~/ Идентификатор ретранслятора 4670 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4671 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4672 +} 4673 + 4674 + 4675 +== **Удаление данных ретранслятора** == 4676 + 4677 +(% class="box infomessage" %) 4678 +((( 4679 +**DELETE** **/api/v3/retranslations/{id}** 4680 +))) 4681 + 4682 +id - Идентификатор ретранслятора 4683 + 4684 + 4685 +== **Создание ретранслятора** == 4686 + 4687 +(% class="box infomessage" %) 4688 +((( 4689 +**POST ** **/api/v3/retranslations/{id}** 4690 +))) 4691 + 4692 +Запрос: 4693 + 4694 +{ 4695 +"description": "", ~/~/ Поле описания ретранслятора 4696 +"subscriberId": "", ~/~/ Идентификатор подписчика 4697 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4698 +"address": "", ~/~/ Адрес и порт принимающего сервера 4699 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4700 +"objects": [ ~/~/Объекты для ретрансляции 4701 +{ 4702 +"id": "", ~/~/ Идентификатор ретранслятора 4703 +"imei": "", ~/~/ IMEI объекта ретрансляции 4704 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4705 +} 4706 + ] 4707 +} 4708 + 4709 + 4710 +Ответ: 4711 + 4712 +{ 4713 +"description": "", ~/~/ Поле описания ретранслятора 4714 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4715 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4716 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4717 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4718 +"objects": [ ~/~/ Объекты для ретрансляции 4719 +{ 4720 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4721 +"name": "string", ~/~/ Наименование объекта ретрансляции 4722 +"imei": "", ~/~/ IMEI объекта ретрансляции 4723 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4724 +} 4725 + ], 4726 +"id": "", ~/~/ Идентификатор ретранслятора 4727 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4728 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4729 +} 4730 + 4731 + 4732 +== **Редактирование ретранслятора** == 4733 + 4734 +(% class="box infomessage" %) 4735 +((( 4736 +**PUT** **/api/v3/retranslations** 4737 +))) 4738 + 4739 +Пример запроса: 4740 + 4741 +{ 4742 +"id": "", ~/~/ Идентификатор ретранслятора 4743 +"description": "string", ~/~/ Поле описания ретранслятора 4744 +"subscriberId": "", ~/~/ Идентификатор подписчика 4745 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4746 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4747 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4748 +"objects": ~/~/ Объекты для ретрансляции 4749 +[ 4750 +{ 4751 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4752 +"imei": "", ~/~/ IMEI объекта ретрансляции 4753 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4754 +} 4755 + ] 4756 +} 4757 + 4758 + 4759 +Пример ответа: 4760 + 4761 +{ 4762 +"description": "", ~/~/ Поле описания ретранслятора 4763 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4764 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4765 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4766 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4767 +"objects": [ ~/~/ Объекты для ретрансляции 4768 +{ 4769 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4770 +"name": "string", ~/~/ Наименование объекта ретрансляции 4771 +"imei": "", ~/~/ IMEI объекта ретрансляции 4772 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4773 +} 4774 + ], 4775 +"id": "", ~/~/ Идентификатор ретранслятора 4776 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4777 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4778 +} 4779 + 4780 + 4781 +== **Получение списка ретранслятора клиента** == 4782 + 4783 +(% class="box infomessage" %) 4784 +((( 4785 +**POST /api/v3/retranslations/find** 4786 +))) 4787 + 4788 +Пример запроса: 4789 + 4790 +{ 4791 +"id": "", ~/~/ Идентификатор ретранслятора 4792 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4793 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4794 +} 4795 + 4796 +Ответ: 4797 + 4798 +[ 4799 +{ 4800 +"description": "", ~/~/ Поле описания ретранслятора 4801 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4802 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4803 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4804 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4805 +"id": "", ~/~/ Идентификатор ретранслятора 4806 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4807 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4808 +} 4809 +] 4810 + 4811 + 4812 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4813 + 4814 +== **API для отчета по выгрузке комбайнов** == 4815 + 4816 +(% class="box infomessage" %) 4817 +((( 4818 +**POST /api/v3/Reports/harvesterUnloading** 4819 +))) 4820 + 4821 +Пример запроса: 4822 + 4823 +{ 4824 + "byTime": 0, ~/~/ Объединение событий по времени 4825 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4826 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4827 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4828 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4829 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4830 + 0 4831 + ], 4832 + "from": "", ~/~/ Дата и время начало запроса 4833 + "to": "", ~/~/ Дата и время окончания запроса 4834 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4835 +} 4836 + 4837 +Пример ответа: 4838 + 4839 +[ 4840 + { 4841 + "harvesterName": "", ~/~/Комбайн, номер 4842 + "harvesterId": 0, ~/~/Комбайн, id 4843 +"harvesterModel": "", ~/~/ Модель комбайна 4844 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4845 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4846 + "events": [ ~/~/Список событий в разрезе комбайна 4847 + { 4848 + "driverId": "", ~/~/Идентификатор водителя 4849 + "driverName": "", ~/~/Водитель комбайна, ФИО 4850 + "RFID": "", ~/~/ идентификатор карты-метки 4851 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4852 + "vehicleId": 0, ~/~/идентификатор объекта 4853 + "vehicleName": "string", ~/~/ Имя объекта 4854 + "modelName": "string", ~/~/ Имя модели объекта 4855 + "nearestVehicles": [ ~/~/Объекты рядом 4856 + { 4857 + "vehicleId": 0, ~/~/идентификатор объекта 4858 + "vehicleName": "string" ~/~/ Имя объекта 4859 + } 4860 + ], 4861 + "fields": [ ~/~/Поля, где происходила выгрузка 4862 + { 4863 + "id": 0, ~/~/ идентификатор пользователя 4864 + "name": "string" ~/~/ имя пользователя 4865 + } 4866 + ], 4867 + "event": "string", ~/~/Событие 4868 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4869 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4870 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4871 + "cultureName": "string", ~/~/ название культуры 4872 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4873 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4874 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4875 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4876 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4877 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4878 + "issued": 0, ~/~/Выдано, бункеров 4879 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4880 + "latitude": 0, ~/~/Широта 4881 + "longitude": 0, ~/~/ Долгота 4882 + "litresAway": 0, ~/~/Отдано, л 4883 + "m3Away": 0 ~/~/Отдано, м3 4884 + } 4885 + ] 4886 + } 4887 +] 4888 + 4889 + 4890 +== **Отчет трек-датчики** == 4891 + 4892 +(% class="box infomessage" %) 4893 +((( 4894 +**POST /api/v3/Reports/sensorsWorks** 4895 +))) 4896 + 4897 +**Пример запроса:** 4898 + 4899 +{ 4900 + "vehicleIds": [ ~/~/ Список ID объектов 4901 + 0 4902 + ], 4903 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4904 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4905 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4906 +} 4907 + 4908 +**Пример ответа:** 4909 + 4910 +((( 4911 +{ 4912 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4913 + { 4914 + "vehicleId": 0, ~/~/ Идентификатор ТС 4915 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4916 + { 4917 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4918 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4919 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4920 + "name": "string", ~/~/ Наименование оборудования. 4921 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4922 + "totalMileage": 0, ~/~/ Общий пробег. 4923 + "avgSpeed": 0 ~/~/ Средняя скорость. 4924 + } 4925 + ] 4926 + } 4927 + ] 4928 +} 4929 + 4930 + 4931 +== **Превышение скорости** == 4932 + 4933 +(% class="box infomessage" %) 4934 +((( 4935 +**POST /api/v3/Reports/overSpeedDuration** 4936 +))) 4937 + 4938 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4939 + 4940 +Пример запроса: 4941 + 4942 +((( 4943 +{ 4944 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4945 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4946 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4947 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4948 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4949 +} 4950 +))) 4951 + 4952 +((( 4953 + 4954 +))) 4955 + 4956 +((( 4957 +Пример ответа: 4958 +))) 4959 + 4960 +((( 4961 +((( 4962 +[ 4963 + { 4964 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4965 + "duration": 0, ~/~/ Продолжительность события в секундах 4966 + "maxSpeed": 0, ~/~/ Максимальная скорость 4967 + "speedLimit": 0 ~/~/ Ограничение скорости 4968 + } 4969 +] 4970 +))) 4971 +))) 4972 +))) 4973 + 4974 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4975 + 4976 + 4977 +== **Запрос списка полей** == 4978 + 4979 +(% class="box successmessage" %) 4980 +((( 4981 +**POST /api/v3/agroLands/find** 4982 +))) 4983 + 4984 +Пример запроса: 4985 + 4986 +((( 4987 +((( 4988 +((( 4989 +{ 4990 + "year": 0, ~/~/ Фильтр по году 4991 + "name": "string", ~/~/ Фильтр по названию 4992 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4993 +} 4994 +))) 4995 +))) 4996 + 4997 + 4998 +))) 4999 + 5000 +Пример ответа: 5001 + 5002 +((( 5003 +[ 5004 + { 5005 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5006 + "year": 0, ~/~/ Год поля 5007 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5008 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5009 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5010 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5011 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5012 + "counts": { ~/~/ Счётчики с/х поля 5013 + "fieldOperations": 0, ~/~/ Количество операций на поле 5014 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5015 + "facts": 0 ~/~/ Счётчик факта 5016 + }, 5017 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5018 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5019 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5020 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5021 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5022 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5023 + "planComment": "string", ~/~/ Комментарий к полю 5024 + "productivity": 0, ~/~/ Урожайность. 5025 + "id": 0, ~/~/ Идентификатор объекта геозоны 5026 + "name": "string", ~/~/ Название объекта геозоны 5027 + "type": 0, ~/~/ Тип объекта геозоны 5028 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5029 + "fname": "string", ~/~/ Имя файла 5030 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5031 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5032 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5033 + "description": "string", ~/~/ Описание объекта геозоны 5034 + "area": 0, ~/~/ Площадь, м2 5035 + "perimetr": 0, ~/~/ Периметр, м 5036 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5037 + } 5038 +] 5039 + 5040 + 5041 +== **Создание нового поля ** == 5042 + 5043 +(% class="box successmessage" %) 5044 +((( 5045 +**POST /api/v3/agroLands** 5046 +))) 5047 + 5048 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5049 +X-agent - ID клиента 5050 + 5051 +Пример запроса: 5052 + 5053 +((( 5054 +{ 5055 + "extId": "string", 5056 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5057 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5058 + "display": "string", ~/~/ Настройки отображения 5059 + "year": 0, ~/~/ Год поля 5060 + "name": "string", ~/~/ Наименование 5061 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5062 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5063 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5064 + "planComment": "string", ~/~/ Комментарий к полю 5065 + "cropRotations": [ ~/~/ Данные по севообороту 5066 + { 5067 + "landId": 0, ~/~/ ID поля 5068 + "landName": "string", ~/~/ Название поля 5069 + "year": 0, ~/~/ Год урожая 5070 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5071 + "cultureName": "string", ~/~/ Название культуры 5072 + "productivity": 0, ~/~/ Урожайность 5073 + "area": 0, ~/~/ Площадь поля, Га 5074 + "total": 0, ~/~/ Валовый сбор 5075 + "productivityFact": 0, ~/~/ Фактическая урожайность 5076 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5077 + "totalFact": 0, ~/~/ Фактический валовый сбор 5078 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5079 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5080 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5081 + "isyearplan": true, ~/~/ Годовой план 5082 + "comment": "string" ~/~/ Комментарий 5083 + } 5084 + ] 5085 +} 5086 +))) 5087 + 5088 +((( 5089 + 5090 +))) 5091 + 5092 +Пример ответа: 5093 + 5094 +((( 5095 +((( 5096 +{ 5097 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5098 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5099 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5100 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5101 + "cropRotations": [ ~/~/ Данные по севообороту 5102 + { 5103 + "landId": 0, ~/~/ ID поля 5104 + "landName": "string", ~/~/ Название поля 5105 + "year": 0, ~/~/ Год урожая 5106 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5107 + "cultureName": "string", ~/~/ Название культуры 5108 + "productivity": 0, ~/~/ Урожайность 5109 + "area": 0, ~/~/ Площадь поля, Га. 5110 + "total": 0, ~/~/ Валовый сбор 5111 + "productivityFact": 0, ~/~/ Фактическая урожайность 5112 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5113 + "totalFact": 0, ~/~/ Фактический валовый сбор 5114 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5115 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5116 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5117 + "isyearplan": true, ~/~/ годовой план 5118 + "comment": "string" ~/~/ Комментарий 5119 + } 5120 + ], 5121 + "cropVegetation": [ ~/~/ История вегетации поля 5122 + { 5123 + "values": [ ~/~/ Данные вегетации и состояния посева 5124 + { 5125 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5126 + "ndvi": 0 ~/~/ Индекс вегетации 5127 + } 5128 + ], 5129 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5130 + { 5131 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5132 + "type": "string", ~/~/ Тип 5133 + "pictureid": "string" ~/~/ Идентификатор ресурса 5134 + } 5135 + ], 5136 + "states": [ ~/~/ Ключевые даты развития поля 5137 + { 5138 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5139 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5140 + } 5141 + ] 5142 + } 5143 + ], 5144 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5145 + "counts": { 5146 + "fieldOperations": 0, ~/~/ Количество операций на поле 5147 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5148 + "facts": 0 ~/~/ Счётчик факта 5149 + }, 5150 + "planComment": "string", ~/~/ Комментарий к полю 5151 +))) 5152 + 5153 +((( 5154 + "productivity": 0, ~/~/ Урожайность. 5155 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5156 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5157 + "year": 0, ~/~/ Год поля 5158 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5159 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5160 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5161 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5162 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5163 + "id": 0, ~/~/ Идентификатор объекта геозоны 5164 + "name": "string", ~/~/ Название объекта геозоны 5165 + "type": 0, ~/~/ Тип объекта геозоны 5166 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5167 + "fname": "string", ~/~/ Имя файла 5168 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5169 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5170 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5171 + "description": "string", ~/~/ Описание объекта геозоны 5172 + "area": 0, ~/~/ Площадь, м2 5173 + "perimetr": 0, ~/~/ Периметр, м 5174 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5175 +} 5176 + 5177 + 5178 +))) 5179 +))) 5180 +))) 5181 + 5182 +== **Получение поля по id** == 5183 + 5184 +(% class="box infomessage" %) 5185 +((( 5186 +**GET /api/v3/agroLands/{id}** 5187 +))) 5188 + 5189 +Пример запроса: 5190 +id ~/~/ Идентификатор поля 5191 + 5192 +Пример ответа: 5193 + 5194 +((( 5195 +{ 5196 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5197 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5198 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5199 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5200 + "cropRotations": [ ~/~/ Данные по севообороту 5201 + { 5202 + "landId": 0, ~/~/ ID поля 5203 + "landName": "string", ~/~/ Название поля 5204 + "year": 0, ~/~/ Год урожая 5205 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5206 + "cultureName": "string", ~/~/ Название культуры 5207 + "productivity": 0, ~/~/ Урожайность 5208 + "area": 0, ~/~/ Площадь поля, Га 5209 + "total": 0, ~/~/ Валовый сбор 5210 + "productivityFact": 0, ~/~/ Фактическая урожайность 5211 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5212 + "totalFact": 0, ~/~/ Фактический валовый сбор 5213 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5214 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5215 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5216 + "isyearplan": true, ~/~/ План года 5217 + "comment": "string" ~/~/ Комментарий 5218 + } 5219 + ], 5220 + "cropVegetation": [ ~/~/ История вегетации поля 5221 + { 5222 + "values": [ ~/~/ Данные вегетации и состояния посева 5223 + { 5224 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5225 + "ndvi": 0 ~/~/ Индекс вегетации 5226 + } 5227 + ], 5228 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5229 + { 5230 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5231 + "type": "string", ~/~/ Тип 5232 + "pictureid": "string" ~/~/ Идентификатор ресурса 5233 + } 5234 + ], 5235 + "states": [ ~/~/ Ключевые даты развития поля 5236 + { 5237 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5238 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5239 + } 5240 + ] 5241 + } 5242 + ], 5243 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5244 + "counts": { 5245 + "fieldOperations": 0, ~/~/ Количество операций на поле 5246 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5247 + "facts": 0 ~/~/ Счётчик факта 5248 + }, 5249 + "planComment": "string", ~/~/ Комментарий к полю 5250 + "productivity": 0, ~/~/ Урожайность. 5251 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5252 +))) 5253 + 5254 +((( 5255 +((( 5256 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5257 + "year": 0, ~/~/ Год поля 5258 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5259 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5260 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5261 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5262 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5263 + "id": 0, ~/~/ Идентификатор объекта геозоны 5264 + "name": "string", ~/~/ Название объекта геозоны 5265 + "type": 0, ~/~/ Тип объекта геозоны 5266 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5267 + "fname": "string", ~/~/ Имя файла 5268 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5269 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5270 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5271 + "description": "string", ~/~/ Описание объекта геозоны 5272 + "area": 0, ~/~/ Площадь, м2 5273 + "perimetr": 0, ~/~/ Периметр, м 5274 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5275 +} 5276 +))) 5277 + 5278 + 5279 +((( 5280 +((( 5281 +((( 5282 +== **Изменение поля** == 5283 + 5284 +(% class="box infomessage" %) 5285 +((( 5286 +**PUT /api/v3/agroLands** 5287 +))) 5288 + 5289 +Пример запроса: 5290 + 5291 +((( 5292 +((( 5293 +{ 5294 + "id": 0, ~/~/ Идентификатор поля 5295 + "extId": "string", ~/~/ ExtId 5296 + "shape": "string", ~/~/ Форма поля 5297 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5298 + "display": "string", ~/~/ Настройки отображения 5299 + "year": 0, ~/~/ Год поля 5300 + "name": "string", ~/~/ Наименование 5301 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5302 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5303 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5304 + "planComment": "string", ~/~/Комментарий к полю 5305 + "cropRotations": [ ~/~/ Данные по севообороту 5306 + { 5307 + "landId": 0, ~/~/ ID поля 5308 + "landName": "string", ~/~/ Название поля 5309 + "year": 0, ~/~/ Год урожая 5310 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5311 + "cultureName": "string", ~/~/ Название культуры 5312 + "productivity": 0, ~/~/ Урожайность 5313 + "area": 0, ~/~/ Площадь поля, Га. 5314 + "total": 0, ~/~/ Валовый сбор 5315 + "productivityFact": 0, ~/~/ Фактическая урожайность 5316 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5317 + "totalFact": 0, ~/~/ Фактический валовый сбор 5318 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5319 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5320 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5321 + "isyearplan": true, 5322 + "comment": "string" ~/~/ Комментарий 5323 + } 5324 + ], 5325 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5326 +} 5327 +))) 5328 +))) 5329 + 5330 +((( 5331 + 5332 +))) 5333 + 5334 +Пример ответа: 5335 + 5336 +((( 5337 +((( 5338 +((( 5339 +{ 5340 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5341 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5342 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5343 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5344 + "cropRotations": [ ~/~/ Данные по севообороту 5345 + { 5346 + "landId": 0, ~/~/ ID поля 5347 + "landName": "string", ~/~/ Название поля 5348 + "year": 0, ~/~/ Год урожая 5349 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5350 + "cultureName": "string", ~/~/ Название культуры 5351 + "productivity": 0, ~/~/ Урожайность 5352 + "area": 0, ~/~/ Площадь поля, Га 5353 + "total": 0, ~/~/ Валовый сбор 5354 + "productivityFact": 0, ~/~/ Фактическая урожайность 5355 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5356 + "totalFact": 0, ~/~/ Фактический валовый сбор 5357 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5358 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5359 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5360 + "isyearplan": true, ~/~/ 5361 + "comment": "string" ~/~/ Комментарий 5362 + } 5363 + ], 5364 + "cropVegetation": [ ~/~/ История вегетации поля 5365 + { 5366 + "values": [ ~/~/ Данные вегетации и состояния посева 5367 + { 5368 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5369 + "ndvi": 0 ~/~/ Индекс вегетации 5370 + } 5371 + ], 5372 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5373 + { 5374 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5375 + "type": "string", ~/~/ Тип 5376 + "pictureid": "string" ~/~/ Идентификатор ресурса 5377 + } 5378 + ], 5379 + "states": [ ~/~/ Ключевые даты развития поля 5380 + { 5381 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5382 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5383 + } 5384 + ] 5385 + } 5386 + ], 5387 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5388 + "counts": { 5389 + "fieldOperations": 0, ~/~/ Количество операций на поле 5390 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5391 + "facts": 0 ~/~/ Счётчик факта 5392 + }, 5393 + "planComment": "string", ~/~/ Комментарий к полю 5394 + "productivity": 0, ~/~/ Урожайность. 5395 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5396 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5397 + "year": 0, ~/~/ Год поля 5398 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5399 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5400 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5401 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5402 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5403 + "id": 0, ~/~/ Идентификатор объекта геозоны 5404 + "name": "string", ~/~/ Название объекта геозоны 5405 + "type": 0, ~/~/ Тип объекта геозоны 5406 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5407 + "fname": "string", ~/~/ Имя файла 5408 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5409 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5410 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5411 + "description": "string", ~/~/ Описание объекта геозоны 5412 + "area": 0, ~/~/ Площадь, м2 5413 + "perimetr": 0, ~/~/ Периметр, м 5414 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5415 +} 5416 +))) 5417 +))) 5418 +))) 5419 +))) 5420 +))) 5421 + 5422 + 5423 +== **Редактирование года урожая ** == 5424 + 5425 +(% class="box successmessage" %) 5426 +((( 5427 +**POST /api/v3/agroLands/updateOpenCloseYear** 5428 +))) 5429 + 5430 +Пример запроса: 5431 + 5432 +((( 5433 +((( 5434 +{ 5435 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5436 + 0 5437 + ], 5438 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5439 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5440 +} 5441 +))) 5442 + 5443 + 5444 +))) 5445 + 5446 +Пример ответа: 5447 + 5448 +((( 5449 +((( 5450 +{ 5451 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5452 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5453 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5454 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5455 + "cropRotations": [ ~/~/ Данные по севообороту 5456 + { 5457 + "landId": 0, ~/~/ ID поля 5458 + "landName": "string", ~/~/ Название поля 5459 + "year": 0, ~/~/ Год урожая 5460 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5461 + "cultureName": "string", ~/~/ Название культуры 5462 + "productivity": 0, ~/~/ Урожайность 5463 + "area": 0, ~/~/ Площадь поля, Га. 5464 + "total": 0, ~/~/ Валовый сбор 5465 + "productivityFact": 0, ~/~/ Фактическая урожайность 5466 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5467 + "totalFact": 0, ~/~/ Фактический валовый сбор 5468 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5469 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5470 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5471 + "isyearplan": true, ~/~/ 5472 + "comment": "string" ~/~/ Комментарий 5473 + } 5474 + ], 5475 + "cropVegetation": [ ~/~/ История вегетации поля 5476 + { 5477 + "values": [ ~/~/ Данные вегетации и состояния посева 5478 + { 5479 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5480 + "ndvi": 0 ~/~/ Индекс вегетации 5481 + } 5482 + ], 5483 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5484 + { 5485 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5486 + "type": "string", ~/~/ Тип 5487 + "pictureid": "string" ~/~/ Идентификатор ресурса 5488 + } 5489 + ], 5490 + "states": [ ~/~/ Ключевые даты развития поля 5491 + { 5492 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5493 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5494 + } 5495 + ] 5496 + } 5497 + ], 5498 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5499 + "counts": { 5500 + "fieldOperations": 0, ~/~/ Количество операций на поле 5501 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5502 + "facts": 0 ~/~/ Счётчик факта 5503 + }, 5504 + "planComment": "string", ~/~/ Комментарий к полю 5505 + "productivity": 0, ~/~/ Урожайность. 5506 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5507 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5508 + "year": 0, ~/~/ Год поля 5509 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5510 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5511 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5512 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5513 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5514 + "id": 0, ~/~/ Идентификатор объекта геозоны 5515 + "name": "string", ~/~/ Название объекта геозоны 5516 + "type": 0, ~/~/ Тип объекта геозоны 5517 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5518 + "fname": "string", ~/~/ Имя файла 5519 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5520 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5521 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5522 + "description": "string", ~/~/ Описание объекта геозоны 5523 + "area": 0, ~/~/ Площадь, м2 5524 + "perimetr": 0, ~/~/ ериметр, м 5525 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5526 +} 5527 + 5528 + 5529 +== **Какие поля посещал объект** == 5530 + 5531 +(% class="box successmessage" %) 5532 +((( 5533 +**POST /api/v3/agroLands/visitingByVehicle** 5534 +))) 5535 + 5536 +Пример запроса: 5537 + 5538 +{ 5539 + "vehicleId": 0, ~/~/ id объекта 5540 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5541 + "byTime": 0, ~/~/ Объединение событий по времени 5542 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5543 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5544 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5545 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5546 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5547 +} 5548 + 5549 +Пример ответа: 5550 + 5551 +[ 5552 + { 5553 + "fieldId": 0, ~/~/ id объекта 5554 + "vehicleName": "string", ~/~/ Наименование объекта 5555 + "fieldName": "string", ~/~/ Наименование поля 5556 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5557 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5558 + "vehicleId": 0, ~/~/ Идентификатор ТС 5559 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5560 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5561 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5562 + "mileage": 0 ~/~/ Пробег 5563 + } 5564 +] 5565 +))) 5566 + 5567 + 5568 +== **Посещение поля объектами ** == 5569 + 5570 +(% class="box successmessage" %) 5571 +((( 5572 +**POST /api/v3/agroLands/visitingByField** 5573 +))) 5574 + 5575 +Пример запроса: 5576 +{ 5577 + "fieldId": 0, ~/~/ ID поля 5578 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5579 + "byTime": 0, ~/~/ Объединение событий по времени 5580 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5581 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5582 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5583 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5584 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5585 +} 5586 + 5587 +Пример ответа: 5588 + 5589 +[ 5590 + { 5591 + "fieldId": 0, ~/~/ ID поля 5592 + "vehicleName": "string", ~/~/ Наименование объекта 5593 + "fieldName": "string", ~/~/ Имя поля 5594 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5595 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5596 + "vehicleId": 0, ~/~/ Идентификатор ТС 5597 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5598 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5599 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5600 + "mileage": 0 ~/~/ Пробег 5601 + } 5602 +] 5603 + 5604 + 5605 +== **Удаление существующего поля** == 5606 + 5607 +(% class="box errormessage" %) 5608 +((( 5609 +**DELETE /api/v3/agroLands/{id}** 5610 +))) 5611 + 5612 +Пример запроса: 5613 +id ~/~/ Идентификатор поля 5614 + 5615 +Пример ответа: 5616 + 5617 +((( 5618 +200 ~/~/ Успех 5619 + 5620 + 5621 +))) 5622 + 5623 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5624 +))) 5625 +))) 5626 +))) 5627 + 5628 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5629 + 5630 + 5631 +(% class="box infomessage" %) 5632 +((( 5633 +**GET api/v3/Vehicles/recyclebin/all** 5634 +))) 5635 + 5636 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5637 + 5638 +Параметр запроса: {parentId} - идентификатор агента 5639 + 5640 +В заголовках запроса: X-Auth: Токен авторизации 5641 + 5642 +Ответ: 5643 + 5644 +[ 5645 + { 5646 + "recordTime": "", ~/~/Время записи 5647 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5648 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5649 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5650 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5651 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5652 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5653 + "items": [ ~/~/ 5654 +nullable: true ~/~/Детали 5655 + { 5656 + "name": "string", ~/~/наименование столбца 5657 + "value": "string" ~/~/содержание столбца 5658 + } 5659 + ] 5660 + }, 5661 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5662 + "string" 5663 + ] 5664 + } 5665 +] 5666 + 5667 + 5668 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5669 + 5670 +(% class="box infomessage" %) 5671 +((( 5672 +**POST api/v3/Vehicles/recyclebin/erase** 5673 +))) 5674 + 5675 +В заголовках запроса: X-Auth: Токен авторизации 5676 + 5677 +Пример запроса: 5678 + 5679 +[ 5680 +0 5681 +] 5682 + 5683 + 5684 +Пример ответа: 5685 + 5686 +[ 5687 +{ 5688 + "recordTime": "", ~/~/Время записи 5689 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5690 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5691 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5692 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5693 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5694 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5695 + "items": [ ~/~/Детали 5696 + { 5697 + "name": "", ~/~/Имя свойства 5698 + "value": "" ~/~/Значение свойства 5699 + } 5700 + ] 5701 + }, 5702 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5703 + "" 5704 + ] 5705 + } 5706 +] 5707 + 5708 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5709 + 5710 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5711 + 5712 +(% class="box infomessage" %) 5713 +((( 5714 +**POST api/v3/Vehicles/recyclebin/restore** 5715 +))) 5716 + 5717 +В заголовках запроса: X-Auth: Токен авторизации 5718 + 5719 +Параметры в теле запроса (JSON): 5720 + 5721 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5722 + 5723 +В заголовках запроса: X-Auth: Токен авторизации 5724 + 5725 + 5726 +Пример запроса: 5727 + 5728 +((( 5729 +[ 5730 +))) 5731 + 5732 +((( 5733 + 0 5734 +))) 5735 + 5736 +((( 5737 +] 5738 +))) 5739 + 5740 + 5741 +Пример ответа: 5742 + 5743 +[ 5744 +{ 5745 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5746 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5747 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5748 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5749 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5750 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5751 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5752 + "items": [ ~/~/Детали 5753 + { 5754 + "name": "string", ~/~/Имя свойства 5755 + "value": "string" ~/~/Значение свойства 5756 + } 5757 + ] 5758 + }, 5759 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5760 + "string" 5761 + ] 5762 + } 5763 +] 5764 + 5765 + 5766 += **Раздел: Журнал заданий ** = 5767 + 5768 + 5769 +== **Создание задания в Журнале заданий** == 5770 + 5771 +(% class="box infomessage" %) 5772 +((( 5773 +**POST /api/v3/vehicletasks** 5774 +))) 5775 + 5776 +Пример запроса: 5777 + 5778 +((( 5779 +{ 5780 + "vehicleId": 0, ~/~/ Идентификатор ТС 5781 + "description": "string", ~/~/ Описание 5782 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5783 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5784 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5785 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5786 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5787 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5788 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5789 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5790 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5791 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5792 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5793 + "cost": { 5794 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5795 + "Name": "string", ~/~/ Наименование 5796 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5797 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5798 + "Norm": 0 ~/~/ Норма внесения 5799 + }, 5800 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5801 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5802 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5803 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5804 + "deleted": true, ~/~/ Признак удаления 5805 + "extId": "string", 5806 + "GeoIds": [ ~/~/ Cвязанные поля 5807 + 0 5808 + ] 5809 +} 5810 +))) 5811 + 5812 + 5813 +Пример ответа: 5814 + 5815 +{ 5816 + "vehicleId": 0, ~/~/ Идентификатор ТС 5817 + "description": "string", ~/~/ Описание 5818 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5819 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5820 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5821 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5822 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5823 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5824 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5825 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5826 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5827 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5828 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5829 + "cost": { 5830 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5831 + "Name": "string", ~/~/ Наименование 5832 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5833 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5834 + "Norm": 0 ~/~/ Норма внесения 5835 + }, 5836 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5837 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5838 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5839 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5840 + "deleted": true, ~/~/ Признак удаления 5841 + "extId": "string", ~/~/ ExtId 5842 + "GeoIds": [ ~/~/ Связанные поля 5843 + 0 5844 + ] 5845 +} 5846 + 5847 + 5848 +== **Редактирование задания в Журнале заданий** == 5849 + 5850 +(% class="box successmessage" %) 5851 +((( 5852 +**PUT /api/v3/vehicletasks** 5853 +))) 5854 + 5855 +Пример запроса: 5856 + 5857 +((( 5858 +{ 5859 + "vehicleId": 0, ~/~/ Идентификатор ТС 5860 + "description": "string", ~/~/ Описание 5861 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5862 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5863 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5864 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5865 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5866 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5867 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5868 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5869 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5870 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5871 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5872 + "cost": { 5873 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5874 + "Name": "string", ~/~/ Наименование 5875 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5876 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5877 + "Norm": 0 ~/~/ Норма внесения 5878 + }, 5879 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5880 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5881 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5882 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5883 + "deleted": true, ~/~/ Признак удаления 5884 + "extId": "string", ~/~/ ExtId 5885 + "GeoIds": [ ~/~/ Связанные поля 5886 + 0 5887 + ] 5888 +} 5889 +))) 5890 + 5891 + 5892 +Пример ответа: 5893 + 5894 +{ 5895 + "vehicleId": 0, ~/~/ Идентификатор ТС 5896 + "description": "string", ~/~/ Описание 5897 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5898 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5899 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5900 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5901 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5902 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5903 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5904 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5905 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5906 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5907 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5908 + "cost": { 5909 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5910 + "Name": "string", ~/~/ Наименование 5911 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5912 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5913 + "Norm": 0 ~/~/ Норма внесения 5914 + }, 5915 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5916 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5917 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5918 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5919 + "deleted": true, ~/~/ Признак удаления 5920 + "extId": "string", ~/~/ ExtId 5921 + "GeoIds": [ ~/~/ Связанные поля 5922 + 0 5923 + ] 5924 +} 5925 + 5926 + 5927 +== **Удаление задания в Журнале заданий** == 5928 + 5929 +(% class="box warningmessage" %) 5930 +((( 5931 +**DELETE /api/v3/vehicletasks** 5932 +))) 5933 + 5934 +Пример запроса: 5935 + 5936 +((( 5937 +[ 5938 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5939 +] 5940 +))) 5941 + 5942 +((( 5943 + 5944 +))) 5945 + 5946 +Пример ответа: 5947 + 5948 +{ 5949 + "vehicleId": 0, ~/~/ Идентификатор ТС 5950 + "description": "string", ~/~/ Описание 5951 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5952 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5953 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5954 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5955 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5956 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5957 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5958 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5959 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5960 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5961 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5962 + "cost": { 5963 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5964 + "Name": "string", ~/~/ Наименование 5965 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5966 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5967 + "Norm": 0 ~/~/ Норма внесения 5968 + }, 5969 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5970 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5971 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5972 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5973 + "deleted": true, ~/~/ Признак удаления 5974 + "extId": "string", ~/~/ ExtId 5975 + "GeoIds": [ ~/~/ Связанные поля 5976 + 0 5977 + ] 5978 +} 5979 + 5980 + 5981 +== **Получение списка Журнала заданий** == 5982 + 5983 +(% class="box infomessage" %) 5984 +((( 5985 +**POST /api/v3/vehicletasks/getbyperiod** 5986 +))) 5987 + 5988 +Пример запроса: 5989 + 5990 +((( 5991 +{ 5992 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5993 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 5994 + "TimeZone": 0, ~/~/ Часовой пояс. 5995 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 5996 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 5997 + ], 5998 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 5999 + 0 6000 + ], 6001 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6002 + 0 6003 + ], 6004 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6005 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6006 +} 6007 +))) 6008 + 6009 + 6010 +Пример ответа: 6011 + 6012 +((( 6013 +{ 6014 + "total": 0, ~/~/ Общее количество записей 6015 + "pages": 0, ~/~/ Общее количество страниц 6016 + "currentPage": 0, ~/~/ Текущая страница 6017 + "items": [ ~/~/ Записи 6018 + { 6019 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6020 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6021 + "name": "string", ~/~/ Название задания. 6022 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6023 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6024 + "workKind": "string", ~/~/ Вид работ 6025 + "techOp": "string", ~/~/ Тех. операция 6026 + "trailerModel": "string", ~/~/ Модель агрегата 6027 + "width": "string", ~/~/ Ширина, м 6028 + "speed": "string", ~/~/ Тех. скорость 6029 + "fields": "string", ~/~/ Поля 6030 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6031 + "vehicles": "string", ~/~/ Объект-модель 6032 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6033 + "drivers": "string", ~/~/ Водители 6034 + "tmc": "string", ~/~/ ТМЦ 6035 + "client": "string", ~/~/ Клиент 6036 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6037 + "dep": "string", ~/~/ Подразделение 6038 + "geoIds": [ ~/~/ Связанные поля 6039 + 0 6040 + ] 6041 + } 6042 + ] 6043 +} 6044 +))) 6045 + 6046 + 6047 += **Раздел: Роли** = 6048 + 6049 +== **Получение списка клиентских и системных ролей пользователя ** == 6050 + 6051 +(% class="box successmessage" %) 6052 +((( 6053 +**POST /api/v3/groups/find** 6054 +))) 6055 + 6056 +Пример запроса: 6057 + 6058 +((( 6059 +{ 6060 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6061 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6062 +} 6063 +))) 6064 + 6065 +((( 6066 + 6067 +))) 6068 + 6069 +((( 6070 +Пример ответа: 6071 +))) 6072 + 6073 +((( 6074 +((( 6075 +{ 6076 + "groups": [ ~/~/ Системные роли пользователя 6077 + { 6078 + "code": "string", ~/~/ Код роли. 6079 + "name": "string", ~/~/ Имя 6080 + "shortName": "string" ~/~/ Короткое имя 6081 + } 6082 + ], 6083 + "customGroups": [ ~/~/ Системные роли пользователя 6084 + { 6085 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6086 + "name": "string", ~/~/ Наименование 6087 + "shortName": "string", ~/~/ Короткое наименование 6088 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6089 + } 6090 + ] 6091 +} 6092 +))) 6093 +))) 6094 + 6095 +((( 6096 + 6097 +))) 6098 + 6099 +((( 6100 + 6101 +))) 6102 + 6103 += **Раздел: Локатор ** = 6104 + 6105 + 6106 +== **Получение данных по локатору** == 6107 + 6108 +(% class="box infomessage" %) 6109 +((( 6110 +**GET /api/v3/locators/{locatorId}** 6111 +))) 6112 + 6113 +В запросе указывается locatorid - идентификатор локатора 6114 + 6115 + 6116 +Пример ответа: 6117 + 6118 +((( 6119 +((( 6120 +{ 6121 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6122 + 0 6123 + ], 6124 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6125 + 0 6126 + ], 6127 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6128 + 0 6129 + ], 6130 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6131 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6132 + "agentName": "string", ~/~/ Наименование агента. 6133 + "isEnabled": true, ~/~/ Активность 6134 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6135 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6136 + "name": "string", ~/~/ Наименование. 6137 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6138 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6139 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6140 + "validity": 0, ~/~/ Значение срока действия 6141 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6142 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6143 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6144 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6145 + "url": "string", ~/~/ Ссылка 6146 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6147 + 6148 + "showVehicleName": true, ~/~/ Наименование объекта 6149 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6150 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6151 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6152 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6153 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6154 + 6155 + 1 6156 + 6157 + ] 6158 +} 6159 +))) 6160 +))) 6161 + 6162 + 6163 +((( 6164 +((( 6165 + 6166 +))) 6167 +))) 6168 + 6169 + 6170 +== **Создание локатора** == 6171 + 6172 +(% class="box successmessage" %) 6173 +((( 6174 +**POST /api/v3/locators** 6175 +))) 6176 + 6177 +Пример запроса: 6178 + 6179 +((( 6180 +{ 6181 + "isEnabled": true, ~/~/ Активность 6182 + "name": "string", ~/~/ Наименование локатора 6183 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6184 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6185 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6186 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6187 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6188 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6189 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6190 + 0 6191 + ], 6192 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6193 + 0 6194 + ], 6195 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6196 + 0 6197 + ], 6198 + 6199 + "showVehicleName": true, ~/~/ Наименование объекта 6200 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6201 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6202 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6203 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6204 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6205 + 6206 + 1 6207 + 6208 + ] 6209 +} 6210 +))) 6211 + 6212 + 6213 +Пример ответа: 6214 + 6215 +((( 6216 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6217 +))) 6218 + 6219 + 6220 +== **Выводит список локаторов ** == 6221 + 6222 +(% class="box successmessage" %) 6223 +((( 6224 +**POST /api/v3/locators/find** 6225 +))) 6226 + 6227 +Пример запроса: 6228 + 6229 +((( 6230 +{ 6231 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6232 +} 6233 +))) 6234 + 6235 +((( 6236 + 6237 +))) 6238 + 6239 +((( 6240 + 6241 +))) 6242 + 6243 + 6244 +Пример ответа: 6245 + 6246 +((( 6247 +[ 6248 + { 6249 + "vehiclesCount": 0, ~/~/ Количество объектов. 6250 + "geozonesCount": 0, ~/~/ Количество геозон. 6251 + "fieldsCount": 0, ~/~/ Количество полей. 6252 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6253 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6254 + "agentName": "string", ~/~/ Наименование агента. 6255 + "isEnabled": true, ~/~/ Активность локатора 6256 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6257 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6258 + "name": "string", ~/~/ Наименование локатора 6259 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6260 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6261 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6262 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6263 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6264 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6265 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6266 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6267 + "url": "string", ~/~/ ссылка на локатор 6268 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6269 + "showVehicleName": true, ~/~/ Наименование объекта 6270 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6271 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6272 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6273 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6274 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6275 + 6276 + 0 6277 + ] 6278 + } 6279 +] 6280 +))) 6281 + 6282 + 6283 +== **Изменение локатора** == 6284 + 6285 +(% class="box infomessage" %) 6286 +((( 6287 +**PUT /api/v3/locators** 6288 +))) 6289 + 6290 +Пример запроса: 6291 + 6292 +((( 6293 +{ 6294 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6295 + "isEnabled": true, ~/~/ Активность 6296 + "name": "string", ~/~/ Наименование 6297 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6298 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6299 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6300 + "autoProlongation": true, ~/~/ Автопродление срока действия 6301 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6302 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6303 + 0 6304 + ], 6305 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6306 + 0 6307 + ], 6308 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6309 + 0 6310 + ], 6311 + "showVehicleName": true, ~/~/ Наименование объекта 6312 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6313 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6314 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6315 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6316 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6317 + 6318 + 0 6319 + 6320 + ] 6321 +} 6322 + 6323 + 6324 +))) 6325 + 6326 +Пример ответа: 6327 + 6328 +200 ~/~/ Success 6329 + 6330 + 6331 +== **Удалить локатор** == 6332 + 6333 +(% class="box warningmessage" %) 6334 +((( 6335 +**DELETE /api/v3/locators** 6336 +))) 6337 + 6338 +Пример запроса: 6339 + 6340 +((( 6341 +[ 6342 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6343 +] 6344 +))) 6345 + 6346 + 6347 += **Раздел: Яндекс Маршруты** = 6348 + 6349 + 6350 +== **Возвращение списка маршрутов** == 6351 + 6352 +(% class="box infomessage" %) 6353 +((( 6354 +**GET /api/v3/TransportRoutes** 6355 +))) 6356 + 6357 +Пример запроса: 6358 +Id ~/~/ Идентификатор поля 6359 + 6360 +Пример ответа: 6361 + 6362 +((( 6363 +[ 6364 + { 6365 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6366 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6367 + "name": "string", ~/~/ Наименование маршрута. 6368 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6369 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6370 + 0 6371 + ] 6372 + } 6373 +] 6374 +))) 6375 + 6376 + 6377 +== **Добавить маршрут** == 6378 + 6379 +(% class="box infomessage" %) 6380 +((( 6381 +**POST /api/v3/TransportRoutes** 6382 +))) 6383 + 6384 +Пример запроса: 6385 +{ 6386 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6387 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6388 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6389 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6390 + 0 6391 + ] 6392 +} 6393 + 6394 + 6395 +Пример ответа: 6396 + 6397 +((( 6398 +{ 6399 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6400 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6401 + "name": "string", ~/~/ Определяет наименование маршрута 6402 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6403 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6404 + 0 6405 + ] 6406 +} 6407 +))) 6408 + 6409 + 6410 +== **Обновление маршрута** == 6411 + 6412 +(% class="box successmessage" %) 6413 +((( 6414 +**PUT /api/v3/TransportRoutes** 6415 +))) 6416 + 6417 +Пример запроса: 6418 + 6419 +((( 6420 +{ 6421 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6422 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6423 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6424 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6425 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6426 + 0 6427 + ] 6428 +} 6429 +))) 6430 + 6431 +Пример ответа: 6432 + 6433 +((( 6434 +{ 6435 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6436 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6437 + "name": "string", ~/~/ Определяет наименование маршрута 6438 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6439 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6440 + 0 6441 + ] 6442 +} 6443 +))) 6444 + 6445 + 6446 +== **Получить связки маршрутов ТС** == 6447 + 6448 +(% class="box infomessage" %) 6449 +((( 6450 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6451 +))) 6452 + 6453 +Пример запроса: 6454 + 6455 +((( 6456 +[ 6457 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6458 +] 6459 +))) 6460 + 6461 +Пример ответа: 6462 + 6463 +((( 6464 +[ 6465 + { 6466 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6467 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6468 + } 6469 +] 6470 +))) 6471 + 6472 + 6473 +== **Удалить маршрут** == 6474 + 6475 +(% class="box warningmessage" %) 6476 +((( 6477 +**DELETE /api/v3/TransportRoutes/{id}** 6478 +))) 6479 + 6480 +Пример запроса: 6481 +Id ~/~/ Идентификатор поля 6482 + 6483 + 6484 += **Раздел: Управление доступа к машинам** = 6485 + 6486 + 6487 +== Получение списка транспортных средств видимых пользователю == 6488 + 6489 +(% class="box infomessage" %) 6490 +((( 6491 +**GET /api/v3/UserVisibleVehicles/{userId}** 6492 +))) 6493 + 6494 +Пример ответа: 6495 + 6496 +((( 6497 +{ 6498 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6499 + 0 6500 + ] 6501 +} 6502 +))) 6503 + 6504 + 6505 +== Задает видимость транспортных средств пользователю == 6506 + 6507 +(% class="box infomessage" %) 6508 +((( 6509 +**POST /api/v3/UserVisibleVehicles** 6510 +))) 6511 + 6512 +Пример запроса: 6513 + 6514 +((( 6515 +((( 6516 +{ 6517 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6518 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6519 + 0 6520 + ] 6521 +} 6522 +))) 6523 + 6524 +((( 6525 + 6526 +))) 6527 + 6528 +((( 6529 +Пример ответа : 6530 +))) 6531 + 6532 +((( 6533 + 6534 +))) 6535 + 6536 +((( 6537 +200 ~/~/ Success 6538 +))) 6539 +))) 6540 + 6541 + 1413 1413 (% class="box" lang="en-US" style="text-align: center;" %) 1414 1414 ((( 1415 1415 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content