Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/08/08 13:28
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" %)**Добавление пользователя**(%%) == ... ... @@ -349,9 +349,8 @@ 349 349 [ 350 350 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 351 351 ], 352 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский457 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 - 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 - 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 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": "" , ~/~/ имя ... ... @@ -436,8 +436,7 @@ 436 436 "email": "" , ~/~/ E-mail 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 - "astLogged": "", ~/~/ дата/время последней авторизации 440 - 534 + "lastLogged": "", ~/~/ дата/время последней авторизации 441 441 (% style="color:#000000" %)} 442 442 443 443 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -511,10 +511,8 @@ 511 511 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 512 512 513 513 (% lang="en-US" style="text-align:left" %) 514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 - 516 -(% lang="en-US" style="text-align:left" %) 517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 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 ... ... @@ -682,8 +682,254 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 769 +(% class="wikigeneratedid" %) 770 += = 686 686 772 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 773 + 774 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 775 + 776 +(% class="box infomessage" %) 777 +((( 778 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 779 +))) 780 + 781 +Метод возвращает полную информацию о модели объекта. 782 + 783 +(% style="color:#000000" %)Метод запроса: **GET** 784 + 785 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 786 + 787 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 788 + 789 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 790 + 791 +(% style="color:#000000" %)Ответ: 792 + 793 +(% style="color:#000000" %){ 794 + "parentName": "string", 795 + "name": "string", 796 + "picture": "string", 797 + "minspeed": 0, 798 + "maxspeed": 0, 799 + "width": 0, 800 + "imbeddedtrailer": true, 801 + "hoppercapacity": 0, 802 + "hopperdischargespeed": 0, 803 + "modelType": 0, 804 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 805 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 806 + "deleted": true 807 +} 808 + 809 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 810 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 811 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 812 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 813 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 814 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 815 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 816 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 817 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 818 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 819 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 820 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 821 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 822 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 823 + 824 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 825 + 826 +(% class="box successmessage" %) 827 +((( 828 +(% lang="en-US" %)**POST /api/v3/models/find** 829 +))) 830 + 831 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 832 + 833 +(% style="color:#000000" %)Метод запроса: **POST** 834 + 835 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 836 + 837 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 838 + 839 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 840 + 841 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 842 +} 843 + 844 +(% style="color:#000000" %)Ответ: 845 + 846 +(% style="color:#000000" %)[ 847 + { 848 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 849 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 850 + "parentName": "string", 851 + "name": "string", 852 + "modelType": 0 853 + } 854 +] 855 + 856 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 857 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 858 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 859 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 860 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 861 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 862 + 863 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 864 + 865 +(% class="box successmessage" %) 866 +((( 867 +(% lang="en-US" %)**POST /api/v3/models** 868 +))) 869 + 870 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 871 + 872 +(% style="color:#000000" %)Метод запроса: **POST** 873 + 874 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 875 + 876 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 877 + 878 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 879 + 880 +{ 881 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 882 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 883 + "deleted": false, 884 + "extId": "string", 885 + "name": "string", 886 + "picture": "string", 887 + "minspeed": 0, 888 + "maxspeed": 0, 889 + "width": 0, 890 + "imbeddedtrailer": true, 891 + "fueloutlay": 0, 892 + "hoppercapacity": 0, 893 + "hopperdischargespeed": 0, 894 + "modelType": 0 895 +} 896 + 897 +Ответ: 898 + 899 +{ 900 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 901 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 902 + "deleted": false, 903 + "extId": "string", 904 + "name": "string", 905 + "picture": "string", 906 + "minspeed": 0, 907 + "maxspeed": 0, 908 + "width": 0, 909 + "imbeddedtrailer": true, 910 + "hoppercapacity": 0, 911 + "hopperdischargespeed": 0, 912 + "modelType": 0 913 +} 914 + 915 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 916 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 917 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 918 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 919 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 920 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 921 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 922 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 923 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 924 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 925 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 926 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 927 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 928 + 929 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 930 + 931 +(% class="box warningmessage" %) 932 +((( 933 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 934 +))) 935 + 936 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 937 + 938 +(% style="color:#000000" %)Метод запроса: **PUT** 939 + 940 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 941 + 942 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 943 + 944 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 945 + 946 +{ 947 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 948 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 949 + "deleted": true, 950 + "extId": "string", 951 + "name": "string", 952 + "picture": "string", 953 + "minspeed": 0, 954 + "maxspeed": 0, 955 + "width": 0, 956 + "imbeddedtrailer": true, 957 + "fueloutlay": 0, 958 + "hoppercapacity": 0, 959 + "hopperdischargespeed": 0, 960 + "modelType": 0 961 +} 962 + 963 +Ответ: 964 + 965 +{ 966 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 967 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 968 + "deleted": true, 969 + "extId": "string", 970 + "name": "string", 971 + "picture": "string", 972 + "minspeed": 0, 973 + "maxspeed": 0, 974 + "width": 0, 975 + "imbeddedtrailer": true, 976 + "fueloutlay": 0, 977 + "hoppercapacity": 0, 978 + "hopperdischargespeed": 0, 979 + "modelType": 0 980 +} 981 + 982 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 983 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 984 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 985 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 986 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 987 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 988 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 989 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 990 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 991 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 992 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 993 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 994 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 995 + 996 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 997 + 998 +(% class="box errormessage" %) 999 +((( 1000 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 1001 +))) 1002 + 1003 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 1004 + 1005 +(% style="color:#000000" %)Метод запроса: **DELETE** 1006 + 1007 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 1008 + 1009 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 1010 + 1011 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1012 + 1013 +Ответ: В случае успеха **Success 200** 1014 + 1015 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 1016 + 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 688 688 689 689 (% class="box infomessage" %) ... ... @@ -701,9 +701,9 @@ 701 701 702 702 (% style="color:#000000" %)Метод запроса: **GET** 703 703 704 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %) <(% lang="en-US" %)v(%%)ehicleID>1034 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID} 705 705 706 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__>- идентификатор объекта (опционально)1036 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 707 707 708 708 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 709 709 ... ... @@ -711,6 +711,17 @@ 711 711 712 712 ((( 713 713 { 1044 + 1045 +((( 1046 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1047 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1048 +))) 1049 + 1050 +((( 1051 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1052 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1053 +))) 1054 + 714 714 "vehicleId": "", ~/~/ ID объекта 715 715 "name": "", ~/~/ Имя объекта 716 716 "imei": "", ~/~/ IMEI объекта ... ... @@ -717,20 +717,130 @@ 717 717 "deviceTypeId": , ~/~/ ID типа устройства 718 718 "deviceTypeName": "", ~/~/ Название типа устройства 719 719 "sim1": "", ~/~/ Номер SIM1 720 - "parentId": "", Номер SIM2 721 - "parentName": "", Наименование клиента-родителя 722 - "modelId": "", ID модели объекта 723 - "modelName": "", Имя модели объекта 724 - "createdAt": "", Дата создания объекта 725 - "mileageCalcMethod": "", Выбранный метод расчета пробега 726 - "counters": { ~/~/ Нормы 727 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 728 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 729 - "mileage": "", ~/~/ Пробег по нормам в метрах 730 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 731 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 732 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 1061 + "sim2": "", ~/~/ Номер SIM2 1062 + "parentId": "", ~/~/ ID клиента-родителя 1063 + "parentName": "", ~/~/ Наименование клиента-родителя 1064 + "modelId": "", ~/~/ ID модели объекта 1065 + "modelName": "", ~/~/ Имя модели объекта 1066 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1067 + "unitName": "string", ~/~/ Наименование подразделения 1068 + "status": 0, ~/~/ Статус объекта 1069 + "createdAt": "", ~/~/ Дата создания объекта 733 733 }, 1071 +"customFields": [ ~/~/ Произвольные поля 1072 + { 1073 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1074 + "name": "string", ~/~/ Имя поля 1075 + "value": "string", ~/~/ Значение поля 1076 + "forClient": true, ~/~/ Не используемая функция 1077 + "forTooltip": true, ~/~/ Отображать в подсказке 1078 + "forReport": true ~/~/ Отображать в отчете 1079 + } 1080 + 1081 +], ~/~/ Данные с вкладки нормы 1082 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1083 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1084 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1085 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1086 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1087 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1088 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1089 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1090 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1091 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1092 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1093 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1094 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1095 + "mileageCoeff": 0, ~/~/ коэффициент пробега 1096 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1097 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1098 + "counters": { ~/~/ Счетчики 1099 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1100 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1101 + "mileage": 0, ~/~/ Текущий пробег 1102 + "motohours": 0, ~/~/ Текущие моточасы 1103 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1104 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 1105 + }, 1106 + 1107 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1108 + "id": "string", ~/~/ ID объекта 1109 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 1110 + "host": "string", ~/~/ CMSV6 Web Host 1111 + "login": "string", ~/~/ CMSV6 Account 1112 + "password": "string" ~/~/ CMSV6 Password 1113 + }, 1114 + 1115 +"commandTemplates": [ ~/~/ Шаблоны команд 1116 + { 1117 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1118 + "name": "string", ~/~/ Наименование команды 1119 + "command": "string", ~/~/ Текст команды 1120 + "retries": 0 ~/~/ Количество попыток 1121 + } 1122 + ], 1123 + "sensors": [ ~/~/ Датчики 1124 + { 1125 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1126 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1127 + "type": 0, ~/~/ Тип датчика 1128 + "name": "string", ~/~/ Имя датчика 1129 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1130 + "inputNumber": 0, ~/~/ Номер входа 1131 + "pseudonym": "string", ~/~/ Псевдоним 1132 + "medianDegree": 0, ~/~/ Медианная фильтрация 1133 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1134 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1135 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1136 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1137 + { 1138 + "grades": [ ~/~/ Таблица тарировки 1 1139 + { 1140 + "input": 0, ~/~/ Входящее значение 1141 + "output": 0 ~/~/ Выходящее значение 1142 + } 1143 + ], 1144 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1145 + } 1146 + ], 1147 + "showInTooltip": true, ~/~/ Отображать в подсказке 1148 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1149 + "color": "string", ~/~/ Код цвета датчиков 1150 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1151 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1152 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1153 + "expr": "string", ~/~/ Формула 1154 + "children": [ ~/~/ массив дочерних датчиков 1155 + "string" 1156 + ], 1157 + "customParams": { ~/~/ прочие произвольные параметры 1158 + "additionalProp1": "string", 1159 + "additionalProp2": "string", 1160 + "additionalProp3": "string" 1161 + }, 1162 + 1163 +~/~/ Характерные для произвольного: 1164 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1165 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1166 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1167 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1168 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1169 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1170 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1171 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1172 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1173 +~/~/ "ValueOn": "Вкл.", 1174 +~/~/ "ValueOff": "Выкл." 1175 + "summaryMaxValue": 0 ~/~/ Макс. значение 1176 + } 1177 + "drivers": [ ~/~/ Водители 1178 + { 1179 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1180 + "name": "string", ~/~/ Наименование 1181 + "description": "string", 1182 + "isDefault": true ~/~/ По умолчанию 1183 + } 1184 + ], 734 734 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 735 735 { 736 736 "id": "", ~/~/ ID задания ... ... @@ -746,10 +746,28 @@ 746 746 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 747 747 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 748 748 } 749 - ] 1200 + ], 1201 +"statusHistory": [ ~/~/ История статусов 1202 + { 1203 + "status": 0, 1204 + "date": "2023-05-22T09:57:39.562Z", 1205 + "description": "string", 1206 + "additionalInfo": "string" 1207 + 1208 +((( 750 750 } 1210 + ], 1211 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1212 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 751 751 ))) 752 752 1215 +((( 1216 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1217 +} 1218 + 1219 +))) 1220 +))) 1221 + 753 753 (% style="text-align:left" %) 754 754 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 755 755 ... ... @@ -756,6 +756,75 @@ 756 756 (% style="text-align:left" %) 757 757 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 758 758 1228 + 1229 +== **Отправить команду на терминал** == 1230 + 1231 +(% class="box successmessage" %) 1232 +((( 1233 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1234 +))) 1235 + 1236 +Команда для отправки на тс. 1237 + 1238 +{ 1239 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1240 +"command": "", ~/~/ Текст отправляемой команды 1241 +"retries": "", ~/~/ Количество попыток отправки на терминал 1242 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1243 +} 1244 + 1245 +В ответ получаем cmdid 1246 + 1247 + 1248 +== **Получить ответ на отправленную на ТС команду** == 1249 + 1250 +(% class="box infomessage" %) 1251 +((( 1252 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1253 +))) 1254 + 1255 +Идентификатор команды: cmdId 1256 + 1257 +Запрос от терминала на ответ команды 1258 + 1259 +Пример ответ от терминала: 1260 + 1261 +ID= "" ~/~/ идентификатор объекта 1262 +Soft="" ~/~/ версия софта 1263 +GPS=4 ~/~/ тип трекера 1264 +Time=11:05:43 28.06.24 ~/~/ время запроса 1265 +Lat=45.056221 ~/~/ широта 1266 +Lon=39.035938 ~/~/ долгота 1267 +Speed=0.0 ~/~/ скорость 1268 +Course=181.4 ~/~/направление 1269 + 1270 +((( 1271 +== **Список отправленных объекту команд с ответами** == 1272 + 1273 +(% class="box infomessage" %) 1274 +((( 1275 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1276 +))) 1277 + 1278 +Идентификатор ТС: vehicleId 1279 + 1280 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1281 + 1282 +Пример ответа терминала 1283 + 1284 +[ 1285 +{ 1286 +"id": "", ~/~/ идентификатор пользователя 1287 +"commandText": "", ~/~/Текст команды. 1288 +"templateId": "", ~/~/Идентификатор шаблона 1289 +"updated": "", ~/~/ Время отправки 1290 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1291 +"answer": "", ~/~/ Ответ терминала. 1292 +"status": "" ~/~/ Статус отправки 1293 +} 1294 +] 1295 +))) 1296 + 759 759 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 760 760 761 761 (% class="box successmessage" %) ... ... @@ -763,7 +763,7 @@ 763 763 (% lang="en-US" %)**POST /api/v3/vehicles** 764 764 ))) 765 765 766 -(% style="color:#000000" %)Метод позволяет добавить объект . Метод позволяет добавить объект, указанный в запросе.1304 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 767 767 768 768 (% style="color:#000000" %)Метод запроса: **POST** 769 769 ... ... @@ -775,6 +775,11 @@ 775 775 776 776 (% style="color:#000000" %){ 777 777 1316 + 1317 +((( 1318 + "vehicleId": 0, ~/~/ ID ТС 1319 +))) 1320 + 778 778 "parentId": "" , ~/~/ ID клиента 779 779 "name": "" , ~/~/ имя ТС 780 780 "imei": "" , ~/~/ IMEI ... ... @@ -795,6 +795,10 @@ 795 795 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 796 796 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 797 797 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1341 + "mileageCalcMethod": 0, 1342 + "mileageCoeff": 0, 1343 + "locationByCellId": true, 1344 + "dottedLineTrackWhenNoCoords": true, 798 798 "counters": ~/~/ счетчики 799 799 { 800 800 "mileage": "" , ~/~/ пробег ... ... @@ -823,67 +823,275 @@ 823 823 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 824 824 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 825 825 } 1373 +"drivers": [ ~/~/ Водители 1374 + { 1375 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1376 + "isDefault": true 1377 + } 1378 + ], 1379 + "commandTemplates": [ ~/~/ Шаблон команды 1380 + { 1381 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1382 + "name": "string", 1383 + "command": "string", 1384 + "retries": 0 1385 + } 1386 + ], 1387 +"sensors": [ ~/~/ Датчики 1388 + { 1389 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1390 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1391 + "type": 0, ~/~/ Тип датчика 1392 + "name": "string", ~/~/ Имя датчика 1393 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1394 + "inputNumber": 0, ~/~/ Номер входа 1395 + "pseudonym": "string", ~/~/ Псевдоним 1396 + "medianDegree": 0, ~/~/ Медианная фильтрация 1397 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1398 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1399 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1400 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1401 + { 1402 + "grades": [ ~/~/ Таблица тарировки 1 1403 + { 1404 + "input": 0, ~/~/ Входящее значение 1405 + "output": 0 ~/~/ Выходящее значение 1406 + } 1407 + ], 1408 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1409 + } 1410 + ], 1411 + "showInTooltip": true, ~/~/ Отображать в подсказке 1412 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1413 + "color": "string", ~/~/ код цвета датчиков 1414 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1415 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1416 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1417 + "expr": "string", ~/~/ Формула 1418 + "children": [ ~/~/ массив дочерних датчиков 1419 + "string" 1420 + ], 1421 + "customParams": { ~/~/ прочие произвольные параметры 1422 + "additionalProp1": "string", 1423 + "additionalProp2": "string", 1424 + "additionalProp3": "string" 1425 + }, 1426 +~/~/ Характерные для произвольного: 1427 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1428 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1429 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1430 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1431 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1432 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1433 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1434 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1435 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1436 +~/~/ "ValueOn": "Вкл.", 1437 +~/~/ "ValueOff": "Выкл." 1438 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 826 826 827 -(% style="color:#000000" %) } 1440 +((( 1441 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1442 + { 1443 + "from": 0, ~/~/ С какого значения 1444 + "color": "string", ~/~/ Каким цветом 1445 + "text": "string" ~/~/ Текст подписи к этому интервалу 1446 + } 1447 + ] 1448 + } 1449 + ], 1450 +))) 828 828 1452 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1453 + 1454 + 1455 + "customFields": [ ~/~/ Произвольные поля 1456 + { 1457 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1458 + "name": "string", ~/~/ Наименование произвольного поля 1459 + "value": "string", ~/~/ Значение произвольного поля 1460 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1461 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1462 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1463 + 1464 +((( 1465 + } 1466 + ], 1467 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1468 +))) 1469 + 1470 +((( 1471 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1472 +} 1473 +))) 1474 + 1475 + 829 829 (% style="color:#000000" %)Ответ: 830 830 831 -(% style="color:#000000" %){ 832 832 833 - "vehicleId": "", ~/~/ID ТС 834 - "parentId": "", ~/~/Guid владельца ТС 835 - "name": "", ~/~/Имя объекта 836 - "imei": "", ~/~/IMEI 837 - "deviceTypeId": "", ~/~/ID типа устройства 838 - "modelId": "", ~/~/ID модели 839 - "unitId": "", ~/~/ID подразделения 840 - "sim1": "", ~/~/SIM1 841 - "sim2": "", ~/~/SIM2 842 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 843 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 844 - "counters": { ~/~/Счётчики 845 - "mileageEnabled": true, 846 - "motohoursEnabled": true, 847 - "mileage": "", 848 - "motohours": 345.0 849 - }, 850 - "cmsv6Parameters": { ~/~/Параметры CmsV6 851 - "id": null, 852 - "enabled": true, ~/~/флаг включения 853 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 854 - "login": "", ~/~/ имя учетной записи 855 - "password": "" ~/~/ пароль учетной записи 856 - }, 857 - "inspectionTasks": { ~/~/ задания на ТО 858 - "id": "", ~/~/ ID задачи 859 - "enabled": false, ~/~/ Признак включения 860 - "name": "", ~/~/ Имя задания 861 - "description": "", ~/~/ Описание задания 862 - "mileageCondition": "", ~/~/ Условие по пробегу 863 - "lastMileage": "", ~/~/ Пробег (в метрах) 864 - "motohoursCondition": "", ~/~/ Условие по моточасам 865 - "lastMotohours": "", ~/~/ Моточасы 866 - "periodicCondition": "", ~/~/ Условие периодичности по времени 867 - "kind": "", ~/~/ Вид периодичности по времени 868 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1479 +((( 1480 +((( 1481 +((( 1482 +{ 1483 + "vehicleId": 0, ~/~/ ID ТС 1484 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1485 + "name": "string", ~/~/ Имя объекта 1486 + "imei": "string", ~/~/ IMEI 1487 + "deviceTypeId": 0, ~/~/ ID типа устройства 1488 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1489 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1490 + "sim1": "string", ~/~/ SIM1 1491 + "sim2": "string", ~/~/ SIM2 1492 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1493 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1494 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1495 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1496 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1497 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1498 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1499 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1500 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1501 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1502 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1503 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1504 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1505 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1506 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1507 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1508 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1509 + "counters": { ~/~/ Dto для состояний счётчиков 1510 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1511 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1512 + "mileage": 0, ~/~/ Пробег 1513 + "motohours": 0 ~/~/ Моточасы 1514 + }, 1515 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1516 + "id": "string", ~/~/ CMSV6 Идентификатор 1517 + "enabled": true, ~/~/ Признак включения 1518 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1519 + "login": "string", ~/~/ CMSV6 имя учетной записи 1520 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1521 + }, 1522 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1523 + { 1524 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1525 + "enabled": true, ~/~/ Признак включения 1526 + "name": "string", ~/~/ Имя задания 1527 + "description": "string", ~/~/ Описание задания 1528 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1529 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1530 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1531 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1532 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1533 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1534 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1535 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 869 869 } 1537 + ], 1538 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1539 + { 1540 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1541 + "inputNumber": 0, ~/~/ № входа. 1542 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1543 + "comment": "string", ~/~/ Комментарий 1544 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1545 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1546 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1547 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1548 + } 1549 + ], 1550 + "commandTemplates": [ ~/~/ Список шаблонов команд 1551 + { 1552 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1553 + "name": "string", ~/~/ Название шаблона команд 1554 + "command": "string", ~/~/ Команда на выполнение 1555 + "retries": 0 ~/~/ Лимит попыток отправки 1556 + } 1557 + ], 1558 + "sensors": [ ~/~/ Список датчиков 1559 + { 1560 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1561 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1562 + "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 1563 + "name": "string", ~/~/ Имя датчика 1564 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1565 + "inputNumber": 0, ~/~/ Номер входа 1566 + "pseudonym": "string", ~/~/ Псевдоним 1567 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1568 + "isInverted": true, ~/~/ Признак инверсии 1569 + "disabled": true, ~/~/ Датчик не участвует в обработке 1570 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1571 + "gradesTables": [ ~/~/ Тарировка 1572 + { 1573 + "grades": [ ~/~/ Таблицы тарировки 1574 + { 1575 + "input": 0, ~/~/ Вход 1576 + "output": 0 ~/~/ Выход 1577 + } 1578 + ], 1579 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1580 + } 1581 + ], 1582 + "showInTooltip": true, ~/~/ Отображение в подсказке 1583 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1584 + "color": "string", ~/~/ код цвета датчиков 1585 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1586 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1587 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1588 + "expr": "string", ~/~/ Выражение 1589 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1590 + "string" 1591 + ], 1592 + "customParams": { 1593 + "additionalProp1": "string", 1594 + "additionalProp2": "string", 1595 + "additionalProp3": "string" 1596 + }, 1597 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1598 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1599 + { 1600 + "from": 0, ~/~/ С какого значения 1601 + "color": "string", ~/~/ Каким цветом 1602 +))) 870 870 871 -(% style="text-align:left" %) 872 -(% style="color:#000000" %)} 1604 +((( 1605 + "text": "string" ~/~/ Текст подписи к этому интервалу 1606 + } 1607 + ] 1608 + } 1609 + ], 1610 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1611 + "customFields": [ ~/~/ Список произвольных полей 1612 + { 1613 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1614 + "name": "string", ~/~/ Наименование произвольного поля 1615 + "value": "string", ~/~/ Значение произвольного поля 1616 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1617 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1618 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1619 + } 1620 + ], 1621 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1622 +} 1623 +))) 1624 +))) 1625 +))) 873 873 1627 + 874 874 **Валидация:** 875 875 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 876 876 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 877 877 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 878 878 879 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 880 880 1634 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1635 + 881 881 (% class="box infomessage" %) 882 882 ((( 883 883 (% lang="en-US" %)**POST /api/v3/vehicles/find** 884 884 ))) 885 885 886 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1641 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 887 887 888 888 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 889 889 ... ... @@ -917,9 +917,12 @@ 917 917 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 918 918 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 919 919 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 920 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 921 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 922 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1675 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1676 + "unitName": "string", ~/~/ Название подразделения (опционально) 1677 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1678 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1679 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1680 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 923 923 } 924 924 925 925 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -926,8 +926,14 @@ 926 926 927 927 (% style="color:#000000" %)Ответ: 928 928 929 -(% style="color:#000000" %){ 1687 +(% style="color:#000000" %)[ 1688 +{ 930 930 1690 +((( 1691 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1692 +))) 1693 + 1694 +((( 931 931 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 932 932 "name": "" ~/~/ наименование объекта 933 933 "imei": "" ~/~/ IMEI объекта ... ... @@ -953,9 +953,21 @@ 953 953 "forClient": true, ~/~/ право на отображение у клиента 954 954 "forTooltip": false, ~/~/ право на отображение в подсказке 955 955 "forReport": false ~/~/ право на отображение в отчетах 956 - }(%%) 957 -(% style="color:#000000" %)} 1720 +))) 958 958 1722 +((( 1723 + } 1724 + ], 1725 + "vehicleGroups": [ ~/~/ Группы ТС 1726 + { 1727 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1728 + "name": "string" ~/~/ Наименование группы ТС 1729 + } 1730 + ] 1731 + } 1732 +] 1733 +))) 1734 + 959 959 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 960 960 961 961 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -987,13 +987,11 @@ 987 987 "data": "", ~/~/ Данные 988 988 "overwrite": false, ~/~/ Флаг перезаписи 989 989 "stage": "", ~/~/ Состояние, может быть null 990 - 991 991 (% style="color:#000000" %)} 992 992 993 993 (% style="color:#000000" %)Ответ: 994 994 995 -(% style="color:#000000" %){ 996 - 1770 +(% style="color:#000000" %){(%%) 997 997 "status": "", ~/~/ значение статуса 998 998 "date": "", ~/~/ Дата смены статуса 999 999 "description": "", ~/~/ Описание ... ... @@ -1000,10 +1000,9 @@ 1000 1000 "data": "", ~/~/ Данные 1001 1001 "overwrite": false, ~/~/ Флаг перезаписи 1002 1002 "stage": "", ~/~/ Состояние 1003 - 1004 -(% style="text-align:left" %) 1005 1005 (% style="color:#000000" %) } 1006 1006 1779 + 1007 1007 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1008 1008 1009 1009 (% class="box warningmessage" %) ... ... @@ -1011,7 +1011,7 @@ 1011 1011 (% lang="en-US" %)**PUT /api/v3/vehicles** 1012 1012 ))) 1013 1013 1014 -(% style="color:#000000" %)Метод позволяет отредактировать объект . Метод позволяет отредактировать объект, указанный в запросе.1787 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 1015 1015 1016 1016 (% style="color:#000000" %)Метод запроса: **PUT** 1017 1017 ... ... @@ -1021,18 +1021,16 @@ 1021 1021 1022 1022 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1023 1023 1024 -(% style="color:#000000" %){ 1025 - 1026 -((( 1027 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 1028 - "parentId": "", ~/~/ ID клиента 1029 - "name": "", ~/~/ имя ТС 1030 - "imei": "", ~/~/ IMEI 1031 - "deviceTypeId": "", ~/~/ ID типа устройства 1032 - "modelId": "", ~/~/ , ID модели 1033 - "unitId": "", ~/~/ подразделения 1034 - "sim1": "", ~/~/ SIM 1 1035 - "sim2": "", ~/~/ SIM2 (%%) 1797 +(% style="color:#000000" %){ 1798 + "vehicleId": , ~/~/ ID объекта 1799 + "parentId": "" , ~/~/ ID клиента 1800 + "name": "" , ~/~/ имя ТС 1801 + "imei": "" , ~/~/ IMEI 1802 + "deviceTypeId": "" , ~/~/ ID типа устройства 1803 + "modelId": "" , ~/~/ ID модели 1804 + "unitId": "" , ~/~/ ID подразделения 1805 + "sim1": "" , ~/~/ Номер SIM 1 1806 + "sim2": "" , ~/~/ Номер SIM2 1036 1036 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1037 1037 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1038 1038 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -1045,89 +1045,326 @@ 1045 1045 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1046 1046 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1047 1047 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1048 -(% style="color:#000000" %) "counters": 1049 - { 1050 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1051 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1052 - "mileage": "", ~/~/ пробег, в метрах 1053 - "motohours": "" ~/~/ моточасы, в секундах 1054 - } 1055 - "cmsv6Parameters": ~/~/ параметры CMSv6 1056 - { 1057 - "id": "", ~/~/ идентификатор 1058 - "enabled": true, ~/~/ флаг включения 1059 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1060 - "login": "", ~/~/ имя учетной записи 1061 - "password": "", ~/~/ пароль учетной записи 1062 - } 1063 - "inspectionTasks": ~/~/ задания на ТО 1064 - { 1065 - "id": "", ~/~/ ID задания 1066 - "enabled": false, ~/~/ Признак включения 1067 - "name": "", ~/~/ Имя задания 1068 - "description": "", ~/~/ Описание задания 1069 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1070 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1071 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1072 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1073 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1074 - "kind": "", ~/~/ Вид периодичности по времени 1075 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1076 - } 1819 + 1820 + "mileageCalcMethod": 0, 1821 + "mileageCoeff": 0, 1822 + "locationByCellId": true, 1823 + "dottedLineTrackWhenNoCoords": true, 1824 + "counters": ~/~/ счетчики 1825 + { 1826 + "mileage": "" , ~/~/ пробег 1827 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1828 + "motohours": "" , ~/~/ моточасы 1829 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1830 + }, 1831 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1832 + "enabled": true, ~/~/ флаг включения 1833 + "id": "" , ~/~/ идентификатор 1834 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1835 + "login": "" , ~/~/ имя учетной записи 1836 + "password": "" ~/~/ пароль учетной записи 1837 + }, 1838 + "inspectionTasks": ~/~/ задания на ТО 1839 + { 1840 + "enabled": "" , ~/~/ Признак включения 1841 + "name": "" , ~/~/ Имя задания 1842 + "description": "" , ~/~/ Описание задания 1843 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1844 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1845 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1846 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1847 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1848 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1849 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1850 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1851 + } 1852 + 1853 +"drivers": [ ~/~/ Водители 1854 + { 1855 + 1856 +((( 1857 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1858 + "inputNumber": 0, ~/~/ № входа. 1859 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1860 + "comment": "string", ~/~/ Комментарий. 1861 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1862 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1863 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1864 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1077 1077 ))) 1078 1078 1079 -(% style="color:#000000" %)} 1867 + } 1868 + ], 1869 + "commandTemplates": [ ~/~/ Шаблон команды 1870 + { 1871 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1872 + "name": "string", 1873 + "command": "string", 1874 + "retries": 0 1875 + } 1876 + ], 1877 +"sensors": [ ~/~/ Датчики 1878 + { 1879 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1880 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1881 + "type": 0, ~/~/ Тип датчика 1882 + "name": "string", ~/~/ Имя датчика 1883 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1884 + "inputNumber": 0, ~/~/ Номер входа 1885 + "pseudonym": "string", ~/~/ Псевдоним 1886 + "medianDegree": 0, ~/~/ Медианная фильтрация 1887 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1888 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1889 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1890 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1891 + { 1892 + "grades": [ ~/~/ Таблица тарировки 1 1893 + { 1894 + "input": 0, ~/~/ Входящее значение 1895 + "output": 0 ~/~/ Выходящее значение 1896 + } 1897 + ], 1898 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1899 + } 1900 + ], 1901 + "showInTooltip": true, ~/~/ Отображать в подсказке 1902 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1080 1080 1904 +((( 1905 + "color": "string",** ~/~/ **Цвет датчика 1906 +))) 1907 + 1908 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1909 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1910 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1911 + "expr": "string", ~/~/ Формула 1912 + "children": [ ~/~/ массив дочерних датчиков 1913 + "string" 1914 + ], 1915 + "customParams": { ~/~/ прочие произвольные параметры 1916 + "additionalProp1": "string", 1917 + "additionalProp2": "string", 1918 + "additionalProp3": "string" 1919 + }, 1920 +~/~/ Характерные для произвольного: 1921 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1922 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1923 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1924 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1925 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1926 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1927 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1928 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1929 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1930 +~/~/ "ValueOn": "Вкл.", 1931 +~/~/ "ValueOff": "Выкл." 1932 + "summaryMaxValue": 0 ~/~/ Макс. значение 1933 + 1934 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1935 + { 1936 + "from": 0, ~/~/ С какого значения 1937 + "color": "string", ~/~/ Каким цветом 1938 + "text": "string" ~/~/ Текст подписи к этому интервалу 1939 + } 1940 + ] 1941 + } 1942 + ], 1943 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1944 + 1945 + "customFields": [ ~/~/ Произвольные поля 1946 + { 1947 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1948 + "name": "string", ~/~/ Наименование произвольного поля 1949 + "value": "string", ~/~/ Значение произвольного поля 1950 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1951 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1952 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1953 + } 1954 + 1955 +((( 1956 + ], 1957 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1958 +))) 1959 + 1960 +} 1961 + 1962 + 1081 1081 (% style="color:#000000" %)Ответ: 1082 1082 1083 -(% lang="en-US" style="text-align:left" %) 1084 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1965 +((( 1966 +{ 1967 + "vehicleId": 0, ~/~/ ID ТС 1968 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1969 + "name": "string", ~/~/ Имя объекта 1970 + "imei": "string", ~/~/ IMEI 1971 + "deviceTypeId": 0, ~/~/ ID типа устройства 1972 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1973 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1974 + "sim1": "string", ~/~/ SIM1 1975 + "sim2": "string", ~/~/ SIM2 1976 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1977 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1978 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1979 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1980 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1981 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1982 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1983 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1984 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1985 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1986 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1987 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1988 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1989 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1990 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1991 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1992 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1993 + "counters": { ~/~/ состояний счётчиков 1994 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1995 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1996 + "mileage": 0, ~/~/ Пробег 1997 + "motohours": 0 ~/~/ Моточасы 1998 + }, 1999 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 2000 + "id": "string", ~/~/ CMSV6 Идентификатор 2001 + "enabled": true, ~/~/ Признак включения 2002 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2003 +))) 1085 1085 1086 -(% lang="en-US" style="text-align:left" %) 1087 - "vehicleId": "", ~/~/ ID ТС 1088 - "parentId": "", ~/~/ ID клиента 1089 - "name": "", ~/~/ имя ТС 1090 - "imei": "", ~/~/ IMEI 1091 - "deviceTypeId": "", ~/~/ типа устройства 1092 - "modelId": "", ~/~/ ID модели 1093 - "unitId": "", ~/~/ ID подразделения 1094 - "sim1": "", ~/~/ SIM 1 1095 - "sim2": "", ~/~/ SIM2 1096 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1097 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1098 - "counters": 1099 - { 1100 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1101 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1102 - "mileage": "", ~/~/ пробег 1103 - "motohours": "", ~/~/ моточасы 1104 - } 1105 - "cmsv6Parameters": ~/~/ параметры CMSv6 2005 + 2006 +((( 2007 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2008 + "login": "string", ~/~/ CMSV6 имя учетной записи 2009 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2010 + }, 2011 + "inspectionTasks": [ ~/~/ Задания на ТО 2012 + { 2013 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2014 + "enabled": true, ~/~/ Признак включения 2015 + "name": "string", ~/~/ Имя задания 2016 + "description": "string", ~/~/ Описание задания 2017 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2018 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2019 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2020 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2021 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2022 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2023 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2024 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2025 + } 2026 + ], 2027 + "drivers": [ ~/~/ Список водителей 2028 + { 2029 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2030 + "inputNumber": 0, ~/~/ № входа. 2031 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2032 + "comment": "string", ~/~/ Комментарий. 2033 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2034 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2035 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2036 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2037 + } 2038 + ], 2039 + "commandTemplates": [ ~/~/ Список шаблонов команд 2040 + { 2041 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2042 + "name": "string", ~/~/ Название шаблона команд 2043 + "command": "string", ~/~/ Команда на выполнение 2044 + "retries": 0 ~/~/ Лимит попыток отправки 2045 + } 2046 + ], 2047 + "sensors": [ ~/~/ Список датчиков 2048 + { 2049 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2050 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2051 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2052 +))) 2053 + 2054 +((( 2055 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2056 +))) 2057 + 2058 +((( 2059 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2060 +))) 2061 + 2062 +((( 2063 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2064 +))) 2065 + 2066 +((( 2067 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2068 +))) 2069 + 2070 +((( 2071 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2072 + "name": "string", ~/~/ Имя датчика 2073 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2074 +))) 2075 + 2076 +((( 2077 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2078 + "inputNumber": 0, ~/~/ Номер входа 2079 + "pseudonym": "string", ~/~/ Псевдоним 2080 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2081 + "isInverted": true, ~/~/ Признак инверсии 2082 + "disabled": true, ~/~/ Датчик не участвует в обработке 2083 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2084 + "gradesTables": [ ~/~/ Тарировка 1106 1106 { 1107 - "id": ~/~/ идентификатор 1108 - "enabled": true, ~/~/ флаг включения 1109 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1110 - "login": "", ~/~/ имя учетной записи 1111 - "password": "", ~/~/ пароль учетной записи 1112 - } 1113 - "inspectionTasks": ~/~/ задания на ТО 1114 - { 1115 - "id": "", ~/~/ ID задания 1116 - "enabled": false, ~/~/ Признак включения 1117 - "name": "", ~/~/ Имя задания 1118 - "description": "", ~/~/ Описание задания 1119 - "mileageCondition": "", ~/~/ Условие по пробегу 1120 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1121 - "motohoursCondition": "", ~/~/ Условие по моточасам 1122 - "lastMotohours": "", ~/~/ Моточасы 1123 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1124 - "kind": "", ~/~/ Вид периодичности по времени 1125 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2086 + "grades": [ ~/~/ Таблицы тарировки 2087 + { 2088 + "input": 0, ~/~/ Вход 2089 + "output": 0 ~/~/ Выход 2090 + } 2091 + ], 2092 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1126 1126 } 2094 + ], 2095 + "showInTooltip": true, ~/~/ Отображение в подсказке 2096 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1127 1127 1128 -(% lang="en-US" style="text-align:left" %) 1129 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2098 +((( 2099 + "color": "string", ~/~/ цвет уведомлений 2100 +))) 1130 1130 2102 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2103 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2104 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2105 + "expr": "string", ~/~/ Выражение 2106 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2107 + "string" 2108 + ], 2109 + "customParams": { ~/~/ Дополнительные настройки 2110 + "additionalProp1": "string", 2111 + "additionalProp2": "string", 2112 + "additionalProp3": "string" 2113 + }, 2114 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2115 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2116 + { 2117 + "from": 0, ~/~/ С какого значения 2118 + "color": "string", ~/~/ Каким цветом 2119 + "text": "string" ~/~/ Текст подписи к этому интервалу 2120 + } 2121 + ] 2122 + } 2123 + ], 2124 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2125 + "customFields": [ ~/~/ Список произвольных полей 2126 + { 2127 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2128 + "name": "string", ~/~/ Наименование произвольного поля 2129 + "value": "string", ~/~/ Значение произвольного поля 2130 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2131 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2132 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2133 + } 2134 + ], 2135 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2136 +} 2137 +))) 2138 + 1131 1131 **Валидация:** 1132 1132 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1133 1133 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1140,7 +1140,7 @@ 1140 1140 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1141 1141 ))) 1142 1142 1143 -(% style="color:#000000" %)Метод позволяет удалить объект . Метод позволяет удалить объект, указанный в строке запроса.2151 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 1144 1144 1145 1145 (% style="color:#000000" %)Метод запроса: **DELETE** 1146 1146 ... ... @@ -1166,18 +1166,15 @@ 1166 1166 1167 1167 (% style="color:#000000" %)Метод запроса: **GET** 1168 1168 1169 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2177 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1170 1170 1171 1171 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1172 1172 1173 1173 (% style="color:#000000" %)Ответ: 1174 1174 1175 -(% style="color:#000000" %){ 1176 - 2183 +(% style="color:#000000" %){(%%) 1177 1177 "deviceTypeId" : "", ~/~/ ID типа устройства 1178 1178 "deviceTypeName" : "" ~/~/ Название типа устройства 1179 - 1180 -(% style="text-align:left" %) 1181 1181 (% style="color:#000000" %)} 1182 1182 1183 1183 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1199,13 +1199,10 @@ 1199 1199 1200 1200 (% style="color:#000000" %)Ответ: 1201 1201 1202 -(% style="color:#000000" %){ 1203 - 2207 +(% style="color:#000000" %){(%%) 1204 1204 "id": "", ~/~/ ID типа датчика 1205 1205 "name": "", ~/~/ Название 1206 1206 "description": "", ~/~/ Описание 1207 - 1208 -(% style="text-align:left" %) 1209 1209 (% style="color:#000000" %)} 1210 1210 1211 1211 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1249,6 +1249,56 @@ 1249 1249 } 1250 1250 ] 1251 1251 2254 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2255 + 2256 +(% class="box infomessage" style="text-align: left;" %) 2257 +((( 2258 +**POST /api/v3/terminalMessages/mapping** 2259 +))) 2260 + 2261 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2262 + 2263 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2264 + 2265 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2266 + 2267 +{ 2268 + "protocolType": 0, 2269 + "params": ["string"] 2270 +} 2271 + 2272 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2273 +|protocolType|ID типа протокола 2274 +|params|((( 2275 +Массив наименований параметров в сообщении 2276 +))) 2277 + 2278 +Ответ: 2279 + 2280 +{ 2281 + "protocolType": 0, 2282 + "mapping": { 2283 + "additionalProp1": { 2284 + "inputType": 0, 2285 + "inputNumber": 0 2286 + }, 2287 + "additionalProp2": { 2288 + "inputType": 0, 2289 + "inputNumber": 0 2290 + } 2291 + } 2292 +} 2293 + 2294 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2295 +|protocolType|Тип протокола 2296 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2297 +|inputNumber|((( 2298 +Номер входа 2299 +))) 2300 + 2301 +(% class="wikigeneratedid" %) 2302 +Перечень 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/]] 2303 + 1252 1252 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1253 1253 1254 1254 (% class="box infomessage" %) ... ... @@ -1273,6 +1273,11 @@ 1273 1273 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1274 1274 } 1275 1275 2328 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2329 +|vehicleId|ID объекта 2330 +|from|Дата и время начала периода запроса 2331 +|to|Дата и время окончания периода запроса 2332 + 1276 1276 Ответ: 1277 1277 1278 1278 [ ... ... @@ -1279,25 +1279,462 @@ 1279 1279 { 1280 1280 "messages": [ 1281 1281 { 1282 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1283 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1284 - "speed": 0, ~/~/ Скорость, км/ч 1285 - "altitude": 0, ~/~/ Высота, м 1286 - "latitude": 0, ~/~/ Широта [-90°;90°] 1287 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1288 - "satellites": 0, ~/~/ Кол-во спутников 1289 - "voltage": 0, ~/~/ Напряжение 1290 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2339 + "deviceTime": "2023-11-29T07:40:44.052Z", 2340 + "serverTime": "2023-11-29T07:40:44.052Z", 2341 + "speed": 0, 2342 + "altitude": 0, 2343 + "latitude": 0, 2344 + "longitude": 0, 2345 + "satellites": 0, 2346 + "course": 0, 2347 + "voltage": 0, 2348 + "parameters": { 1291 1291 "additionalProp1": "string", 1292 1292 "additionalProp2": "string", 1293 1293 "additionalProp3": "string" 1294 1294 }, 1295 - "photoCount": 0 ~/~/ Кол-во фото 2353 + "photoCount": 0, 2354 + "lbsCorrectedCoords": true, 2355 + "protocolType": 0 1296 1296 } 1297 1297 ] 1298 1298 } 1299 1299 ] 1300 1300 2361 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2362 +|deviceTime|Время сообщения терминала 2363 +|serverTime|Время когда сообщение поступило на сервер 2364 +|speed|Скорость 2365 +|altitude|Высота над уровнем моря 2366 +|latitude|Широта 2367 +|longitude|Долгота 2368 +|satellites|Кол-во спутников 2369 +|course|Курс 2370 +|voltage|Бортовое напряжение 2371 +|parameters|Список параметров и их значений 2372 +|photoCount|Количество фото 2373 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2374 +|protocolType|ID типа протокола 2375 + 2376 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2377 + 2378 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2379 + 2380 +(% class="box infomessage" %) 2381 +((( 2382 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2383 +))) 2384 + 2385 +(% style="color:#000000" %)Метод запроса: **POST** 2386 + 2387 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2388 + 2389 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2390 + 2391 +(% style="text-align:left" %) 2392 +Тело запроса: 2393 + 2394 +{ 2395 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2396 + "vehicleIds": [0], ~/~/ Список ID объектов 2397 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2398 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2399 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2400 +} 2401 + 2402 +Ответ: 2403 + 2404 +[ 2405 + { 2406 + "vehicleId": 0, ~/~/ ID объекта 2407 + "name": "string", ~/~/ Имя ТС 2408 + "periods": [ ~/~/ Периоды 2409 + { 2410 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2411 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2412 + "mileage": 0, ~/~/ Пробег за период, километры 2413 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2414 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2415 + "motohours": 0, ~/~/ Моточасы за период, секунды 2416 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2417 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2418 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2419 + 2420 + } 2421 + ] 2422 + } 2423 +] 2424 + 2425 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2426 + 2427 +(% class="box infomessage" %) 2428 +((( 2429 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2430 +))) 2431 + 2432 +(% style="color:#000000" %)Метод запроса: **POST** 2433 + 2434 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2435 + 2436 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2437 + 2438 +(% style="text-align:left" %) 2439 +Тело запроса: 2440 + 2441 +{ 2442 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2443 + "vehicleIds": [0], ~/~/ Список ID объектов 2444 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2445 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2446 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2447 +} 2448 + 2449 +Ответ: 2450 + 2451 +[ 2452 + { 2453 + "vehicleId": 0, ~/~/ ID объекта 2454 + "name": "string", ~/~/ Имя ТС 2455 + "periods": [ ~/~/ Периоды 2456 + { 2457 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2458 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2459 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2460 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2461 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2462 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2463 + "fuelConsumption": 0, ~/~/ Расход топлива 2464 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2465 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2466 + 2467 + } 2468 + ] 2469 + } 2470 +] 2471 + 2472 +(% class="box warningmessage" %) 2473 +((( 2474 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2475 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2476 +))) 2477 + 2478 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2479 + 2480 +(% class="box infomessage" %) 2481 +((( 2482 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2483 +))) 2484 + 2485 +(% style="color:#000000" %)Метод запроса: **POST** 2486 + 2487 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2488 + 2489 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2490 + 2491 +(% style="text-align:left" %) 2492 +Тело запроса: 2493 + 2494 +{ 2495 + "vehicleIds": [0], ~/~/ Список ID объектов 2496 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2497 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2498 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2499 +} 2500 + 2501 +Ответ: 2502 + 2503 +[ 2504 + { 2505 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2506 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2507 + "vehicleId": 0, ~/~/ ID объекта 2508 + "name": "string", ~/~/ Имя объекта 2509 + "model": "string", ~/~/ Модель объекта 2510 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2511 + { 2512 + "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 2513 + 2514 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2515 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2516 + "valueFuel": 0, ~/~/ Количество 2517 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2518 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2519 + } 2520 + ] 2521 + } 2522 +] 2523 + 2524 + 2525 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2526 + 2527 +(% class="box infomessage" %) 2528 +((( 2529 +**POST /api/v3/vehicles/moveStop** 2530 +))) 2531 + 2532 +Метод запроса: **POST** 2533 + 2534 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2535 + 2536 +В заголовках запроса: X-Auth: Токен авторизации 2537 + 2538 + 2539 +Тело запроса: 2540 + 2541 +{ 2542 + "vehicleIds": [ ], ~/~/ Список ID объектов 2543 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2544 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2545 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2546 +} 2547 + 2548 +Ответ: 2549 + 2550 +[ 2551 + { 2552 + "vehicleId": 0, ~/~/ ID объекта 2553 + "vehicleName": "string", ~/~/ Имя объекта 2554 + "moves": [ ~/~/ Событие движения 2555 + { 2556 + "mileage": 0, ~/~/ Пробег, км 2557 + "eventId": 0, ~/~/ Идентификатор события 2558 + "eventName": "string", ~/~/ Название события 2559 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2560 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2561 + "duration": 0 ~/~/ Продолжительность события, секунд 2562 + } 2563 + ], 2564 + "stops": [ ~/~/ События стоянок 2565 + { 2566 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2567 + "eventId": 0, ~/~/ Идентификатор события 2568 + "eventName": "string", ~/~/ Название события 2569 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2570 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2571 + "duration": 0 ~/~/ Продолжительность события, секунд 2572 + } 2573 + ] 2574 + } 2575 +] 2576 + 2577 + 2578 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2579 + 2580 +(% class="box infomessage" %) 2581 +((( 2582 +**POST /api/v3/vehicles/getlastdata** 2583 +))) 2584 + 2585 +Метод запроса: **POST** 2586 + 2587 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2588 + 2589 +В заголовках запроса: X-Auth: Токен авторизации 2590 + 2591 + 2592 +В массиве указываем id объектов через запятую 2593 + 2594 +Ответ: 2595 + 2596 +[ 2597 + { 2598 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2599 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2600 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2601 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2602 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2603 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2604 + "speed": 31, ~/~/ Скорость объекта 2605 + "course": 116, ~/~/ Курс движения [0;360] 2606 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2607 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2608 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2609 + "geozones": [ ~/~/ Сведения по геозонам. 2610 + { 2611 + "id": 10225647, ~/~/ ID Геозоны 2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2613 + }, 2614 + { 2615 + "id": 10282875, ~/~/ ID Геозоны 2616 + "name": "Ё2" ~/~/ Наименование геозоны 2617 + }, 2618 + { 2619 + "id": 10226240, ~/~/ ID Геозоны 2620 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2621 + }, 2622 + { 2623 + "id": 9747869, ~/~/ ID Геозоны 2624 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2625 + }, 2626 + { 2627 + "id": 10221123, ~/~/ ID Геозоны 2628 + "name": "53r" ~/~/ Наименование геозоны 2629 + }, 2630 + { 2631 + "id": 10197638, ~/~/ ID Геозоны 2632 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2633 + } 2634 + ] 2635 + } 2636 + 2637 + 2638 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2639 + 2640 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2641 + 2642 +(% class="box infomessage" %) 2643 +((( 2644 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2645 +))) 2646 + 2647 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2648 + 2649 +(% style="color:#000000" %)Метод запроса: **POST** 2650 + 2651 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2652 + 2653 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2654 + 2655 +(% style="text-align:left" %) 2656 +Тело запроса: 2657 + 2658 +(% style="text-align:left" %) 2659 +{ 2660 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2661 +} 2662 + 2663 +(% style="text-align:left" %) 2664 +Ответ: 2665 + 2666 +[ 2667 + { 2668 + "id": 0, ~/~/ Идентификатор объекта геозоны 2669 + "name": "string", ~/~/ Название объекта геозоны 2670 + "type": 0, ~/~/ Тип объекта геозоны 2671 + "fname": "string", ~/~/ Имя файла 2672 + "parentId": "string", ~/~/ Идентификатор клиента 2673 + "radius": 0, ~/~/ Радиус геообъекта 2674 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2675 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2676 + "description": "string", ~/~/ Описание 2677 + "area": 0, ~/~/ Площадь, м^^2^^ 2678 + "perimetr": 0, ~/~/ Периметр, м 2679 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2680 + } 2681 +] 2682 + 2683 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2684 + 2685 +(% class="box infomessage" %) 2686 +((( 2687 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2688 +))) 2689 + 2690 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2691 + 2692 +(% style="color:#000000" %)Метод запроса: **POST** 2693 + 2694 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2695 + 2696 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2697 + 2698 +(% style="text-align:left" %) 2699 +Тело запроса: 2700 + 2701 +{ 2702 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2703 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2704 + "ids": [ ], ~/~/ Массив id объектов 2705 + "byTime": 0, ~/~/ Объединение событий по времени 2706 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2707 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2708 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2709 +} 2710 + 2711 +Ответ: 2712 +[ 2713 + { 2714 + "geozoneId": 0, ~/~/ ID геообъекта 2715 + "geozoneName": "string", ~/~/ Название геообъекта 2716 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2717 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2718 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2719 + "vehicleId": 0, ~/~/ ID объекта 2720 + "vehicleName": "string" ~/~/ Имя объекта 2721 + } 2722 +] 2723 + 2724 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2725 + 2726 +(% class="box infomessage" %) 2727 +((( 2728 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2729 +))) 2730 + 2731 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2732 + 2733 +(% style="color:#000000" %)Метод запроса: **POST** 2734 + 2735 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2736 + 2737 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2738 + 2739 +(% style="text-align:left" %) 2740 +Тело запроса: 2741 + 2742 +{ 2743 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2744 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2745 + "ids": [ ], ~/~/ Массив id геообъектов 2746 + "byTime": 0, ~/~/ Объединение событий по времени 2747 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2748 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2749 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2750 +} 2751 + 2752 +Ответ: 2753 + 2754 +[ 2755 + { 2756 + "geozoneId": 0, ~/~/ ID геообъекта 2757 + "geozoneName": "string", ~/~/ Название геообъекта 2758 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2759 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2760 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2761 + "vehicleId": 0, ~/~/ ID объекта 2762 + "vehicleName": "string" ~/~/ Имя объекта 2763 + } 2764 +] 2765 + 2766 + 2767 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2768 + 2769 +(% class="box successmessage" %) 2770 +((( 2771 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2772 +))) 2773 + 2774 +(% style="color:#000000" %)Метод запроса: **PUT** 2775 + 2776 +Пример запроса: 2777 + 2778 +((( 2779 +{ 2780 + "id": 0, ~/~/ Идентификатор объекта геозоны 2781 + "name": "string", ~/~/ Наименование объекта геозоны 2782 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2783 + "description": "string", ~/~/ Описание объекта геозоны 2784 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2785 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2786 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2787 +} 2788 +))) 2789 + 2790 + 2791 +Пример ответа: 2792 + 2793 +200 ~/~/ Success 2794 + 1301 1301 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1302 1302 1303 1303 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -1329,7 +1329,7 @@ 1329 1329 "id": 0, ~/~/ ID уведомления 1330 1330 "name": "string", ~/~/ Название уведомления 1331 1331 "active": true, ~/~/ Состояние true - активен, false - деактивирован 1332 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2826 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 1333 1333 "userId": "", ~/~/ Пользователь, создавший уведомление 1334 1334 "parentId": "", ~/~/ Идентификатор клиента 1335 1335 "parentName": "string" ~/~/ Имя клиента ... ... @@ -1336,6 +1336,155 @@ 1336 1336 } 1337 1337 ] 1338 1338 2833 + 2834 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2835 + 2836 +(% class="box infomessage" %) 2837 +((( 2838 +**POST /api/v3/notifications** 2839 +))) 2840 + 2841 +Метод запроса **POST** 2842 + 2843 +(% style="text-align: left;" %) 2844 +(% style="color:#000000" %)Пример запроса 2845 + 2846 +((( 2847 +{ 2848 + "id": 0, ~/~/ ID правила 2849 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2850 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2851 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2852 + "name": "string", ~/~/ Имя правила 2853 + "active": true, ~/~/ Активность правила 2854 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2855 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2856 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2857 + ], 2858 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2859 + 0 2860 + ], 2861 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2862 + 0 2863 + ], 2864 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2865 + 0 2866 + ], 2867 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2868 + "additionalProp1": "string", 2869 + "additionalProp2": "string", 2870 + "additionalProp3": "string" 2871 + }, 2872 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2873 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2874 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2875 + ], 2876 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2877 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2878 + "string" 2879 + ], 2880 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2881 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2882 + { 2883 + "id": 0, ~/~/ Идентификатор участника чата. 2884 + "info": "string" ~/~/ Дополнительные сведения. 2885 + } 2886 + ], 2887 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2888 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2889 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2890 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2891 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2892 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2893 + "timezone": 0, ~/~/ часовой пояс 2894 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2895 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2896 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2897 + { 2898 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2899 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2900 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2901 + "additionalProp1": "string", 2902 + "additionalProp2": "string", 2903 + "additionalProp3": "string" 2904 + } 2905 + } 2906 + ] 2907 +} 2908 +))) 2909 + 2910 +((( 2911 + 2912 +))) 2913 + 2914 +((( 2915 + 2916 +))) 2917 + 2918 +Ответ: 2919 + 2920 +{ 2921 + "id": 0, ~/~/ ID правила 2922 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2923 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2924 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2925 + "name": "string", ~/~/ Имя правила 2926 + "active": true, ~/~/ Активность правила 2927 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2928 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2929 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2930 + ], 2931 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2932 + 0 2933 + ], 2934 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2935 + 0 2936 + ], 2937 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2938 + 0 2939 + ], 2940 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2941 + "additionalProp1": "string", 2942 + "additionalProp2": "string", 2943 + "additionalProp3": "string" 2944 + }, 2945 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2946 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2947 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2948 + ], 2949 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2950 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2951 + "string" 2952 + ], 2953 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2954 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2955 + { 2956 + "id": 0, ~/~/ Идентификатор участника чата. 2957 + "info": "string" ~/~/ Дополнительные сведения. 2958 + } 2959 + ], 2960 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2961 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2962 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2963 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2964 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2965 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2966 + "timezone": 0, ~/~/ часовой пояс 2967 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2968 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2969 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2970 + { 2971 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2972 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2973 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2974 + "additionalProp1": "string", 2975 + "additionalProp2": "string", 2976 + "additionalProp3": "string" 2977 + } 2978 + } 2979 + ] 2980 +} 2981 + 1339 1339 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1340 1340 1341 1341 (% class="box infomessage" %) ... ... @@ -1349,7 +1349,7 @@ 1349 1349 Метод запроса **GET** 1350 1350 1351 1351 (% style="text-align: left;" %) 1352 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]2995 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1353 1353 1354 1354 (% style="text-align: left;" %) 1355 1355 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления ... ... @@ -1409,24 +1409,100 @@ 1409 1409 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 1410 1410 (% style="color:#000000" %)} 1411 1411 1412 -== (% style="color:#000000; font-size:16px" %)** Добавление уведомления**(%%) ==3055 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 1413 1413 1414 -(% class="box successmessage" %)3057 +(% class="box warningmessage" %) 1415 1415 ((( 1416 -**P OST /api/v3/notifications/**3059 +**PUT /api/v3/notifications/** 1417 1417 ))) 1418 1418 1419 -Метод возвращает3062 +Метод позволяет отредактировать уведомление. 1420 1420 1421 - == (% style="color:#000000; font-size:16px" %)**Редактированиеуведомления**(%%) ==3064 +Метод запроса **PUT** 1422 1422 3066 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 3067 + 3068 +В заголовках запроса: X-Auth: Токен авторизации 3069 + 3070 +Тело запроса: 3071 +{ 3072 + "id": 0, ~/~/ id уведомления 3073 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 3074 + "userId": "", ~/~/ Пользователь, создавший уведомление 3075 + "parentId": "", ~/~/ Идентификатор клиента 3076 + "parentName": "string", ~/~/ Имя клиента 3077 + "name": "string", ~/~/ Название уведомления 3078 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 3079 + "vehicleIds": [ ~/~/ Список id объектов для анализа 3080 + 0 3081 + ], 3082 + "geoids": [ ~/~/ Список id геообъектов для анализа 3083 + 0 3084 + ], 3085 + "fieldids": [ ~/~/ Список id полей для анализа 3086 + 0 3087 + ], 3088 + "settings": { ~/~/ Список параметров уведомления 3089 + "additionalProp1": "string", 3090 + "additionalProp2": "string", 3091 + "additionalProp3": "string" 3092 + }, 3093 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 3094 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 3095 + "" 3096 + ], 3097 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 3098 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 3099 + "string" 3100 + ], 3101 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 3102 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 3103 + { 3104 + "id": 0, ~/~/ Идентификатор участника чата 3105 + "info": "string" ~/~/ Дополнительные сведения 3106 + } 3107 + ], 3108 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 3109 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 3110 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 3111 + "kind": 0, ~/~/ Определяет вид уведомления 3112 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 3113 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 3114 + "timezone": 0, ~/~/ Сдвиг часового пояса 3115 + "validity": 0, ~/~/ Срок действия в днях (1-90) 3116 + "autoProlongation": true ~/~/ Автопродление срока действия 3117 +} 3118 + 3119 +Ответ: 3120 + 3121 +Success 3122 + 3123 + 3124 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 3125 + 1423 1423 (% class="box warningmessage" %) 1424 1424 ((( 1425 -**PUT /api/v3/notifications/ **3128 +**PUT** /api/v3/notifications/prolongation 1426 1426 ))) 1427 1427 1428 -Метод возвращает3131 +Метод позволяет продлить уведомления. 1429 1429 3133 +Метод запроса **PUT** 3134 + 3135 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 3136 + 3137 +В заголовках запроса: X-Auth: Токен авторизации. 3138 + 3139 +Тело запроса: 3140 + 3141 +[ 3142 + 3143 +0 3144 + 3145 +] 3146 + 3147 +где 0 идентификатор ids. 3148 + 1430 1430 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1431 1431 1432 1432 (% class="box errormessage" %) ... ... @@ -1434,9 +1434,3563 @@ 1434 1434 **DELETE /api/v3/notifications/{id}** 1435 1435 ))) 1436 1436 1437 -Метод возвращает3156 +Метод позволяет удалить выбранное уведомление. 1438 1438 3158 +Метод запроса **DELETE** 1439 1439 3160 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 3161 + 3162 +Передаваемый параметр: {id} - id уведомления 3163 + 3164 +В заголовках запроса: X-Auth: Токен авторизации 3165 + 3166 +Ответ: 3167 + 3168 +Success 3169 + 3170 + 3171 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 3172 + 3173 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 3174 + 3175 +(% class="box infomessage" %) 3176 +((( 3177 +**POST /api/v3/Drivers/find** 3178 +))) 3179 + 3180 +Передается параметр: parentId - ID клиента-родителя 3181 + 3182 +Ответ: 3183 + 3184 +[ 3185 + { 3186 + "name": "string", ~/~/ Определяет наименование 3187 + "description": "string", ~/~/ Определяет описание 3188 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 3189 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 3190 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3191 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3192 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3193 + "deleted": true ~/~/ Признак удаления 3194 + } 3195 +] 3196 + 3197 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 3198 + 3199 +(% class="box infomessage" %) 3200 +((( 3201 +**GET /api/v3/Drivers/{driverGuid}** 3202 +))) 3203 + 3204 +Передается параметр: ID водителя 3205 + 3206 +Ответ: 3207 + 3208 +{ 3209 + "name": "string", ~/~/ Определяет наименование 3210 + "description": "string", ~/~/ Определяет описание 3211 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 3212 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 3213 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3214 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3215 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3216 + "deleted": true ~/~/ Признак удаления 3217 +} 3218 + 3219 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 3220 + 3221 +(% class="box successmessage" %) 3222 +((( 3223 +**POST /api/v3/Drivers** 3224 +))) 3225 + 3226 +Запрос: 3227 + 3228 +{ 3229 + "name": "string", 3230 + "description": "string", 3231 + "hiredate": "2023-06-30T12:50:54.020Z", 3232 + "chopdate": "2023-06-30T12:50:54.020Z", 3233 + "exclusive": true, 3234 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3235 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3236 + "deleted": true 3237 +} 3238 + 3239 +Ответ: 3240 + 3241 +{ 3242 + "name": "string", 3243 + "description": "string", 3244 + "hiredate": "2023-06-30T12:50:54.051Z", 3245 + "chopdate": "2023-06-30T12:50:54.051Z", 3246 + "exclusive": true, 3247 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3248 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3249 + "deleted": true 3250 +} 3251 + 3252 + 3253 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 3254 + 3255 +(% class="box warningmessage" %) 3256 +((( 3257 +**PUT /api/v3/Drivers** 3258 +))) 3259 + 3260 +Запрос: 3261 + 3262 +{ 3263 + "name": "string", 3264 + "description": "string", 3265 + "hiredate": "2023-06-30T12:50:27.910Z", 3266 + "chopdate": "2023-06-30T12:50:27.910Z", 3267 + "exclusive": true, 3268 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3269 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3270 + "deleted": true 3271 +} 3272 + 3273 +Ответ: 3274 + 3275 +{ 3276 + "name": "string", 3277 + "description": "string", 3278 + "hiredate": "2023-06-30T12:50:27.929Z", 3279 + "chopdate": "2023-06-30T12:50:27.929Z", 3280 + "exclusive": true, 3281 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3282 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3283 + "deleted": true 3284 +} 3285 + 3286 + 3287 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 3288 + 3289 +(% class="box errormessage" %) 3290 +((( 3291 +**DELETE /api/v3/Drivers/{driverGuid}** 3292 +))) 3293 + 3294 +Передается параметр: ID водителя 3295 + 3296 +Ответ: 3297 + 3298 +Success 3299 + 3300 + 3301 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 3302 + 3303 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 3304 + 3305 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 3306 + 3307 +(% class="box infomessage" %) 3308 +((( 3309 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3310 +))) 3311 + 3312 +Запрос: 3313 + 3314 +{ 3315 + "Ids": [ 3316 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3317 + ], 3318 + "BeginTime": "2023-06-30T12:49:04.365Z", 3319 + "EndTime": "2023-06-30T12:49:04.365Z" 3320 +} 3321 + 3322 +Ответ: 3323 + 3324 +[ 3325 + { 3326 + "VehicleId": 0, 3327 + "CreateTime": "2023-06-30T09:52:31.240Z", 3328 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3329 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3330 + "BeginTime": "2023-06-30T09:52:31.240Z", 3331 + "EndTime": "2023-06-30T09:52:31.240Z" 3332 + } 3333 +] 3334 + 3335 + 3336 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 3337 + 3338 +(% class="box infomessage" %) 3339 +((( 3340 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3341 +))) 3342 + 3343 +Запрос: 3344 + 3345 +{ 3346 + "Ids": [ 3347 + 0 3348 + ], 3349 + "BeginTime": "2023-06-30T12:48:39.419Z", 3350 + "EndTime": "2023-06-30T12:48:39.419Z" 3351 +} 3352 + 3353 +Ответ: 3354 + 3355 +[ 3356 + { 3357 + "VehicleId": 0, 3358 + "CreateTime": "2023-06-30T09:54:01.631Z", 3359 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3360 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3361 + "BeginTime": "2023-06-30T09:54:01.631Z", 3362 + "EndTime": "2023-06-30T09:54:01.631Z" 3363 + } 3364 +] 3365 + 3366 + 3367 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 3368 + 3369 +(% class="box successmessage" %) 3370 +((( 3371 +**POST /api/v3/DriversVehiclesAssignments** 3372 +))) 3373 + 3374 +Передается массив назначений 3375 + 3376 +Запрос: 3377 + 3378 +[ 3379 + { 3380 + "VehicleId": 0, ~/~/ Идентификатор объекта 3381 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3382 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3383 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3384 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 3385 + } 3386 +] 3387 + 3388 +Ответ: 3389 + 3390 +[ 3391 + { 3392 + "VehicleId": 0, 3393 + "CreateTime": "2023-06-30T11:04:46.903Z", 3394 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3395 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3396 + "BeginTime": "2023-06-30T11:04:46.903Z", 3397 + "EndTime": "2023-06-30T11:04:46.903Z" 3398 + } 3399 +] 3400 + 3401 + 3402 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 3403 + 3404 +(% class="box warningmessage" %) 3405 +((( 3406 +**PUT /api/v3/DriversVehiclesAssignments** 3407 +))) 3408 + 3409 +Запрос: 3410 + 3411 +[ 3412 + { 3413 + "VehicleId": 0, 3414 + "CreateTime": "2023-06-30T11:14:08.117Z", 3415 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3416 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3417 + "BeginTime": "2023-06-30T11:14:08.117Z", 3418 + "EndTime": "2023-06-30T11:14:08.117Z" 3419 + } 3420 +] 3421 + 3422 +Ответ: 3423 + 3424 +[ 3425 + { 3426 + "VehicleId": 0, 3427 + "CreateTime": "2023-06-30T11:14:53.349Z", 3428 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3429 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3430 + "BeginTime": "2023-06-30T11:14:53.349Z", 3431 + "EndTime": "2023-06-30T11:14:53.349Z" 3432 + } 3433 +] 3434 + 3435 + 3436 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 3437 + 3438 +(% class="box errormessage" %) 3439 +((( 3440 +**DELETE /api/v3/DriversVehiclesAssignments** 3441 +))) 3442 + 3443 +Запрос: 3444 + 3445 +[ 3446 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3447 +] 3448 + 3449 +Ответ: 3450 + 3451 +Success 3452 + 3453 + 3454 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 3455 + 3456 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 3457 + 3458 +(% class="box infomessage" %) 3459 +((( 3460 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3461 +))) 3462 + 3463 +Запрос: 3464 + 3465 +{ 3466 + "Ids": [ 3467 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3468 + ], 3469 + "BeginTime": "2023-06-30T12:47:12.162Z", 3470 + "EndTime": "2023-06-30T12:47:12.162Z" 3471 +} 3472 + 3473 +Ответ: 3474 + 3475 +[ 3476 + { 3477 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3478 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3479 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3480 + "BeginTime": "2023-06-30T11:19:40.703Z", 3481 + "EndTime": "2023-06-30T11:19:40.703Z" 3482 + } 3483 +] 3484 + 3485 + 3486 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 3487 + 3488 +(% class="box infomessage" %) 3489 +((( 3490 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3491 +))) 3492 + 3493 +Запрос: 3494 + 3495 +{ 3496 + "Ids": [ 3497 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3498 + ], 3499 + "BeginTime": "2023-06-30T12:47:12.162Z", 3500 + "EndTime": "2023-06-30T12:47:12.162Z" 3501 +} 3502 + 3503 +Ответ: 3504 + 3505 +[ 3506 + { 3507 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3508 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3509 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3510 + "BeginTime": "2023-06-30T11:19:40.703Z", 3511 + "EndTime": "2023-06-30T11:19:40.703Z" 3512 + } 3513 +] 3514 + 3515 + 3516 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 3517 + 3518 +(% class="box successmessage" %) 3519 +((( 3520 +**POST /api/v3/DriversRfidsAssignments** 3521 +))) 3522 + 3523 +Запрос: 3524 + 3525 +[ 3526 + { 3527 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3528 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3529 + "BeginTime": "2023-06-30T11:27:08.635Z", 3530 + "EndTime": "2023-06-30T11:27:08.635Z" 3531 + } 3532 +] 3533 + 3534 +Ответ: 3535 + 3536 +[ 3537 + { 3538 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3539 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3540 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3541 + "BeginTime": "2023-06-30T11:27:08.677Z", 3542 + "EndTime": "2023-06-30T11:27:08.677Z" 3543 + } 3544 +] 3545 + 3546 + 3547 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 3548 + 3549 +(% class="box warningmessage" %) 3550 +((( 3551 +**PUT /api/v3/DriversRfidsAssignments** 3552 +))) 3553 + 3554 +Запрос: 3555 + 3556 +[ 3557 + { 3558 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3559 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3560 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3561 + "BeginTime": "2023-06-30T11:28:43.330Z", 3562 + "EndTime": "2023-06-30T11:28:43.330Z" 3563 + } 3564 +] 3565 + 3566 +Ответ: 3567 + 3568 +[ 3569 + { 3570 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3571 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3572 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3573 + "BeginTime": "2023-06-30T11:28:43.331Z", 3574 + "EndTime": "2023-06-30T11:28:43.331Z" 3575 + } 3576 +] 3577 + 3578 + 3579 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3580 + 3581 +(% class="box errormessage" %) 3582 +((( 3583 +**DELETE /api/v3/DriversRfidsAssignments** 3584 +))) 3585 + 3586 +Запрос: 3587 + 3588 +[ 3589 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3590 +] 3591 + 3592 +Ответ: 3593 + 3594 +Success 3595 + 3596 + 3597 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3598 + 3599 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3600 + 3601 +(% class="box infomessage" %) 3602 +((( 3603 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3604 +))) 3605 + 3606 +Запрос: 3607 + 3608 +{ 3609 + "Ids": [ 3610 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3611 + ], 3612 + "BeginTime": "2023-06-30T12:45:10.852Z", 3613 + "EndTime": "2023-06-30T12:45:10.852Z" 3614 +} 3615 + 3616 +Ответ: 3617 + 3618 +[ 3619 + { 3620 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3621 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3622 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3623 + "BeginTime": "2023-06-30T11:58:04.695Z", 3624 + "EndTime": "2023-06-30T11:58:04.695Z" 3625 + } 3626 +] 3627 + 3628 + 3629 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3630 + 3631 +(% class="box infomessage" %) 3632 +((( 3633 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3634 +))) 3635 + 3636 +Запрос: 3637 + 3638 +{ 3639 + "Ids": [ 3640 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3641 + ], 3642 + "BeginTime": "2023-06-30T12:45:10.852Z", 3643 + "EndTime": "2023-06-30T12:45:10.852Z" 3644 +} 3645 + 3646 +Ответ: 3647 + 3648 +[ 3649 + { 3650 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3651 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3652 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3653 + "BeginTime": "2023-06-30T11:58:04.695Z", 3654 + "EndTime": "2023-06-30T11:58:04.695Z" 3655 + } 3656 +] 3657 + 3658 + 3659 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3660 + 3661 +(% class="box successmessage" %) 3662 +((( 3663 +**POST /api/v3/DriversFuelCardsAssignments** 3664 +))) 3665 + 3666 +Запрос: 3667 + 3668 +[ 3669 + { 3670 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3671 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3672 + "BeginTime": "2023-06-30T12:09:53.175Z", 3673 + "EndTime": "2023-06-30T12:09:53.175Z" 3674 + } 3675 +] 3676 + 3677 +Ответ: 3678 + 3679 +[ 3680 + { 3681 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3682 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3683 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3684 + "BeginTime": "2023-06-30T12:09:53.201Z", 3685 + "EndTime": "2023-06-30T12:09:53.201Z" 3686 + } 3687 +] 3688 + 3689 + 3690 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3691 + 3692 +(% class="box warningmessage" %) 3693 +((( 3694 +**PUT /api/v3/DriversFuelCardsAssignments** 3695 +))) 3696 + 3697 +Запрос: 3698 + 3699 +[ 3700 + { 3701 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3702 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3703 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3704 + "BeginTime": "2023-06-30T12:09:53.201Z", 3705 + "EndTime": "2023-06-30T12:09:53.201Z" 3706 + } 3707 +] 3708 + 3709 +Ответ: 3710 + 3711 +[ 3712 + { 3713 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3714 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3715 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3716 + "BeginTime": "2023-06-30T12:09:53.201Z", 3717 + "EndTime": "2023-06-30T12:09:53.201Z" 3718 + } 3719 +] 3720 + 3721 + 3722 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3723 + 3724 +(% class="box errormessage" %) 3725 +((( 3726 +**DELETE /api/v3/DriversFuelCardsAssignments** 3727 +))) 3728 + 3729 +Запрос: 3730 + 3731 +[ 3732 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3733 +] 3734 + 3735 +Ответ: 3736 + 3737 +Success 3738 + 3739 + 3740 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3741 + 3742 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3743 + 3744 +(% class="box infomessage" %) 3745 +((( 3746 +**POST /api/v3/Trailers** 3747 +))) 3748 + 3749 +Пример запроса: 3750 + 3751 +{ 3752 + "startDate": "2023-11-14T10:48:03.671Z", 3753 + "endDate": "2023-11-14T10:48:03.671Z", 3754 + "ids": [ 0 ], 3755 + "timezone": 0 3756 +} 3757 + 3758 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3759 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3760 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3761 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3762 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3763 + 3764 +Пример ответа: 3765 + 3766 +[ 3767 + { 3768 + "SD": "2023-11-14T10:48:03.717Z", 3769 + "ED": "2023-11-14T10:48:03.717Z", 3770 + "id": 0, 3771 + "SLat": 0, 3772 + "SLon": 0, 3773 + "ELat": 0, 3774 + "ELon": 0, 3775 + "mileage": 0 3776 + "Duration": 0 3777 + "Address": "string", 3778 + "Address2": "string", 3779 + "name": "string", 3780 + "rid": "string", 3781 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3782 + "trailer": { 3783 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3784 + "Number": "string", 3785 + "Description": "string", 3786 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3787 + "ExternalID": "string", 3788 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3789 + "CreateTime": "2023-11-14T10:48:03.717Z", 3790 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3791 + "IsDeleted": true 3792 + }, 3793 + "filesCount": 0, 3794 + } 3795 +] 3796 + 3797 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3798 +|SD|Дата и время начала события 3799 +|ED|Дата и время окончания события 3800 +|id|ID объекта 3801 +|SLat|Широта начальной координаты 3802 +|SLon|Долгота начальной координаты 3803 +|ELat|Широта конечной координаты 3804 +|ELon|Долгота конечной координаты 3805 +|mileage|Пробег 3806 +|Duration|Продолжительность 3807 +|Address|Адрес начального местоположения 3808 +|Address2|Адрес конечного местоположения 3809 +|name|Имя радиометки 3810 +|rid|Номер радиометки 3811 +|rguid|ID радиометки 3812 +|trailer|Информация об агрегате 3813 +|ModelGuid|ID агрегата 3814 +|Number|Название/номер агрегата 3815 +|Description|Текст примечания агрегата 3816 + 3817 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3818 + 3819 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3820 + 3821 +(% class="box infomessage" %) 3822 +((( 3823 +**POST /api/v3/Rfids/find** 3824 +))) 3825 + 3826 +Запрос: 3827 + 3828 +{ 3829 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3830 +} 3831 + 3832 +Ответ: 3833 + 3834 +[ 3835 + { 3836 + "name": "string", 3837 + "number": 0, 3838 + "period": 0, 3839 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3840 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3841 + } 3842 +] 3843 + 3844 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3845 +|parentId|ID клиента 3846 +|name|Название карты-метки 3847 +|number|Номер 3848 +|period|Период запросов в секундах (работает только для агрегатов) 3849 +|id|ID карты-метки 3850 + 3851 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3852 + 3853 +(% class="box infomessage" %) 3854 +((( 3855 +**GET /api/v3/Rfids/{rfidGuid}** 3856 +))) 3857 + 3858 +Передаем параметр rfidGuid - идентификатор карты-метки 3859 + 3860 +Ответ: 3861 + 3862 +[ 3863 + { 3864 + "name": "string", 3865 + "number": 0, 3866 + "period": 0, 3867 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3868 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3869 + } 3870 +] 3871 + 3872 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3873 +|name|Название карты-метки 3874 +|number|Номер 3875 +|period|Период запросов в секундах (работает только для агрегатов) 3876 +|id|ID карты-метки 3877 +|parentId|ID клиента 3878 + 3879 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3880 + 3881 +(% class="box successmessage" %) 3882 +((( 3883 +**POST /api/v3/Rfids** 3884 +))) 3885 + 3886 +Запрос: 3887 + 3888 +{ 3889 + "name": "string", 3890 + "number": 0, 3891 + "period": 0, 3892 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3893 +} 3894 + 3895 +Ответ: 3896 + 3897 +{ 3898 + "name": "string", 3899 + "number": 0, 3900 + "period": 0, 3901 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3902 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3903 +} 3904 + 3905 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3906 +|name|Название карты-метки 3907 +|number|Номер 3908 +|period|Период запросов в секундах (работает только для агрегатов) 3909 +|id|ID карты-метки 3910 +|parentId|ID клиента 3911 + 3912 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3913 + 3914 +(% class="box warningmessage" %) 3915 +((( 3916 +**PUT /api/v3/Rfids** 3917 +))) 3918 + 3919 +Запрос: 3920 + 3921 +{ 3922 + "name": "string", 3923 + "number": 0, 3924 + "period": 0, 3925 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3926 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3927 +} 3928 + 3929 +Ответ: 3930 + 3931 +{ 3932 + "name": "string", 3933 + "number": 0, 3934 + "period": 0, 3935 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3936 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3937 +} 3938 + 3939 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3940 +|name|Название карты-метки 3941 +|number|Номер 3942 +|period|Период запросов в секундах (работает только для агрегатов) 3943 +|id|ID карты-метки 3944 +|parentId|ID клиента 3945 + 3946 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3947 + 3948 +(% class="box errormessage" %) 3949 +((( 3950 +**DELETE /api/v3/Rfids/{rfidGuid}** 3951 +))) 3952 + 3953 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3954 + 3955 +Ответ: 3956 + 3957 +Success 3958 + 3959 + 3960 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3961 + 3962 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3963 + 3964 +(% class="box infomessage" %) 3965 +((( 3966 +**GET /api/v3/Billing/client/balance/{clientId}** 3967 +))) 3968 + 3969 +Параметр запроса: **clientId **- идентификатор клиента. 3970 + 3971 +Ответ: 3972 + 3973 +{ 3974 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3975 + "Balance": 0 3976 +} 3977 + 3978 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3979 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3980 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3981 + 3982 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3983 + 3984 +(% class="box infomessage" %) 3985 +((( 3986 +**GET /api/v3/Billing/client/constraint/{clientId}** 3987 +))) 3988 + 3989 +Параметр запроса: **clientId **- идентификатор клиента. 3990 + 3991 +Ответ: 3992 + 3993 +{ 3994 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3995 + "CalculationType": 0, 3996 + "PermissibleBalance": 0, 3997 + "DefermentDays": 0, 3998 + "SendUiNotifications": true, 3999 + "SendEmailNotifications": true, 4000 + "IsPrivate": true, 4001 +} 4002 + 4003 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4004 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4005 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 4006 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 4007 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 4008 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4009 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4010 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4011 + 4012 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 4013 + 4014 +(% class="box infomessage" %) 4015 +((( 4016 +**GET /api/v3/Billing/client/plan/{clientId}** 4017 +))) 4018 + 4019 +Параметры запроса: 4020 + 4021 +**clientId **- идентификатор клиента. 4022 + 4023 +**planId **- идентификатор тарифного плана. 4024 + 4025 +Ответ: 4026 + 4027 +{ 4028 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4029 + "Plan": { **~/~/ Описание тарифного плана** 4030 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4031 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4032 + "Name": "string", 4033 + "IsArchived": true, 4034 + "Constraint": { 4035 + "CalculationType": 0, 4036 + "PermissibleBalance": 0, 4037 + "DefermentDays": 0 4038 + }, 4039 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 4040 + { 4041 + "Feature": "string", 4042 + "IsFactual": true, 4043 + "Limit": 0, 4044 + "Price": 0, 4045 + "PeriodValue": 0, 4046 + "PeriodType": 0 4047 + } 4048 + ] 4049 + }, 4050 + "DebitDate": "2023-10-18T12:46:24.213Z", 4051 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 4052 + { 4053 + "Feature": "string", 4054 + "IsEnabled": true, 4055 + "IsPrivate": true, 4056 + "IsFactual": true, 4057 + "Limit": 0, 4058 + "Price": 0, 4059 + "DebitDate": "2023-10-18T12:46:24.213Z", 4060 + "PeriodValue": 0, 4061 + "PeriodType": 0 4062 + } 4063 + ] 4064 +} 4065 + 4066 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4067 +|ClientId|Идентификатор клиента 4068 +|Id|Идентификатор тарифного плана 4069 +|OwnerId|Идентификатор клиента-владельца 4070 +|Name|Наименование тарифного плана 4071 +|IsArchived|Признак, определяющий архивный тарифный план 4072 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4073 +|PermissibleBalance|Допустимый баланс 4074 +|DefermentDays|Отсрочка, количество дней 4075 +|Feature|Код услуги 4076 +|IsEnabled|Признак, определяющий активирована ли услуга 4077 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4078 +|IsFactual|Признак, определяющий расчёт по факту 4079 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4080 +|Price|Цена за единицу. 4081 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4082 +|PeriodValue|Значение периода. 4083 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4084 + 4085 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 4086 + 4087 +(% class="box infomessage" %) 4088 +((( 4089 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 4090 +))) 4091 + 4092 +Параметр запроса: **clientId **- идентификатор клиента. 4093 + 4094 +Ответ: 4095 + 4096 +[ 4097 + { 4098 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4099 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4100 + "Name": "string", 4101 + "IsArchived": true, 4102 + "Constraint": { 4103 + "CalculationType": 0, 4104 + "PermissibleBalance": 0, 4105 + "DefermentDays": 0 4106 + }, 4107 + "Features": [ 4108 + { 4109 + "Feature": "string", 4110 + "IsFactual": true, 4111 + "Limit": 0, 4112 + "Price": 0, 4113 + "PeriodValue": 0, 4114 + "PeriodType": 0 4115 + } 4116 + ] 4117 + } 4118 +] 4119 + 4120 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4121 +|ClientId|Идентификатор клиента 4122 +|Id|Идентификатор тарифного плана 4123 +|OwnerId|Идентификатор клиента-владельца 4124 +|Name|Наименование тарифного плана 4125 +|IsArchived|Признак, определяющий архивный тарифный план 4126 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4127 +|PermissibleBalance|Допустимый баланс 4128 +|DefermentDays|Отсрочка, количество дней 4129 +|Feature|Код услуги 4130 +|IsFactual|Признак, определяющий расчёт по факту 4131 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4132 +|Price|Цена за единицу. 4133 +|PeriodValue|Значение периода. 4134 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4135 + 4136 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 4137 + 4138 +(% class="box infomessage" %) 4139 +((( 4140 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 4141 +))) 4142 + 4143 +Параметр запроса: **clientId **- идентификатор клиента. 4144 + 4145 +Ответ: 4146 + 4147 +[ 4148 + { 4149 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4150 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4151 + "Name": "string", 4152 + "IsArchived": true, 4153 + "Constraint": { 4154 + "CalculationType": 0, 4155 + "PermissibleBalance": 0, 4156 + "DefermentDays": 0 4157 + }, 4158 + "Features": [ 4159 + { 4160 + "Feature": "string", 4161 + "IsFactual": true, 4162 + "Limit": 0, 4163 + "Price": 0, 4164 + "PeriodValue": 0, 4165 + "PeriodType": 0 4166 + } 4167 + ] 4168 + } 4169 +] 4170 + 4171 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4172 +|ClientId|Идентификатор клиента 4173 +|Id|Идентификатор тарифного плана 4174 +|OwnerId|Идентификатор клиента-владельца 4175 +|Name|Наименование тарифного плана 4176 +|IsArchived|Признак, определяющий архивный тарифный план 4177 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4178 +|PermissibleBalance|Допустимый баланс 4179 +|DefermentDays|Отсрочка, количество дней 4180 +|Feature|Код услуги 4181 +|IsFactual|Признак, определяющий расчёт по факту 4182 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4183 +|Price|Цена за единицу. 4184 +|PeriodValue|Значение периода. 4185 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4186 + 4187 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4188 + 4189 +(% class="box warningmessage" %) 4190 +((( 4191 +**PUT /api/v3/Billing/client/balance** 4192 +))) 4193 + 4194 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4195 + 4196 +Тело запроса: 4197 + 4198 +{ 4199 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4200 + "Balance": 0 ~/~/ Значение баланса. 4201 +} 4202 + 4203 +Ответ: Success 4204 + 4205 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4206 + 4207 +(% class="box warningmessage" %) 4208 +((( 4209 +**PUT /api/v3/billing/client/balance/deposit** 4210 +))) 4211 + 4212 +Создает операцию **Пополнение **с указанной суммой 4213 + 4214 +Тело запроса: 4215 + 4216 +((( 4217 +{ 4218 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4219 + "amount": 0 ~/~/ Сумма пополнения баланса 4220 +} 4221 +))) 4222 + 4223 +((( 4224 + 4225 +))) 4226 + 4227 +Ответ: Success 4228 + 4229 +((( 4230 +{ 4231 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4232 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4233 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4234 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4235 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4236 + "Description": "string" ~/~/ Описание корректировки. 4237 +} 4238 +))) 4239 + 4240 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4241 + 4242 +Создает операцию **Списание **с указанной суммой 4243 + 4244 +(% class="box warningmessage" %) 4245 +((( 4246 +**PUT /api/v3/billing/client/balance/withdraw** 4247 +))) 4248 + 4249 +Тело запроса: 4250 + 4251 +((( 4252 +{ 4253 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4254 + "amount": 0 ~/~/ Сумма списания с баланса 4255 +} 4256 +))) 4257 + 4258 +Ответ: Success 4259 + 4260 +((( 4261 +{ 4262 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4263 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4264 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4265 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4266 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4267 + "Description": "string" ~/~/ Описание корректировки 4268 +} 4269 +))) 4270 + 4271 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4272 + 4273 +(% class="box warningmessage" %) 4274 +((( 4275 +**PUT /api/v3/Billing/client/constraint** 4276 +))) 4277 + 4278 +Тело запроса: 4279 + 4280 +((( 4281 +{ 4282 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4283 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4284 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4285 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4286 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4287 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4288 +} 4289 +))) 4290 + 4291 +((( 4292 + 4293 +))) 4294 + 4295 +Ответ: Success 4296 + 4297 +((( 4298 +{ 4299 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4300 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4301 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4302 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4303 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4304 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4305 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4306 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4307 +} 4308 +))) 4309 + 4310 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4311 + 4312 +(% class="box warningmessage" %) 4313 +((( 4314 +**PUT /api/v3/Billing/client/plan** 4315 +))) 4316 + 4317 +Тело запроса: 4318 + 4319 +{ 4320 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4321 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4322 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4323 + { 4324 + "Feature": "string", ~/~/ Код услуги. 4325 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4326 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4327 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4328 + "Price": 0, ~/~/ Цена за единицу. 4329 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4330 + "PeriodValue": 0, ~/~/ Значение периода. 4331 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4332 + } 4333 + ] 4334 +} 4335 + 4336 + 4337 +Ответ: Success 4338 + 4339 +((( 4340 +{ 4341 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4342 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4343 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4344 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4345 + "Name": "string", ~/~/ Наименование. 4346 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4347 + "Constraint": { ~/~/ Ограничения по тарифу 4348 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4349 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4350 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4351 + }, 4352 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4353 + { 4354 + "Feature": "string", ~/~/Код услуги. 4355 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4356 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4357 + "Price": 0, ~/~/ Цена за единицу. 4358 + "PeriodValue": 0, ~/~/ Значение периода. 4359 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4360 + } 4361 + ], 4362 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4363 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4364 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4365 + }, 4366 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4367 + { 4368 + "Feature": "string", ~/~/ Код услуги. 4369 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4370 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4371 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4372 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4373 + "Price": 0, ~/~/ Цена за единицу. 4374 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4375 + "PeriodValue": 0, ~/~/ Значение периода. 4376 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4377 + "Quantity": 0 ~/~/ Количество использования услуги. 4378 + } 4379 + ] 4380 +} 4381 +))) 4382 + 4383 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4384 + 4385 +(% class="box warningmessage" %) 4386 +((( 4387 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4388 +))) 4389 + 4390 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4391 + 4392 +(% class="box infomessage" %) 4393 +((( 4394 +**POST /api/v3/vehicles/import/{agentId}** 4395 +))) 4396 + 4397 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4398 + 4399 +В пути указывается **agentId** - id клиента. 4400 + 4401 +**Заголовок** 4402 + 4403 +**X-Auth: [токен авторизации]** 4404 + 4405 +**Параметры** 4406 + 4407 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4408 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4409 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4410 + 4411 +В теле использовать тип **form-data,** тип значения** file** 4412 + 4413 +**Ключи** 4414 + 4415 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4416 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4417 +|csv|В значении передаем файл датчиков, формат **csv** 4418 + 4419 +Ответ: 4420 + 4421 +{ 4422 + "vehicleId": 0, 4423 + "name": "string", 4424 + "errors": ["string"] 4425 +} 4426 + 4427 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4428 +|vehicleId|ID созданного объекта 4429 +|name|Имя созданного объекта 4430 +|errors|Ошибки и их описание 4431 + 4432 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4433 + 4434 +(% class="box infomessage" %) 4435 +((( 4436 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4437 +))) 4438 + 4439 +(% class="wikigeneratedid" %) 4440 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4441 + 4442 +(% class="wikigeneratedid" %) 4443 +В пути указывается **vehicleId **- id объекта. 4444 + 4445 +**Заголовок** 4446 + 4447 +**X-Auth: [токен авторизации]** 4448 + 4449 +В теле использовать тип **form-data.** 4450 + 4451 +Ключи: 4452 + 4453 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4454 +|**history**|В значении передавать файл с историей 4455 + 4456 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4457 + 4458 +Ответ: 4459 + 4460 +{ 4461 + "results": [ 4462 + { 4463 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4464 + "vehicleId": 0, 4465 + "errors": [ 4466 + "string" 4467 + ], 4468 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4469 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4470 + "producedCount": 0, 4471 + "msgCount": 0 4472 + } 4473 + ] 4474 +} 4475 + 4476 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4477 +|results|Результаты импорта в разрезе ТС 4478 +|vehicleGuid|Guid ТС 4479 +|vehicleId|ID ТС 4480 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4481 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4482 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4483 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4484 +|msgCount|Кол-во обработанных сообщений всего 4485 + 4486 +== **Импортировать историю ТС (Асинхронный запрос)** == 4487 + 4488 +(% class="box successmessage" %) 4489 +((( 4490 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4491 +))) 4492 + 4493 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4494 + 4495 +Метод запроса: **POST** 4496 + 4497 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4498 + 4499 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4500 + 4501 + 4502 +Ответ: 4503 + 4504 +{ 4505 + 4506 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4507 + 4508 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4509 + 4510 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4511 + 4512 + "Message": "string", ~/~/ Информация о выполнении запроса 4513 + 4514 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4515 + 4516 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4517 + 4518 + "Data": "string" ~/~/ Данные 4519 + 4520 +} 4521 + 4522 + 4523 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4524 + 4525 +(% class="box infomessage" %) 4526 +((( 4527 +**GET /api/v3/vehicles/import/history/status** 4528 +))) 4529 + 4530 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4531 + 4532 +Ответ: 4533 + 4534 +{ 4535 + "activity": true, 4536 + "progress": 0, 4537 + "message": "string" 4538 +} 4539 + 4540 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4541 +**Параметр** 4542 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4543 +**Описание** 4544 +))) 4545 +|((( 4546 +activity 4547 +)))|((( 4548 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4549 +))) 4550 +|((( 4551 +progress 4552 +)))|((( 4553 +Guid ТС 4554 +))) 4555 + 4556 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4557 + 4558 +(% class="box infomessage" %) 4559 +((( 4560 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4561 +))) 4562 + 4563 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4564 + 4565 +Метод запроса: **GET** 4566 + 4567 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4568 + 4569 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4570 + 4571 + 4572 +Ответ: 4573 + 4574 +{ 4575 + 4576 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4577 + 4578 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4579 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4580 + 4581 + "Message": "string", ~/~/ Информация о выполнении запроса 4582 + 4583 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4584 + 4585 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4586 + 4587 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4588 + 4589 + "Data": "string" ~/~/ Данные 4590 + 4591 +} 4592 + 4593 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4594 + 4595 +(% class="box infomessage" %) 4596 +((( 4597 +**POST /api/v3/vehicles/export** 4598 +))) 4599 + 4600 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4601 + 4602 +Тело запроса: 4603 + 4604 +[ 4605 + id 4606 +] 4607 + 4608 +Ответ: Success 200, получаете файлы с настройками. 4609 + 4610 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4611 + 4612 +(% class="box infomessage" %) 4613 +((( 4614 +**POST /api/v3/vehicles/export/history** 4615 +))) 4616 + 4617 +Метод возвращает список сообщений терминала объекта за выбранный период. 4618 + 4619 +Тело запроса: 4620 + 4621 +{ 4622 + "vehicleId": 0, 4623 + "asArchive": true, 4624 + "from": "2023-09-27T12:17:45.973Z", 4625 + "to": "2023-09-27T12:17:45.973Z" 4626 +} 4627 + 4628 +Ответ: 4629 + 4630 +Получаете файл. Сообщение: Code 200/Success 4631 + 4632 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4633 +|vehicleId|ID объекта 4634 +|asArchive|true - Архивировать файл, False - не архивировать 4635 +|from|Дата и время начала запроса 4636 +|to|Дата и время окончания запроса 4637 + 4638 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4639 + 4640 +(% class="box infomessage" %) 4641 +((( 4642 +**GET /api/v3/vehicles/export/history/status** 4643 +))) 4644 + 4645 +Метод возвращает список сообщений терминала объекта за выбранный период. 4646 + 4647 +Ответ: 4648 + 4649 +{ 4650 + "activity": true, 4651 + "progress": 0, 4652 + "message": "string" 4653 +} 4654 + 4655 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4656 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4657 +|progress|Прогресс экспорта, от 0 до 100% 4658 +|message|Текст описывающий статус 4659 + 4660 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4661 + 4662 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4663 + 4664 +(% class="box infomessage" %) 4665 +((( 4666 +**POST /api/v3/EcoDriving/rating** 4667 +))) 4668 + 4669 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4670 + 4671 +Тело запроса: 4672 + 4673 +{ 4674 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4675 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4676 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4677 +} 4678 + 4679 +Ответ: 4680 + 4681 +{ 4682 + "items": [ ~/~/ Список в разрезе ТС 4683 + { 4684 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4685 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4686 + "vehicleId": 0, ~/~/ ID ТС 4687 + "vehicleName": "string", ~/~/ Название ТС 4688 + "vehicleModel": "string", ~/~/ Модель ТС 4689 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4690 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4691 + "totalViolations": 0, ~/~/ Нарушений всего 4692 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4693 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4694 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4695 + "brakingViolations": 0, ~/~/ Нарушений торможения 4696 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4697 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4698 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4699 + }, 4700 + 4701 +((( 4702 + 4703 +))) 4704 + 4705 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4706 + "mileage": 0, ~/~/ Пробег, м 4707 + "tripsCount": 0, ~/~/ Кол-во рейсов 4708 + "trips": [ ~/~/ Информация по рейсу 4709 + { 4710 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4711 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4712 + "violationsCount": 0, ~/~/ Всего нарушений 4713 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4714 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4715 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4716 + "brakingViolations": 0, ~/~/ Нарушений торможения 4717 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4718 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4719 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4720 + }, 4721 + 4722 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4723 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4724 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4725 + "mileage": 0, ~/~/ Пробег, м 4726 + "motohours": 0, ~/~/ Моточасы, секунды 4727 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4728 + "startAddress": "string", ~/~/ Адрес начала рейса 4729 + "endAddress": "string", ~/~/ Адрес конца рейса 4730 + "drivers": [ ~/~/ Список водителей 4731 + { 4732 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4733 + "driverName": "string", ~/~/ФИО водителя 4734 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4735 + } 4736 + ] 4737 + } 4738 + ] 4739 + } 4740 + ] 4741 +} 4742 + 4743 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4744 + 4745 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4746 + 4747 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4748 + 4749 +(% class="box infomessage" %) 4750 +((( 4751 +**POST /api/v3/fuelcards/transactions** 4752 +))) 4753 + 4754 +Метод запроса: POST 4755 + 4756 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4757 +\\В заголовках запроса: X-Auth: Токен авторизации 4758 + 4759 +Параметры в теле запроса (JSON): 4760 + 4761 +{ 4762 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4763 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4764 + "ids": [ 4765 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4766 + ], 4767 + "timezone": 0 ~/~/ Часовой пояс 4768 +} 4769 + 4770 + 4771 +Ответ: 4772 + { 4773 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4774 + "driver": "string", ~/~/ Водители, привязанные к ТК 4775 + "object": "string", ~/~/ Наименование ТС 4776 + "amount": 0, ~/~/ Количество топлива 4777 + "amountDut": 0, ~/~/ Количество по ДУТ 4778 + "amountDiff": 0, ~/~/ Разница, л 4779 + "amountDiffPerc": 0, ~/~/ Разница, % 4780 + "summa": 0, ~/~/ Стоимость, руб 4781 + "serviceName": "string", ~/~/ Тип топлива 4782 + "price": 0, ~/~/ Цена за литр, руб 4783 + "cardName": "string", ~/~/ Наименование ТК 4784 + "cardNum": "string", ~/~/ Номер ТК 4785 + "operator": "string", ~/~/ Оператор ТК 4786 + "address": "string" ~/~/ Адрес АЗС 4787 + } 4788 + 4789 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4790 + 4791 +(% class="box infomessage" %) 4792 +((( 4793 +**GET /api/v3/fuelcards** 4794 +))) 4795 + 4796 +Метод запроса: GET 4797 + 4798 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4799 + 4800 +Ответ: 4801 + 4802 +[ 4803 + { 4804 + "Name": "string", ~/~/ Определяет наименование карты. 4805 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4806 + "Number": "string", ~/~/ Определяет № карты. 4807 + "Enabled": true, ~/~/ Определяет признак активности карты. 4808 + "Description": "string", ~/~/ Определяет описание карты. 4809 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4810 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4811 + "deleted": true ~/~/ Признак удаления 4812 + } 4813 +] 4814 + 4815 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4816 + 4817 + 4818 +== **Получение полных данных о ретрансляторе** == 4819 + 4820 +(% class="box infomessage" %) 4821 +((( 4822 +**GET ** **/api/v3/retranslations/{id}** 4823 +))) 4824 + 4825 +id - Идентификатор ретранслятора 4826 + 4827 + 4828 +Пример ответа: 4829 + 4830 +{ 4831 +"description": "", ~/~/ Поле описания ретранслятора 4832 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4833 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4834 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4835 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4836 +"objects": [ ~/~/ Объекты для ретрансляции 4837 +{ 4838 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4839 +"name": "", ~/~/ Наименование объекта ретрансляции 4840 +"imei": "", ~/~/ IMEI объекта ретрансляции 4841 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4842 +} 4843 + ], 4844 +"id": "", ~/~/ Идентификатор ретранслятора 4845 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4846 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4847 +} 4848 + 4849 + 4850 +== **Удаление данных ретранслятора** == 4851 + 4852 +(% class="box infomessage" %) 4853 +((( 4854 +**DELETE** **/api/v3/retranslations/{id}** 4855 +))) 4856 + 4857 +id - Идентификатор ретранслятора 4858 + 4859 + 4860 +== **Создание ретранслятора** == 4861 + 4862 +(% class="box infomessage" %) 4863 +((( 4864 +**POST ** **/api/v3/retranslations/{id}** 4865 +))) 4866 + 4867 +Запрос: 4868 + 4869 +{ 4870 +"description": "", ~/~/ Поле описания ретранслятора 4871 +"subscriberId": "", ~/~/ Идентификатор подписчика 4872 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4873 +"address": "", ~/~/ Адрес и порт принимающего сервера 4874 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4875 +"objects": [ ~/~/Объекты для ретрансляции 4876 +{ 4877 +"id": "", ~/~/ Идентификатор ретранслятора 4878 +"imei": "", ~/~/ IMEI объекта ретрансляции 4879 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4880 +} 4881 + ] 4882 +} 4883 + 4884 + 4885 +Ответ: 4886 + 4887 +{ 4888 +"description": "", ~/~/ Поле описания ретранслятора 4889 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4890 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4891 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4892 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4893 +"objects": [ ~/~/ Объекты для ретрансляции 4894 +{ 4895 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4896 +"name": "string", ~/~/ Наименование объекта ретрансляции 4897 +"imei": "", ~/~/ IMEI объекта ретрансляции 4898 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4899 +} 4900 + ], 4901 +"id": "", ~/~/ Идентификатор ретранслятора 4902 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4903 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4904 +} 4905 + 4906 + 4907 +== **Редактирование ретранслятора** == 4908 + 4909 +(% class="box infomessage" %) 4910 +((( 4911 +**PUT** **/api/v3/retranslations** 4912 +))) 4913 + 4914 +Пример запроса: 4915 + 4916 +{ 4917 +"id": "", ~/~/ Идентификатор ретранслятора 4918 +"description": "string", ~/~/ Поле описания ретранслятора 4919 +"subscriberId": "", ~/~/ Идентификатор подписчика 4920 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4921 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4922 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4923 +"objects": ~/~/ Объекты для ретрансляции 4924 +[ 4925 +{ 4926 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4927 +"imei": "", ~/~/ IMEI объекта ретрансляции 4928 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4929 +} 4930 + ] 4931 +} 4932 + 4933 + 4934 +Пример ответа: 4935 + 4936 +{ 4937 +"description": "", ~/~/ Поле описания ретранслятора 4938 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4939 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4940 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4941 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4942 +"objects": [ ~/~/ Объекты для ретрансляции 4943 +{ 4944 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4945 +"name": "string", ~/~/ Наименование объекта ретрансляции 4946 +"imei": "", ~/~/ IMEI объекта ретрансляции 4947 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4948 +} 4949 + ], 4950 +"id": "", ~/~/ Идентификатор ретранслятора 4951 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4952 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4953 +} 4954 + 4955 + 4956 +== **Получение списка ретранслятора клиента** == 4957 + 4958 +(% class="box infomessage" %) 4959 +((( 4960 +**POST /api/v3/retranslations/find** 4961 +))) 4962 + 4963 +Пример запроса: 4964 + 4965 +{ 4966 +"id": "", ~/~/ Идентификатор ретранслятора 4967 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4968 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4969 +} 4970 + 4971 +Ответ: 4972 + 4973 +[ 4974 +{ 4975 +"description": "", ~/~/ Поле описания ретранслятора 4976 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4977 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4978 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4979 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4980 +"id": "", ~/~/ Идентификатор ретранслятора 4981 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4982 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4983 +} 4984 +] 4985 + 4986 + 4987 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4988 + 4989 +== **API для отчета по выгрузке комбайнов** == 4990 + 4991 +(% class="box infomessage" %) 4992 +((( 4993 +**POST /api/v3/Reports/harvesterUnloading** 4994 +))) 4995 + 4996 +Пример запроса: 4997 + 4998 +{ 4999 + "byTime": 0, ~/~/ Объединение событий по времени 5000 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5001 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5002 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5003 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 5004 + "vehicleIds": [ ~/~/ Список id объектов для анализа 5005 + 0 5006 + ], 5007 + "from": "", ~/~/ Дата и время начало запроса 5008 + "to": "", ~/~/ Дата и время окончания запроса 5009 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 5010 +} 5011 + 5012 +Пример ответа: 5013 + 5014 +[ 5015 + { 5016 + "harvesterName": "", ~/~/Комбайн, номер 5017 + "harvesterId": 0, ~/~/Комбайн, id 5018 +"harvesterModel": "", ~/~/ Модель комбайна 5019 +"hopperCapacity": 0, ~/~/ Объем бункера м3 5020 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 5021 + "events": [ ~/~/Список событий в разрезе комбайна 5022 + { 5023 + "driverId": "", ~/~/Идентификатор водителя 5024 + "driverName": "", ~/~/Водитель комбайна, ФИО 5025 + "RFID": "", ~/~/ идентификатор карты-метки 5026 + "rfidName": "", ~/~/Водитель комбайна, имя метки 5027 + "vehicleId": 0, ~/~/идентификатор объекта 5028 + "vehicleName": "string", ~/~/ Имя объекта 5029 + "modelName": "string", ~/~/ Имя модели объекта 5030 + "nearestVehicles": [ ~/~/Объекты рядом 5031 + { 5032 + "vehicleId": 0, ~/~/идентификатор объекта 5033 + "vehicleName": "string" ~/~/ Имя объекта 5034 + } 5035 + ], 5036 + "fields": [ ~/~/Поля, где происходила выгрузка 5037 + { 5038 + "id": 0, ~/~/ идентификатор пользователя 5039 + "name": "string" ~/~/ имя пользователя 5040 + } 5041 + ], 5042 + "event": "string", ~/~/Событие 5043 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 5044 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 5045 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 5046 + "cultureName": "string", ~/~/ название культуры 5047 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 5048 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 5049 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 5050 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 5051 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 5052 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 5053 + "issued": 0, ~/~/Выдано, бункеров 5054 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 5055 + "latitude": 0, ~/~/Широта 5056 + "longitude": 0, ~/~/ Долгота 5057 + "litresAway": 0, ~/~/Отдано, л 5058 + "m3Away": 0 ~/~/Отдано, м3 5059 + } 5060 + ] 5061 + } 5062 +] 5063 + 5064 + 5065 +== **Отчет трек-датчики** == 5066 + 5067 +(% class="box infomessage" %) 5068 +((( 5069 +**POST /api/v3/Reports/sensorsWorks** 5070 +))) 5071 + 5072 +**Пример запроса:** 5073 + 5074 +{ 5075 + "vehicleIds": [ ~/~/ Список ID объектов 5076 + 0 5077 + ], 5078 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 5079 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 5080 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5081 +} 5082 + 5083 +**Пример ответа:** 5084 + 5085 +((( 5086 +{ 5087 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 5088 + { 5089 + "vehicleId": 0, ~/~/ Идентификатор ТС 5090 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 5091 + { 5092 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 5093 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 5094 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 5095 + "name": "string", ~/~/ Наименование оборудования. 5096 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 5097 + "totalMileage": 0, ~/~/ Общий пробег. 5098 + "avgSpeed": 0 ~/~/ Средняя скорость. 5099 + } 5100 + ] 5101 + } 5102 + ] 5103 +} 5104 + 5105 + 5106 +== **Превышение скорости** == 5107 + 5108 +(% class="box infomessage" %) 5109 +((( 5110 +**POST /api/v3/Reports/overSpeedDuration** 5111 +))) 5112 + 5113 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5114 + 5115 +Пример запроса: 5116 + 5117 +((( 5118 +{ 5119 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5120 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5121 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5122 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5123 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5124 +} 5125 +))) 5126 + 5127 +((( 5128 + 5129 +))) 5130 + 5131 +((( 5132 +Пример ответа: 5133 +))) 5134 + 5135 +((( 5136 +((( 5137 +[ 5138 + { 5139 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5140 + "duration": 0, ~/~/ Продолжительность события в секундах 5141 + "maxSpeed": 0, ~/~/ Максимальная скорость 5142 + "speedLimit": 0 ~/~/ Ограничение скорости 5143 + } 5144 +] 5145 +))) 5146 +))) 5147 +))) 5148 + 5149 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 5150 + 5151 + 5152 +== **Запрос списка полей** == 5153 + 5154 +(% class="box successmessage" %) 5155 +((( 5156 +**POST /api/v3/agroLands/find** 5157 +))) 5158 + 5159 +Пример запроса: 5160 + 5161 +((( 5162 +((( 5163 +((( 5164 +{ 5165 + "year": 0, ~/~/ Фильтр по году 5166 + "name": "string", ~/~/ Фильтр по названию 5167 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5168 +} 5169 +))) 5170 +))) 5171 + 5172 + 5173 +))) 5174 + 5175 +Пример ответа: 5176 + 5177 +((( 5178 +[ 5179 + { 5180 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5181 + "year": 0, ~/~/ Год поля 5182 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5183 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5184 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5185 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5186 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5187 + "counts": { ~/~/ Счётчики с/х поля 5188 + "fieldOperations": 0, ~/~/ Количество операций на поле 5189 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5190 + "facts": 0 ~/~/ Счётчик факта 5191 + }, 5192 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5193 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5194 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5195 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5196 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5197 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5198 + "planComment": "string", ~/~/ Комментарий к полю 5199 + "productivity": 0, ~/~/ Урожайность. 5200 + "id": 0, ~/~/ Идентификатор объекта геозоны 5201 + "name": "string", ~/~/ Название объекта геозоны 5202 + "type": 0, ~/~/ Тип объекта геозоны 5203 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5204 + "fname": "string", ~/~/ Имя файла 5205 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5206 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5207 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5208 + "description": "string", ~/~/ Описание объекта геозоны 5209 + "area": 0, ~/~/ Площадь, м2 5210 + "perimetr": 0, ~/~/ Периметр, м 5211 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5212 + } 5213 +] 5214 + 5215 + 5216 +== **Создание нового поля ** == 5217 + 5218 +(% class="box successmessage" %) 5219 +((( 5220 +**POST /api/v3/agroLands** 5221 +))) 5222 + 5223 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5224 +X-agent - ID клиента 5225 + 5226 +Пример запроса: 5227 + 5228 +((( 5229 +{ 5230 + "extId": "string", 5231 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5232 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5233 + "display": "string", ~/~/ Настройки отображения 5234 + "year": 0, ~/~/ Год поля 5235 + "name": "string", ~/~/ Наименование 5236 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5237 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5238 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5239 + "planComment": "string", ~/~/ Комментарий к полю 5240 + "cropRotations": [ ~/~/ Данные по севообороту 5241 + { 5242 + "landId": 0, ~/~/ ID поля 5243 + "landName": "string", ~/~/ Название поля 5244 + "year": 0, ~/~/ Год урожая 5245 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5246 + "cultureName": "string", ~/~/ Название культуры 5247 + "productivity": 0, ~/~/ Урожайность 5248 + "area": 0, ~/~/ Площадь поля, Га 5249 + "total": 0, ~/~/ Валовый сбор 5250 + "productivityFact": 0, ~/~/ Фактическая урожайность 5251 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5252 + "totalFact": 0, ~/~/ Фактический валовый сбор 5253 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5254 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5255 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5256 + "isyearplan": true, ~/~/ Годовой план 5257 + "comment": "string" ~/~/ Комментарий 5258 + } 5259 + ] 5260 +} 5261 +))) 5262 + 5263 +((( 5264 + 5265 +))) 5266 + 5267 +Пример ответа: 5268 + 5269 +((( 5270 +((( 5271 +{ 5272 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5273 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5274 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5275 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5276 + "cropRotations": [ ~/~/ Данные по севообороту 5277 + { 5278 + "landId": 0, ~/~/ ID поля 5279 + "landName": "string", ~/~/ Название поля 5280 + "year": 0, ~/~/ Год урожая 5281 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5282 + "cultureName": "string", ~/~/ Название культуры 5283 + "productivity": 0, ~/~/ Урожайность 5284 + "area": 0, ~/~/ Площадь поля, Га. 5285 + "total": 0, ~/~/ Валовый сбор 5286 + "productivityFact": 0, ~/~/ Фактическая урожайность 5287 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5288 + "totalFact": 0, ~/~/ Фактический валовый сбор 5289 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5290 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5291 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5292 + "isyearplan": true, ~/~/ годовой план 5293 + "comment": "string" ~/~/ Комментарий 5294 + } 5295 + ], 5296 + "cropVegetation": [ ~/~/ История вегетации поля 5297 + { 5298 + "values": [ ~/~/ Данные вегетации и состояния посева 5299 + { 5300 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5301 + "ndvi": 0 ~/~/ Индекс вегетации 5302 + } 5303 + ], 5304 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5305 + { 5306 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5307 + "type": "string", ~/~/ Тип 5308 + "pictureid": "string" ~/~/ Идентификатор ресурса 5309 + } 5310 + ], 5311 + "states": [ ~/~/ Ключевые даты развития поля 5312 + { 5313 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5314 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5315 + } 5316 + ] 5317 + } 5318 + ], 5319 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5320 + "counts": { 5321 + "fieldOperations": 0, ~/~/ Количество операций на поле 5322 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5323 + "facts": 0 ~/~/ Счётчик факта 5324 + }, 5325 + "planComment": "string", ~/~/ Комментарий к полю 5326 +))) 5327 + 5328 +((( 5329 + "productivity": 0, ~/~/ Урожайность. 5330 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5331 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5332 + "year": 0, ~/~/ Год поля 5333 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5334 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5335 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5336 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5337 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5338 + "id": 0, ~/~/ Идентификатор объекта геозоны 5339 + "name": "string", ~/~/ Название объекта геозоны 5340 + "type": 0, ~/~/ Тип объекта геозоны 5341 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5342 + "fname": "string", ~/~/ Имя файла 5343 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5344 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5345 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5346 + "description": "string", ~/~/ Описание объекта геозоны 5347 + "area": 0, ~/~/ Площадь, м2 5348 + "perimetr": 0, ~/~/ Периметр, м 5349 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5350 +} 5351 + 5352 + 5353 +))) 5354 +))) 5355 +))) 5356 + 5357 +== **Получение поля по id** == 5358 + 5359 +(% class="box infomessage" %) 5360 +((( 5361 +**GET /api/v3/agroLands/{id}** 5362 +))) 5363 + 5364 +Пример запроса: 5365 +id ~/~/ Идентификатор поля 5366 + 5367 +Пример ответа: 5368 + 5369 +((( 5370 +{ 5371 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5372 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5373 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5374 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5375 + "cropRotations": [ ~/~/ Данные по севообороту 5376 + { 5377 + "landId": 0, ~/~/ ID поля 5378 + "landName": "string", ~/~/ Название поля 5379 + "year": 0, ~/~/ Год урожая 5380 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5381 + "cultureName": "string", ~/~/ Название культуры 5382 + "productivity": 0, ~/~/ Урожайность 5383 + "area": 0, ~/~/ Площадь поля, Га 5384 + "total": 0, ~/~/ Валовый сбор 5385 + "productivityFact": 0, ~/~/ Фактическая урожайность 5386 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5387 + "totalFact": 0, ~/~/ Фактический валовый сбор 5388 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5389 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5390 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5391 + "isyearplan": true, ~/~/ План года 5392 + "comment": "string" ~/~/ Комментарий 5393 + } 5394 + ], 5395 + "cropVegetation": [ ~/~/ История вегетации поля 5396 + { 5397 + "values": [ ~/~/ Данные вегетации и состояния посева 5398 + { 5399 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5400 + "ndvi": 0 ~/~/ Индекс вегетации 5401 + } 5402 + ], 5403 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5404 + { 5405 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5406 + "type": "string", ~/~/ Тип 5407 + "pictureid": "string" ~/~/ Идентификатор ресурса 5408 + } 5409 + ], 5410 + "states": [ ~/~/ Ключевые даты развития поля 5411 + { 5412 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5413 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5414 + } 5415 + ] 5416 + } 5417 + ], 5418 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5419 + "counts": { 5420 + "fieldOperations": 0, ~/~/ Количество операций на поле 5421 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5422 + "facts": 0 ~/~/ Счётчик факта 5423 + }, 5424 + "planComment": "string", ~/~/ Комментарий к полю 5425 + "productivity": 0, ~/~/ Урожайность. 5426 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5427 +))) 5428 + 5429 +((( 5430 +((( 5431 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5432 + "year": 0, ~/~/ Год поля 5433 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5434 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5435 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5436 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5437 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5438 + "id": 0, ~/~/ Идентификатор объекта геозоны 5439 + "name": "string", ~/~/ Название объекта геозоны 5440 + "type": 0, ~/~/ Тип объекта геозоны 5441 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5442 + "fname": "string", ~/~/ Имя файла 5443 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5444 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5445 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5446 + "description": "string", ~/~/ Описание объекта геозоны 5447 + "area": 0, ~/~/ Площадь, м2 5448 + "perimetr": 0, ~/~/ Периметр, м 5449 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5450 +} 5451 +))) 5452 + 5453 + 5454 +== **Удаление существующего поля** == 5455 + 5456 +(% class="box errormessage" %) 5457 +((( 5458 +**DELETE /api/v3/agroLands/{id}** 5459 +))) 5460 + 5461 +Пример запроса: 5462 +id ~/~/ Идентификатор поля 5463 + 5464 +Пример ответа: 5465 + 5466 +((( 5467 +200 ~/~/ Успех 5468 +))) 5469 + 5470 +((( 5471 + 5472 +))) 5473 + 5474 +((( 5475 +((( 5476 +((( 5477 + 5478 +))) 5479 + 5480 +((( 5481 +== **Изменение поля** == 5482 + 5483 +(% class="box infomessage" %) 5484 +((( 5485 +**PUT /api/v3/agroLands** 5486 +))) 5487 + 5488 +Пример запроса: 5489 + 5490 +((( 5491 +((( 5492 +{ 5493 + "id": 0, ~/~/ Идентификатор поля 5494 + "extId": "string", ~/~/ ExtId 5495 + "shape": "string", ~/~/ Форма поля 5496 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5497 + "display": "string", ~/~/ Настройки отображения 5498 + "year": 0, ~/~/ Год поля 5499 + "name": "string", ~/~/ Наименование 5500 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5501 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5502 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5503 + "planComment": "string", ~/~/Комментарий к полю 5504 + "cropRotations": [ ~/~/ Данные по севообороту 5505 + { 5506 + "landId": 0, ~/~/ ID поля 5507 + "landName": "string", ~/~/ Название поля 5508 + "year": 0, ~/~/ Год урожая 5509 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5510 + "cultureName": "string", ~/~/ Название культуры 5511 + "productivity": 0, ~/~/ Урожайность 5512 + "area": 0, ~/~/ Площадь поля, Га. 5513 + "total": 0, ~/~/ Валовый сбор 5514 + "productivityFact": 0, ~/~/ Фактическая урожайность 5515 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5516 + "totalFact": 0, ~/~/ Фактический валовый сбор 5517 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5518 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5519 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5520 + "isyearplan": true, 5521 + "comment": "string" ~/~/ Комментарий 5522 + } 5523 + ], 5524 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5525 +} 5526 +))) 5527 +))) 5528 + 5529 +((( 5530 + 5531 +))) 5532 + 5533 +Пример ответа: 5534 + 5535 +((( 5536 +((( 5537 +((( 5538 +{ 5539 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5540 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5541 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5542 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5543 + "cropRotations": [ ~/~/ Данные по севообороту 5544 + { 5545 + "landId": 0, ~/~/ ID поля 5546 + "landName": "string", ~/~/ Название поля 5547 + "year": 0, ~/~/ Год урожая 5548 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5549 + "cultureName": "string", ~/~/ Название культуры 5550 + "productivity": 0, ~/~/ Урожайность 5551 + "area": 0, ~/~/ Площадь поля, Га 5552 + "total": 0, ~/~/ Валовый сбор 5553 + "productivityFact": 0, ~/~/ Фактическая урожайность 5554 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5555 + "totalFact": 0, ~/~/ Фактический валовый сбор 5556 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5557 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5558 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5559 + "isyearplan": true, ~/~/ 5560 + "comment": "string" ~/~/ Комментарий 5561 + } 5562 + ], 5563 + "cropVegetation": [ ~/~/ История вегетации поля 5564 + { 5565 + "values": [ ~/~/ Данные вегетации и состояния посева 5566 + { 5567 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5568 + "ndvi": 0 ~/~/ Индекс вегетации 5569 + } 5570 + ], 5571 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5572 + { 5573 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5574 + "type": "string", ~/~/ Тип 5575 + "pictureid": "string" ~/~/ Идентификатор ресурса 5576 + } 5577 + ], 5578 + "states": [ ~/~/ Ключевые даты развития поля 5579 + { 5580 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5581 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5582 + } 5583 + ] 5584 + } 5585 + ], 5586 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5587 + "counts": { 5588 + "fieldOperations": 0, ~/~/ Количество операций на поле 5589 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5590 + "facts": 0 ~/~/ Счётчик факта 5591 + }, 5592 + "planComment": "string", ~/~/ Комментарий к полю 5593 + "productivity": 0, ~/~/ Урожайность. 5594 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5595 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5596 + "year": 0, ~/~/ Год поля 5597 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5598 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5599 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5600 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5601 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5602 + "id": 0, ~/~/ Идентификатор объекта геозоны 5603 + "name": "string", ~/~/ Название объекта геозоны 5604 + "type": 0, ~/~/ Тип объекта геозоны 5605 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5606 + "fname": "string", ~/~/ Имя файла 5607 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5608 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5609 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5610 + "description": "string", ~/~/ Описание объекта геозоны 5611 + "area": 0, ~/~/ Площадь, м2 5612 + "perimetr": 0, ~/~/ Периметр, м 5613 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5614 +} 5615 +))) 5616 +))) 5617 +))) 5618 +))) 5619 +))) 5620 + 5621 + 5622 +== **Редактирование года урожая ** == 5623 + 5624 +(% class="box successmessage" %) 5625 +((( 5626 +**POST /api/v3/agroLands/updateOpenCloseYear** 5627 +))) 5628 + 5629 +Пример запроса: 5630 + 5631 +((( 5632 +((( 5633 +{ 5634 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5635 + 0 5636 + ], 5637 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5638 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5639 +} 5640 +))) 5641 + 5642 + 5643 +))) 5644 + 5645 +Пример ответа: 5646 + 5647 +((( 5648 +((( 5649 +{ 5650 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5651 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5652 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5653 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5654 + "cropRotations": [ ~/~/ Данные по севообороту 5655 + { 5656 + "landId": 0, ~/~/ ID поля 5657 + "landName": "string", ~/~/ Название поля 5658 + "year": 0, ~/~/ Год урожая 5659 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5660 + "cultureName": "string", ~/~/ Название культуры 5661 + "productivity": 0, ~/~/ Урожайность 5662 + "area": 0, ~/~/ Площадь поля, Га. 5663 + "total": 0, ~/~/ Валовый сбор 5664 + "productivityFact": 0, ~/~/ Фактическая урожайность 5665 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5666 + "totalFact": 0, ~/~/ Фактический валовый сбор 5667 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5668 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5669 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5670 + "isyearplan": true, ~/~/ 5671 + "comment": "string" ~/~/ Комментарий 5672 + } 5673 + ], 5674 + "cropVegetation": [ ~/~/ История вегетации поля 5675 + { 5676 + "values": [ ~/~/ Данные вегетации и состояния посева 5677 + { 5678 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5679 + "ndvi": 0 ~/~/ Индекс вегетации 5680 + } 5681 + ], 5682 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5683 + { 5684 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5685 + "type": "string", ~/~/ Тип 5686 + "pictureid": "string" ~/~/ Идентификатор ресурса 5687 + } 5688 + ], 5689 + "states": [ ~/~/ Ключевые даты развития поля 5690 + { 5691 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5692 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5693 + } 5694 + ] 5695 + } 5696 + ], 5697 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5698 + "counts": { 5699 + "fieldOperations": 0, ~/~/ Количество операций на поле 5700 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5701 + "facts": 0 ~/~/ Счётчик факта 5702 + }, 5703 + "planComment": "string", ~/~/ Комментарий к полю 5704 + "productivity": 0, ~/~/ Урожайность. 5705 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5706 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5707 + "year": 0, ~/~/ Год поля 5708 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5709 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5710 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5711 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5712 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5713 + "id": 0, ~/~/ Идентификатор объекта геозоны 5714 + "name": "string", ~/~/ Название объекта геозоны 5715 + "type": 0, ~/~/ Тип объекта геозоны 5716 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5717 + "fname": "string", ~/~/ Имя файла 5718 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5719 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5720 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5721 + "description": "string", ~/~/ Описание объекта геозоны 5722 + "area": 0, ~/~/ Площадь, м2 5723 + "perimetr": 0, ~/~/ ериметр, м 5724 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5725 +} 5726 +))) 5727 + 5728 + 5729 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5730 +))) 5731 +))) 5732 +))) 5733 + 5734 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5735 + 5736 + 5737 +(% class="box infomessage" %) 5738 +((( 5739 +**GET api/v3/Vehicles/recyclebin/all** 5740 +))) 5741 + 5742 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5743 + 5744 +Параметр запроса: {parentId} - идентификатор агента 5745 + 5746 +В заголовках запроса: X-Auth: Токен авторизации 5747 + 5748 +Ответ: 5749 + 5750 +[ 5751 + { 5752 + "recordTime": "", ~/~/Время записи 5753 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5754 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5755 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5756 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5757 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5758 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5759 + "items": [ ~/~/ 5760 +nullable: true ~/~/Детали 5761 + { 5762 + "name": "string", ~/~/наименование столбца 5763 + "value": "string" ~/~/содержание столбца 5764 + } 5765 + ] 5766 + }, 5767 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5768 + "string" 5769 + ] 5770 + } 5771 +] 5772 + 5773 + 5774 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5775 + 5776 +(% class="box infomessage" %) 5777 +((( 5778 +**POST api/v3/Vehicles/recyclebin/erase** 5779 +))) 5780 + 5781 +В заголовках запроса: X-Auth: Токен авторизации 5782 + 5783 +Пример запроса: 5784 + 5785 +[ 5786 +0 5787 +] 5788 + 5789 + 5790 +Пример ответа: 5791 + 5792 +[ 5793 +{ 5794 + "recordTime": "", ~/~/Время записи 5795 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5796 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5797 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5798 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5799 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5800 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5801 + "items": [ ~/~/Детали 5802 + { 5803 + "name": "", ~/~/Имя свойства 5804 + "value": "" ~/~/Значение свойства 5805 + } 5806 + ] 5807 + }, 5808 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5809 + "" 5810 + ] 5811 + } 5812 +] 5813 + 5814 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5815 + 5816 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5817 + 5818 +(% class="box infomessage" %) 5819 +((( 5820 +**POST api/v3/Vehicles/recyclebin/restore** 5821 +))) 5822 + 5823 +В заголовках запроса: X-Auth: Токен авторизации 5824 + 5825 +Параметры в теле запроса (JSON): 5826 + 5827 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5828 + 5829 +В заголовках запроса: X-Auth: Токен авторизации 5830 + 5831 + 5832 +Пример запроса: 5833 + 5834 +((( 5835 +[ 5836 +))) 5837 + 5838 +((( 5839 + 0 5840 +))) 5841 + 5842 +((( 5843 +] 5844 +))) 5845 + 5846 + 5847 +Пример ответа: 5848 + 5849 +[ 5850 +{ 5851 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5852 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5853 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5854 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5855 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5856 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5857 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5858 + "items": [ ~/~/Детали 5859 + { 5860 + "name": "string", ~/~/Имя свойства 5861 + "value": "string" ~/~/Значение свойства 5862 + } 5863 + ] 5864 + }, 5865 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5866 + "string" 5867 + ] 5868 + } 5869 +] 5870 + 5871 + 5872 += **Раздел: Журнал заданий ** = 5873 + 5874 + 5875 +== **Создание задания в Журнале заданий** == 5876 + 5877 +(% class="box infomessage" %) 5878 +((( 5879 +**POST /api/v3/vehicletasks** 5880 +))) 5881 + 5882 +Пример запроса: 5883 + 5884 +((( 5885 +{ 5886 + "vehicleId": 0, ~/~/ Идентификатор ТС 5887 + "description": "string", ~/~/ Описание 5888 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5889 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5890 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5891 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5892 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5893 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5894 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5895 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5896 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5897 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5898 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5899 + "cost": { 5900 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5901 + "Name": "string", ~/~/ Наименование 5902 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5903 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5904 + "Norm": 0 ~/~/ Норма внесения 5905 + }, 5906 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5907 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5908 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5909 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5910 + "deleted": true, ~/~/ Признак удаления 5911 + "extId": "string", 5912 + "GeoIds": [ ~/~/ Cвязанные поля 5913 + 0 5914 + ] 5915 +} 5916 +))) 5917 + 5918 + 5919 +Пример ответа: 5920 + 5921 +{ 5922 + "vehicleId": 0, ~/~/ Идентификатор ТС 5923 + "description": "string", ~/~/ Описание 5924 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5925 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5926 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5927 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5928 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5929 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5930 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5931 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5932 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5933 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5934 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5935 + "cost": { 5936 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5937 + "Name": "string", ~/~/ Наименование 5938 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5939 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5940 + "Norm": 0 ~/~/ Норма внесения 5941 + }, 5942 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5943 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5944 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5945 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5946 + "deleted": true, ~/~/ Признак удаления 5947 + "extId": "string", ~/~/ ExtId 5948 + "GeoIds": [ ~/~/ Связанные поля 5949 + 0 5950 + ] 5951 +} 5952 + 5953 + 5954 +== **Редактирование задания в Журнале заданий** == 5955 + 5956 +(% class="box successmessage" %) 5957 +((( 5958 +**PUT /api/v3/vehicletasks** 5959 +))) 5960 + 5961 +Пример запроса: 5962 + 5963 +((( 5964 +{ 5965 + "vehicleId": 0, ~/~/ Идентификатор ТС 5966 + "description": "string", ~/~/ Описание 5967 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5968 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5969 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5970 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5971 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5972 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5973 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5974 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5975 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5976 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5977 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5978 + "cost": { 5979 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5980 + "Name": "string", ~/~/ Наименование 5981 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5982 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5983 + "Norm": 0 ~/~/ Норма внесения 5984 + }, 5985 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5986 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5987 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5988 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5989 + "deleted": true, ~/~/ Признак удаления 5990 + "extId": "string", ~/~/ ExtId 5991 + "GeoIds": [ ~/~/ Связанные поля 5992 + 0 5993 + ] 5994 +} 5995 +))) 5996 + 5997 + 5998 +Пример ответа: 5999 + 6000 +{ 6001 + "vehicleId": 0, ~/~/ Идентификатор ТС 6002 + "description": "string", ~/~/ Описание 6003 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6004 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6005 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6006 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6007 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6008 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6009 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6010 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6011 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6012 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6013 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6014 + "cost": { 6015 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6016 + "Name": "string", ~/~/ Наименование 6017 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6018 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6019 + "Norm": 0 ~/~/ Норма внесения 6020 + }, 6021 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6022 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6023 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6024 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6025 + "deleted": true, ~/~/ Признак удаления 6026 + "extId": "string", ~/~/ ExtId 6027 + "GeoIds": [ ~/~/ Связанные поля 6028 + 0 6029 + ] 6030 +} 6031 + 6032 + 6033 +== **Удаление задания в Журнале заданий** == 6034 + 6035 +(% class="box warningmessage" %) 6036 +((( 6037 +**DELETE /api/v3/vehicletasks** 6038 +))) 6039 + 6040 +Пример запроса: 6041 + 6042 +((( 6043 +[ 6044 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 6045 +] 6046 +))) 6047 + 6048 +((( 6049 + 6050 +))) 6051 + 6052 +Пример ответа: 6053 + 6054 +{ 6055 + "vehicleId": 0, ~/~/ Идентификатор ТС 6056 + "description": "string", ~/~/ Описание 6057 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6058 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6059 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6060 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6061 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6062 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6063 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6064 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6065 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6066 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6067 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6068 + "cost": { 6069 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6070 + "Name": "string", ~/~/ Наименование 6071 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6072 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6073 + "Norm": 0 ~/~/ Норма внесения 6074 + }, 6075 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6076 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6077 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6078 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6079 + "deleted": true, ~/~/ Признак удаления 6080 + "extId": "string", ~/~/ ExtId 6081 + "GeoIds": [ ~/~/ Связанные поля 6082 + 0 6083 + ] 6084 +} 6085 + 6086 + 6087 +== **Получение списка Журнала заданий** == 6088 + 6089 +(% class="box infomessage" %) 6090 +((( 6091 +**POST /api/v3/vehicletasks/getbyperiod** 6092 +))) 6093 + 6094 +Пример запроса: 6095 + 6096 +((( 6097 +{ 6098 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6099 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6100 + "TimeZone": 0, ~/~/ Часовой пояс. 6101 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6102 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6103 + ], 6104 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6105 + 0 6106 + ], 6107 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6108 + 0 6109 + ], 6110 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6111 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6112 +} 6113 +))) 6114 + 6115 + 6116 +Пример ответа: 6117 + 6118 +((( 6119 +{ 6120 + "total": 0, ~/~/ Общее количество записей 6121 + "pages": 0, ~/~/ Общее количество страниц 6122 + "currentPage": 0, ~/~/ Текущая страница 6123 + "items": [ ~/~/ Записи 6124 + { 6125 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6126 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6127 + "name": "string", ~/~/ Название задания. 6128 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6129 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6130 + "workKind": "string", ~/~/ Вид работ 6131 + "techOp": "string", ~/~/ Тех. операция 6132 + "trailerModel": "string", ~/~/ Модель агрегата 6133 + "width": "string", ~/~/ Ширина, м 6134 + "speed": "string", ~/~/ Тех. скорость 6135 + "fields": "string", ~/~/ Поля 6136 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6137 + "vehicles": "string", ~/~/ Объект-модель 6138 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6139 + "drivers": "string", ~/~/ Водители 6140 + "tmc": "string", ~/~/ ТМЦ 6141 + "client": "string", ~/~/ Клиент 6142 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6143 + "dep": "string", ~/~/ Подразделение 6144 + "geoIds": [ ~/~/ Связанные поля 6145 + 0 6146 + ] 6147 + } 6148 + ] 6149 +} 6150 +))) 6151 + 6152 + 6153 += **Раздел: Роли** = 6154 + 6155 +== **Получение списка клиентских и системных ролей пользователя ** == 6156 + 6157 +(% class="box successmessage" %) 6158 +((( 6159 +**POST /api/v3/groups/find** 6160 +))) 6161 + 6162 +Пример запроса: 6163 + 6164 +((( 6165 +{ 6166 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6167 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6168 +} 6169 +))) 6170 + 6171 +((( 6172 + 6173 +))) 6174 + 6175 +((( 6176 +Пример ответа: 6177 +))) 6178 + 6179 +((( 6180 +((( 6181 +{ 6182 + "groups": [ ~/~/ Системные роли пользователя 6183 + { 6184 + "code": "string", ~/~/ Код роли. 6185 + "name": "string", ~/~/ Имя 6186 + "shortName": "string" ~/~/ Короткое имя 6187 + } 6188 + ], 6189 + "customGroups": [ ~/~/ Системные роли пользователя 6190 + { 6191 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6192 + "name": "string", ~/~/ Наименование 6193 + "shortName": "string", ~/~/ Короткое наименование 6194 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6195 + } 6196 + ] 6197 +} 6198 +))) 6199 +))) 6200 + 6201 +((( 6202 + 6203 +))) 6204 + 6205 +((( 6206 + 6207 +))) 6208 + 6209 += **Раздел: Локатор ** = 6210 + 6211 + 6212 +== **Получение списка локаторов, доступных пользователю ** == 6213 + 6214 +(% class="box infomessage" %) 6215 +((( 6216 +**GET /api/v3/locators ** 6217 +))) 6218 + 6219 +В заголовках запроса: X-Auth: Токен авторизации 6220 + 6221 + 6222 +Пример ответа: 6223 + 6224 +((( 6225 +((( 6226 +{ 6227 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6228 + 0 6229 + ], 6230 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6231 + 0 6232 + ], 6233 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6234 + 0 6235 + ], 6236 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6237 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6238 + "agentName": "string", ~/~/ Наименование агента. 6239 + "isEnabled": true, ~/~/ Активность 6240 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6241 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6242 + "name": "string", ~/~/ Наименование. 6243 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6244 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6245 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6246 + "validity": 0, ~/~/ Значение срока действия 6247 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6248 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6249 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6250 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6251 + "url": "string", ~/~/ Ссылка 6252 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6253 + "showVehicleName": true, ~/~/ Наименование объекта 6254 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6255 + "allowTrackReport": true, ~/~/ Трек 6256 + "showTrackTracing": true, ~/~/ Трассировка трека 6257 + "showSensors": true, ~/~/ Датчик 6258 + "availableMapLayers": [ ~/~/ Слои на карте 6259 + 0 6260 + ] 6261 +} 6262 +))) 6263 +))) 6264 + 6265 + 6266 +((( 6267 +((( 6268 + 6269 +))) 6270 +))) 6271 + 6272 + 6273 +== **Создание локатора** == 6274 + 6275 +(% class="box successmessage" %) 6276 +((( 6277 +**POST /api/v3/locators** 6278 +))) 6279 + 6280 +Пример запроса: 6281 + 6282 +((( 6283 +{ 6284 + "isEnabled": true, ~/~/ Активность 6285 + "name": "string", ~/~/ Наименование локатора 6286 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6287 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6288 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6289 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6290 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6291 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6292 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6293 + 0 6294 + ], 6295 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6296 + 0 6297 + ], 6298 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6299 + 0 6300 + ], 6301 + "showVehicleName": true, ~/~/ Наименование объекта 6302 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6303 + "allowTrackReport": true, ~/~/ Трек 6304 + "showTrackTracing": true, ~/~/ Трассировка трека 6305 + "showSensors": true, ~/~/ Датчик 6306 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6307 + ] 6308 +} 6309 +))) 6310 + 6311 + 6312 +Пример ответа: 6313 + 6314 +((( 6315 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6316 +))) 6317 + 6318 + 6319 +== **Выводит список локаторов ** == 6320 + 6321 +(% class="box successmessage" %) 6322 +((( 6323 +**POST /api/v3/locators/find** 6324 +))) 6325 + 6326 +Пример запроса: 6327 + 6328 +((( 6329 +{ 6330 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6331 +} 6332 +))) 6333 + 6334 +((( 6335 + 6336 +))) 6337 + 6338 +((( 6339 +{ 6340 + "isEnabled": true, ~/~/ Активность 6341 + "name": "string", ~/~/ Наименование локатора 6342 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6343 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6344 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6345 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6346 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6347 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6348 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6349 + 0 6350 + ], 6351 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6352 + 0 6353 + ], 6354 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6355 + 0 6356 + ], 6357 + "showVehicleName": true, ~/~/ Наименование объекта 6358 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6359 + "allowTrackReport": true, ~/~/ Трек 6360 + "showTrackTracing": true, ~/~/ Трассировка трека 6361 + "showSensors": true, ~/~/ Датчик 6362 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6363 + ] 6364 +} 6365 +))) 6366 + 6367 + 6368 +Пример ответа: 6369 + 6370 +((( 6371 +[ 6372 + { 6373 + "vehiclesCount": 0, ~/~/ Количество объектов. 6374 + "geozonesCount": 0, ~/~/ Количество геозон. 6375 + "fieldsCount": 0, ~/~/ Количество полей. 6376 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6377 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6378 + "agentName": "string", ~/~/ Наименование агента. 6379 + "isEnabled": true, ~/~/ Активность локатора 6380 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6381 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6382 + "name": "string", ~/~/ Наименование локатора 6383 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6384 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6385 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6386 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6387 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6388 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6389 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6390 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6391 + "url": "string", ~/~/ ссылка на локатор 6392 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6393 + "showVehicleName": true, ~/~/ Наименование объекта 6394 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6395 + "allowTrackReport": true, ~/~/ Трек 6396 + "showTrackTracing": true, ~/~/ Трассировка трека 6397 + "showSensors": true, ~/~/ Датчик 6398 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6399 + 6400 + 0 6401 + ] 6402 + } 6403 +] 6404 +))) 6405 + 6406 + 6407 + 6408 +== **Изменение локатора** == 6409 + 6410 +(% class="box infomessage" %) 6411 +((( 6412 +**PUT /api/v3/locators** 6413 +))) 6414 + 6415 +Пример запроса: 6416 + 6417 +((( 6418 +{ 6419 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6420 + "isEnabled": true, ~/~/ Активность 6421 + "name": "string", ~/~/ Наименование 6422 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6423 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6424 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6425 + "autoProlongation": true, ~/~/ Автопродление срока действия 6426 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6427 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6428 + 0 6429 + ], 6430 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6431 + 0 6432 + ], 6433 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6434 + 0 6435 + ], 6436 + "showVehicleName": true, ~/~/ Наименование объекта 6437 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6438 + "allowTrackReport": true, ~/~/ Трек 6439 + "showTrackTracing": true, ~/~/ Трассировка трека 6440 + "showSensors": true, ~/~/ Датчик 6441 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6442 + ] 6443 +} 6444 + 6445 + 6446 +))) 6447 + 6448 +Пример ответа: 6449 + 6450 +200 ~/~/ Success 6451 + 6452 + 6453 +== **Удалить локатор** == 6454 + 6455 +(% class="box warningmessage" %) 6456 +((( 6457 +**DELETE /api/v3/locators** 6458 +))) 6459 + 6460 +Пример запроса: 6461 + 6462 +((( 6463 +[ 6464 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6465 +] 6466 +))) 6467 + 6468 + 6469 + 6470 += **Раздел: Яндекс Маршруты** = 6471 + 6472 + 6473 +== **Возвращение списка маршрутов** == 6474 + 6475 +(% class="box infomessage" %) 6476 +((( 6477 +**GET /api/v3/TransportRoutes** 6478 +))) 6479 + 6480 +Пример запроса: 6481 +Id ~/~/ Идентификатор поля 6482 + 6483 + 6484 +Пример ответа: 6485 + 6486 +((( 6487 +[ 6488 + { 6489 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6490 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6491 + "name": "string", ~/~/ Наименование маршрута. 6492 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6493 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6494 + 0 6495 + ] 6496 + } 6497 +] 6498 +))) 6499 + 6500 + 6501 + 6502 +== **Добавить маршрут** == 6503 + 6504 +(% class="box infomessage" %) 6505 +((( 6506 +**POST /api/v3/TransportRoutes** 6507 +))) 6508 + 6509 +Пример запроса: 6510 +{ 6511 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6512 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6513 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6514 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6515 + 0 6516 + ] 6517 +} 6518 + 6519 + 6520 +Пример ответа: 6521 + 6522 +((( 6523 +{ 6524 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6525 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6526 + "name": "string", ~/~/ Определяет наименование маршрута 6527 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6528 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6529 + 0 6530 + ] 6531 +} 6532 +))) 6533 + 6534 + 6535 +== **Обновление маршрута** == 6536 + 6537 +(% class="box successmessage" %) 6538 +((( 6539 +**PUT /api/v3/TransportRoutes** 6540 +))) 6541 + 6542 +Пример запроса: 6543 + 6544 +((( 6545 +{ 6546 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6547 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6548 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6549 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6550 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6551 + 0 6552 + ] 6553 +} 6554 +))) 6555 + 6556 + 6557 +Пример ответа: 6558 + 6559 +((( 6560 +{ 6561 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6562 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6563 + "name": "string", ~/~/ Определяет наименование маршрута 6564 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6565 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6566 + 0 6567 + ] 6568 +} 6569 +))) 6570 + 6571 + 6572 +== **Получить связки маршрутов ТС** == 6573 + 6574 +(% class="box infomessage" %) 6575 +((( 6576 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6577 +))) 6578 + 6579 +Пример запроса: 6580 + 6581 +((( 6582 +[ 6583 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6584 +] 6585 +))) 6586 + 6587 + 6588 +Пример ответа: 6589 + 6590 +((( 6591 +[ 6592 + { 6593 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6594 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6595 + } 6596 +] 6597 +))) 6598 + 6599 + 6600 +== **Удалить маршрут** == 6601 + 6602 +(% class="box warningmessage" %) 6603 +((( 6604 +**DELETE /api/v3/TransportRoutes/{id}** 6605 +))) 6606 + 6607 +Пример запроса: 6608 +Id ~/~/ Идентификатор поля 6609 + 6610 + 6611 + 6612 += **Раздел: Управление доступа к машинам** = 6613 + 6614 + 6615 +== Получение списка транспортных средств видимых пользователю == 6616 + 6617 +(% class="box infomessage" %) 6618 +((( 6619 +**GET /api/v3/UserVisibleVehicles/{userId}** 6620 +))) 6621 + 6622 +Пример ответа: 6623 + 6624 +((( 6625 +{ 6626 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6627 + 0 6628 + ] 6629 +} 6630 +))) 6631 + 6632 + 6633 + 6634 +== Задает видимость транспортных средств пользователю == 6635 + 6636 +(% class="box infomessage" %) 6637 +((( 6638 +**POST /api/v3/UserVisibleVehicles** 6639 +))) 6640 + 6641 +Пример запроса: 6642 + 6643 +((( 6644 +((( 6645 +{ 6646 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6647 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6648 + 0 6649 + ] 6650 +} 6651 +))) 6652 + 6653 +((( 6654 + 6655 +))) 6656 + 6657 +((( 6658 + 6659 +))) 6660 + 6661 +((( 6662 +Пример ответа : 6663 +))) 6664 + 6665 +((( 6666 + 6667 +))) 6668 + 6669 +((( 6670 +200 ~/~/ Success 6671 +))) 6672 +))) 6673 + 6674 + 6675 +== **Получение перечня моделей ** == 6676 + 6677 +(% class="box successmessage" %) 6678 +((( 6679 +**POST /api/v3/models/find** 6680 +))) 6681 + 6682 +Пример запроса: 6683 + 6684 +((( 6685 +((( 6686 +{ 6687 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6688 + "name": "string", ~/~/ Наименование локатора 6689 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6690 +))) 6691 + 6692 + 6693 + 6694 + Пример ответа: 6695 + 6696 + 6697 +((( 6698 +[ 6699 + { 6700 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6701 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6702 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6703 + "name": "string", ~/~/ Наименование локатора 6704 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 6705 + } 6706 +] 6707 +))) 6708 +))) 6709 + 6710 + 6711 + 6712 + 1440 1440 (% class="box" lang="en-US" style="text-align: center;" %) 1441 1441 ((( 1442 1442 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content