Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/05/06 12:41
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 { ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 291 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 292 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 293 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 294 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 295 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 296 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 297 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 298 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 299 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 300 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 301 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 302 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 303 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 304 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 305 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 306 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 307 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 308 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 309 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 310 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 311 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 393 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 394 + 395 +(% class="box warningmessage" %) 396 +((( 397 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 398 +))) 399 + 400 +Метод позволяет изменить статус клиента, указанного в запросе. 401 + 402 +В пути указывается GUID клиента и статус клиента. 403 + 404 +**status **- значение 0 - заблокирован, 1 - активен. 405 + 406 +Ответ: Code 204 407 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -351,7 +351,6 @@ 351 351 ], 352 352 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 - 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 - 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 472 +{ 473 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 490 +} 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 - 512 +(% style="color:#000000" %){(%%) 416 416 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 417 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 418 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 419 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 423 (% style="color:#000000" %)Ответ: 424 424 425 425 (% style="color:#000000" %){ (%%) 426 - 427 427 "id": "" , ~/~/ идентификатор пользователя 428 428 "lastName": "" , ~/~/ фамилия 429 429 "firstName": "" , ~/~/ имя ... ... @@ -437,7 +437,6 @@ 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 439 "lastLogged": "", ~/~/ дата/время последней авторизации 440 - 441 441 (% style="color:#000000" %)} 442 442 443 443 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -511,10 +511,8 @@ 511 511 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 512 512 513 513 (% lang="en-US" style="text-align:left" %) 514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 - 516 -(% lang="en-US" style="text-align:left" %) 517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 608 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 609 + "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" %) 631 + "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": "" , ~/~/ идентификатор пользователя 638 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 639 + "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» названия группы пользователя 660 +} 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 - 681 +(% 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 - 706 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -711,7 +711,6 @@ 711 711 "maxspeed": 0, 712 712 "width": 0, 713 713 "imbeddedtrailer": true, 714 - "fueloutlay": 0, 715 715 "hoppercapacity": 0, 716 716 "hopperdischargespeed": 0, 717 717 "modelType": 0, ... ... @@ -728,9 +728,8 @@ 728 728 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 729 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 730 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 732 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 815 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 734 734 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 735 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 736 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -822,12 +822,24 @@ 822 822 "maxspeed": 0, 823 823 "width": 0, 824 824 "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 826 "hoppercapacity": 0, 827 827 "hopperdischargespeed": 0, 828 828 "modelType": 0 829 829 } 830 830 912 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 913 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 914 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 915 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 916 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 917 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 918 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 919 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 920 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 921 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 922 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 923 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 924 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 831 831 832 832 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 833 ... ... @@ -882,6 +882,20 @@ 882 882 "modelType": 0 883 883 } 884 884 979 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 980 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 981 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 982 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 983 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 984 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 985 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 986 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 987 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 988 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 989 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 990 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 991 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 992 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -901,7 +901,7 @@ 901 901 902 902 Ответ: В случае успеха **Success 200** 903 903 904 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 1012 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 905 905 906 906 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 907 907 ... ... @@ -930,6 +930,17 @@ 930 930 931 931 ((( 932 932 { 1041 + 1042 +((( 1043 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1044 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1045 +))) 1046 + 1047 +((( 1048 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1049 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1050 +))) 1051 + 933 933 "vehicleId": "", ~/~/ ID объекта 934 934 "name": "", ~/~/ Имя объекта 935 935 "imei": "", ~/~/ IMEI объекта ... ... @@ -937,19 +937,15 @@ 937 937 "deviceTypeName": "", ~/~/ Название типа устройства 938 938 "sim1": "", ~/~/ Номер SIM1 939 939 "sim2": "", ~/~/ Номер SIM2 940 - 941 941 "parentId": "", ~/~/ ID клиента-родителя 942 942 "parentName": "", ~/~/ Наименование клиента-родителя 943 943 "modelId": "", ~/~/ ID модели объекта 944 944 "modelName": "", ~/~/ Имя модели объекта 945 - 946 946 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 947 947 "unitName": "string", ~/~/ Наименование подразделения 948 948 "status": 0, ~/~/ Статус объекта 949 - 950 950 "createdAt": "", ~/~/ Дата создания объекта 951 951 }, 952 - 953 953 "customFields": [ ~/~/ Произвольные поля 954 954 { 955 955 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -972,8 +972,7 @@ 972 972 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 973 973 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 974 974 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 975 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 - 1090 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 977 977 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 978 978 "mileageCoeff": 0, ~/~/ коэффициент пробега 979 979 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1003,7 +1003,6 @@ 1003 1003 "retries": 0 ~/~/ Количество попыток 1004 1004 } 1005 1005 ], 1006 - 1007 1007 "sensors": [ ~/~/ Датчики 1008 1008 { 1009 1009 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1030,6 +1030,7 @@ 1030 1030 ], 1031 1031 "showInTooltip": true, ~/~/ Отображать в подсказке 1032 1032 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 1033 1033 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1034 1034 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1035 1035 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1044,31 +1044,19 @@ 1044 1044 }, 1045 1045 1046 1046 ~/~/ Характерные для произвольного: 1047 - 1048 1048 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 - 1050 1050 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 - 1052 1052 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 - 1054 1054 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 - 1056 1056 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 - 1058 1058 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 - 1060 1060 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 - 1062 1062 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 - 1064 1064 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 - 1066 1066 ~/~/ "ValueOn": "Вкл.", 1067 - 1068 1068 ~/~/ "ValueOff": "Выкл." 1069 1069 "summaryMaxValue": 0 ~/~/ Макс. значение 1070 1070 } 1071 - 1072 1072 "drivers": [ ~/~/ Водители 1073 1073 { 1074 1074 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1077,7 +1077,6 @@ 1077 1077 "isDefault": true ~/~/ По умолчанию 1078 1078 } 1079 1079 ], 1080 - 1081 1081 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1082 1082 { 1083 1083 "id": "", ~/~/ ID задания ... ... @@ -1094,19 +1094,27 @@ 1094 1094 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1095 1095 } 1096 1096 ], 1097 - 1098 - "statusHistory": [ ~/~/ История статусов 1198 +"statusHistory": [ ~/~/ История статусов 1099 1099 { 1100 1100 "status": 0, 1101 1101 "date": "2023-05-22T09:57:39.562Z", 1102 1102 "description": "string", 1103 1103 "additionalInfo": "string" 1104 - } 1105 - ] 1106 1106 1205 +((( 1107 1107 } 1207 + ], 1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1108 1108 ))) 1109 1109 1212 +((( 1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1214 +} 1215 + 1216 +))) 1217 +))) 1218 + 1110 1110 (% style="text-align:left" %) 1111 1111 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1112 1112 ... ... @@ -1113,6 +1113,75 @@ 1113 1113 (% style="text-align:left" %) 1114 1114 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1115 1115 1225 + 1226 +== **Отправить команду на терминал** == 1227 + 1228 +(% class="box successmessage" %) 1229 +((( 1230 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1231 +))) 1232 + 1233 +Команда для отправки на тс. 1234 + 1235 +{ 1236 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1237 +"command": "", ~/~/ Текст отправляемой команды 1238 +"retries": "", ~/~/ Количество попыток отправки на терминал 1239 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1240 +} 1241 + 1242 +В ответ получаем cmdid 1243 + 1244 + 1245 +== **Получить ответ на отправленную на ТС команду** == 1246 + 1247 +(% class="box infomessage" %) 1248 +((( 1249 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1250 +))) 1251 + 1252 +Идентификатор команды: cmdId 1253 + 1254 +Запрос от терминала на ответ команды 1255 + 1256 +Пример ответ от терминала: 1257 + 1258 +ID= "" ~/~/ идентификатор объекта 1259 +Soft="" ~/~/ версия софта 1260 +GPS=4 ~/~/ тип трекера 1261 +Time=11:05:43 28.06.24 ~/~/ время запроса 1262 +Lat=45.056221 ~/~/ широта 1263 +Lon=39.035938 ~/~/ долгота 1264 +Speed=0.0 ~/~/ скорость 1265 +Course=181.4 ~/~/направление 1266 + 1267 +((( 1268 +== **Список отправленных объекту команд с ответами** == 1269 + 1270 +(% class="box infomessage" %) 1271 +((( 1272 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1273 +))) 1274 + 1275 +Идентификатор ТС: vehicleId 1276 + 1277 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1278 + 1279 +Пример ответа терминала 1280 + 1281 +[ 1282 +{ 1283 +"id": "", ~/~/ идентификатор пользователя 1284 +"commandText": "", ~/~/Текст команды. 1285 +"templateId": "", ~/~/Идентификатор шаблона 1286 +"updated": "", ~/~/ Время отправки 1287 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1288 +"answer": "", ~/~/ Ответ терминала. 1289 +"status": "" ~/~/ Статус отправки 1290 +} 1291 +] 1292 +))) 1293 + 1116 1116 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1117 1117 1118 1118 (% class="box successmessage" %) ... ... @@ -1132,6 +1132,11 @@ 1132 1132 1133 1133 (% style="color:#000000" %){ 1134 1134 1313 + 1314 +((( 1315 + "vehicleId": 0, ~/~/ ID ТС 1316 +))) 1317 + 1135 1135 "parentId": "" , ~/~/ ID клиента 1136 1136 "name": "" , ~/~/ имя ТС 1137 1137 "imei": "" , ~/~/ IMEI ... ... @@ -1152,7 +1152,6 @@ 1152 1152 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1153 1153 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1154 1154 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 - 1156 1156 "mileageCalcMethod": 0, 1157 1157 "mileageCoeff": 0, 1158 1158 "locationByCellId": true, ... ... @@ -1185,7 +1185,6 @@ 1185 1185 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1186 1186 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1187 1187 } 1188 - 1189 1189 "drivers": [ ~/~/ Водители 1190 1190 { 1191 1191 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1200,8 +1200,7 @@ 1200 1200 "retries": 0 1201 1201 } 1202 1202 ], 1203 - 1204 - "sensors": [ ~/~/ Датчики 1384 +"sensors": [ ~/~/ Датчики 1205 1205 { 1206 1206 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1207 1207 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1227,6 +1227,7 @@ 1227 1227 ], 1228 1228 "showInTooltip": true, ~/~/ Отображать в подсказке 1229 1229 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1230 1230 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1231 1231 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1232 1232 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1239,103 +1239,297 @@ 1239 1239 "additionalProp2": "string", 1240 1240 "additionalProp3": "string" 1241 1241 }, 1242 - 1243 1243 ~/~/ Характерные для произвольного: 1244 - 1245 1245 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 - 1247 1247 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 - 1249 1249 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 - 1251 1251 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 - 1253 1253 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 - 1255 1255 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 - 1257 1257 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 - 1259 1259 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 - 1261 1261 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 - 1263 1263 ~/~/ "ValueOn": "Вкл.", 1264 - 1265 1265 ~/~/ "ValueOff": "Выкл." 1266 - "summaryMaxValue": 0 ~/~/ Макс. значение 1435 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1436 + 1437 +((( 1438 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1439 + { 1440 + "from": 0, ~/~/ С какого значения 1441 + "color": "string", ~/~/ Каким цветом 1442 + "text": "string" ~/~/ Текст подписи к этому интервалу 1443 + } 1444 + ] 1267 1267 } 1268 1268 ], 1447 +))) 1448 + 1449 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1450 + 1451 + 1269 1269 "customFields": [ ~/~/ Произвольные поля 1270 1270 { 1271 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1272 - "name": "string", 1273 - "value": "string", 1274 - "forClient": true, 1275 - "forTooltip": true, 1276 - "forReport": true 1277 - } 1278 - ] 1454 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1455 + "name": "string", ~/~/ Наименование произвольного поля 1456 + "value": "string", ~/~/ Значение произвольного поля 1457 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1458 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1459 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1460 + 1461 +((( 1462 + } 1463 + ], 1464 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1465 +))) 1466 + 1467 +((( 1468 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1279 1279 } 1470 +))) 1280 1280 1472 + 1281 1281 (% style="color:#000000" %)Ответ: 1282 1282 1283 -(% style="color:#000000" %){ 1284 1284 1285 - "vehicleId": "", ~/~/ID ТС 1286 - "parentId": "", ~/~/Guid владельца ТС 1287 - "name": "", ~/~/Имя объекта 1288 - "imei": "", ~/~/IMEI 1289 - "deviceTypeId": "", ~/~/ID типа устройства 1290 - "modelId": "", ~/~/ID модели 1291 - "unitId": "", ~/~/ID подразделения 1292 - "sim1": "", ~/~/SIM1 1293 - "sim2": "", ~/~/SIM2 1294 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1295 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1296 - "counters": { ~/~/Счётчики 1297 - "mileageEnabled": true, 1298 - "motohoursEnabled": true, 1299 - "mileage": "", 1300 - "motohours": 345.0 1301 - }, 1302 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1303 - "id": null, 1304 - "enabled": true, ~/~/флаг включения 1305 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1306 - "login": "", ~/~/ имя учетной записи 1307 - "password": "" ~/~/ пароль учетной записи 1308 - }, 1309 - "inspectionTasks": { ~/~/ задания на ТО 1310 - "id": "", ~/~/ ID задачи 1311 - "enabled": false, ~/~/ Признак включения 1312 - "name": "", ~/~/ Имя задания 1313 - "description": "", ~/~/ Описание задания 1314 - "mileageCondition": "", ~/~/ Условие по пробегу 1315 - "lastMileage": "", ~/~/ Пробег (в метрах) 1316 - "motohoursCondition": "", ~/~/ Условие по моточасам 1317 - "lastMotohours": "", ~/~/ Моточасы 1318 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1319 - "kind": "", ~/~/ Вид периодичности по времени 1320 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1476 +((( 1477 +((( 1478 +((( 1479 +{ 1480 + "vehicleId": 0, ~/~/ ID ТС 1481 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1482 + "name": "string", ~/~/ Имя объекта 1483 + "imei": "string", ~/~/ IMEI 1484 + "deviceTypeId": 0, ~/~/ ID типа устройства 1485 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1486 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1487 + "sim1": "string", ~/~/ SIM1 1488 + "sim2": "string", ~/~/ SIM2 1489 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1490 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1491 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1492 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1493 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1494 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1495 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1496 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1497 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1498 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1499 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1500 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1501 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1502 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1503 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1504 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1505 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1506 + "counters": { ~/~/ Dto для состояний счётчиков 1507 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1508 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1509 + "mileage": 0, ~/~/ Пробег 1510 + "motohours": 0 ~/~/ Моточасы 1511 + }, 1512 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1513 + "id": "string", ~/~/ CMSV6 Идентификатор 1514 + "enabled": true, ~/~/ Признак включения 1515 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1516 + "login": "string", ~/~/ CMSV6 имя учетной записи 1517 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1518 + }, 1519 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1520 + { 1521 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1522 + "enabled": true, ~/~/ Признак включения 1523 + "name": "string", ~/~/ Имя задания 1524 + "description": "string", ~/~/ Описание задания 1525 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1526 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1527 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1528 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1529 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1530 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1531 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1532 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1321 1321 } 1534 + ], 1535 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1536 + { 1537 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1538 + "inputNumber": 0, ~/~/ № входа. 1539 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1540 + "comment": "string", ~/~/ Комментарий 1541 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1542 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1543 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1544 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1545 + } 1546 + ], 1547 + "commandTemplates": [ ~/~/ Список шаблонов команд 1548 + { 1549 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1550 + "name": "string", ~/~/ Название шаблона команд 1551 + "command": "string", ~/~/ Команда на выполнение 1552 + "retries": 0 ~/~/ Лимит попыток отправки 1553 + } 1554 + ], 1555 + "sensors": [ ~/~/ Список датчиков 1556 + { 1557 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1558 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1559 + "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 1560 + "name": "string", ~/~/ Имя датчика 1561 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1562 + "inputNumber": 0, ~/~/ Номер входа 1563 + "pseudonym": "string", ~/~/ Псевдоним 1564 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1565 + "isInverted": true, ~/~/ Признак инверсии 1566 + "disabled": true, ~/~/ Датчик не участвует в обработке 1567 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1568 + "gradesTables": [ ~/~/ Тарировка 1569 + { 1570 + "grades": [ ~/~/ Таблицы тарировки 1571 + { 1572 + "input": 0, ~/~/ Вход 1573 + "output": 0 ~/~/ Выход 1574 + } 1575 + ], 1576 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1577 + } 1578 + ], 1579 + "showInTooltip": true, ~/~/ Отображение в подсказке 1580 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1581 + "color": "string", ~/~/ код цвета датчиков 1582 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1583 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1584 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1585 + "expr": "string", ~/~/ Выражение 1586 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1587 + "string" 1588 + ], 1589 + "customParams": { 1590 + "additionalProp1": "string", 1591 + "additionalProp2": "string", 1592 + "additionalProp3": "string" 1593 + }, 1594 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1595 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1596 + { 1597 + "from": 0, ~/~/ С какого значения 1598 + "color": "string", ~/~/ Каким цветом 1599 +))) 1322 1322 1323 -(% style="text-align:left" %) 1324 -(% style="color:#000000" %)} 1601 +((( 1602 + "text": "string" ~/~/ Текст подписи к этому интервалу 1603 + } 1604 + ] 1605 + } 1606 + ], 1607 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1608 + "customFields": [ ~/~/ Список произвольных полей 1609 + { 1610 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1611 + "name": "string", ~/~/ Наименование произвольного поля 1612 + "value": "string", ~/~/ Значение произвольного поля 1613 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1614 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1615 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1616 + } 1617 + ], 1618 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1619 +} 1620 +))) 1621 +))) 1622 +))) 1325 1325 1624 + 1326 1326 **Валидация:** 1327 1327 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1328 1328 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1329 1329 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1330 1330 1331 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1332 1332 1631 +== **Импортировать историю ТС (Асинхронный запрос)** == 1632 + 1633 +(% class="box successmessage" %) 1634 +((( 1635 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1636 +))) 1637 + 1638 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 1639 + 1640 +Метод запроса: **POST** 1641 + 1642 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1643 + 1644 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1645 + 1646 + 1647 +Ответ: 1648 + 1649 +{ 1650 + 1651 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1652 + 1653 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1654 + 1655 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1656 + 1657 + "Message": "string", ~/~/ Информация о выполнении запроса 1658 + 1659 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1660 + 1661 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1662 + 1663 + "Data": "string" ~/~/ Данные 1664 + 1665 +} 1666 + 1667 + 1668 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1669 + 1333 1333 (% class="box infomessage" %) 1334 1334 ((( 1672 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1673 +))) 1674 + 1675 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 1676 + 1677 +Метод запроса: **GET** 1678 + 1679 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1680 + 1681 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1682 + 1683 + 1684 +Ответ: 1685 + 1686 +{ 1687 + 1688 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1689 + 1690 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1691 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1692 + 1693 + "Message": "string", ~/~/ Информация о выполнении запроса 1694 + 1695 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1696 + 1697 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1698 + 1699 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1700 + 1701 + "Data": "string" ~/~/ Данные 1702 + 1703 +} 1704 + 1705 + 1706 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1707 + 1708 +(% class="box infomessage" %) 1709 +((( 1335 1335 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1336 1336 ))) 1337 1337 1338 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1713 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1339 1339 1340 1340 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1341 1341 ... ... @@ -1369,9 +1369,12 @@ 1369 1369 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1370 1370 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1371 1371 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1372 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1373 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1374 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1747 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1748 + "unitName": "string", ~/~/ Название подразделения (опционально) 1749 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1750 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1751 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1752 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1375 1375 } 1376 1376 1377 1377 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1378,8 +1378,14 @@ 1378 1378 1379 1379 (% style="color:#000000" %)Ответ: 1380 1380 1381 -(% style="color:#000000" %){ 1759 +(% style="color:#000000" %)[ 1760 +{ 1382 1382 1762 +((( 1763 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1764 +))) 1765 + 1766 +((( 1383 1383 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1384 1384 "name": "" ~/~/ наименование объекта 1385 1385 "imei": "" ~/~/ IMEI объекта ... ... @@ -1405,9 +1405,21 @@ 1405 1405 "forClient": true, ~/~/ право на отображение у клиента 1406 1406 "forTooltip": false, ~/~/ право на отображение в подсказке 1407 1407 "forReport": false ~/~/ право на отображение в отчетах 1408 - }(%%) 1409 -(% style="color:#000000" %)} 1792 +))) 1410 1410 1794 +((( 1795 + } 1796 + ], 1797 + "vehicleGroups": [ ~/~/ Группы ТС 1798 + { 1799 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1800 + "name": "string" ~/~/ Наименование группы ТС 1801 + } 1802 + ] 1803 + } 1804 +] 1805 +))) 1806 + 1411 1411 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1412 1412 1413 1413 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1439,13 +1439,11 @@ 1439 1439 "data": "", ~/~/ Данные 1440 1440 "overwrite": false, ~/~/ Флаг перезаписи 1441 1441 "stage": "", ~/~/ Состояние, может быть null 1442 - 1443 1443 (% style="color:#000000" %)} 1444 1444 1445 1445 (% style="color:#000000" %)Ответ: 1446 1446 1447 -(% style="color:#000000" %){ 1448 - 1842 +(% style="color:#000000" %){(%%) 1449 1449 "status": "", ~/~/ значение статуса 1450 1450 "date": "", ~/~/ Дата смены статуса 1451 1451 "description": "", ~/~/ Описание ... ... @@ -1452,10 +1452,10 @@ 1452 1452 "data": "", ~/~/ Данные 1453 1453 "overwrite": false, ~/~/ Флаг перезаписи 1454 1454 "stage": "", ~/~/ Состояние 1455 - 1456 -(% style="text-align:left" %) 1457 1457 (% style="color:#000000" %) } 1458 1458 1851 +== == 1852 + 1459 1459 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1460 1460 1461 1461 (% class="box warningmessage" %) ... ... @@ -1531,9 +1531,19 @@ 1531 1531 1532 1532 "drivers": [ ~/~/ Водители 1533 1533 { 1534 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1535 - "isDefault": true 1536 - } 1928 + 1929 +((( 1930 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1931 + "inputNumber": 0, ~/~/ № входа. 1932 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1933 + "comment": "string", ~/~/ Комментарий. 1934 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1935 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1936 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1937 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1938 +))) 1939 + 1940 + } 1537 1537 ], 1538 1538 "commandTemplates": [ ~/~/ Шаблон команды 1539 1539 { ... ... @@ -1543,8 +1543,7 @@ 1543 1543 "retries": 0 1544 1544 } 1545 1545 ], 1546 - 1547 - "sensors": [ ~/~/ Датчики 1950 +"sensors": [ ~/~/ Датчики 1548 1548 { 1549 1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1550 1550 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1570,6 +1570,11 @@ 1570 1570 ], 1571 1571 "showInTooltip": true, ~/~/ Отображать в подсказке 1572 1572 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1976 + 1977 +((( 1978 + "color": "string",** ~/~/ **Цвет датчика 1979 +))) 1980 + 1573 1573 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1574 1574 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1575 1575 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1582,95 +1582,225 @@ 1582 1582 "additionalProp2": "string", 1583 1583 "additionalProp3": "string" 1584 1584 }, 1585 - 1586 1586 ~/~/ Характерные для произвольного: 1587 - 1588 1588 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 - 1590 1590 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 - 1592 1592 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 - 1594 1594 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 - 1596 1596 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 - 1598 1598 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 - 1600 1600 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 - 1602 1602 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 - 1604 1604 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 - 1606 1606 ~/~/ "ValueOn": "Вкл.", 1607 - 1608 1608 ~/~/ "ValueOff": "Выкл." 1609 1609 "summaryMaxValue": 0 ~/~/ Макс. значение 2006 + 2007 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2008 + { 2009 + "from": 0, ~/~/ С какого значения 2010 + "color": "string", ~/~/ Каким цветом 2011 + "text": "string" ~/~/ Текст подписи к этому интервалу 2012 + } 2013 + ] 1610 1610 } 1611 1611 ], 2016 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2017 + 1612 1612 "customFields": [ ~/~/ Произвольные поля 1613 - { 1614 - 1615 - "name": "string", 1616 - "value": "string", 1617 - "forClient": true, 1618 - "forTooltip": true, 1619 - "forReport": true 2019 + { 2020 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2021 + "name": "string", ~/~/ Наименование произвольного поля 2022 + "value": "string", ~/~/ Значение произвольного поля 2023 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2024 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2025 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1620 1620 } 1621 - ] 2027 + 2028 +((( 2029 + ], 2030 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 2031 +))) 2032 + 1622 1622 } 1623 1623 2035 + 1624 1624 (% style="color:#000000" %)Ответ: 1625 1625 1626 -(% lang="en-US" style="text-align:left" %) 1627 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 2038 +((( 2039 +{ 2040 + "vehicleId": 0, ~/~/ ID ТС 2041 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 2042 + "name": "string", ~/~/ Имя объекта 2043 + "imei": "string", ~/~/ IMEI 2044 + "deviceTypeId": 0, ~/~/ ID типа устройства 2045 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 2046 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 2047 + "sim1": "string", ~/~/ SIM1 2048 + "sim2": "string", ~/~/ SIM2 2049 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 2050 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 2051 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 2052 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 2053 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 2054 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 2055 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 2056 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 2057 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 2058 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 2059 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 2060 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 2061 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 2062 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 2063 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 2064 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 2065 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 2066 + "counters": { ~/~/ состояний счётчиков 2067 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 2068 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 2069 + "mileage": 0, ~/~/ Пробег 2070 + "motohours": 0 ~/~/ Моточасы 2071 + }, 2072 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 2073 + "id": "string", ~/~/ CMSV6 Идентификатор 2074 + "enabled": true, ~/~/ Признак включения 2075 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2076 +))) 1628 1628 1629 -(% lang="en-US" style="text-align:left" %) 1630 - "vehicleId": "", ~/~/ ID ТС 1631 - "parentId": "", ~/~/ ID клиента 1632 - "name": "", ~/~/ имя ТС 1633 - "imei": "", ~/~/ IMEI 1634 - "deviceTypeId": "", ~/~/ типа устройства 1635 - "modelId": "", ~/~/ ID модели 1636 - "unitId": "", ~/~/ ID подразделения 1637 - "sim1": "", ~/~/ SIM 1 1638 - "sim2": "", ~/~/ SIM2 1639 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1640 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1641 - "counters": 1642 - { 1643 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1644 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1645 - "mileage": "", ~/~/ пробег 1646 - "motohours": "", ~/~/ моточасы 1647 - } 1648 - "cmsv6Parameters": ~/~/ параметры CMSv6 2078 + 2079 +((( 2080 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2081 + "login": "string", ~/~/ CMSV6 имя учетной записи 2082 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2083 + }, 2084 + "inspectionTasks": [ ~/~/ Задания на ТО 2085 + { 2086 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2087 + "enabled": true, ~/~/ Признак включения 2088 + "name": "string", ~/~/ Имя задания 2089 + "description": "string", ~/~/ Описание задания 2090 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2091 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2092 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2093 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2094 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2095 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2096 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2097 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2098 + } 2099 + ], 2100 + "drivers": [ ~/~/ Список водителей 2101 + { 2102 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2103 + "inputNumber": 0, ~/~/ № входа. 2104 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2105 + "comment": "string", ~/~/ Комментарий. 2106 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2107 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2108 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2109 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2110 + } 2111 + ], 2112 + "commandTemplates": [ ~/~/ Список шаблонов команд 2113 + { 2114 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2115 + "name": "string", ~/~/ Название шаблона команд 2116 + "command": "string", ~/~/ Команда на выполнение 2117 + "retries": 0 ~/~/ Лимит попыток отправки 2118 + } 2119 + ], 2120 + "sensors": [ ~/~/ Список датчиков 2121 + { 2122 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2123 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2124 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2125 +))) 2126 + 2127 +((( 2128 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2129 +))) 2130 + 2131 +((( 2132 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2133 +))) 2134 + 2135 +((( 2136 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2137 +))) 2138 + 2139 +((( 2140 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2141 +))) 2142 + 2143 +((( 2144 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2145 + "name": "string", ~/~/ Имя датчика 2146 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2147 +))) 2148 + 2149 +((( 2150 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2151 + "inputNumber": 0, ~/~/ Номер входа 2152 + "pseudonym": "string", ~/~/ Псевдоним 2153 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2154 + "isInverted": true, ~/~/ Признак инверсии 2155 + "disabled": true, ~/~/ Датчик не участвует в обработке 2156 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2157 + "gradesTables": [ ~/~/ Тарировка 1649 1649 { 1650 - "id": ~/~/ идентификатор 1651 - "enabled": true, ~/~/ флаг включения 1652 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1653 - "login": "", ~/~/ имя учетной записи 1654 - "password": "", ~/~/ пароль учетной записи 1655 - } 1656 - "inspectionTasks": ~/~/ задания на ТО 1657 - { 1658 - "id": "", ~/~/ ID задания 1659 - "enabled": false, ~/~/ Признак включения 1660 - "name": "", ~/~/ Имя задания 1661 - "description": "", ~/~/ Описание задания 1662 - "mileageCondition": "", ~/~/ Условие по пробегу 1663 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1664 - "motohoursCondition": "", ~/~/ Условие по моточасам 1665 - "lastMotohours": "", ~/~/ Моточасы 1666 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1667 - "kind": "", ~/~/ Вид периодичности по времени 1668 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2159 + "grades": [ ~/~/ Таблицы тарировки 2160 + { 2161 + "input": 0, ~/~/ Вход 2162 + "output": 0 ~/~/ Выход 2163 + } 2164 + ], 2165 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1669 1669 } 2167 + ], 2168 + "showInTooltip": true, ~/~/ Отображение в подсказке 2169 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1670 1670 1671 -(% lang="en-US" style="text-align:left" %) 1672 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2171 +((( 2172 + "color": "string", ~/~/ цвет уведомлений 2173 +))) 1673 1673 2175 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2176 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2177 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2178 + "expr": "string", ~/~/ Выражение 2179 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2180 + "string" 2181 + ], 2182 + "customParams": { ~/~/ Дополнительные настройки 2183 + "additionalProp1": "string", 2184 + "additionalProp2": "string", 2185 + "additionalProp3": "string" 2186 + }, 2187 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2188 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2189 + { 2190 + "from": 0, ~/~/ С какого значения 2191 + "color": "string", ~/~/ Каким цветом 2192 + "text": "string" ~/~/ Текст подписи к этому интервалу 2193 + } 2194 + ] 2195 + } 2196 + ], 2197 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2198 + "customFields": [ ~/~/ Список произвольных полей 2199 + { 2200 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2201 + "name": "string", ~/~/ Наименование произвольного поля 2202 + "value": "string", ~/~/ Значение произвольного поля 2203 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2204 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2205 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2206 + } 2207 + ], 2208 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2209 +} 2210 +))) 2211 + 1674 1674 **Валидация:** 1675 1675 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1676 1676 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1709,18 +1709,15 @@ 1709 1709 1710 1710 (% style="color:#000000" %)Метод запроса: **GET** 1711 1711 1712 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2250 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1713 1713 1714 1714 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1715 1715 1716 1716 (% style="color:#000000" %)Ответ: 1717 1717 1718 -(% style="color:#000000" %){ 1719 - 2256 +(% style="color:#000000" %){(%%) 1720 1720 "deviceTypeId" : "", ~/~/ ID типа устройства 1721 1721 "deviceTypeName" : "" ~/~/ Название типа устройства 1722 - 1723 -(% style="text-align:left" %) 1724 1724 (% style="color:#000000" %)} 1725 1725 1726 1726 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1742,13 +1742,10 @@ 1742 1742 1743 1743 (% style="color:#000000" %)Ответ: 1744 1744 1745 -(% style="color:#000000" %){ 1746 - 2280 +(% style="color:#000000" %){(%%) 1747 1747 "id": "", ~/~/ ID типа датчика 1748 1748 "name": "", ~/~/ Название 1749 1749 "description": "", ~/~/ Описание 1750 - 1751 -(% style="text-align:left" %) 1752 1752 (% style="color:#000000" %)} 1753 1753 1754 1754 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1792,6 +1792,56 @@ 1792 1792 } 1793 1793 ] 1794 1794 2327 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2328 + 2329 +(% class="box infomessage" style="text-align: left;" %) 2330 +((( 2331 +**POST /api/v3/terminalMessages/mapping** 2332 +))) 2333 + 2334 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2335 + 2336 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2337 + 2338 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2339 + 2340 +{ 2341 + "protocolType": 0, 2342 + "params": ["string"] 2343 +} 2344 + 2345 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2346 +|protocolType|ID типа протокола 2347 +|params|((( 2348 +Массив наименований параметров в сообщении 2349 +))) 2350 + 2351 +Ответ: 2352 + 2353 +{ 2354 + "protocolType": 0, 2355 + "mapping": { 2356 + "additionalProp1": { 2357 + "inputType": 0, 2358 + "inputNumber": 0 2359 + }, 2360 + "additionalProp2": { 2361 + "inputType": 0, 2362 + "inputNumber": 0 2363 + } 2364 + } 2365 +} 2366 + 2367 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2368 +|protocolType|Тип протокола 2369 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2370 +|inputNumber|((( 2371 +Номер входа 2372 +))) 2373 + 2374 +(% class="wikigeneratedid" %) 2375 +Перечень 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/]] 2376 + 1795 1795 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 1796 1797 1797 (% class="box infomessage" %) ... ... @@ -1816,6 +1816,11 @@ 1816 1816 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 1817 } 1818 1818 2401 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2402 +|vehicleId|ID объекта 2403 +|from|Дата и время начала периода запроса 2404 +|to|Дата и время окончания периода запроса 2405 + 1819 1819 Ответ: 1820 1820 1821 1821 [ ... ... @@ -1822,80 +1822,43 @@ 1822 1822 { 1823 1823 "messages": [ 1824 1824 { 1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 - "speed": 0, ~/~/ Скорость, км/ч 1828 - "altitude": 0, ~/~/ Высота, м 1829 - "latitude": 0, ~/~/ Широта [-90°;90°] 1830 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 - "satellites": 0, ~/~/ Кол-во спутников 1832 - "voltage": 0, ~/~/ Напряжение 1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2412 + "deviceTime": "2023-11-29T07:40:44.052Z", 2413 + "serverTime": "2023-11-29T07:40:44.052Z", 2414 + "speed": 0, 2415 + "altitude": 0, 2416 + "latitude": 0, 2417 + "longitude": 0, 2418 + "satellites": 0, 2419 + "course": 0, 2420 + "voltage": 0, 2421 + "parameters": { 1834 1834 "additionalProp1": "string", 1835 1835 "additionalProp2": "string", 1836 1836 "additionalProp3": "string" 1837 1837 }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 2426 + "photoCount": 0, 2427 + "lbsCorrectedCoords": true, 2428 + "protocolType": 0 1839 1839 } 1840 1840 ] 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2434 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2435 +|deviceTime|Время сообщения терминала 2436 +|serverTime|Время когда сообщение поступило на сервер 2437 +|speed|Скорость 2438 +|altitude|Высота над уровнем моря 2439 +|latitude|Широта 2440 +|longitude|Долгота 2441 +|satellites|Кол-во спутников 2442 +|course|Курс 2443 +|voltage|Бортовое напряжение 2444 +|parameters|Список параметров и их значений 2445 +|photoCount|Количество фото 2446 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2447 +|protocolType|ID типа протокола 1845 1845 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 1899 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 1900 1901 1901 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1932,10 +1932,14 @@ 1932 1932 { 1933 1933 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1934 1934 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1935 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1936 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1937 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1938 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2485 + "mileage": 0, ~/~/ Пробег за период, километры 2486 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2487 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2488 + "motohours": 0, ~/~/ Моточасы за период, секунды 2489 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2490 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2491 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2492 + 1939 1939 } 1940 1940 ] 1941 1941 } ... ... @@ -1979,11 +1979,19 @@ 1979 1979 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 1980 1980 "fuelConsumption": 0, ~/~/ Расход топлива 1981 1981 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2536 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2537 + 1982 1982 } 1983 1983 ] 1984 1984 } 1985 1985 ] 1986 1986 2543 +(% class="box warningmessage" %) 2544 +((( 2545 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2546 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2547 +))) 2548 + 1987 1987 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1988 1988 1989 1989 (% class="box infomessage" %) ... ... @@ -2018,7 +2018,8 @@ 2018 2018 "model": "string", ~/~/ Модель объекта 2019 2019 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2020 2020 { 2021 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2583 + "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 2584 + 2022 2022 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2023 2023 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2024 2024 "valueFuel": 0, ~/~/ Количество ... ... @@ -2029,6 +2029,96 @@ 2029 2029 } 2030 2030 ] 2031 2031 2595 + 2596 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2597 + 2598 +(% class="box infomessage" %) 2599 +((( 2600 +**POST /api/v3/vehicles/moveStop** 2601 +))) 2602 + 2603 +Метод запроса: **POST** 2604 + 2605 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2606 + 2607 +В заголовках запроса: X-Auth: Токен авторизации 2608 + 2609 + 2610 +Тело запроса: 2611 + 2612 +{ 2613 + "vehicleIds": [ ], ~/~/ Список ID объектов 2614 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2615 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2616 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2617 +} 2618 + 2619 +Ответ: 2620 + 2621 +[ 2622 + { 2623 + "vehicleId": 0, ~/~/ ID объекта 2624 + "vehicleName": "string", ~/~/ Имя объекта 2625 + "moves": [ ~/~/ Событие движения 2626 + { 2627 + "mileage": 0, ~/~/ Пробег, км 2628 + "eventId": 0, ~/~/ Идентификатор события 2629 + "eventName": "string", ~/~/ Название события 2630 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2631 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2632 + "duration": 0 ~/~/ Продолжительность события, секунд 2633 + } 2634 + ], 2635 + "stops": [ ~/~/ События стоянок 2636 + { 2637 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2638 + "eventId": 0, ~/~/ Идентификатор события 2639 + "eventName": "string", ~/~/ Название события 2640 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2641 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2642 + "duration": 0 ~/~/ Продолжительность события, секунд 2643 + } 2644 + ] 2645 + } 2646 +] 2647 + 2648 + 2649 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2650 + 2651 +(% class="box infomessage" %) 2652 +((( 2653 +**POST /api/v3/vehicles/getlastdata** 2654 +))) 2655 + 2656 +Метод запроса: **POST** 2657 + 2658 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2659 + 2660 +В заголовках запроса: X-Auth: Токен авторизации 2661 + 2662 + 2663 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2664 + 2665 +Ответ: 2666 + { 2667 + "vehicleId": 0, ~/~/Идентификатор объекта. 2668 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2669 + "vehicleNumber": "string",~/~/Номер объекта. 2670 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2671 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2672 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2673 + "speed": 0,~/~/Скорость объекта. 2674 + "course": 0,~/~/Курс движения [0;360] 2675 + "latitude": 0,~/~/Широта [-90°;90°]. 2676 + "longitude": 0,~/~/Долгота [-180°;180°]. 2677 + "address": "string",~/~/Адрес. 2678 + "geozones": [ ~/~/Сведения по геозонам. 2679 + { 2680 + "id": 0, 2681 + "name": "string" 2682 + } 2683 + 2684 + 2032 2032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 2033 2034 2034 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2157,6 +2157,35 @@ 2157 2157 } 2158 2158 ] 2159 2159 2813 + 2814 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2815 + 2816 +(% class="box successmessage" %) 2817 +((( 2818 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2819 +))) 2820 + 2821 +(% style="color:#000000" %)Метод запроса: **PUT** 2822 + 2823 +Пример запроса: 2824 + 2825 +((( 2826 +{ 2827 + "id": 0, ~/~/ Идентификатор объекта геозоны 2828 + "name": "string", ~/~/ Наименование объекта геозоны 2829 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2830 + "description": "string", ~/~/ Описание объекта геозоны 2831 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2832 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2833 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2834 +} 2835 +))) 2836 + 2837 + 2838 +Пример ответа: 2839 + 2840 +200 ~/~/ Success 2841 + 2160 2160 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2161 2161 2162 2162 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2336,6 +2336,32 @@ 2336 2336 2337 2337 Success 2338 2338 3021 + 3022 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 3023 + 3024 +(% class="box warningmessage" %) 3025 +((( 3026 +**PUT** /api/v3/notifications/prolongation 3027 +))) 3028 + 3029 +Метод позволяет продлить уведомления. 3030 + 3031 +Метод запроса **PUT** 3032 + 3033 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 3034 + 3035 +В заголовках запроса: X-Auth: Токен авторизации. 3036 + 3037 +Тело запроса: 3038 + 3039 +[ 3040 + 3041 +0 3042 + 3043 +] 3044 + 3045 +где 0 идентификатор ids. 3046 + 2339 2339 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2340 2340 2341 2341 (% class="box errormessage" %) ... ... @@ -2927,6 +2927,83 @@ 2927 2927 Success 2928 2928 2929 2929 3638 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3639 + 3640 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3641 + 3642 +(% class="box infomessage" %) 3643 +((( 3644 +**POST /api/v3/Trailers** 3645 +))) 3646 + 3647 +Пример запроса: 3648 + 3649 +{ 3650 + "startDate": "2023-11-14T10:48:03.671Z", 3651 + "endDate": "2023-11-14T10:48:03.671Z", 3652 + "ids": [ 0 ], 3653 + "timezone": 0 3654 +} 3655 + 3656 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3657 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3658 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3659 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3660 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3661 + 3662 +Пример ответа: 3663 + 3664 +[ 3665 + { 3666 + "SD": "2023-11-14T10:48:03.717Z", 3667 + "ED": "2023-11-14T10:48:03.717Z", 3668 + "id": 0, 3669 + "SLat": 0, 3670 + "SLon": 0, 3671 + "ELat": 0, 3672 + "ELon": 0, 3673 + "mileage": 0 3674 + "Duration": 0 3675 + "Address": "string", 3676 + "Address2": "string", 3677 + "name": "string", 3678 + "rid": "string", 3679 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3680 + "trailer": { 3681 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3682 + "Number": "string", 3683 + "Description": "string", 3684 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3685 + "ExternalID": "string", 3686 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3687 + "CreateTime": "2023-11-14T10:48:03.717Z", 3688 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3689 + "IsDeleted": true 3690 + }, 3691 + "filesCount": 0, 3692 + } 3693 +] 3694 + 3695 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3696 +|SD|Дата и время начала события 3697 +|ED|Дата и время окончания события 3698 +|id|ID объекта 3699 +|SLat|Широта начальной координаты 3700 +|SLon|Долгота начальной координаты 3701 +|ELat|Широта конечной координаты 3702 +|ELon|Долгота конечной координаты 3703 +|mileage|Пробег 3704 +|Duration|Продолжительность 3705 +|Address|Адрес начального местоположения 3706 +|Address2|Адрес конечного местоположения 3707 +|name|Имя радиометки 3708 +|rid|Номер радиометки 3709 +|rguid|ID радиометки 3710 +|trailer|Информация об агрегате 3711 +|ModelGuid|ID агрегата 3712 +|Number|Название/номер агрегата 3713 +|Description|Текст примечания агрегата 3714 + 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2948,13 +2948,19 @@ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки3736 + "period": 0, 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "deleted": true 2955 2955 } 2956 2956 ] 2957 2957 3742 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3743 +|parentId|ID клиента 3744 +|name|Название карты-метки 3745 +|number|Номер 3746 +|period|Период запросов в секундах (работает только для агрегатов) 3747 +|id|ID карты-метки 3748 + 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 2960 (% class="box infomessage" %) ... ... @@ -2970,13 +2970,18 @@ 2970 2970 { 2971 2971 "name": "string", 2972 2972 "number": 0, 2973 - "period": 0, ~/~/ Частота трансляции радиометки3764 + "period": 0, 2974 2974 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 2975 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 - "deleted": true 2977 2977 } 2978 2978 ] 2979 2979 3770 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3771 +|name|Название карты-метки 3772 +|number|Номер 3773 +|period|Период запросов в секундах (работает только для агрегатов) 3774 +|id|ID карты-метки 3775 +|parentId|ID клиента 2980 2980 2981 2981 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2982 2982 ... ... @@ -2992,7 +2992,6 @@ 2992 2992 "number": 0, 2993 2993 "period": 0, 2994 2994 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 - "deleted": true 2996 2996 } 2997 2997 2998 2998 Ответ: ... ... @@ -3003,9 +3003,15 @@ 3003 3003 "period": 0, 3004 3004 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3005 3005 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 - "deleted": true 3007 3007 } 3008 3008 3803 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3804 +|name|Название карты-метки 3805 +|number|Номер 3806 +|period|Период запросов в секундах (работает только для агрегатов) 3807 +|id|ID карты-метки 3808 +|parentId|ID клиента 3809 + 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 3011 (% class="box warningmessage" %) ... ... @@ -3021,7 +3021,6 @@ 3021 3021 "period": 0, 3022 3022 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 3023 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 - "deleted": true 3025 3025 } 3026 3026 3027 3027 Ответ: ... ... @@ -3032,9 +3032,15 @@ 3032 3032 "period": 0, 3033 3033 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 3034 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 - "deleted": true 3036 3036 } 3037 3037 3837 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3838 +|name|Название карты-метки 3839 +|number|Номер 3840 +|period|Период запросов в секундах (работает только для агрегатов) 3841 +|id|ID карты-метки 3842 +|parentId|ID клиента 3843 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 3040 (% class="box errormessage" %) ... ... @@ -3042,7 +3042,7 @@ 3042 3042 **DELETE /api/v3/Rfids/{rfidGuid}** 3043 3043 ))) 3044 3044 3045 -Передаем параметр rfidGuid - идентификатор карты-метки 3851 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3046 3046 3047 3047 Ответ: 3048 3048 ... ... @@ -3283,6 +3283,8 @@ 3283 3283 **PUT /api/v3/Billing/client/balance** 3284 3284 ))) 3285 3285 4092 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4093 + 3286 3286 Тело запроса: 3287 3287 3288 3288 { ... ... @@ -3296,6 +3296,50 @@ 3296 3296 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3297 3297 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3298 3298 4107 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4108 + 4109 +(% class="box warningmessage" %) 4110 +((( 4111 +**PUT /api/v3/billing/client/balance/deposit** 4112 +))) 4113 + 4114 +Создает операцию **Пополнение **с указанной суммой 4115 + 4116 +Тело запроса: 4117 + 4118 +{ 4119 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4120 + "Balance": 0 4121 +} 4122 + 4123 +Ответ: Success 4124 + 4125 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4126 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4127 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4128 + 4129 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4130 + 4131 +Создает операцию **Списание **с указанной суммой 4132 + 4133 +(% class="box warningmessage" %) 4134 +((( 4135 +**PUT /api/v3/billing/client/balance/withdraw** 4136 +))) 4137 + 4138 +Тело запроса: 4139 + 4140 +{ 4141 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4142 + "Balance": 0 4143 +} 4144 + 4145 +Ответ: Success 4146 + 4147 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4148 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4149 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4150 + 3299 3299 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 3300 3301 3301 (% class="box warningmessage" %) ... ... @@ -3368,6 +3368,2021 @@ 3368 3368 |PeriodValue|Значение периода. 3369 3369 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3370 3370 4223 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4224 + 4225 +(% class="box warningmessage" %) 4226 +((( 4227 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4228 +))) 4229 + 4230 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4231 + 4232 +(% class="box infomessage" %) 4233 +((( 4234 +**POST /api/v3/vehicles/import/{agentId}** 4235 +))) 4236 + 4237 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4238 + 4239 +В пути указывается **agentId** - id клиента. 4240 + 4241 +**Заголовок** 4242 + 4243 +**X-Auth: [токен авторизации]** 4244 + 4245 +**Параметры** 4246 + 4247 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4248 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4249 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4250 + 4251 +В теле использовать тип **form-data,** тип значения** file** 4252 + 4253 +**Ключи** 4254 + 4255 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4256 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4257 +|csv|В значении передаем файл датчиков, формат **csv** 4258 + 4259 +Ответ: 4260 + 4261 +{ 4262 + "vehicleId": 0, 4263 + "name": "string", 4264 + "errors": ["string"] 4265 +} 4266 + 4267 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4268 +|vehicleId|ID созданного объекта 4269 +|name|Имя созданного объекта 4270 +|errors|Ошибки и их описание 4271 + 4272 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4273 + 4274 +(% class="box infomessage" %) 4275 +((( 4276 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4277 +))) 4278 + 4279 +(% class="wikigeneratedid" %) 4280 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4281 + 4282 +(% class="wikigeneratedid" %) 4283 +В пути указывается **vehicleId **- id объекта. 4284 + 4285 +**Заголовок** 4286 + 4287 +**X-Auth: [токен авторизации]** 4288 + 4289 +В теле использовать тип **form-data.** 4290 + 4291 +Ключи: 4292 + 4293 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4294 +|**history**|В значении передавать файл с историей 4295 + 4296 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4297 + 4298 +Ответ: 4299 + 4300 +{ 4301 + "results": [ 4302 + { 4303 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4304 + "vehicleId": 0, 4305 + "errors": [ 4306 + "string" 4307 + ], 4308 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4309 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4310 + "producedCount": 0, 4311 + "msgCount": 0 4312 + } 4313 + ] 4314 +} 4315 + 4316 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4317 +|results|Результаты импорта в разрезе ТС 4318 +|vehicleGuid|Guid ТС 4319 +|vehicleId|ID ТС 4320 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4321 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4322 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4323 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4324 +|msgCount|Кол-во обработанных сообщений всего 4325 + 4326 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4327 + 4328 +(% class="box infomessage" %) 4329 +((( 4330 +**GET /api/v3/vehicles/import/history/status** 4331 +))) 4332 + 4333 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4334 + 4335 +Ответ: 4336 + 4337 +{ 4338 + "activity": true, 4339 + "progress": 0, 4340 + "message": "string" 4341 +} 4342 + 4343 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4344 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4345 +|progress|Guid ТС 4346 + 4347 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4348 + 4349 +(% class="box infomessage" %) 4350 +((( 4351 +**POST /api/v3/vehicles/export** 4352 +))) 4353 + 4354 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4355 + 4356 +Тело запроса: 4357 + 4358 +[ 4359 + id 4360 +] 4361 + 4362 +Ответ: Success 200, получаете файлы с настройками. 4363 + 4364 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4365 + 4366 +(% class="box infomessage" %) 4367 +((( 4368 +**POST /api/v3/vehicles/export/history** 4369 +))) 4370 + 4371 +Метод возвращает список сообщений терминала объекта за выбранный период. 4372 + 4373 +Тело запроса: 4374 + 4375 +{ 4376 + "vehicleId": 0, 4377 + "asArchive": true, 4378 + "from": "2023-09-27T12:17:45.973Z", 4379 + "to": "2023-09-27T12:17:45.973Z" 4380 +} 4381 + 4382 +Ответ: 4383 + 4384 +Получаете файл. Сообщение: Code 200/Success 4385 + 4386 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4387 +|vehicleId|ID объекта 4388 +|asArchive|true - Архивировать файл, False - не архивировать 4389 +|from|Дата и время начала запроса 4390 +|to|Дата и время окончания запроса 4391 + 4392 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4393 + 4394 +(% class="box infomessage" %) 4395 +((( 4396 +**GET /api/v3/vehicles/export/history/status** 4397 +))) 4398 + 4399 +Метод возвращает список сообщений терминала объекта за выбранный период. 4400 + 4401 +Ответ: 4402 + 4403 +{ 4404 + "activity": true, 4405 + "progress": 0, 4406 + "message": "string" 4407 +} 4408 + 4409 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4410 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4411 +|progress|Прогресс экспорта, от 0 до 100% 4412 +|message|Текст описывающий статус 4413 + 4414 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4415 + 4416 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4417 + 4418 +(% class="box infomessage" %) 4419 +((( 4420 +**POST /api/v3/EcoDriving/rating** 4421 +))) 4422 + 4423 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4424 + 4425 +Тело запроса: 4426 + 4427 +{ 4428 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4429 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4430 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4431 +} 4432 + 4433 +Ответ: 4434 + 4435 +{ 4436 + "items": [ ~/~/ Список в разрезе ТС 4437 + { 4438 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4439 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4440 + "vehicleId": 0, ~/~/ ID ТС 4441 + "vehicleName": "string", ~/~/ Название ТС 4442 + "vehicleModel": "string", ~/~/ Модель ТС 4443 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4444 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4445 + "totalViolations": 0, ~/~/ Нарушений всего 4446 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4447 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4448 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4449 + "brakingViolations": 0, ~/~/ Нарушений торможения 4450 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4451 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4452 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4453 + }, 4454 + 4455 +((( 4456 + 4457 +))) 4458 + 4459 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4460 + "mileage": 0, ~/~/ Пробег, м 4461 + "tripsCount": 0, ~/~/ Кол-во рейсов 4462 + "trips": [ ~/~/ Информация по рейсу 4463 + { 4464 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4465 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4466 + "violationsCount": 0, ~/~/ Всего нарушений 4467 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4468 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4469 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4470 + "brakingViolations": 0, ~/~/ Нарушений торможения 4471 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4472 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4473 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4474 + }, 4475 + 4476 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4477 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4478 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4479 + "mileage": 0, ~/~/ Пробег, м 4480 + "motohours": 0, ~/~/ Моточасы, секунды 4481 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4482 + "startAddress": "string", ~/~/ Адрес начала рейса 4483 + "endAddress": "string", ~/~/ Адрес конца рейса 4484 + "drivers": [ ~/~/ Список водителей 4485 + { 4486 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4487 + "driverName": "string", ~/~/ФИО водителя 4488 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4489 + } 4490 + ] 4491 + } 4492 + ] 4493 + } 4494 + ] 4495 +} 4496 + 4497 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4498 + 4499 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4500 + 4501 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4502 + 4503 +(% class="box infomessage" %) 4504 +((( 4505 +**POST /api/v3/fuelcards/transactions** 4506 +))) 4507 + 4508 +Метод запроса: POST 4509 + 4510 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4511 +\\В заголовках запроса: X-Auth: Токен авторизации 4512 + 4513 +Параметры в теле запроса (JSON): 4514 + 4515 +{ 4516 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4517 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4518 + "ids": [ 4519 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4520 + ], 4521 + "timezone": 0 ~/~/ Часовой пояс 4522 +} 4523 + 4524 + 4525 +Ответ: 4526 + { 4527 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4528 + "driver": "string", ~/~/ Водители, привязанные к ТК 4529 + "object": "string", ~/~/ Наименование ТС 4530 + "amount": 0, ~/~/ Количество топлива 4531 + "amountDut": 0, ~/~/ Количество по ДУТ 4532 + "amountDiff": 0, ~/~/ Разница, л 4533 + "amountDiffPerc": 0, ~/~/ Разница, % 4534 + "summa": 0, ~/~/ Стоимость, руб 4535 + "serviceName": "string", ~/~/ Тип топлива 4536 + "price": 0, ~/~/ Цена за литр, руб 4537 + "cardName": "string", ~/~/ Наименование ТК 4538 + "cardNum": "string", ~/~/ Номер ТК 4539 + "operator": "string", ~/~/ Оператор ТК 4540 + "address": "string" ~/~/ Адрес АЗС 4541 + } 4542 + 4543 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4544 + 4545 +(% class="box infomessage" %) 4546 +((( 4547 +**GET /api/v3/fuelcards** 4548 +))) 4549 + 4550 +Метод запроса: GET 4551 + 4552 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4553 + 4554 +Ответ: 4555 + 4556 +[ 4557 + { 4558 + "Name": "string", ~/~/ Определяет наименование карты. 4559 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4560 + "Number": "string", ~/~/ Определяет № карты. 4561 + "Enabled": true, ~/~/ Определяет признак активности карты. 4562 + "Description": "string", ~/~/ Определяет описание карты. 4563 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4564 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4565 + "deleted": true ~/~/ Признак удаления 4566 + } 4567 +] 4568 + 4569 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4570 + 4571 + 4572 +== **Получение полных данных о ретрансляторе** == 4573 + 4574 +(% class="box infomessage" %) 4575 +((( 4576 +**GET ** **/api/v3/retranslations/{id}** 4577 +))) 4578 + 4579 +id - Идентификатор ретранслятора 4580 + 4581 + 4582 +Пример ответа: 4583 + 4584 +{ 4585 +"description": "", ~/~/ Поле описания ретранслятора 4586 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4587 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4588 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4589 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4590 +"objects": [ ~/~/ Объекты для ретрансляции 4591 +{ 4592 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4593 +"name": "", ~/~/ Наименование объекта ретрансляции 4594 +"imei": "", ~/~/ IMEI объекта ретрансляции 4595 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4596 +} 4597 + ], 4598 +"id": "", ~/~/ Идентификатор ретранслятора 4599 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4600 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4601 +} 4602 + 4603 + 4604 +== **Удаление данных ретранслятора** == 4605 + 4606 +(% class="box infomessage" %) 4607 +((( 4608 +**DELETE** **/api/v3/retranslations/{id}** 4609 +))) 4610 + 4611 +id - Идентификатор ретранслятора 4612 + 4613 + 4614 +== **Создание ретранслятора** == 4615 + 4616 +(% class="box infomessage" %) 4617 +((( 4618 +**POST ** **/api/v3/retranslations/{id}** 4619 +))) 4620 + 4621 +Запрос: 4622 + 4623 +{ 4624 +"description": "", ~/~/ Поле описания ретранслятора 4625 +"subscriberId": "", ~/~/ Идентификатор подписчика 4626 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4627 +"address": "", ~/~/ Адрес и порт принимающего сервера 4628 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4629 +"objects": [ ~/~/Объекты для ретрансляции 4630 +{ 4631 +"id": "", ~/~/ Идентификатор ретранслятора 4632 +"imei": "", ~/~/ IMEI объекта ретрансляции 4633 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4634 +} 4635 + ] 4636 +} 4637 + 4638 + 4639 +Ответ: 4640 + 4641 +{ 4642 +"description": "", ~/~/ Поле описания ретранслятора 4643 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4644 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4645 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4646 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4647 +"objects": [ ~/~/ Объекты для ретрансляции 4648 +{ 4649 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4650 +"name": "string", ~/~/ Наименование объекта ретрансляции 4651 +"imei": "", ~/~/ IMEI объекта ретрансляции 4652 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4653 +} 4654 + ], 4655 +"id": "", ~/~/ Идентификатор ретранслятора 4656 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4657 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4658 +} 4659 + 4660 + 4661 +== **Редактирование ретранслятора** == 4662 + 4663 +(% class="box infomessage" %) 4664 +((( 4665 +**PUT** **/api/v3/retranslations** 4666 +))) 4667 + 4668 +Пример запроса: 4669 + 4670 +{ 4671 +"id": "", ~/~/ Идентификатор ретранслятора 4672 +"description": "string", ~/~/ Поле описания ретранслятора 4673 +"subscriberId": "", ~/~/ Идентификатор подписчика 4674 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4675 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4676 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4677 +"objects": ~/~/ Объекты для ретрансляции 4678 +[ 4679 +{ 4680 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4681 +"imei": "", ~/~/ IMEI объекта ретрансляции 4682 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4683 +} 4684 + ] 4685 +} 4686 + 4687 + 4688 +Пример ответа: 4689 + 4690 +{ 4691 +"description": "", ~/~/ Поле описания ретранслятора 4692 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4693 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4694 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4695 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4696 +"objects": [ ~/~/ Объекты для ретрансляции 4697 +{ 4698 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4699 +"name": "string", ~/~/ Наименование объекта ретрансляции 4700 +"imei": "", ~/~/ IMEI объекта ретрансляции 4701 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4702 +} 4703 + ], 4704 +"id": "", ~/~/ Идентификатор ретранслятора 4705 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4706 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4707 +} 4708 + 4709 + 4710 +== **Получение списка ретранслятора клиента** == 4711 + 4712 +(% class="box infomessage" %) 4713 +((( 4714 +**POST /api/v3/retranslations/find** 4715 +))) 4716 + 4717 +Пример запроса: 4718 + 4719 +{ 4720 +"id": "", ~/~/ Идентификатор ретранслятора 4721 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4722 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4723 +} 4724 + 4725 +Ответ: 4726 + 4727 +[ 4728 +{ 4729 +"description": "", ~/~/ Поле описания ретранслятора 4730 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4731 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4732 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4733 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4734 +"id": "", ~/~/ Идентификатор ретранслятора 4735 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4736 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4737 +} 4738 +] 4739 + 4740 + 4741 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4742 + 4743 +== **API для отчета по выгрузке комбайнов** == 4744 + 4745 +(% class="box infomessage" %) 4746 +((( 4747 +**POST /api/v3/Reports/harvesterUnloading** 4748 +))) 4749 + 4750 +Пример запроса: 4751 + 4752 +{ 4753 + "byTime": 0, ~/~/ Объединение событий по времени 4754 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4755 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4756 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4757 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4758 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4759 + 0 4760 + ], 4761 + "from": "", ~/~/ Дата и время начало запроса 4762 + "to": "", ~/~/ Дата и время окончания запроса 4763 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4764 +} 4765 + 4766 +Пример ответа: 4767 + 4768 +[ 4769 + { 4770 + "harvesterName": "", ~/~/Комбайн, номер 4771 + "harvesterId": 0, ~/~/Комбайн, id 4772 +"harvesterModel": "", ~/~/ Модель комбайна 4773 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4774 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4775 + "events": [ ~/~/Список событий в разрезе комбайна 4776 + { 4777 + "driverId": "", ~/~/Идентификатор водителя 4778 + "driverName": "", ~/~/Водитель комбайна, ФИО 4779 + "RFID": "", ~/~/ идентификатор карты-метки 4780 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4781 + "vehicleId": 0, ~/~/идентификатор объекта 4782 + "vehicleName": "string", ~/~/ Имя объекта 4783 + "modelName": "string", ~/~/ Имя модели объекта 4784 + "nearestVehicles": [ ~/~/Объекты рядом 4785 + { 4786 + "vehicleId": 0, ~/~/идентификатор объекта 4787 + "vehicleName": "string" ~/~/ Имя объекта 4788 + } 4789 + ], 4790 + "fields": [ ~/~/Поля, где происходила выгрузка 4791 + { 4792 + "id": 0, ~/~/ идентификатор пользователя 4793 + "name": "string" ~/~/ имя пользователя 4794 + } 4795 + ], 4796 + "event": "string", ~/~/Событие 4797 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4798 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4799 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4800 + "cultureName": "string", ~/~/ название культуры 4801 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4802 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4803 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4804 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4805 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4806 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4807 + "issued": 0, ~/~/Выдано, бункеров 4808 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4809 + "latitude": 0, ~/~/Широта 4810 + "longitude": 0, ~/~/ Долгота 4811 + "litresAway": 0, ~/~/Отдано, л 4812 + "m3Away": 0 ~/~/Отдано, м3 4813 + } 4814 + ] 4815 + } 4816 +] 4817 + 4818 + 4819 +== **Отчет трек-датчики** == 4820 + 4821 +(% class="box infomessage" %) 4822 +((( 4823 +**POST /api/v3/Reports/sensorsWorks** 4824 +))) 4825 + 4826 +**Пример запроса:** 4827 + 4828 +{ 4829 + "vehicleIds": [ ~/~/ Список ID объектов 4830 + 0 4831 + ], 4832 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4833 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4834 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4835 +} 4836 + 4837 +**Пример ответа:** 4838 + 4839 +((( 4840 +{ 4841 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4842 + { 4843 + "vehicleId": 0, ~/~/ Идентификатор ТС 4844 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4845 + { 4846 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4847 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4848 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4849 + "name": "string", ~/~/ Наименование оборудования. 4850 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4851 + "totalMileage": 0, ~/~/ Общий пробег. 4852 + "avgSpeed": 0 ~/~/ Средняя скорость. 4853 + } 4854 + ] 4855 + } 4856 + ] 4857 +} 4858 + 4859 + 4860 +== **Превышение скорости** == 4861 + 4862 +(% class="box infomessage" %) 4863 +((( 4864 +**POST /api/v3/Reports/overSpeedDuration** 4865 +))) 4866 + 4867 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4868 + 4869 +Пример запроса: 4870 + 4871 +((( 4872 +{ 4873 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4874 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4875 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4876 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4877 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4878 +} 4879 +))) 4880 + 4881 +((( 4882 + 4883 +))) 4884 + 4885 +((( 4886 +Пример ответа: 4887 +))) 4888 + 4889 +((( 4890 +((( 4891 +[ 4892 + { 4893 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4894 + "duration": 0, ~/~/ Продолжительность события в секундах 4895 + "maxSpeed": 0, ~/~/ Максимальная скорость 4896 + "speedLimit": 0 ~/~/ Ограничение скорости 4897 + } 4898 +] 4899 +))) 4900 +))) 4901 +))) 4902 + 4903 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4904 + 4905 + 4906 +== **Запрос списка полей** == 4907 + 4908 +(% class="box successmessage" %) 4909 +((( 4910 +**POST /api/v3/agroLands/find** 4911 +))) 4912 + 4913 +Пример запроса: 4914 + 4915 +((( 4916 +((( 4917 +((( 4918 +{ 4919 + "year": 0, ~/~/ Фильтр по году 4920 + "name": "string", ~/~/ Фильтр по названию 4921 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4922 +} 4923 +))) 4924 +))) 4925 + 4926 + 4927 +))) 4928 + 4929 +Пример ответа: 4930 + 4931 +((( 4932 +[ 4933 + { 4934 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4935 + "year": 0, ~/~/ Год поля 4936 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 4937 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 4938 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 4939 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4940 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4941 + "counts": { ~/~/ Счётчики с/х поля 4942 + "fieldOperations": 0, ~/~/ Количество операций на поле 4943 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4944 + "facts": 0 ~/~/ Счётчик факта 4945 + }, 4946 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4947 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4948 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4949 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4950 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4951 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4952 + "planComment": "string", ~/~/ Комментарий к полю 4953 + "productivity": 0, ~/~/ Урожайность. 4954 + "id": 0, ~/~/ Идентификатор объекта геозоны 4955 + "name": "string", ~/~/ Название объекта геозоны 4956 + "type": 0, ~/~/ Тип объекта геозоны 4957 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4958 + "fname": "string", ~/~/ Имя файла 4959 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4960 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 4961 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 4962 + "description": "string", ~/~/ Описание объекта геозоны 4963 + "area": 0, ~/~/ Площадь, м2 4964 + "perimetr": 0, ~/~/ Периметр, м 4965 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 4966 + } 4967 +] 4968 + 4969 + 4970 +== **Создание нового поля ** == 4971 + 4972 +(% class="box successmessage" %) 4973 +((( 4974 +**POST /api/v3/agroLands** 4975 +))) 4976 + 4977 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4978 +X-agent - ID клиента 4979 + 4980 +Пример запроса: 4981 + 4982 +((( 4983 +{ 4984 + "extId": "string", 4985 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 4986 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4987 + "display": "string", ~/~/ Настройки отображения 4988 + "year": 0, ~/~/ Год поля 4989 + "name": "string", ~/~/ Наименование 4990 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4991 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 4992 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 4993 + "planComment": "string", ~/~/ Комментарий к полю 4994 + "cropRotations": [ ~/~/ Данные по севообороту 4995 + { 4996 + "landId": 0, ~/~/ ID поля 4997 + "landName": "string", ~/~/ Название поля 4998 + "year": 0, ~/~/ Год урожая 4999 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5000 + "cultureName": "string", ~/~/ Название культуры 5001 + "productivity": 0, ~/~/ Урожайность 5002 + "area": 0, ~/~/ Площадь поля, Га 5003 + "total": 0, ~/~/ Валовый сбор 5004 + "productivityFact": 0, ~/~/ Фактическая урожайность 5005 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5006 + "totalFact": 0, ~/~/ Фактический валовый сбор 5007 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5008 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5009 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5010 + "isyearplan": true, ~/~/ Годовой план 5011 + "comment": "string" ~/~/ Комментарий 5012 + } 5013 + ] 5014 +} 5015 +))) 5016 + 5017 +((( 5018 + 5019 +))) 5020 + 5021 +Пример ответа: 5022 + 5023 +((( 5024 +((( 5025 +{ 5026 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5027 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5028 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5029 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5030 + "cropRotations": [ ~/~/ Данные по севообороту 5031 + { 5032 + "landId": 0, ~/~/ ID поля 5033 + "landName": "string", ~/~/ Название поля 5034 + "year": 0, ~/~/ Год урожая 5035 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5036 + "cultureName": "string", ~/~/ Название культуры 5037 + "productivity": 0, ~/~/ Урожайность 5038 + "area": 0, ~/~/ Площадь поля, Га. 5039 + "total": 0, ~/~/ Валовый сбор 5040 + "productivityFact": 0, ~/~/ Фактическая урожайность 5041 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5042 + "totalFact": 0, ~/~/ Фактический валовый сбор 5043 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5044 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5045 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5046 + "isyearplan": true, ~/~/ годовой план 5047 + "comment": "string" ~/~/ Комментарий 5048 + } 5049 + ], 5050 + "cropVegetation": [ ~/~/ История вегетации поля 5051 + { 5052 + "values": [ ~/~/ Данные вегетации и состояния посева 5053 + { 5054 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5055 + "ndvi": 0 ~/~/ Индекс вегетации 5056 + } 5057 + ], 5058 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5059 + { 5060 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5061 + "type": "string", ~/~/ Тип 5062 + "pictureid": "string" ~/~/ Идентификатор ресурса 5063 + } 5064 + ], 5065 + "states": [ ~/~/ Ключевые даты развития поля 5066 + { 5067 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5068 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5069 + } 5070 + ] 5071 + } 5072 + ], 5073 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5074 + "counts": { 5075 + "fieldOperations": 0, ~/~/ Количество операций на поле 5076 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5077 + "facts": 0 ~/~/ Счётчик факта 5078 + }, 5079 + "planComment": "string", ~/~/ Комментарий к полю 5080 +))) 5081 + 5082 +((( 5083 + "productivity": 0, ~/~/ Урожайность. 5084 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5085 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5086 + "year": 0, ~/~/ Год поля 5087 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5088 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5089 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5090 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5091 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5092 + "id": 0, ~/~/ Идентификатор объекта геозоны 5093 + "name": "string", ~/~/ Название объекта геозоны 5094 + "type": 0, ~/~/ Тип объекта геозоны 5095 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5096 + "fname": "string", ~/~/ Имя файла 5097 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5098 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5099 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5100 + "description": "string", ~/~/ Описание объекта геозоны 5101 + "area": 0, ~/~/ Площадь, м2 5102 + "perimetr": 0, ~/~/ Периметр, м 5103 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5104 +} 5105 + 5106 + 5107 +))) 5108 +))) 5109 +))) 5110 + 5111 +== **Получение поля по id** == 5112 + 5113 +(% class="box infomessage" %) 5114 +((( 5115 +**GET /api/v3/agroLands/{id}** 5116 +))) 5117 + 5118 +Пример запроса: 5119 +id ~/~/ Идентификатор поля 5120 + 5121 +Пример ответа: 5122 + 5123 +((( 5124 +{ 5125 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5126 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5127 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5128 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5129 + "cropRotations": [ ~/~/ Данные по севообороту 5130 + { 5131 + "landId": 0, ~/~/ ID поля 5132 + "landName": "string", ~/~/ Название поля 5133 + "year": 0, ~/~/ Год урожая 5134 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5135 + "cultureName": "string", ~/~/ Название культуры 5136 + "productivity": 0, ~/~/ Урожайность 5137 + "area": 0, ~/~/ Площадь поля, Га 5138 + "total": 0, ~/~/ Валовый сбор 5139 + "productivityFact": 0, ~/~/ Фактическая урожайность 5140 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5141 + "totalFact": 0, ~/~/ Фактический валовый сбор 5142 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5143 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5144 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5145 + "isyearplan": true, ~/~/ План года 5146 + "comment": "string" ~/~/ Комментарий 5147 + } 5148 + ], 5149 + "cropVegetation": [ ~/~/ История вегетации поля 5150 + { 5151 + "values": [ ~/~/ Данные вегетации и состояния посева 5152 + { 5153 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5154 + "ndvi": 0 ~/~/ Индекс вегетации 5155 + } 5156 + ], 5157 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5158 + { 5159 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5160 + "type": "string", ~/~/ Тип 5161 + "pictureid": "string" ~/~/ Идентификатор ресурса 5162 + } 5163 + ], 5164 + "states": [ ~/~/ Ключевые даты развития поля 5165 + { 5166 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5167 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5168 + } 5169 + ] 5170 + } 5171 + ], 5172 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5173 + "counts": { 5174 + "fieldOperations": 0, ~/~/ Количество операций на поле 5175 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5176 + "facts": 0 ~/~/ Счётчик факта 5177 + }, 5178 + "planComment": "string", ~/~/ Комментарий к полю 5179 + "productivity": 0, ~/~/ Урожайность. 5180 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5181 +))) 5182 + 5183 +((( 5184 +((( 5185 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5186 + "year": 0, ~/~/ Год поля 5187 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5188 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5189 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5190 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5191 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5192 + "id": 0, ~/~/ Идентификатор объекта геозоны 5193 + "name": "string", ~/~/ Название объекта геозоны 5194 + "type": 0, ~/~/ Тип объекта геозоны 5195 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5196 + "fname": "string", ~/~/ Имя файла 5197 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5198 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5199 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5200 + "description": "string", ~/~/ Описание объекта геозоны 5201 + "area": 0, ~/~/ Площадь, м2 5202 + "perimetr": 0, ~/~/ Периметр, м 5203 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5204 +} 5205 +))) 5206 + 5207 + 5208 +== **Удаление существующего поля** == 5209 + 5210 +(% class="box errormessage" %) 5211 +((( 5212 +**DELETE /api/v3/agroLands/{id}** 5213 +))) 5214 + 5215 +Пример запроса: 5216 +id ~/~/ Идентификатор поля 5217 + 5218 +Пример ответа: 5219 + 5220 +((( 5221 +200 ~/~/ Успех 5222 +))) 5223 + 5224 +((( 5225 + 5226 +))) 5227 + 5228 +((( 5229 +((( 5230 +((( 5231 + 5232 +))) 5233 + 5234 +((( 5235 +== **Изменение поля** == 5236 + 5237 +(% class="box infomessage" %) 5238 +((( 5239 +**PUT /api/v3/agroLands** 5240 +))) 5241 + 5242 +Пример запроса: 5243 + 5244 +((( 5245 +((( 5246 +{ 5247 + "id": 0, ~/~/ Идентификатор поля 5248 + "extId": "string", ~/~/ ExtId 5249 + "shape": "string", ~/~/ Форма поля 5250 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5251 + "display": "string", ~/~/ Настройки отображения 5252 + "year": 0, ~/~/ Год поля 5253 + "name": "string", ~/~/ Наименование 5254 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5255 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5256 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5257 + "planComment": "string", ~/~/Комментарий к полю 5258 + "cropRotations": [ ~/~/ Данные по севообороту 5259 + { 5260 + "landId": 0, ~/~/ ID поля 5261 + "landName": "string", ~/~/ Название поля 5262 + "year": 0, ~/~/ Год урожая 5263 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5264 + "cultureName": "string", ~/~/ Название культуры 5265 + "productivity": 0, ~/~/ Урожайность 5266 + "area": 0, ~/~/ Площадь поля, Га. 5267 + "total": 0, ~/~/ Валовый сбор 5268 + "productivityFact": 0, ~/~/ Фактическая урожайность 5269 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5270 + "totalFact": 0, ~/~/ Фактический валовый сбор 5271 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5272 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5273 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5274 + "isyearplan": true, 5275 + "comment": "string" ~/~/ Комментарий 5276 + } 5277 + ], 5278 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5279 +} 5280 +))) 5281 +))) 5282 + 5283 +((( 5284 + 5285 +))) 5286 + 5287 +Пример ответа: 5288 + 5289 +((( 5290 +((( 5291 +((( 5292 +{ 5293 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5294 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5295 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5296 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5297 + "cropRotations": [ ~/~/ Данные по севообороту 5298 + { 5299 + "landId": 0, ~/~/ ID поля 5300 + "landName": "string", ~/~/ Название поля 5301 + "year": 0, ~/~/ Год урожая 5302 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5303 + "cultureName": "string", ~/~/ Название культуры 5304 + "productivity": 0, ~/~/ Урожайность 5305 + "area": 0, ~/~/ Площадь поля, Га 5306 + "total": 0, ~/~/ Валовый сбор 5307 + "productivityFact": 0, ~/~/ Фактическая урожайность 5308 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5309 + "totalFact": 0, ~/~/ Фактический валовый сбор 5310 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5311 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5312 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5313 + "isyearplan": true, ~/~/ 5314 + "comment": "string" ~/~/ Комментарий 5315 + } 5316 + ], 5317 + "cropVegetation": [ ~/~/ История вегетации поля 5318 + { 5319 + "values": [ ~/~/ Данные вегетации и состояния посева 5320 + { 5321 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5322 + "ndvi": 0 ~/~/ Индекс вегетации 5323 + } 5324 + ], 5325 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5326 + { 5327 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5328 + "type": "string", ~/~/ Тип 5329 + "pictureid": "string" ~/~/ Идентификатор ресурса 5330 + } 5331 + ], 5332 + "states": [ ~/~/ Ключевые даты развития поля 5333 + { 5334 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5335 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5336 + } 5337 + ] 5338 + } 5339 + ], 5340 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5341 + "counts": { 5342 + "fieldOperations": 0, ~/~/ Количество операций на поле 5343 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5344 + "facts": 0 ~/~/ Счётчик факта 5345 + }, 5346 + "planComment": "string", ~/~/ Комментарий к полю 5347 + "productivity": 0, ~/~/ Урожайность. 5348 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5349 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5350 + "year": 0, ~/~/ Год поля 5351 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5352 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5353 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5354 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5355 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5356 + "id": 0, ~/~/ Идентификатор объекта геозоны 5357 + "name": "string", ~/~/ Название объекта геозоны 5358 + "type": 0, ~/~/ Тип объекта геозоны 5359 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5360 + "fname": "string", ~/~/ Имя файла 5361 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5362 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5363 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5364 + "description": "string", ~/~/ Описание объекта геозоны 5365 + "area": 0, ~/~/ Площадь, м2 5366 + "perimetr": 0, ~/~/ Периметр, м 5367 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5368 +} 5369 +))) 5370 +))) 5371 +))) 5372 +))) 5373 +))) 5374 + 5375 + 5376 +== **Редактирование года урожая ** == 5377 + 5378 +(% class="box successmessage" %) 5379 +((( 5380 +**POST /api/v3/agroLands/updateOpenCloseYear** 5381 +))) 5382 + 5383 +Пример запроса: 5384 + 5385 +((( 5386 +((( 5387 +{ 5388 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5389 + 0 5390 + ], 5391 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5392 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5393 +} 5394 +))) 5395 + 5396 + 5397 +))) 5398 + 5399 +Пример ответа: 5400 + 5401 +((( 5402 +((( 5403 +{ 5404 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5405 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5406 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5407 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5408 + "cropRotations": [ ~/~/ Данные по севообороту 5409 + { 5410 + "landId": 0, ~/~/ ID поля 5411 + "landName": "string", ~/~/ Название поля 5412 + "year": 0, ~/~/ Год урожая 5413 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5414 + "cultureName": "string", ~/~/ Название культуры 5415 + "productivity": 0, ~/~/ Урожайность 5416 + "area": 0, ~/~/ Площадь поля, Га. 5417 + "total": 0, ~/~/ Валовый сбор 5418 + "productivityFact": 0, ~/~/ Фактическая урожайность 5419 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5420 + "totalFact": 0, ~/~/ Фактический валовый сбор 5421 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5422 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5423 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5424 + "isyearplan": true, ~/~/ 5425 + "comment": "string" ~/~/ Комментарий 5426 + } 5427 + ], 5428 + "cropVegetation": [ ~/~/ История вегетации поля 5429 + { 5430 + "values": [ ~/~/ Данные вегетации и состояния посева 5431 + { 5432 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5433 + "ndvi": 0 ~/~/ Индекс вегетации 5434 + } 5435 + ], 5436 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5437 + { 5438 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5439 + "type": "string", ~/~/ Тип 5440 + "pictureid": "string" ~/~/ Идентификатор ресурса 5441 + } 5442 + ], 5443 + "states": [ ~/~/ Ключевые даты развития поля 5444 + { 5445 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5446 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5447 + } 5448 + ] 5449 + } 5450 + ], 5451 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5452 + "counts": { 5453 + "fieldOperations": 0, ~/~/ Количество операций на поле 5454 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5455 + "facts": 0 ~/~/ Счётчик факта 5456 + }, 5457 + "planComment": "string", ~/~/ Комментарий к полю 5458 + "productivity": 0, ~/~/ Урожайность. 5459 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5460 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5461 + "year": 0, ~/~/ Год поля 5462 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5463 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5464 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5465 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5466 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5467 + "id": 0, ~/~/ Идентификатор объекта геозоны 5468 + "name": "string", ~/~/ Название объекта геозоны 5469 + "type": 0, ~/~/ Тип объекта геозоны 5470 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5471 + "fname": "string", ~/~/ Имя файла 5472 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5473 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5474 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5475 + "description": "string", ~/~/ Описание объекта геозоны 5476 + "area": 0, ~/~/ Площадь, м2 5477 + "perimetr": 0, ~/~/ ериметр, м 5478 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5479 +} 5480 +))) 5481 + 5482 + 5483 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5484 +))) 5485 +))) 5486 +))) 5487 + 5488 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5489 + 5490 + 5491 +(% class="box infomessage" %) 5492 +((( 5493 +**GET api/v3/Vehicles/recyclebin/all** 5494 +))) 5495 + 5496 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5497 + 5498 +Параметр запроса: {parentId} - идентификатор агента 5499 + 5500 +В заголовках запроса: X-Auth: Токен авторизации 5501 + 5502 +Ответ: 5503 + 5504 +[ 5505 + { 5506 + "recordTime": "", ~/~/Время записи 5507 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5508 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5509 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5510 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5511 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5512 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5513 + "items": [ ~/~/ 5514 +nullable: true ~/~/Детали 5515 + { 5516 + "name": "string", ~/~/наименование столбца 5517 + "value": "string" ~/~/содержание столбца 5518 + } 5519 + ] 5520 + }, 5521 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5522 + "string" 5523 + ] 5524 + } 5525 +] 5526 + 5527 + 5528 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5529 + 5530 +(% class="box infomessage" %) 5531 +((( 5532 +**POST api/v3/Vehicles/recyclebin/erase** 5533 +))) 5534 + 5535 +В заголовках запроса: X-Auth: Токен авторизации 5536 + 5537 +Пример запроса: 5538 + 5539 +[ 5540 +0 5541 +] 5542 + 5543 + 5544 +Пример ответа: 5545 + 5546 +[ 5547 +{ 5548 + "recordTime": "", ~/~/Время записи 5549 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5550 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5551 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5552 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5553 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5554 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5555 + "items": [ ~/~/Детали 5556 + { 5557 + "name": "", ~/~/Имя свойства 5558 + "value": "" ~/~/Значение свойства 5559 + } 5560 + ] 5561 + }, 5562 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5563 + "" 5564 + ] 5565 + } 5566 +] 5567 + 5568 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5569 + 5570 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5571 + 5572 +(% class="box infomessage" %) 5573 +((( 5574 +**POST api/v3/Vehicles/recyclebin/restore** 5575 +))) 5576 + 5577 +В заголовках запроса: X-Auth: Токен авторизации 5578 + 5579 +Параметры в теле запроса (JSON): 5580 + 5581 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5582 + 5583 +В заголовках запроса: X-Auth: Токен авторизации 5584 + 5585 + 5586 +Пример запроса: 5587 + 5588 +((( 5589 +[ 5590 +))) 5591 + 5592 +((( 5593 + 0 5594 +))) 5595 + 5596 +((( 5597 +] 5598 +))) 5599 + 5600 + 5601 +Пример ответа: 5602 + 5603 +[ 5604 +{ 5605 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5606 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5607 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5608 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5609 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5610 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5611 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5612 + "items": [ ~/~/Детали 5613 + { 5614 + "name": "string", ~/~/Имя свойства 5615 + "value": "string" ~/~/Значение свойства 5616 + } 5617 + ] 5618 + }, 5619 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5620 + "string" 5621 + ] 5622 + } 5623 +] 5624 + 5625 + 5626 += **Раздел: Журнал заданий ** = 5627 + 5628 + 5629 +== **Создание задания в Журнале заданий** == 5630 + 5631 +(% class="box infomessage" %) 5632 +((( 5633 +**POST /api/v3/vehicletasks** 5634 +))) 5635 + 5636 +Пример запроса: 5637 + 5638 +((( 5639 +{ 5640 + "vehicleId": 0, ~/~/ Идентификатор ТС 5641 + "description": "string", ~/~/ Описание 5642 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5643 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5644 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5645 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5646 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5647 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5648 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5649 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5650 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5651 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5652 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5653 + "cost": { 5654 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5655 + "Name": "string", ~/~/ Наименование 5656 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5657 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5658 + "Norm": 0 ~/~/ Норма внесения 5659 + }, 5660 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5661 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5662 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5663 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5664 + "deleted": true, ~/~/ Признак удаления 5665 + "extId": "string", 5666 + "GeoIds": [ ~/~/ Cвязанные поля 5667 + 0 5668 + ] 5669 +} 5670 +))) 5671 + 5672 + 5673 +Пример ответа: 5674 + 5675 +{ 5676 + "vehicleId": 0, ~/~/ Идентификатор ТС 5677 + "description": "string", ~/~/ Описание 5678 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5679 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5680 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5681 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5682 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5683 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5684 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5685 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5686 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5687 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5688 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5689 + "cost": { 5690 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5691 + "Name": "string", ~/~/ Наименование 5692 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5693 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5694 + "Norm": 0 ~/~/ Норма внесения 5695 + }, 5696 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5697 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5698 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5699 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5700 + "deleted": true, ~/~/ Признак удаления 5701 + "extId": "string", ~/~/ ExtId 5702 + "GeoIds": [ ~/~/ Связанные поля 5703 + 0 5704 + ] 5705 +} 5706 + 5707 + 5708 +== **Редактирование задания в Журнале заданий** == 5709 + 5710 +(% class="box successmessage" %) 5711 +((( 5712 +**PUT /api/v3/vehicletasks** 5713 +))) 5714 + 5715 +Пример запроса: 5716 + 5717 +((( 5718 +{ 5719 + "vehicleId": 0, ~/~/ Идентификатор ТС 5720 + "description": "string", ~/~/ Описание 5721 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5722 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5723 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5724 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5725 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5726 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5727 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5728 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5729 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5730 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5731 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5732 + "cost": { 5733 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5734 + "Name": "string", ~/~/ Наименование 5735 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5736 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5737 + "Norm": 0 ~/~/ Норма внесения 5738 + }, 5739 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5740 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5741 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5742 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5743 + "deleted": true, ~/~/ Признак удаления 5744 + "extId": "string", ~/~/ ExtId 5745 + "GeoIds": [ ~/~/ Связанные поля 5746 + 0 5747 + ] 5748 +} 5749 +))) 5750 + 5751 + 5752 +Пример ответа: 5753 + 5754 +{ 5755 + "vehicleId": 0, ~/~/ Идентификатор ТС 5756 + "description": "string", ~/~/ Описание 5757 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5758 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5759 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5760 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5761 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5762 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5763 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5764 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5765 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5766 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5767 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5768 + "cost": { 5769 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5770 + "Name": "string", ~/~/ Наименование 5771 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5772 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5773 + "Norm": 0 ~/~/ Норма внесения 5774 + }, 5775 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5776 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5777 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5778 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5779 + "deleted": true, ~/~/ Признак удаления 5780 + "extId": "string", ~/~/ ExtId 5781 + "GeoIds": [ ~/~/ Связанные поля 5782 + 0 5783 + ] 5784 +} 5785 + 5786 + 5787 +== **Удаление задания в Журнале заданий** == 5788 + 5789 +(% class="box warningmessage" %) 5790 +((( 5791 +**DELETE /api/v3/vehicletasks** 5792 +))) 5793 + 5794 +Пример запроса: 5795 + 5796 +((( 5797 +[ 5798 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5799 +] 5800 +))) 5801 + 5802 +((( 5803 + 5804 +))) 5805 + 5806 +Пример ответа: 5807 + 5808 +{ 5809 + "vehicleId": 0, ~/~/ Идентификатор ТС 5810 + "description": "string", ~/~/ Описание 5811 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5812 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5813 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5814 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5815 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5816 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5817 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5818 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5819 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5820 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5821 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5822 + "cost": { 5823 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5824 + "Name": "string", ~/~/ Наименование 5825 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5826 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5827 + "Norm": 0 ~/~/ Норма внесения 5828 + }, 5829 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5830 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5831 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5832 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5833 + "deleted": true, ~/~/ Признак удаления 5834 + "extId": "string", ~/~/ ExtId 5835 + "GeoIds": [ ~/~/ Связанные поля 5836 + 0 5837 + ] 5838 +} 5839 + 5840 + 5841 +== **Получение списка Журнала заданий** == 5842 + 5843 +(% class="box infomessage" %) 5844 +((( 5845 +**POST /api/v3/vehicletasks/getbyperiod** 5846 +))) 5847 + 5848 +Пример запроса: 5849 + 5850 +((( 5851 +{ 5852 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5853 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 5854 + "TimeZone": 0, ~/~/ Часовой пояс. 5855 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 5856 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 5857 + ], 5858 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 5859 + 0 5860 + ], 5861 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 5862 + 0 5863 + ], 5864 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 5865 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 5866 +} 5867 +))) 5868 + 5869 + 5870 +Пример ответа: 5871 + 5872 +((( 5873 +{ 5874 + "total": 0, ~/~/ Общее количество записей 5875 + "pages": 0, ~/~/ Общее количество страниц 5876 + "currentPage": 0, ~/~/ Текущая страница 5877 + "items": [ ~/~/ Записи 5878 + { 5879 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5880 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 5881 + "name": "string", ~/~/ Название задания. 5882 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 5883 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 5884 + "workKind": "string", ~/~/ Вид работ 5885 + "techOp": "string", ~/~/ Тех. операция 5886 + "trailerModel": "string", ~/~/ Модель агрегата 5887 + "width": "string", ~/~/ Ширина, м 5888 + "speed": "string", ~/~/ Тех. скорость 5889 + "fields": "string", ~/~/ Поля 5890 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 5891 + "vehicles": "string", ~/~/ Объект-модель 5892 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 5893 + "drivers": "string", ~/~/ Водители 5894 + "tmc": "string", ~/~/ ТМЦ 5895 + "client": "string", ~/~/ Клиент 5896 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5897 + "dep": "string", ~/~/ Подразделение 5898 + "geoIds": [ ~/~/ Связанные поля 5899 + 0 5900 + ] 5901 + } 5902 + ] 5903 +} 5904 +))) 5905 + 5906 + 5907 += **Раздел: Локатор ** = 5908 + 5909 + 5910 +== **Получение списка локаторов, доступных пользователю ** == 5911 + 5912 +(% class="box infomessage" %) 5913 +((( 5914 +**GET /api/v3/locators** 5915 +))) 5916 + 5917 +В заголовках запроса: X-Auth: Токен авторизации 5918 + 5919 + 5920 +Пример ответа: 5921 + 5922 +((( 5923 +[ 5924 + { 5925 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5926 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5927 + "agentName": "string", ~/~/ Наименование агента. 5928 + "isEnabled": true, ~/~/ Активен 5929 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5930 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5931 + "name": "string", ~/~/ Наименование 5932 + "status": 0, ~/~/ 5933 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5934 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5935 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5936 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5937 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5938 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5939 + "url": "string", ~/~/ Ссылка 5940 + "language": 0, ~/~/ Язык. 5941 + "vehiclesCount": 0, ~/~/ Количество объектов. 5942 + "geozonesCount": 0, ~/~/ Количество геозон. 5943 + "fieldsCount": 0 ~/~/ Количество полей. 5944 + } 5945 +] 5946 +))) 5947 + 5948 + 5949 + 5950 +== **Создание локатора** == 5951 + 5952 +(% class="box successmessage" %) 5953 +((( 5954 +**POST /api/v3/locators** 5955 +))) 5956 + 5957 +Пример запроса: 5958 + 5959 +((( 5960 +{ 5961 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5962 + "isEnabled": true, ~/~/ Активность 5963 + "name": "string", ~/~/ Наименование локатора 5964 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 5965 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5966 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5967 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5968 + "url": "string", ~/~/ Ссылка 5969 + "language": 0 ~/~/ Язык 5970 +} 5971 +))) 5972 + 5973 + 5974 +Пример ответа: 5975 + 5976 +((( 5977 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 5978 +))) 5979 + 5980 + 5981 + 5982 +== **Изменение локатора** == 5983 + 5984 +(% class="box infomessage" %) 5985 +((( 5986 +**PUT /api/v3/locators** 5987 +))) 5988 + 5989 +Пример запроса: 5990 + 5991 +((( 5992 +{ 5993 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5994 + "isEnabled": true, ~/~/ Активность 5995 + "name": "string", ~/~/ Наименование 5996 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 5997 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5998 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5999 + "autoProlongation": true, ~/~/ Автопродление срока действия 6000 + "url": "string", ~/~/ Ссылка 6001 + "language": 0 ~/~/ Язык 6002 +} 6003 +))) 6004 + 6005 + 6006 +Пример ответа: 6007 + 6008 +200 ~/~/ Success 6009 + 6010 + 6011 +== **Удалить локатор** == 6012 + 6013 +(% class="box warningmessage" %) 6014 +((( 6015 +**DELETE /api/v3/locators** 6016 +))) 6017 + 6018 +Пример запроса: 6019 + 6020 +((( 6021 +[ 6022 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6023 +] 6024 +))) 6025 + 6026 + 6027 + 6028 += **Раздел: Яндекс Маршруты** = 6029 + 6030 + 6031 +== **Возвращение списка маршрутов** == 6032 + 6033 +(% class="box infomessage" %) 6034 +((( 6035 +**GET /api/v3/TransportRoutes** 6036 +))) 6037 + 6038 +Пример запроса: 6039 +Id ~/~/ Идентификатор поля 6040 + 6041 + 6042 +Пример ответа: 6043 + 6044 +((( 6045 +[ 6046 + { 6047 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6048 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6049 + "name": "string", ~/~/ Наименование маршрута. 6050 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6051 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6052 + 0 6053 + ] 6054 + } 6055 +] 6056 +))) 6057 + 6058 + 6059 + 6060 +== **Добавить маршрут** == 6061 + 6062 +(% class="box infomessage" %) 6063 +((( 6064 +**POST /api/v3/TransportRoutes** 6065 +))) 6066 + 6067 +Пример запроса: 6068 +{ 6069 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6070 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6071 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6072 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6073 + 0 6074 + ] 6075 +} 6076 + 6077 + 6078 +Пример ответа: 6079 + 6080 +((( 6081 +{ 6082 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6083 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6084 + "name": "string", ~/~/ Определяет наименование маршрута 6085 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6086 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6087 + 0 6088 + ] 6089 +} 6090 +))) 6091 + 6092 + 6093 +== **Обновление маршрута** == 6094 + 6095 +(% class="box successmessage" %) 6096 +((( 6097 +**PUT /api/v3/TransportRoutes** 6098 +))) 6099 + 6100 +Пример запроса: 6101 + 6102 +((( 6103 +{ 6104 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6105 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6106 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6107 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6108 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6109 + 0 6110 + ] 6111 +} 6112 +))) 6113 + 6114 + 6115 +Пример ответа: 6116 + 6117 +((( 6118 +{ 6119 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6120 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6121 + "name": "string", ~/~/ Определяет наименование маршрута 6122 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6123 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6124 + 0 6125 + ] 6126 +} 6127 +))) 6128 + 6129 + 6130 +== **Получить связки маршрутов ТС** == 6131 + 6132 +(% class="box infomessage" %) 6133 +((( 6134 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6135 +))) 6136 + 6137 +Пример запроса: 6138 + 6139 +((( 6140 +[ 6141 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6142 +] 6143 +))) 6144 + 6145 + 6146 +Пример ответа: 6147 + 6148 +((( 6149 +[ 6150 + { 6151 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6152 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6153 + } 6154 +] 6155 +))) 6156 + 6157 + 6158 +== **Удалить маршрут** == 6159 + 6160 +(% class="box warningmessage" %) 6161 +((( 6162 +**DELETE /api/v3/TransportRoutes/{id}** 6163 +))) 6164 + 6165 +Пример запроса: 6166 +Id ~/~/ Идентификатор поля 6167 + 6168 + 6169 +==== ==== 6170 + 6171 += **Раздел: Управление доступа к машинам** = 6172 + 6173 + 6174 +== Получение списка транспортных средств видимых пользователю == 6175 + 6176 +(% class="box infomessage" %) 6177 +((( 6178 +**GET /api/v3/UserVisibleVehicles/{userId}** 6179 +))) 6180 + 6181 +Пример ответа: 6182 + 6183 +((( 6184 +{ 6185 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6186 + 0 6187 + ] 6188 +} 6189 +))) 6190 + 6191 + 6192 + 6193 +== Задает видимость транспортных средств пользователю == 6194 + 6195 +(% class="box infomessage" %) 6196 +((( 6197 +**POST /api/v3/UserVisibleVehicles** 6198 +))) 6199 + 6200 +Пример запроса: 6201 + 6202 +((( 6203 +((( 6204 +{ 6205 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6206 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6207 + 0 6208 + ] 6209 +} 6210 +))) 6211 + 6212 +((( 6213 + 6214 +))) 6215 + 6216 +((( 6217 + 6218 +))) 6219 + 6220 +((( 6221 +Пример ответа : 6222 +))) 6223 + 6224 +((( 6225 + 6226 +))) 6227 + 6228 +((( 6229 +200 ~/~/ Success 6230 +))) 6231 +))) 6232 + 6233 + 6234 + 6235 + 6236 + 6237 + 3371 3371 (% class="box" lang="en-US" style="text-align: center;" %) 3372 3372 ((( 3373 3373 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **