Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/04/21 14:13
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,5 +1,22 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 8 + 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 11 + 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 + 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 19 + 3 3 **Содержание страницы:** 4 4 ))) 5 5 ... ... @@ -14,13 +14,22 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!34 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 36 + 37 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 38 + 39 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 40 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 43 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 44 +((( 45 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 46 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 47 +))) 22 22 23 -(% class="box infomessage" %)49 +(% class="box successmessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».60 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,21 +40,25 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) 47 47 (% style="color:#000000" %){ 48 - 49 -(% lang="en-US" %) 50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 - "User": "testuser" , ~/~/ имя пользователя 52 - 53 -(% lang="en-US" %) 73 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 74 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 79 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 80 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 81 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 82 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 83 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 84 + 85 +(% class="wikigeneratedid" %) 86 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 87 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,63 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 126 + 127 +((( 97 97 { 98 - "agentId": "", ~/~/ идентификатор клиента (%%) 99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 - "isForeign": true/false, ~/~/ Иностранный контрагент 105 - "district": "string", ~/~/ округ 106 - "region": "string", ~/~/ регион 107 - "city": "string", ~/~/ город 108 - "inn": "string", ~/~/ ИНН клиента 109 - "kpp": "string", ~/~/ КПП клиента 110 - "address": "string", ~/~/ юридический адрес 111 - "addressFact": "string", ~/~/ фактический адрес 112 - "email": "string", ~/~/ почта 113 - "director": "string", ~/~/ ФИО руководителя 114 - "bankName": "string", ~/~/ Банк 115 - "bankBIK": "string", ~/~/ БИК 116 - "bankRS": "string", ~/~/ Номер счета 117 - "bankKS": "string" ~/~/ Корр. счет 118 - } 129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента 130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя 131 + "parentName": "string", ~/~/ Наименование агента 132 + "name": "string", ~/~/ Имя клиента 133 + "fullName": "string", ~/~/ ФИО клиента 134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%)) 135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент" 136 + "district": "string", ~/~/ Район 137 + "region": "string", ~/~/ Область 138 + "city": "string", ~/~/ Город 139 + "email": "string", ~/~/ Email 140 + "director": "string", ~/~/ Руководитель 141 + "RegionalData": [ ~/~/ Определяет региональные сведения. 142 + { 143 + "Country": 0, ~/~/ Страна 144 + "groups": [ ~/~/ Список групп 145 + { 146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 147 + "fields": [ ~/~/ Список значений полей 148 + { 149 + "name": "string", ~/~/ Имя поля формы 150 + "value": "string" ~/~/ Значение поля формы 151 + } 152 + ] 153 + } 154 + ] 155 + } 156 + ] 157 +} 158 +))) 119 119 160 + 161 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 162 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 163 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 164 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 165 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 166 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 167 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 168 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 169 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 170 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 171 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 172 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 173 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 174 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 175 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 176 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 177 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 178 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 179 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 180 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 181 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 182 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».196 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,23 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 211 + "agentId": "",(% style="color:#000000" %) (%%) 212 + "parentId": "", 213 + "name": "string", 214 + "fullName": "string", 215 + "agentInfoType": 0, 216 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 219 + 220 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 221 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 222 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 223 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 224 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 225 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 226 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 227 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 246 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -192,7 +192,6 @@ 192 192 "bankKS": "string" ~/~/ корр. счёт 193 193 } 194 194 195 - 196 196 Ответ: 197 197 198 198 { ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 291 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 292 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 293 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 294 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 295 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 296 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 297 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 298 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 299 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 300 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 301 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 302 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 303 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 304 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 305 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 306 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 307 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 308 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 309 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 310 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 311 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 393 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 394 + 395 +(% class="box warningmessage" %) 396 +((( 397 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 398 +))) 399 + 400 +Метод позволяет изменить статус клиента, указанного в запросе. 401 + 402 +В пути указывается GUID клиента и статус клиента. 403 + 404 +**status **- значение 0 - заблокирован, 1 - активен. 405 + 406 +Ответ: Code 204 407 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -351,7 +351,6 @@ 351 351 ], 352 352 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 - 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 - 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 472 +{ 473 + "id": "" , ~/~/ ID пользователя 375 375 "lastName": "" , ~/~/ Фамилия , 376 376 "firstName": "" , ~/~/ Имя 377 377 "position": "" , ~/~/ Должность ... ... @@ -388,9 +388,8 @@ 388 388 "kind": "" , ~/~/ тип аутентификации 389 389 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 390 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 490 +} 391 391 392 -(% style="text-align:left" %) 393 -(% style="color:#000000; font-weight:normal" %)} 394 394 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 ... ... @@ -411,19 +411,16 @@ 411 411 412 412 (% style="color:#000000" %)Параметры в теле запроса (JSON): 413 413 414 -(% style="color:#000000" %){ 415 - 512 +(% style="color:#000000" %){(%%) 416 416 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 417 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 418 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 419 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 423 (% style="color:#000000" %)Ответ: 424 424 425 425 (% style="color:#000000" %){ (%%) 426 - 427 427 "id": "" , ~/~/ идентификатор пользователя 428 428 "lastName": "" , ~/~/ фамилия 429 429 "firstName": "" , ~/~/ имя ... ... @@ -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,251 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: ** Транспортныесредства**(%%) =769 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 686 686 771 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 772 + 773 +(% class="box infomessage" %) 774 +((( 775 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 776 +))) 777 + 778 +Метод возвращает полную информацию о модели объекта. 779 + 780 +(% style="color:#000000" %)Метод запроса: **GET** 781 + 782 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 783 + 784 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 785 + 786 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 787 + 788 +(% style="color:#000000" %)Ответ: 789 + 790 +(% style="color:#000000" %){ 791 + "parentName": "string", 792 + "name": "string", 793 + "picture": "string", 794 + "minspeed": 0, 795 + "maxspeed": 0, 796 + "width": 0, 797 + "imbeddedtrailer": true, 798 + "hoppercapacity": 0, 799 + "hopperdischargespeed": 0, 800 + "modelType": 0, 801 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 802 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 803 + "deleted": true 804 +} 805 + 806 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 807 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 808 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 809 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 810 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 811 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 812 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 813 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 814 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 815 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 816 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 817 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 818 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 819 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 820 + 821 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 822 + 823 +(% class="box successmessage" %) 824 +((( 825 +(% lang="en-US" %)**POST /api/v3/models/find** 826 +))) 827 + 828 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 829 + 830 +(% style="color:#000000" %)Метод запроса: **POST** 831 + 832 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 833 + 834 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 835 + 836 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 837 + 838 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 839 +} 840 + 841 +(% style="color:#000000" %)Ответ: 842 + 843 +(% style="color:#000000" %)[ 844 + { 845 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 846 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 847 + "parentName": "string", 848 + "name": "string", 849 + "modelType": 0 850 + } 851 +] 852 + 853 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 854 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 855 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 856 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 857 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 858 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 859 + 860 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 861 + 862 +(% class="box successmessage" %) 863 +((( 864 +(% lang="en-US" %)**POST /api/v3/models** 865 +))) 866 + 867 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 868 + 869 +(% style="color:#000000" %)Метод запроса: **POST** 870 + 871 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 872 + 873 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 874 + 875 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 876 + 877 +{ 878 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 879 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 880 + "deleted": true, 881 + "extId": "string", 882 + "name": "string", 883 + "picture": "string", 884 + "minspeed": 0, 885 + "maxspeed": 0, 886 + "width": 0, 887 + "imbeddedtrailer": true, 888 + "fueloutlay": 0, 889 + "hoppercapacity": 0, 890 + "hopperdischargespeed": 0, 891 + "modelType": 0 892 +} 893 + 894 +Ответ: 895 + 896 +{ 897 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 898 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 899 + "deleted": true, 900 + "extId": "string", 901 + "name": "string", 902 + "picture": "string", 903 + "minspeed": 0, 904 + "maxspeed": 0, 905 + "width": 0, 906 + "imbeddedtrailer": true, 907 + "hoppercapacity": 0, 908 + "hopperdischargespeed": 0, 909 + "modelType": 0 910 +} 911 + 912 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 913 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 914 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 915 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 916 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 917 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 918 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 919 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 920 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 921 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 922 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 923 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 924 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 925 + 926 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 927 + 928 +(% class="box warningmessage" %) 929 +((( 930 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 931 +))) 932 + 933 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе. 934 + 935 +(% style="color:#000000" %)Метод запроса: **PUT** 936 + 937 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 938 + 939 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 940 + 941 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 942 + 943 +{ 944 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 945 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 946 + "deleted": true, 947 + "extId": "string", 948 + "name": "string", 949 + "picture": "string", 950 + "minspeed": 0, 951 + "maxspeed": 0, 952 + "width": 0, 953 + "imbeddedtrailer": true, 954 + "fueloutlay": 0, 955 + "hoppercapacity": 0, 956 + "hopperdischargespeed": 0, 957 + "modelType": 0 958 +} 959 + 960 +Ответ: 961 + 962 +{ 963 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 964 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 965 + "deleted": true, 966 + "extId": "string", 967 + "name": "string", 968 + "picture": "string", 969 + "minspeed": 0, 970 + "maxspeed": 0, 971 + "width": 0, 972 + "imbeddedtrailer": true, 973 + "fueloutlay": 0, 974 + "hoppercapacity": 0, 975 + "hopperdischargespeed": 0, 976 + "modelType": 0 977 +} 978 + 979 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 980 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 981 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 982 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 983 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 984 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 985 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 986 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 987 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 988 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 989 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 990 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 991 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 992 + 993 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 994 + 995 +(% class="box errormessage" %) 996 +((( 997 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 998 +))) 999 + 1000 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса. 1001 + 1002 +(% style="color:#000000" %)Метод запроса: **DELETE** 1003 + 1004 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 1005 + 1006 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 1007 + 1008 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1009 + 1010 +Ответ: В случае успеха **Success 200** 1011 + 1012 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 1013 + 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>1031 +(% 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**__>- идентификатор объекта (опционально)1033 +(% 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 { 1041 + 1042 +((( 1043 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1044 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1045 +))) 1046 + 1047 +((( 1048 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1049 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1050 +))) 1051 + 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" ~/~/ временная метка редактирования/обновления счетчика моточасов 1058 + "sim2": "", ~/~/ Номер SIM2 1059 + "parentId": "", ~/~/ ID клиента-родителя 1060 + "parentName": "", ~/~/ Наименование клиента-родителя 1061 + "modelId": "", ~/~/ ID модели объекта 1062 + "modelName": "", ~/~/ Имя модели объекта 1063 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1064 + "unitName": "string", ~/~/ Наименование подразделения 1065 + "status": 0, ~/~/ Статус объекта 1066 + "createdAt": "", ~/~/ Дата создания объекта 733 733 }, 1068 +"customFields": [ ~/~/ Произвольные поля 1069 + { 1070 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1071 + "name": "string", ~/~/ Имя поля 1072 + "value": "string", ~/~/ Значение поля 1073 + "forClient": true, ~/~/ Не используемая функция 1074 + "forTooltip": true, ~/~/ Отображать в подсказке 1075 + "forReport": true ~/~/ Отображать в отчете 1076 + } 1077 + 1078 +], ~/~/ Данные с вкладки нормы 1079 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1080 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1081 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1082 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1083 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1084 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1085 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1086 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1087 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1088 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1089 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1090 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1091 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1092 + "mileageCoeff": 0, ~/~/ коэффициент пробега 1093 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1094 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1095 + "counters": { ~/~/ Счетчики 1096 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1097 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1098 + "mileage": 0, ~/~/ Текущий пробег 1099 + "motohours": 0, ~/~/ Текущие моточасы 1100 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1101 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 1102 + }, 1103 + 1104 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1105 + "id": "string", ~/~/ ID объекта 1106 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 1107 + "host": "string", ~/~/ CMSV6 Web Host 1108 + "login": "string", ~/~/ CMSV6 Account 1109 + "password": "string" ~/~/ CMSV6 Password 1110 + }, 1111 + 1112 +"commandTemplates": [ ~/~/ Шаблоны команд 1113 + { 1114 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1115 + "name": "string", ~/~/ Наименование команды 1116 + "command": "string", ~/~/ Текст команды 1117 + "retries": 0 ~/~/ Количество попыток 1118 + } 1119 + ], 1120 + "sensors": [ ~/~/ Датчики 1121 + { 1122 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1123 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1124 + "type": 0, ~/~/ Тип датчика 1125 + "name": "string", ~/~/ Имя датчика 1126 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1127 + "inputNumber": 0, ~/~/ Номер входа 1128 + "pseudonym": "string", ~/~/ Псевдоним 1129 + "medianDegree": 0, ~/~/ Медианная фильтрация 1130 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1131 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1132 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1133 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1134 + { 1135 + "grades": [ ~/~/ Таблица тарировки 1 1136 + { 1137 + "input": 0, ~/~/ Входящее значение 1138 + "output": 0 ~/~/ Выходящее значение 1139 + } 1140 + ], 1141 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1142 + } 1143 + ], 1144 + "showInTooltip": true, ~/~/ Отображать в подсказке 1145 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 1147 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1148 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1149 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1150 + "expr": "string", ~/~/ Формула 1151 + "children": [ ~/~/ массив дочерних датчиков 1152 + "string" 1153 + ], 1154 + "customParams": { ~/~/ прочие произвольные параметры 1155 + "additionalProp1": "string", 1156 + "additionalProp2": "string", 1157 + "additionalProp3": "string" 1158 + }, 1159 + 1160 +~/~/ Характерные для произвольного: 1161 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1162 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1163 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1164 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1165 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1166 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1167 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1168 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1169 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1170 +~/~/ "ValueOn": "Вкл.", 1171 +~/~/ "ValueOff": "Выкл." 1172 + "summaryMaxValue": 0 ~/~/ Макс. значение 1173 + } 1174 + "drivers": [ ~/~/ Водители 1175 + { 1176 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1177 + "name": "string", ~/~/ Наименование 1178 + "description": "string", 1179 + "isDefault": true ~/~/ По умолчанию 1180 + } 1181 + ], 734 734 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 735 735 { 736 736 "id": "", ~/~/ ID задания ... ... @@ -746,10 +746,28 @@ 746 746 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 747 747 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 748 748 } 749 - ] 1197 + ], 1198 +"statusHistory": [ ~/~/ История статусов 1199 + { 1200 + "status": 0, 1201 + "date": "2023-05-22T09:57:39.562Z", 1202 + "description": "string", 1203 + "additionalInfo": "string" 1204 + 1205 +((( 750 750 } 1207 + ], 1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 751 751 ))) 752 752 1212 +((( 1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1214 +} 1215 + 1216 +))) 1217 +))) 1218 + 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 1225 + 1226 +== **Отправить команду на терминал** == 1227 + 1228 +(% class="box successmessage" %) 1229 +((( 1230 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1231 +))) 1232 + 1233 +Команда для отправки на тс. 1234 + 1235 +{ 1236 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1237 +"command": "", ~/~/ Текст отправляемой команды 1238 +"retries": "", ~/~/ Количество попыток отправки на терминал 1239 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1240 +} 1241 + 1242 +В ответ получаем cmdid 1243 + 1244 + 1245 +== **Получить ответ на отправленную на ТС команду** == 1246 + 1247 +(% class="box infomessage" %) 1248 +((( 1249 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1250 +))) 1251 + 1252 +Идентификатор команды: cmdId 1253 + 1254 +Запрос от терминала на ответ команды 1255 + 1256 +Пример ответ от терминала: 1257 + 1258 +ID= "" ~/~/ идентификатор объекта 1259 +Soft="" ~/~/ версия софта 1260 +GPS=4 ~/~/ тип трекера 1261 +Time=11:05:43 28.06.24 ~/~/ время запроса 1262 +Lat=45.056221 ~/~/ широта 1263 +Lon=39.035938 ~/~/ долгота 1264 +Speed=0.0 ~/~/ скорость 1265 +Course=181.4 ~/~/направление 1266 + 1267 +((( 1268 +== **Список отправленных объекту команд с ответами** == 1269 + 1270 +(% class="box infomessage" %) 1271 +((( 1272 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1273 +))) 1274 + 1275 +Идентификатор ТС: vehicleId 1276 + 1277 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1278 + 1279 +Пример ответа терминала 1280 + 1281 +[ 1282 +{ 1283 +"id": "", ~/~/ идентификатор пользователя 1284 +"commandText": "", ~/~/Текст команды. 1285 +"templateId": "", ~/~/Идентификатор шаблона 1286 +"updated": "", ~/~/ Время отправки 1287 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1288 +"answer": "", ~/~/ Ответ терминала. 1289 +"status": "" ~/~/ Статус отправки 1290 +} 1291 +] 1292 +))) 1293 + 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" %)Метод позволяет добавить объект . Метод позволяет добавить объект, указанный в запросе.1301 +(% 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 1313 + 1314 +((( 1315 + "vehicleId": 0, ~/~/ ID ТС 1316 +))) 1317 + 778 778 "parentId": "" , ~/~/ ID клиента 779 779 "name": "" , ~/~/ имя ТС 780 780 "imei": "" , ~/~/ IMEI ... ... @@ -795,6 +795,10 @@ 795 795 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 796 796 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 797 797 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1338 + "mileageCalcMethod": 0, 1339 + "mileageCoeff": 0, 1340 + "locationByCellId": true, 1341 + "dottedLineTrackWhenNoCoords": true, 798 798 "counters": ~/~/ счетчики 799 799 { 800 800 "mileage": "" , ~/~/ пробег ... ... @@ -823,67 +823,346 @@ 823 823 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 824 824 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 825 825 } 1370 +"drivers": [ ~/~/ Водители 1371 + { 1372 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1373 + "isDefault": true 1374 + } 1375 + ], 1376 + "commandTemplates": [ ~/~/ Шаблон команды 1377 + { 1378 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1379 + "name": "string", 1380 + "command": "string", 1381 + "retries": 0 1382 + } 1383 + ], 1384 +"sensors": [ ~/~/ Датчики 1385 + { 1386 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1387 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1388 + "type": 0, ~/~/ Тип датчика 1389 + "name": "string", ~/~/ Имя датчика 1390 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1391 + "inputNumber": 0, ~/~/ Номер входа 1392 + "pseudonym": "string", ~/~/ Псевдоним 1393 + "medianDegree": 0, ~/~/ Медианная фильтрация 1394 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1395 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1396 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1397 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1398 + { 1399 + "grades": [ ~/~/ Таблица тарировки 1 1400 + { 1401 + "input": 0, ~/~/ Входящее значение 1402 + "output": 0 ~/~/ Выходящее значение 1403 + } 1404 + ], 1405 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1406 + } 1407 + ], 1408 + "showInTooltip": true, ~/~/ Отображать в подсказке 1409 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1411 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1412 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1413 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1414 + "expr": "string", ~/~/ Формула 1415 + "children": [ ~/~/ массив дочерних датчиков 1416 + "string" 1417 + ], 1418 + "customParams": { ~/~/ прочие произвольные параметры 1419 + "additionalProp1": "string", 1420 + "additionalProp2": "string", 1421 + "additionalProp3": "string" 1422 + }, 1423 +~/~/ Характерные для произвольного: 1424 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1425 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1426 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1427 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1428 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1429 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1430 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1431 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1432 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1433 +~/~/ "ValueOn": "Вкл.", 1434 +~/~/ "ValueOff": "Выкл." 1435 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 826 826 827 -(% style="color:#000000" %) } 1437 +((( 1438 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1439 + { 1440 + "from": 0, ~/~/ С какого значения 1441 + "color": "string", ~/~/ Каким цветом 1442 + "text": "string" ~/~/ Текст подписи к этому интервалу 1443 + } 1444 + ] 1445 + } 1446 + ], 1447 +))) 828 828 1449 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1450 + 1451 + 1452 + "customFields": [ ~/~/ Произвольные поля 1453 + { 1454 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1455 + "name": "string", ~/~/ Наименование произвольного поля 1456 + "value": "string", ~/~/ Значение произвольного поля 1457 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1458 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1459 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1460 + 1461 +((( 1462 + } 1463 + ], 1464 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1465 +))) 1466 + 1467 +((( 1468 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1469 +} 1470 +))) 1471 + 1472 + 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 - однократно) 1476 +((( 1477 +((( 1478 +((( 1479 +{ 1480 + "vehicleId": 0, ~/~/ ID ТС 1481 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1482 + "name": "string", ~/~/ Имя объекта 1483 + "imei": "string", ~/~/ IMEI 1484 + "deviceTypeId": 0, ~/~/ ID типа устройства 1485 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1486 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1487 + "sim1": "string", ~/~/ SIM1 1488 + "sim2": "string", ~/~/ SIM2 1489 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1490 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1491 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1492 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1493 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1494 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1495 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1496 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1497 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1498 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1499 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1500 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1501 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1502 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1503 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1504 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1505 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1506 + "counters": { ~/~/ Dto для состояний счётчиков 1507 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1508 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1509 + "mileage": 0, ~/~/ Пробег 1510 + "motohours": 0 ~/~/ Моточасы 1511 + }, 1512 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1513 + "id": "string", ~/~/ CMSV6 Идентификатор 1514 + "enabled": true, ~/~/ Признак включения 1515 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1516 + "login": "string", ~/~/ CMSV6 имя учетной записи 1517 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1518 + }, 1519 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1520 + { 1521 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1522 + "enabled": true, ~/~/ Признак включения 1523 + "name": "string", ~/~/ Имя задания 1524 + "description": "string", ~/~/ Описание задания 1525 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1526 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1527 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1528 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1529 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1530 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1531 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1532 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 869 869 } 1534 + ], 1535 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1536 + { 1537 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1538 + "inputNumber": 0, ~/~/ № входа. 1539 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1540 + "comment": "string", ~/~/ Комментарий 1541 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1542 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1543 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1544 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1545 + } 1546 + ], 1547 + "commandTemplates": [ ~/~/ Список шаблонов команд 1548 + { 1549 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1550 + "name": "string", ~/~/ Название шаблона команд 1551 + "command": "string", ~/~/ Команда на выполнение 1552 + "retries": 0 ~/~/ Лимит попыток отправки 1553 + } 1554 + ], 1555 + "sensors": [ ~/~/ Список датчиков 1556 + { 1557 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1558 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1559 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1560 + "name": "string", ~/~/ Имя датчика 1561 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1562 + "inputNumber": 0, ~/~/ Номер входа 1563 + "pseudonym": "string", ~/~/ Псевдоним 1564 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1565 + "isInverted": true, ~/~/ Признак инверсии 1566 + "disabled": true, ~/~/ Датчик не участвует в обработке 1567 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1568 + "gradesTables": [ ~/~/ Тарировка 1569 + { 1570 + "grades": [ ~/~/ Таблицы тарировки 1571 + { 1572 + "input": 0, ~/~/ Вход 1573 + "output": 0 ~/~/ Выход 1574 + } 1575 + ], 1576 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1577 + } 1578 + ], 1579 + "showInTooltip": true, ~/~/ Отображение в подсказке 1580 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1581 + "color": "string", ~/~/ код цвета датчиков 1582 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1583 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1584 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1585 + "expr": "string", ~/~/ Выражение 1586 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1587 + "string" 1588 + ], 1589 + "customParams": { 1590 + "additionalProp1": "string", 1591 + "additionalProp2": "string", 1592 + "additionalProp3": "string" 1593 + }, 1594 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1595 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1596 + { 1597 + "from": 0, ~/~/ С какого значения 1598 + "color": "string", ~/~/ Каким цветом 1599 +))) 870 870 871 -(% style="text-align:left" %) 872 -(% style="color:#000000" %)} 1601 +((( 1602 + "text": "string" ~/~/ Текст подписи к этому интервалу 1603 + } 1604 + ] 1605 + } 1606 + ], 1607 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1608 + "customFields": [ ~/~/ Список произвольных полей 1609 + { 1610 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1611 + "name": "string", ~/~/ Наименование произвольного поля 1612 + "value": "string", ~/~/ Значение произвольного поля 1613 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1614 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1615 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1616 + } 1617 + ], 1618 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1619 +} 1620 +))) 1621 +))) 1622 +))) 873 873 1624 + 874 874 **Валидация:** 875 875 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 876 876 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 877 877 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 878 878 879 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 880 880 1631 +== **Импортировать историю ТС (Асинхронный запрос)** == 1632 + 1633 +(% class="box successmessage" %) 1634 +((( 1635 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1636 +))) 1637 + 1638 +Метод запроса: **POST** 1639 + 1640 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1641 + 1642 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1643 + 1644 + 1645 +Ответ: 1646 + 1647 +{ 1648 + 1649 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1650 + 1651 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1652 + 1653 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1654 + 1655 + "Message": "string", ~/~/ Информация о выполнении запроса 1656 + 1657 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1658 + 1659 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1660 + 1661 + "Data": "string" ~/~/ Данные 1662 + 1663 +} 1664 + 1665 + 1666 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1667 + 881 881 (% class="box infomessage" %) 882 882 ((( 1670 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1671 +))) 1672 + 1673 +Метод запроса: **GET** 1674 + 1675 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1676 + 1677 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1678 + 1679 + 1680 +Ответ: 1681 + 1682 +{ 1683 + 1684 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1685 + 1686 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1687 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1688 + 1689 + "Message": "string", ~/~/ Информация о выполнении запроса 1690 + 1691 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1692 + 1693 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1694 + 1695 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1696 + 1697 + "Data": "string" ~/~/ Данные 1698 + 1699 +} 1700 + 1701 + 1702 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1703 + 1704 +(% class="box infomessage" %) 1705 +((( 883 883 (% lang="en-US" %)**POST /api/v3/vehicles/find** 884 884 ))) 885 885 886 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1709 +(% 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 ~/~/ значение любого из произвольных полей ТС 1743 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1744 + "unitName": "string", ~/~/ Название подразделения (опционально) 1745 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1746 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1747 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1748 + "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" %){ 1755 +(% style="color:#000000" %)[ 1756 +{ 930 930 1758 +((( 1759 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1760 +))) 1761 + 1762 +((( 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" %)} 1788 +))) 958 958 1790 +((( 1791 + } 1792 + ], 1793 + "vehicleGroups": [ ~/~/ Группы ТС 1794 + { 1795 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1796 + "name": "string" ~/~/ Наименование группы ТС 1797 + } 1798 + ] 1799 + } 1800 +] 1801 +))) 1802 + 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 - 1838 +(% style="color:#000000" %){(%%) 997 997 "status": "", ~/~/ значение статуса 998 998 "date": "", ~/~/ Дата смены статуса 999 999 "description": "", ~/~/ Описание ... ... @@ -1000,10 +1000,10 @@ 1000 1000 "data": "", ~/~/ Данные 1001 1001 "overwrite": false, ~/~/ Флаг перезаписи 1002 1002 "stage": "", ~/~/ Состояние 1003 - 1004 -(% style="text-align:left" %) 1005 1005 (% style="color:#000000" %) } 1006 1006 1847 +== == 1848 + 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" %)Метод позволяет отредактировать объект . Метод позволяет отредактировать объект, указанный в запросе.1856 +(% 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 (%%) 1866 +(% style="color:#000000" %){ 1867 + "vehicleId": , ~/~/ ID объекта 1868 + "parentId": "" , ~/~/ ID клиента 1869 + "name": "" , ~/~/ имя ТС 1870 + "imei": "" , ~/~/ IMEI 1871 + "deviceTypeId": "" , ~/~/ ID типа устройства 1872 + "modelId": "" , ~/~/ ID модели 1873 + "unitId": "" , ~/~/ ID подразделения 1874 + "sim1": "" , ~/~/ Номер SIM 1 1875 + "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 - } 1888 + 1889 + "mileageCalcMethod": 0, 1890 + "mileageCoeff": 0, 1891 + "locationByCellId": true, 1892 + "dottedLineTrackWhenNoCoords": true, 1893 + "counters": ~/~/ счетчики 1894 + { 1895 + "mileage": "" , ~/~/ пробег 1896 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1897 + "motohours": "" , ~/~/ моточасы 1898 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1899 + }, 1900 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1901 + "enabled": true, ~/~/ флаг включения 1902 + "id": "" , ~/~/ идентификатор 1903 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1904 + "login": "" , ~/~/ имя учетной записи 1905 + "password": "" ~/~/ пароль учетной записи 1906 + }, 1907 + "inspectionTasks": ~/~/ задания на ТО 1908 + { 1909 + "enabled": "" , ~/~/ Признак включения 1910 + "name": "" , ~/~/ Имя задания 1911 + "description": "" , ~/~/ Описание задания 1912 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1913 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1914 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1915 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1916 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1917 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1918 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1919 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1920 + } 1921 + 1922 +"drivers": [ ~/~/ Водители 1923 + { 1924 + 1925 +((( 1926 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1927 + "inputNumber": 0, ~/~/ № входа. 1928 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1929 + "comment": "string", ~/~/ Комментарий. 1930 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1931 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1932 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1933 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1077 1077 ))) 1078 1078 1079 -(% style="color:#000000" %)} 1936 + } 1937 + ], 1938 + "commandTemplates": [ ~/~/ Шаблон команды 1939 + { 1940 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1941 + "name": "string", 1942 + "command": "string", 1943 + "retries": 0 1944 + } 1945 + ], 1946 +"sensors": [ ~/~/ Датчики 1947 + { 1948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1949 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1950 + "type": 0, ~/~/ Тип датчика 1951 + "name": "string", ~/~/ Имя датчика 1952 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1953 + "inputNumber": 0, ~/~/ Номер входа 1954 + "pseudonym": "string", ~/~/ Псевдоним 1955 + "medianDegree": 0, ~/~/ Медианная фильтрация 1956 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1957 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1958 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1959 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1960 + { 1961 + "grades": [ ~/~/ Таблица тарировки 1 1962 + { 1963 + "input": 0, ~/~/ Входящее значение 1964 + "output": 0 ~/~/ Выходящее значение 1965 + } 1966 + ], 1967 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1968 + } 1969 + ], 1970 + "showInTooltip": true, ~/~/ Отображать в подсказке 1971 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1080 1080 1973 +((( 1974 + "color": "string",** ~/~/ **Цвет датчика 1975 +))) 1976 + 1977 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1978 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1979 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1980 + "expr": "string", ~/~/ Формула 1981 + "children": [ ~/~/ массив дочерних датчиков 1982 + "string" 1983 + ], 1984 + "customParams": { ~/~/ прочие произвольные параметры 1985 + "additionalProp1": "string", 1986 + "additionalProp2": "string", 1987 + "additionalProp3": "string" 1988 + }, 1989 +~/~/ Характерные для произвольного: 1990 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1991 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1992 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1993 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1994 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1995 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1996 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1997 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1998 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1999 +~/~/ "ValueOn": "Вкл.", 2000 +~/~/ "ValueOff": "Выкл." 2001 + "summaryMaxValue": 0 ~/~/ Макс. значение 2002 + 2003 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2004 + { 2005 + "from": 0, ~/~/ С какого значения 2006 + "color": "string", ~/~/ Каким цветом 2007 + "text": "string" ~/~/ Текст подписи к этому интервалу 2008 + } 2009 + ] 2010 + } 2011 + ], 2012 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2013 + 2014 + "customFields": [ ~/~/ Произвольные поля 2015 + { 2016 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2017 + "name": "string", ~/~/ Наименование произвольного поля 2018 + "value": "string", ~/~/ Значение произвольного поля 2019 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2020 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2021 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2022 + } 2023 + 2024 +((( 2025 + ], 2026 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 2027 +))) 2028 + 2029 +} 2030 + 2031 + 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" %){ 2034 +((( 2035 +{ 2036 + "vehicleId": 0, ~/~/ ID ТС 2037 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 2038 + "name": "string", ~/~/ Имя объекта 2039 + "imei": "string", ~/~/ IMEI 2040 + "deviceTypeId": 0, ~/~/ ID типа устройства 2041 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 2042 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 2043 + "sim1": "string", ~/~/ SIM1 2044 + "sim2": "string", ~/~/ SIM2 2045 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 2046 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 2047 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 2048 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 2049 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 2050 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 2051 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 2052 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 2053 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 2054 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 2055 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 2056 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 2057 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 2058 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 2059 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 2060 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 2061 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 2062 + "counters": { ~/~/ состояний счётчиков 2063 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 2064 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 2065 + "mileage": 0, ~/~/ Пробег 2066 + "motohours": 0 ~/~/ Моточасы 2067 + }, 2068 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 2069 + "id": "string", ~/~/ CMSV6 Идентификатор 2070 + "enabled": true, ~/~/ Признак включения 2071 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2072 +))) 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 2074 + 2075 +((( 2076 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2077 + "login": "string", ~/~/ CMSV6 имя учетной записи 2078 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2079 + }, 2080 + "inspectionTasks": [ ~/~/ Задания на ТО 2081 + { 2082 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2083 + "enabled": true, ~/~/ Признак включения 2084 + "name": "string", ~/~/ Имя задания 2085 + "description": "string", ~/~/ Описание задания 2086 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2087 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2088 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2089 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2090 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2091 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2092 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2093 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2094 + } 2095 + ], 2096 + "drivers": [ ~/~/ Список водителей 2097 + { 2098 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2099 + "inputNumber": 0, ~/~/ № входа. 2100 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2101 + "comment": "string", ~/~/ Комментарий. 2102 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2103 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2104 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2105 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2106 + } 2107 + ], 2108 + "commandTemplates": [ ~/~/ Список шаблонов команд 2109 + { 2110 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2111 + "name": "string", ~/~/ Название шаблона команд 2112 + "command": "string", ~/~/ Команда на выполнение 2113 + "retries": 0 ~/~/ Лимит попыток отправки 2114 + } 2115 + ], 2116 + "sensors": [ ~/~/ Список датчиков 2117 + { 2118 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2119 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2120 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2121 +))) 2122 + 2123 +((( 2124 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2125 +))) 2126 + 2127 +((( 2128 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2129 +))) 2130 + 2131 +((( 2132 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2133 +))) 2134 + 2135 +((( 2136 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2137 +))) 2138 + 2139 +((( 2140 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2141 + "name": "string", ~/~/ Имя датчика 2142 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2143 +))) 2144 + 2145 +((( 2146 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2147 + "inputNumber": 0, ~/~/ Номер входа 2148 + "pseudonym": "string", ~/~/ Псевдоним 2149 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2150 + "isInverted": true, ~/~/ Признак инверсии 2151 + "disabled": true, ~/~/ Датчик не участвует в обработке 2152 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2153 + "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": "", ~/~/ Сколько раз выполнить задание 2155 + "grades": [ ~/~/ Таблицы тарировки 2156 + { 2157 + "input": 0, ~/~/ Вход 2158 + "output": 0 ~/~/ Выход 2159 + } 2160 + ], 2161 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1126 1126 } 2163 + ], 2164 + "showInTooltip": true, ~/~/ Отображение в подсказке 2165 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1127 1127 1128 -(% lang="en-US" style="text-align:left" %) 1129 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2167 +((( 2168 + "color": "string", ~/~/ цвет уведомлений 2169 +))) 1130 1130 2171 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2172 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2173 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2174 + "expr": "string", ~/~/ Выражение 2175 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2176 + "string" 2177 + ], 2178 + "customParams": { ~/~/ Дополнительные настройки 2179 + "additionalProp1": "string", 2180 + "additionalProp2": "string", 2181 + "additionalProp3": "string" 2182 + }, 2183 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2184 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2185 + { 2186 + "from": 0, ~/~/ С какого значения 2187 + "color": "string", ~/~/ Каким цветом 2188 + "text": "string" ~/~/ Текст подписи к этому интервалу 2189 + } 2190 + ] 2191 + } 2192 + ], 2193 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2194 + "customFields": [ ~/~/ Список произвольных полей 2195 + { 2196 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2197 + "name": "string", ~/~/ Наименование произвольного поля 2198 + "value": "string", ~/~/ Значение произвольного поля 2199 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2200 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2201 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2202 + } 2203 + ], 2204 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2205 +} 2206 +))) 2207 + 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" %)Метод позволяет удалить объект . Метод позволяет удалить объект, указанный в строке запроса.2220 +(% 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]]2246 +(% 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 - 2252 +(% 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 - 2276 +(% 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 2323 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2324 + 2325 +(% class="box infomessage" style="text-align: left;" %) 2326 +((( 2327 +**POST /api/v3/terminalMessages/mapping** 2328 +))) 2329 + 2330 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2331 + 2332 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2333 + 2334 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2335 + 2336 +{ 2337 + "protocolType": 0, 2338 + "params": ["string"] 2339 +} 2340 + 2341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2342 +|protocolType|ID типа протокола 2343 +|params|((( 2344 +Массив наименований параметров в сообщении 2345 +))) 2346 + 2347 +Ответ: 2348 + 2349 +{ 2350 + "protocolType": 0, 2351 + "mapping": { 2352 + "additionalProp1": { 2353 + "inputType": 0, 2354 + "inputNumber": 0 2355 + }, 2356 + "additionalProp2": { 2357 + "inputType": 0, 2358 + "inputNumber": 0 2359 + } 2360 + } 2361 +} 2362 + 2363 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2364 +|protocolType|Тип протокола 2365 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2366 +|inputNumber|((( 2367 +Номер входа 2368 +))) 2369 + 2370 +(% class="wikigeneratedid" %) 2371 +Перечень 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/]] 2372 + 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 2397 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2398 +|vehicleId|ID объекта 2399 +|from|Дата и время начала периода запроса 2400 +|to|Дата и время окончания периода запроса 2401 + 1276 1276 Ответ: 1277 1277 1278 1278 [ ... ... @@ -1279,30 +1279,415 @@ 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": { ~/~/ список параметров датчиков передаваемых терминалом 2408 + "deviceTime": "2023-11-29T07:40:44.052Z", 2409 + "serverTime": "2023-11-29T07:40:44.052Z", 2410 + "speed": 0, 2411 + "altitude": 0, 2412 + "latitude": 0, 2413 + "longitude": 0, 2414 + "satellites": 0, 2415 + "course": 0, 2416 + "voltage": 0, 2417 + "parameters": { 1291 1291 "additionalProp1": "string", 1292 1292 "additionalProp2": "string", 1293 1293 "additionalProp3": "string" 1294 1294 }, 1295 - "photoCount": 0 ~/~/ Кол-во фото 2422 + "photoCount": 0, 2423 + "lbsCorrectedCoords": true, 2424 + "protocolType": 0 1296 1296 } 1297 1297 ] 1298 1298 } 1299 1299 ] 1300 1300 2430 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2431 +|deviceTime|Время сообщения терминала 2432 +|serverTime|Время когда сообщение поступило на сервер 2433 +|speed|Скорость 2434 +|altitude|Высота над уровнем моря 2435 +|latitude|Широта 2436 +|longitude|Долгота 2437 +|satellites|Кол-во спутников 2438 +|course|Курс 2439 +|voltage|Бортовое напряжение 2440 +|parameters|Список параметров и их значений 2441 +|photoCount|Количество фото 2442 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2443 +|protocolType|ID типа протокола 2444 + 2445 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2446 + 2447 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2448 + 2449 +(% class="box infomessage" %) 2450 +((( 2451 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2452 +))) 2453 + 2454 +(% style="color:#000000" %)Метод запроса: **POST** 2455 + 2456 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2457 + 2458 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2459 + 2460 +(% style="text-align:left" %) 2461 +Тело запроса: 2462 + 2463 +{ 2464 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2465 + "vehicleIds": [0], ~/~/ Список ID объектов 2466 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2467 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2468 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2469 +} 2470 + 2471 +Ответ: 2472 + 2473 +[ 2474 + { 2475 + "vehicleId": 0, ~/~/ ID объекта 2476 + "name": "string", ~/~/ Имя ТС 2477 + "periods": [ ~/~/ Периоды 2478 + { 2479 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2480 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2481 + "mileage": 0, ~/~/ Пробег за период, километры 2482 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2483 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2484 + "motohours": 0, ~/~/ Моточасы за период, секунды 2485 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2486 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2487 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2488 + 2489 + } 2490 + ] 2491 + } 2492 +] 2493 + 2494 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2495 + 2496 +(% class="box infomessage" %) 2497 +((( 2498 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2499 +))) 2500 + 2501 +(% style="color:#000000" %)Метод запроса: **POST** 2502 + 2503 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2504 + 2505 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2506 + 2507 +(% style="text-align:left" %) 2508 +Тело запроса: 2509 + 2510 +{ 2511 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2512 + "vehicleIds": [0], ~/~/ Список ID объектов 2513 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2514 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2515 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2516 +} 2517 + 2518 +Ответ: 2519 + 2520 +[ 2521 + { 2522 + "vehicleId": 0, ~/~/ ID объекта 2523 + "name": "string", ~/~/ Имя ТС 2524 + "periods": [ ~/~/ Периоды 2525 + { 2526 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2527 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2528 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2529 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2530 + "fuelConsumption": 0, ~/~/ Расход топлива 2531 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2532 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2533 + 2534 + } 2535 + ] 2536 + } 2537 +] 2538 + 2539 +(% class="box warningmessage" %) 2540 +((( 2541 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2542 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2543 +))) 2544 + 2545 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2546 + 2547 +(% class="box infomessage" %) 2548 +((( 2549 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2550 +))) 2551 + 2552 +(% style="color:#000000" %)Метод запроса: **POST** 2553 + 2554 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2555 + 2556 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2557 + 2558 +(% style="text-align:left" %) 2559 +Тело запроса: 2560 + 2561 +{ 2562 + "vehicleIds": [0], ~/~/ Список ID объектов 2563 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2564 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2565 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2566 +} 2567 + 2568 +Ответ: 2569 + 2570 +[ 2571 + { 2572 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2573 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2574 + "vehicleId": 0, ~/~/ ID объекта 2575 + "name": "string", ~/~/ Имя объекта 2576 + "model": "string", ~/~/ Модель объекта 2577 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2578 + { 2579 + "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 2580 + 2581 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2582 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2583 + "valueFuel": 0, ~/~/ Количество 2584 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2585 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2586 + } 2587 + ] 2588 + } 2589 +] 2590 + 2591 + 2592 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2593 + 2594 +(% class="box infomessage" %) 2595 +((( 2596 +**POST /api/v3/vehicles/moveStop** 2597 +))) 2598 + 2599 +Метод запроса: **POST** 2600 + 2601 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2602 + 2603 +В заголовках запроса: X-Auth: Токен авторизации 2604 + 2605 + 2606 +Тело запроса: 2607 + 2608 +{ 2609 + "vehicleIds": [ ], ~/~/ Список ID объектов 2610 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2611 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2612 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2613 +} 2614 + 2615 +Ответ: 2616 + 2617 +[ 2618 + { 2619 + "vehicleId": 0, ~/~/ ID объекта 2620 + "vehicleName": "string", ~/~/ Имя объекта 2621 + "moves": [ ~/~/ Событие движения 2622 + { 2623 + "mileage": 0, ~/~/ Пробег, км 2624 + "eventId": 0, ~/~/ Идентификатор события 2625 + "eventName": "string", ~/~/ Название события 2626 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2627 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2628 + "duration": 0 ~/~/ Продолжительность события, секунд 2629 + } 2630 + ], 2631 + "stops": [ ~/~/ События стоянок 2632 + { 2633 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2634 + "eventId": 0, ~/~/ Идентификатор события 2635 + "eventName": "string", ~/~/ Название события 2636 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2637 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2638 + "duration": 0 ~/~/ Продолжительность события, секунд 2639 + } 2640 + ] 2641 + } 2642 +] 2643 + 2644 + 2645 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2646 + 2647 +(% class="box infomessage" %) 2648 +((( 2649 +**POST /api/v3/vehicles/getlastdata** 2650 +))) 2651 + 2652 +Метод запроса: **POST** 2653 + 2654 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2655 + 2656 +В заголовках запроса: X-Auth: Токен авторизации 2657 + 2658 + 2659 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2660 + 2661 +Ответ: 2662 + { 2663 + "vehicleId": 0, ~/~/Идентификатор объекта. 2664 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2665 + "vehicleNumber": "string",~/~/Номер объекта. 2666 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2667 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2668 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2669 + "speed": 0,~/~/Скорость объекта. 2670 + "course": 0,~/~/Курс движения [0;360] 2671 + "latitude": 0,~/~/Широта [-90°;90°]. 2672 + "longitude": 0,~/~/Долгота [-180°;180°]. 2673 + "address": "string",~/~/Адрес. 2674 + "geozones": [ ~/~/Сведения по геозонам. 2675 + { 2676 + "id": 0, 2677 + "name": "string" 2678 + } 2679 + 2680 + 2681 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 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/find** 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/find 2695 + 2696 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2697 + 2698 +(% style="text-align:left" %) 2699 +Тело запроса: 2700 + 2701 +(% style="text-align:left" %) 2702 +{ 2703 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2704 +} 2705 + 2706 +(% style="text-align:left" %) 2707 +Ответ: 2708 + 2709 +[ 2710 + { 2711 + "id": 0, ~/~/ Идентификатор объекта геозоны 2712 + "name": "string", ~/~/ Название объекта геозоны 2713 + "type": 0, ~/~/ Тип объекта геозоны 2714 + "fname": "string", ~/~/ Имя файла 2715 + "parentId": "string", ~/~/ Идентификатор клиента 2716 + "radius": 0, ~/~/ Радиус геообъекта 2717 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2718 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2719 + "description": "string", ~/~/ Описание 2720 + "area": 0, ~/~/ Площадь, м^^2^^ 2721 + "perimetr": 0, ~/~/ Периметр, м 2722 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2723 + } 2724 +] 2725 + 2726 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2727 + 2728 +(% class="box infomessage" %) 2729 +((( 2730 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2731 +))) 2732 + 2733 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2734 + 2735 +(% style="color:#000000" %)Метод запроса: **POST** 2736 + 2737 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2738 + 2739 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2740 + 2741 +(% style="text-align:left" %) 2742 +Тело запроса: 2743 + 2744 +{ 2745 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2746 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2747 + "ids": [ ], ~/~/ Массив id объектов 2748 + "byTime": 0, ~/~/ Объединение событий по времени 2749 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2750 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2751 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2752 +} 2753 + 2754 +Ответ: 2755 +[ 2756 + { 2757 + "geozoneId": 0, ~/~/ ID геообъекта 2758 + "geozoneName": "string", ~/~/ Название геообъекта 2759 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2760 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2761 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2762 + "vehicleId": 0, ~/~/ ID объекта 2763 + "vehicleName": "string" ~/~/ Имя объекта 2764 + } 2765 +] 2766 + 2767 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2768 + 2769 +(% class="box infomessage" %) 2770 +((( 2771 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2772 +))) 2773 + 2774 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2775 + 2776 +(% style="color:#000000" %)Метод запроса: **POST** 2777 + 2778 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2779 + 2780 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2781 + 2782 +(% style="text-align:left" %) 2783 +Тело запроса: 2784 + 2785 +{ 2786 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2787 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2788 + "ids": [ ], ~/~/ Массив id геообъектов 2789 + "byTime": 0, ~/~/ Объединение событий по времени 2790 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2791 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2792 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2793 +} 2794 + 2795 +Ответ: 2796 + 2797 +[ 2798 + { 2799 + "geozoneId": 0, ~/~/ ID геообъекта 2800 + "geozoneName": "string", ~/~/ Название геообъекта 2801 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2802 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2803 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2804 + "vehicleId": 0, ~/~/ ID объекта 2805 + "vehicleName": "string" ~/~/ Имя объекта 2806 + } 2807 +] 2808 + 1301 1301 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1302 1302 1303 1303 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 1304 1304 1305 -POST /api/v3/notifications/find 2813 +(% class="box infomessage" %) 2814 +((( 2815 +**POST /api/v3/notifications/find** 2816 +))) 1306 1306 1307 1307 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 1308 1308 ... ... @@ -1323,19 +1323,22 @@ 1323 1323 1324 1324 [ 1325 1325 { 1326 - "id": 0, 1327 - "name": "string", 1328 - "active": true, 1329 - "type": 0, 1330 - "userId": "", 1331 - "parentId": "", 1332 - "parentName": "string" 2837 + "id": 0, ~/~/ ID уведомления 2838 + "name": "string", ~/~/ Название уведомления 2839 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2840 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2841 + "userId": "", ~/~/ Пользователь, создавший уведомление 2842 + "parentId": "", ~/~/ Идентификатор клиента 2843 + "parentName": "string" ~/~/ Имя клиента 1333 1333 } 1334 1334 ] 1335 1335 1336 1336 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1337 1337 1338 -GET /api/v3/notifications/{id} 2849 +(% class="box infomessage" %) 2850 +((( 2851 +**GET /api/v3/notifications/{id}** 2852 +))) 1339 1339 1340 1340 Метод возвращает данные правил формирования выбранного уведомления. 1341 1341 ... ... @@ -1343,7 +1343,7 @@ 1343 1343 Метод запроса **GET** 1344 1344 1345 1345 (% style="text-align: left;" %) 1346 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]2860 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1347 1347 1348 1348 (% style="text-align: left;" %) 1349 1349 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления ... ... @@ -1356,54 +1356,3290 @@ 1356 1356 1357 1357 (% style="text-align: left;" %) 1358 1358 (% style="color:#000000" %){ 1359 - "id": 0, 1360 - "type": 0, 1361 - "userId": "", 1362 - "parentId": "", 1363 - "parentName": "string", 1364 - "name": "string", 1365 - "active": true, 1366 - "vehicleIds": [ 2873 + "id": 0, ~/~/ (%%)id уведомления 2874 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2875 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2876 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2877 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2878 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2879 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2880 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2881 +(% style="color:#000000" %) 0 2882 + ], 2883 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2884 +(% style="color:#000000" %) 0 2885 + ], 2886 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 2887 +(% style="color:#000000" %) 0 2888 + ], 2889 + "settings": { ~/~/ Список параметров уведомления 2890 + "additionalProp1": "string", 2891 + "additionalProp2": "string", 2892 + "additionalProp3": "string" 2893 + }, 2894 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2895 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2896 +(% style="color:#000000" %) "" 2897 + ], 2898 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2899 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2900 +(% style="color:#000000" %) "string" 2901 + ], 2902 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2903 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2904 +(% style="color:#000000" %) { 2905 + "id": 0, ~/~/ (%%)Идентификатор участника чата 2906 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2907 +(% style="color:#000000" %) } 2908 + ], 2909 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2910 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2911 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2912 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2913 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2914 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2915 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2916 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2917 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2918 +(% style="color:#000000" %)} 2919 + 2920 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2921 + 2922 +(% class="box warningmessage" %) 2923 +((( 2924 +**PUT /api/v3/notifications/** 2925 +))) 2926 + 2927 +Метод позволяет отредактировать уведомление. 2928 + 2929 +Метод запроса **PUT** 2930 + 2931 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2932 + 2933 +В заголовках запроса: X-Auth: Токен авторизации 2934 + 2935 +Тело запроса: 2936 +{ 2937 + "id": 0, ~/~/ id уведомления 2938 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2939 + "userId": "", ~/~/ Пользователь, создавший уведомление 2940 + "parentId": "", ~/~/ Идентификатор клиента 2941 + "parentName": "string", ~/~/ Имя клиента 2942 + "name": "string", ~/~/ Название уведомления 2943 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2944 + "vehicleIds": [ ~/~/ Список id объектов для анализа 1367 1367 0 1368 1368 ], 1369 - "geoids": [ 2947 + "geoids": [ ~/~/ Список id геообъектов для анализа 1370 1370 0 1371 1371 ], 1372 - "fieldids": [ 2950 + "fieldids": [ ~/~/ Список id полей для анализа 1373 1373 0 1374 1374 ], 1375 - "settings": { 2953 + "settings": { ~/~/ Список параметров уведомления 1376 1376 "additionalProp1": "string", 1377 1377 "additionalProp2": "string", 1378 1378 "additionalProp3": "string" 1379 1379 }, 1380 - "toEmail": true, 1381 - "recipientIds": [ 2958 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2959 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1382 1382 "" 1383 1383 ], 1384 - "enableSideEmails": true, 1385 - "sideEmails": [ 2962 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2963 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 1386 1386 "string" 1387 1387 ], 1388 - "toTelegram": true, 1389 - "telegrams": [ 2966 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2967 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 1390 1390 { 1391 - "id": 0, 1392 - "info": "string" 2969 + "id": 0, ~/~/ Идентификатор участника чата 2970 + "info": "string" ~/~/ Дополнительные сведения 1393 1393 } 1394 1394 ], 1395 - "toMobile": true, 1396 - "toClient": true, 1397 - "stored": true, 1398 - "kind": 0, 1399 - "activationMode": 0, 1400 - "activationTime": "2023-03-29T09:57:48.932Z", 1401 - "timezone": 0, 1402 - "validity": 0, 1403 - "autoProlongation": true 2973 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2974 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2975 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2976 + "kind": 0, ~/~/ Определяет вид уведомления 2977 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2978 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2979 + "timezone": 0, ~/~/ Сдвиг часового пояса 2980 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2981 + "autoProlongation": true ~/~/ Автопродление срока действия 1404 1404 } 1405 1405 2984 +Ответ: 1406 1406 2986 +Success 2987 + 2988 + 2989 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2990 + 2991 +(% class="box warningmessage" %) 2992 +((( 2993 +**PUT** /api/v3/notifications/prolongation 2994 +))) 2995 + 2996 +Метод позволяет продлить уведомления. 2997 + 2998 +Метод запроса **PUT** 2999 + 3000 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 3001 + 3002 +В заголовках запроса: X-Auth: Токен авторизации. 3003 + 3004 +Тело запроса: 3005 + 3006 +[ 3007 + 3008 +0 3009 + 3010 +] 3011 + 3012 +где 0 идентификатор ids. 3013 + 3014 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 3015 + 3016 +(% class="box errormessage" %) 3017 +((( 3018 +**DELETE /api/v3/notifications/{id}** 3019 +))) 3020 + 3021 +Метод позволяет удалить выбранное уведомление. 3022 + 3023 +Метод запроса **DELETE** 3024 + 3025 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 3026 + 3027 +Передаваемый параметр: {id} - id уведомления 3028 + 3029 +В заголовках запроса: X-Auth: Токен авторизации 3030 + 3031 +Ответ: 3032 + 3033 +Success 3034 + 3035 + 3036 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 3037 + 3038 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 3039 + 3040 +(% class="box infomessage" %) 3041 +((( 3042 +**POST /api/v3/Drivers/find** 3043 +))) 3044 + 3045 +Передается параметр: parentId - ID клиента-родителя 3046 + 3047 +Ответ: 3048 + 3049 +[ 3050 + { 3051 + "name": "string", ~/~/ Определяет наименование 3052 + "description": "string", ~/~/ Определяет описание 3053 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 3054 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 3055 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3056 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3057 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3058 + "deleted": true ~/~/ Признак удаления 3059 + } 3060 +] 3061 + 3062 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 3063 + 3064 +(% class="box infomessage" %) 3065 +((( 3066 +**GET /api/v3/Drivers/{driverGuid}** 3067 +))) 3068 + 3069 +Передается параметр: ID водителя 3070 + 3071 +Ответ: 3072 + 3073 +{ 3074 + "name": "string", ~/~/ Определяет наименование 3075 + "description": "string", ~/~/ Определяет описание 3076 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 3077 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 3078 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3079 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3080 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3081 + "deleted": true ~/~/ Признак удаления 3082 +} 3083 + 3084 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 3085 + 3086 +(% class="box successmessage" %) 3087 +((( 3088 +**POST /api/v3/Drivers** 3089 +))) 3090 + 3091 +Запрос: 3092 + 3093 +{ 3094 + "name": "string", 3095 + "description": "string", 3096 + "hiredate": "2023-06-30T12:50:54.020Z", 3097 + "chopdate": "2023-06-30T12:50:54.020Z", 3098 + "exclusive": true, 3099 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3100 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3101 + "deleted": true 3102 +} 3103 + 3104 +Ответ: 3105 + 3106 +{ 3107 + "name": "string", 3108 + "description": "string", 3109 + "hiredate": "2023-06-30T12:50:54.051Z", 3110 + "chopdate": "2023-06-30T12:50:54.051Z", 3111 + "exclusive": true, 3112 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3113 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3114 + "deleted": true 3115 +} 3116 + 3117 + 3118 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 3119 + 3120 +(% class="box warningmessage" %) 3121 +((( 3122 +**PUT /api/v3/Drivers** 3123 +))) 3124 + 3125 +Запрос: 3126 + 3127 +{ 3128 + "name": "string", 3129 + "description": "string", 3130 + "hiredate": "2023-06-30T12:50:27.910Z", 3131 + "chopdate": "2023-06-30T12:50:27.910Z", 3132 + "exclusive": true, 3133 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3134 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3135 + "deleted": true 3136 +} 3137 + 3138 +Ответ: 3139 + 3140 +{ 3141 + "name": "string", 3142 + "description": "string", 3143 + "hiredate": "2023-06-30T12:50:27.929Z", 3144 + "chopdate": "2023-06-30T12:50:27.929Z", 3145 + "exclusive": true, 3146 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3147 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3148 + "deleted": true 3149 +} 3150 + 3151 + 3152 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 3153 + 3154 +(% class="box errormessage" %) 3155 +((( 3156 +**DELETE /api/v3/Drivers/{driverGuid}** 3157 +))) 3158 + 3159 +Передается параметр: ID водителя 3160 + 3161 +Ответ: 3162 + 3163 +Success 3164 + 3165 + 3166 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 3167 + 3168 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 3169 + 3170 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 3171 + 3172 +(% class="box infomessage" %) 3173 +((( 3174 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3175 +))) 3176 + 3177 +Запрос: 3178 + 3179 +{ 3180 + "Ids": [ 3181 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3182 + ], 3183 + "BeginTime": "2023-06-30T12:49:04.365Z", 3184 + "EndTime": "2023-06-30T12:49:04.365Z" 3185 +} 3186 + 3187 +Ответ: 3188 + 3189 +[ 3190 + { 3191 + "VehicleId": 0, 3192 + "CreateTime": "2023-06-30T09:52:31.240Z", 3193 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3194 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3195 + "BeginTime": "2023-06-30T09:52:31.240Z", 3196 + "EndTime": "2023-06-30T09:52:31.240Z" 3197 + } 3198 +] 3199 + 3200 + 3201 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 3202 + 3203 +(% class="box infomessage" %) 3204 +((( 3205 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3206 +))) 3207 + 3208 +Запрос: 3209 + 3210 +{ 3211 + "Ids": [ 3212 + 0 3213 + ], 3214 + "BeginTime": "2023-06-30T12:48:39.419Z", 3215 + "EndTime": "2023-06-30T12:48:39.419Z" 3216 +} 3217 + 3218 +Ответ: 3219 + 3220 +[ 3221 + { 3222 + "VehicleId": 0, 3223 + "CreateTime": "2023-06-30T09:54:01.631Z", 3224 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3225 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3226 + "BeginTime": "2023-06-30T09:54:01.631Z", 3227 + "EndTime": "2023-06-30T09:54:01.631Z" 3228 + } 3229 +] 3230 + 3231 + 3232 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 3233 + 3234 +(% class="box successmessage" %) 3235 +((( 3236 +**POST /api/v3/DriversVehiclesAssignments** 3237 +))) 3238 + 3239 +Передается массив назначений 3240 + 3241 +Запрос: 3242 + 3243 +[ 3244 + { 3245 + "VehicleId": 0, ~/~/ Идентификатор объекта 3246 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3247 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3248 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3249 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 3250 + } 3251 +] 3252 + 3253 +Ответ: 3254 + 3255 +[ 3256 + { 3257 + "VehicleId": 0, 3258 + "CreateTime": "2023-06-30T11:04:46.903Z", 3259 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3260 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3261 + "BeginTime": "2023-06-30T11:04:46.903Z", 3262 + "EndTime": "2023-06-30T11:04:46.903Z" 3263 + } 3264 +] 3265 + 3266 + 3267 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 3268 + 3269 +(% class="box warningmessage" %) 3270 +((( 3271 +**PUT /api/v3/DriversVehiclesAssignments** 3272 +))) 3273 + 3274 +Запрос: 3275 + 3276 +[ 3277 + { 3278 + "VehicleId": 0, 3279 + "CreateTime": "2023-06-30T11:14:08.117Z", 3280 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3281 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3282 + "BeginTime": "2023-06-30T11:14:08.117Z", 3283 + "EndTime": "2023-06-30T11:14:08.117Z" 3284 + } 3285 +] 3286 + 3287 +Ответ: 3288 + 3289 +[ 3290 + { 3291 + "VehicleId": 0, 3292 + "CreateTime": "2023-06-30T11:14:53.349Z", 3293 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3294 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3295 + "BeginTime": "2023-06-30T11:14:53.349Z", 3296 + "EndTime": "2023-06-30T11:14:53.349Z" 3297 + } 3298 +] 3299 + 3300 + 3301 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 3302 + 3303 +(% class="box errormessage" %) 3304 +((( 3305 +**DELETE /api/v3/DriversVehiclesAssignments** 3306 +))) 3307 + 3308 +Запрос: 3309 + 3310 +[ 3311 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3312 +] 3313 + 3314 +Ответ: 3315 + 3316 +Success 3317 + 3318 + 3319 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 3320 + 3321 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 3322 + 3323 +(% class="box infomessage" %) 3324 +((( 3325 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3326 +))) 3327 + 3328 +Запрос: 3329 + 3330 +{ 3331 + "Ids": [ 3332 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3333 + ], 3334 + "BeginTime": "2023-06-30T12:47:12.162Z", 3335 + "EndTime": "2023-06-30T12:47:12.162Z" 3336 +} 3337 + 3338 +Ответ: 3339 + 3340 +[ 3341 + { 3342 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3343 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3344 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3345 + "BeginTime": "2023-06-30T11:19:40.703Z", 3346 + "EndTime": "2023-06-30T11:19:40.703Z" 3347 + } 3348 +] 3349 + 3350 + 3351 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 3352 + 3353 +(% class="box infomessage" %) 3354 +((( 3355 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3356 +))) 3357 + 3358 +Запрос: 3359 + 3360 +{ 3361 + "Ids": [ 3362 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3363 + ], 3364 + "BeginTime": "2023-06-30T12:47:12.162Z", 3365 + "EndTime": "2023-06-30T12:47:12.162Z" 3366 +} 3367 + 3368 +Ответ: 3369 + 3370 +[ 3371 + { 3372 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3373 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3374 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3375 + "BeginTime": "2023-06-30T11:19:40.703Z", 3376 + "EndTime": "2023-06-30T11:19:40.703Z" 3377 + } 3378 +] 3379 + 3380 + 3381 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 3382 + 3383 +(% class="box successmessage" %) 3384 +((( 3385 +**POST /api/v3/DriversRfidsAssignments** 3386 +))) 3387 + 3388 +Запрос: 3389 + 3390 +[ 3391 + { 3392 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3393 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3394 + "BeginTime": "2023-06-30T11:27:08.635Z", 3395 + "EndTime": "2023-06-30T11:27:08.635Z" 3396 + } 3397 +] 3398 + 3399 +Ответ: 3400 + 3401 +[ 3402 + { 3403 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3404 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3405 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3406 + "BeginTime": "2023-06-30T11:27:08.677Z", 3407 + "EndTime": "2023-06-30T11:27:08.677Z" 3408 + } 3409 +] 3410 + 3411 + 3412 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 3413 + 3414 +(% class="box warningmessage" %) 3415 +((( 3416 +**PUT /api/v3/DriversRfidsAssignments** 3417 +))) 3418 + 3419 +Запрос: 3420 + 3421 +[ 3422 + { 3423 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3424 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3425 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3426 + "BeginTime": "2023-06-30T11:28:43.330Z", 3427 + "EndTime": "2023-06-30T11:28:43.330Z" 3428 + } 3429 +] 3430 + 3431 +Ответ: 3432 + 3433 +[ 3434 + { 3435 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3436 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3437 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3438 + "BeginTime": "2023-06-30T11:28:43.331Z", 3439 + "EndTime": "2023-06-30T11:28:43.331Z" 3440 + } 3441 +] 3442 + 3443 + 3444 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3445 + 3446 +(% class="box errormessage" %) 3447 +((( 3448 +**DELETE /api/v3/DriversRfidsAssignments** 3449 +))) 3450 + 3451 +Запрос: 3452 + 3453 +[ 3454 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3455 +] 3456 + 3457 +Ответ: 3458 + 3459 +Success 3460 + 3461 + 3462 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3463 + 3464 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3465 + 3466 +(% class="box infomessage" %) 3467 +((( 3468 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3469 +))) 3470 + 3471 +Запрос: 3472 + 3473 +{ 3474 + "Ids": [ 3475 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3476 + ], 3477 + "BeginTime": "2023-06-30T12:45:10.852Z", 3478 + "EndTime": "2023-06-30T12:45:10.852Z" 3479 +} 3480 + 3481 +Ответ: 3482 + 3483 +[ 3484 + { 3485 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3486 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3487 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3488 + "BeginTime": "2023-06-30T11:58:04.695Z", 3489 + "EndTime": "2023-06-30T11:58:04.695Z" 3490 + } 3491 +] 3492 + 3493 + 3494 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3495 + 3496 +(% class="box infomessage" %) 3497 +((( 3498 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3499 +))) 3500 + 3501 +Запрос: 3502 + 3503 +{ 3504 + "Ids": [ 3505 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3506 + ], 3507 + "BeginTime": "2023-06-30T12:45:10.852Z", 3508 + "EndTime": "2023-06-30T12:45:10.852Z" 3509 +} 3510 + 3511 +Ответ: 3512 + 3513 +[ 3514 + { 3515 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3516 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3517 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3518 + "BeginTime": "2023-06-30T11:58:04.695Z", 3519 + "EndTime": "2023-06-30T11:58:04.695Z" 3520 + } 3521 +] 3522 + 3523 + 3524 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3525 + 3526 +(% class="box successmessage" %) 3527 +((( 3528 +**POST /api/v3/DriversFuelCardsAssignments** 3529 +))) 3530 + 3531 +Запрос: 3532 + 3533 +[ 3534 + { 3535 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3536 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3537 + "BeginTime": "2023-06-30T12:09:53.175Z", 3538 + "EndTime": "2023-06-30T12:09:53.175Z" 3539 + } 3540 +] 3541 + 3542 +Ответ: 3543 + 3544 +[ 3545 + { 3546 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3547 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3548 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3549 + "BeginTime": "2023-06-30T12:09:53.201Z", 3550 + "EndTime": "2023-06-30T12:09:53.201Z" 3551 + } 3552 +] 3553 + 3554 + 3555 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3556 + 3557 +(% class="box warningmessage" %) 3558 +((( 3559 +**PUT /api/v3/DriversFuelCardsAssignments** 3560 +))) 3561 + 3562 +Запрос: 3563 + 3564 +[ 3565 + { 3566 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3567 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3568 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3569 + "BeginTime": "2023-06-30T12:09:53.201Z", 3570 + "EndTime": "2023-06-30T12:09:53.201Z" 3571 + } 3572 +] 3573 + 3574 +Ответ: 3575 + 3576 +[ 3577 + { 3578 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3579 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3580 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3581 + "BeginTime": "2023-06-30T12:09:53.201Z", 3582 + "EndTime": "2023-06-30T12:09:53.201Z" 3583 + } 3584 +] 3585 + 3586 + 3587 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3588 + 3589 +(% class="box errormessage" %) 3590 +((( 3591 +**DELETE /api/v3/DriversFuelCardsAssignments** 3592 +))) 3593 + 3594 +Запрос: 3595 + 3596 +[ 3597 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3598 +] 3599 + 3600 +Ответ: 3601 + 3602 +Success 3603 + 3604 + 3605 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3606 + 3607 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3608 + 3609 +(% class="box infomessage" %) 3610 +((( 3611 +**POST /api/v3/Trailers** 3612 +))) 3613 + 3614 +Пример запроса: 3615 + 3616 +{ 3617 + "startDate": "2023-11-14T10:48:03.671Z", 3618 + "endDate": "2023-11-14T10:48:03.671Z", 3619 + "ids": [ 0 ], 3620 + "timezone": 0 3621 +} 3622 + 3623 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3624 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3625 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3626 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3627 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3628 + 3629 +Пример ответа: 3630 + 3631 +[ 3632 + { 3633 + "SD": "2023-11-14T10:48:03.717Z", 3634 + "ED": "2023-11-14T10:48:03.717Z", 3635 + "id": 0, 3636 + "SLat": 0, 3637 + "SLon": 0, 3638 + "ELat": 0, 3639 + "ELon": 0, 3640 + "mileage": 0 3641 + "Duration": 0 3642 + "Address": "string", 3643 + "Address2": "string", 3644 + "name": "string", 3645 + "rid": "string", 3646 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3647 + "trailer": { 3648 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3649 + "Number": "string", 3650 + "Description": "string", 3651 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3652 + "ExternalID": "string", 3653 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3654 + "CreateTime": "2023-11-14T10:48:03.717Z", 3655 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3656 + "IsDeleted": true 3657 + }, 3658 + "filesCount": 0, 3659 + } 3660 +] 3661 + 3662 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3663 +|SD|Дата и время начала события 3664 +|ED|Дата и время окончания события 3665 +|id|ID объекта 3666 +|SLat|Широта начальной координаты 3667 +|SLon|Долгота начальной координаты 3668 +|ELat|Широта конечной координаты 3669 +|ELon|Долгота конечной координаты 3670 +|mileage|Пробег 3671 +|Duration|Продолжительность 3672 +|Address|Адрес начального местоположения 3673 +|Address2|Адрес конечного местоположения 3674 +|name|Имя радиометки 3675 +|rid|Номер радиометки 3676 +|rguid|ID радиометки 3677 +|trailer|Информация об агрегате 3678 +|ModelGuid|ID агрегата 3679 +|Number|Название/номер агрегата 3680 +|Description|Текст примечания агрегата 3681 + 3682 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3683 + 3684 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3685 + 3686 +(% class="box infomessage" %) 3687 +((( 3688 +**POST /api/v3/Rfids/find** 3689 +))) 3690 + 3691 +Запрос: 3692 + 3693 +{ 3694 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3695 +} 3696 + 3697 +Ответ: 3698 + 3699 +[ 3700 + { 3701 + "name": "string", 3702 + "number": 0, 3703 + "period": 0, 3704 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3705 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3706 + } 3707 +] 3708 + 3709 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3710 +|parentId|ID клиента 3711 +|name|Название карты-метки 3712 +|number|Номер 3713 +|period|Период запросов в секундах (работает только для агрегатов) 3714 +|id|ID карты-метки 3715 + 3716 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3717 + 3718 +(% class="box infomessage" %) 3719 +((( 3720 +**GET /api/v3/Rfids/{rfidGuid}** 3721 +))) 3722 + 3723 +Передаем параметр rfidGuid - идентификатор карты-метки 3724 + 3725 +Ответ: 3726 + 3727 +[ 3728 + { 3729 + "name": "string", 3730 + "number": 0, 3731 + "period": 0, 3732 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3733 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3734 + } 3735 +] 3736 + 3737 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3738 +|name|Название карты-метки 3739 +|number|Номер 3740 +|period|Период запросов в секундах (работает только для агрегатов) 3741 +|id|ID карты-метки 3742 +|parentId|ID клиента 3743 + 3744 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3745 + 3746 +(% class="box successmessage" %) 3747 +((( 3748 +**POST /api/v3/Rfids** 3749 +))) 3750 + 3751 +Запрос: 3752 + 3753 +{ 3754 + "name": "string", 3755 + "number": 0, 3756 + "period": 0, 3757 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3758 +} 3759 + 3760 +Ответ: 3761 + 3762 +{ 3763 + "name": "string", 3764 + "number": 0, 3765 + "period": 0, 3766 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3767 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3768 +} 3769 + 3770 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3771 +|name|Название карты-метки 3772 +|number|Номер 3773 +|period|Период запросов в секундах (работает только для агрегатов) 3774 +|id|ID карты-метки 3775 +|parentId|ID клиента 3776 + 3777 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3778 + 3779 +(% class="box warningmessage" %) 3780 +((( 3781 +**PUT /api/v3/Rfids** 3782 +))) 3783 + 3784 +Запрос: 3785 + 3786 +{ 3787 + "name": "string", 3788 + "number": 0, 3789 + "period": 0, 3790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3791 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3792 +} 3793 + 3794 +Ответ: 3795 + 3796 +{ 3797 + "name": "string", 3798 + "number": 0, 3799 + "period": 0, 3800 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3801 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3802 +} 3803 + 3804 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3805 +|name|Название карты-метки 3806 +|number|Номер 3807 +|period|Период запросов в секундах (работает только для агрегатов) 3808 +|id|ID карты-метки 3809 +|parentId|ID клиента 3810 + 3811 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3812 + 3813 +(% class="box errormessage" %) 3814 +((( 3815 +**DELETE /api/v3/Rfids/{rfidGuid}** 3816 +))) 3817 + 3818 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3819 + 3820 +Ответ: 3821 + 3822 +Success 3823 + 3824 + 3825 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3826 + 3827 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3828 + 3829 +(% class="box infomessage" %) 3830 +((( 3831 +**GET /api/v3/Billing/client/balance/{clientId}** 3832 +))) 3833 + 3834 +Параметр запроса: **clientId **- идентификатор клиента. 3835 + 3836 +Ответ: 3837 + 3838 +{ 3839 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3840 + "Balance": 0 3841 +} 3842 + 3843 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3844 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3845 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3846 + 3847 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3848 + 3849 +(% class="box infomessage" %) 3850 +((( 3851 +**GET /api/v3/Billing/client/constraint/{clientId}** 3852 +))) 3853 + 3854 +Параметр запроса: **clientId **- идентификатор клиента. 3855 + 3856 +Ответ: 3857 + 3858 +{ 3859 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3860 + "CalculationType": 0, 3861 + "PermissibleBalance": 0, 3862 + "DefermentDays": 0, 3863 + "SendUiNotifications": true, 3864 + "SendEmailNotifications": true, 3865 + "IsPrivate": true, 3866 +} 3867 + 3868 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3869 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3870 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3871 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3872 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3873 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3874 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3875 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3876 + 3877 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3878 + 3879 +(% class="box infomessage" %) 3880 +((( 3881 +**GET /api/v3/Billing/client/plan/{clientId}** 3882 +))) 3883 + 3884 +Параметры запроса: 3885 + 3886 +**clientId **- идентификатор клиента. 3887 + 3888 +**planId **- идентификатор тарифного плана. 3889 + 3890 +Ответ: 3891 + 3892 +{ 3893 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3894 + "Plan": { **~/~/ Описание тарифного плана** 3895 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3896 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3897 + "Name": "string", 3898 + "IsArchived": true, 3899 + "Constraint": { 3900 + "CalculationType": 0, 3901 + "PermissibleBalance": 0, 3902 + "DefermentDays": 0 3903 + }, 3904 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3905 + { 3906 + "Feature": "string", 3907 + "IsFactual": true, 3908 + "Limit": 0, 3909 + "Price": 0, 3910 + "PeriodValue": 0, 3911 + "PeriodType": 0 3912 + } 3913 + ] 3914 + }, 3915 + "DebitDate": "2023-10-18T12:46:24.213Z", 3916 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3917 + { 3918 + "Feature": "string", 3919 + "IsEnabled": true, 3920 + "IsPrivate": true, 3921 + "IsFactual": true, 3922 + "Limit": 0, 3923 + "Price": 0, 3924 + "DebitDate": "2023-10-18T12:46:24.213Z", 3925 + "PeriodValue": 0, 3926 + "PeriodType": 0 3927 + } 3928 + ] 3929 +} 3930 + 3931 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3932 +|ClientId|Идентификатор клиента 3933 +|Id|Идентификатор тарифного плана 3934 +|OwnerId|Идентификатор клиента-владельца 3935 +|Name|Наименование тарифного плана 3936 +|IsArchived|Признак, определяющий архивный тарифный план 3937 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3938 +|PermissibleBalance|Допустимый баланс 3939 +|DefermentDays|Отсрочка, количество дней 3940 +|Feature|Код услуги 3941 +|IsEnabled|Признак, определяющий активирована ли услуга 3942 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3943 +|IsFactual|Признак, определяющий расчёт по факту 3944 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3945 +|Price|Цена за единицу. 3946 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3947 +|PeriodValue|Значение периода. 3948 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3949 + 3950 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3951 + 3952 +(% class="box infomessage" %) 3953 +((( 3954 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3955 +))) 3956 + 3957 +Параметр запроса: **clientId **- идентификатор клиента. 3958 + 3959 +Ответ: 3960 + 3961 +[ 3962 + { 3963 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3964 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3965 + "Name": "string", 3966 + "IsArchived": true, 3967 + "Constraint": { 3968 + "CalculationType": 0, 3969 + "PermissibleBalance": 0, 3970 + "DefermentDays": 0 3971 + }, 3972 + "Features": [ 3973 + { 3974 + "Feature": "string", 3975 + "IsFactual": true, 3976 + "Limit": 0, 3977 + "Price": 0, 3978 + "PeriodValue": 0, 3979 + "PeriodType": 0 3980 + } 3981 + ] 3982 + } 3983 +] 3984 + 3985 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3986 +|ClientId|Идентификатор клиента 3987 +|Id|Идентификатор тарифного плана 3988 +|OwnerId|Идентификатор клиента-владельца 3989 +|Name|Наименование тарифного плана 3990 +|IsArchived|Признак, определяющий архивный тарифный план 3991 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3992 +|PermissibleBalance|Допустимый баланс 3993 +|DefermentDays|Отсрочка, количество дней 3994 +|Feature|Код услуги 3995 +|IsFactual|Признак, определяющий расчёт по факту 3996 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3997 +|Price|Цена за единицу. 3998 +|PeriodValue|Значение периода. 3999 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4000 + 4001 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 4002 + 4003 +(% class="box infomessage" %) 4004 +((( 4005 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 4006 +))) 4007 + 4008 +Параметр запроса: **clientId **- идентификатор клиента. 4009 + 4010 +Ответ: 4011 + 4012 +[ 4013 + { 4014 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4015 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4016 + "Name": "string", 4017 + "IsArchived": true, 4018 + "Constraint": { 4019 + "CalculationType": 0, 4020 + "PermissibleBalance": 0, 4021 + "DefermentDays": 0 4022 + }, 4023 + "Features": [ 4024 + { 4025 + "Feature": "string", 4026 + "IsFactual": true, 4027 + "Limit": 0, 4028 + "Price": 0, 4029 + "PeriodValue": 0, 4030 + "PeriodType": 0 4031 + } 4032 + ] 4033 + } 4034 +] 4035 + 4036 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4037 +|ClientId|Идентификатор клиента 4038 +|Id|Идентификатор тарифного плана 4039 +|OwnerId|Идентификатор клиента-владельца 4040 +|Name|Наименование тарифного плана 4041 +|IsArchived|Признак, определяющий архивный тарифный план 4042 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4043 +|PermissibleBalance|Допустимый баланс 4044 +|DefermentDays|Отсрочка, количество дней 4045 +|Feature|Код услуги 4046 +|IsFactual|Признак, определяющий расчёт по факту 4047 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4048 +|Price|Цена за единицу. 4049 +|PeriodValue|Значение периода. 4050 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4051 + 4052 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4053 + 4054 +(% class="box warningmessage" %) 4055 +((( 4056 +**PUT /api/v3/Billing/client/balance** 4057 +))) 4058 + 4059 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4060 + 4061 +Тело запроса: 4062 + 4063 +{ 4064 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4065 + "Balance": 0 4066 +} 4067 + 4068 +Ответ: Success 4069 + 4070 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4071 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4072 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4073 + 4074 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4075 + 4076 +(% class="box warningmessage" %) 4077 +((( 4078 +**PUT /api/v3/billing/client/balance/deposit** 4079 +))) 4080 + 4081 +Создает операцию **Пополнение **с указанной суммой 4082 + 4083 +Тело запроса: 4084 + 4085 +{ 4086 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4087 + "Balance": 0 4088 +} 4089 + 4090 +Ответ: Success 4091 + 4092 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4093 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4094 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4095 + 4096 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4097 + 4098 +Создает операцию **Списание **с указанной суммой 4099 + 4100 +(% class="box warningmessage" %) 4101 +((( 4102 +**PUT /api/v3/billing/client/balance/withdraw** 4103 +))) 4104 + 4105 +Тело запроса: 4106 + 4107 +{ 4108 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4109 + "Balance": 0 4110 +} 4111 + 4112 +Ответ: Success 4113 + 4114 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4115 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4116 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4117 + 4118 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4119 + 4120 +(% class="box warningmessage" %) 4121 +((( 4122 +**PUT /api/v3/Billing/client/constraint** 4123 +))) 4124 + 4125 +Тело запроса: 4126 + 4127 +{ 4128 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4129 + "CalculationType": 0, 4130 + "PermissibleBalance": 0, 4131 + "DefermentDays": 0, 4132 + "SendUiNotifications": true, 4133 + "SendEmailNotifications": true, 4134 + "IsPrivate": true, 4135 +} 4136 + 4137 +Ответ: Success 4138 + 4139 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4140 +|ClientId|Идентификатор клиента 4141 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4142 +|PermissibleBalance|Допустимый баланс 4143 +|DefermentDays|((( 4144 +Отсрочка, количество дней 4145 +))) 4146 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4147 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4148 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4149 + 4150 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4151 + 4152 +(% class="box warningmessage" %) 4153 +((( 4154 +**PUT /api/v3/Billing/client/plan** 4155 +))) 4156 + 4157 +Тело запроса: 4158 + 4159 +{ 4160 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4161 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4162 + "Features": [ 4163 + { 4164 + "Feature": "string", 4165 + "IsEnabled": true, 4166 + "IsFactual": true, 4167 + "Limit": 0, 4168 + "Price": 0, 4169 + "DebitDate": "2023-10-18T13:26:58.987Z", 4170 + "PeriodValue": 0, 4171 + "PeriodType": 0 4172 + } 4173 + ] 4174 +} 4175 + 4176 +Ответ: Success 4177 + 4178 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4179 +|ClientId|Идентификатор клиента 4180 +|PlanId|Идентификатор тарифного плана 4181 +|Feature|Код услуги 4182 +|IsEnabled|Признак, определяющий активирована ли услуга 4183 +|IsFactual|Признак, определяющий расчёт по факту 4184 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4185 +|Price|Цена за единицу. 4186 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4187 +|PeriodValue|Значение периода. 4188 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4189 + 4190 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4191 + 4192 +(% class="box warningmessage" %) 4193 +((( 4194 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4195 +))) 4196 + 4197 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4198 + 4199 +(% class="box infomessage" %) 4200 +((( 4201 +**POST /api/v3/vehicles/import/{agentId}** 4202 +))) 4203 + 4204 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4205 + 4206 +В пути указывается **agentId** - id клиента. 4207 + 4208 +**Заголовок** 4209 + 4210 +**X-Auth: [токен авторизации]** 4211 + 4212 +**Параметры** 4213 + 4214 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4215 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4216 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4217 + 4218 +В теле использовать тип **form-data,** тип значения** file** 4219 + 4220 +**Ключи** 4221 + 4222 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4223 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4224 +|csv|В значении передаем файл датчиков, формат **csv** 4225 + 4226 +Ответ: 4227 + 4228 +{ 4229 + "vehicleId": 0, 4230 + "name": "string", 4231 + "errors": ["string"] 4232 +} 4233 + 4234 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4235 +|vehicleId|ID созданного объекта 4236 +|name|Имя созданного объекта 4237 +|errors|Ошибки и их описание 4238 + 4239 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4240 + 4241 +(% class="box infomessage" %) 4242 +((( 4243 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4244 +))) 4245 + 4246 +(% class="wikigeneratedid" %) 4247 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4248 + 4249 +(% class="wikigeneratedid" %) 4250 +В пути указывается **vehicleId **- id объекта. 4251 + 4252 +**Заголовок** 4253 + 4254 +**X-Auth: [токен авторизации]** 4255 + 4256 +В теле использовать тип **form-data.** 4257 + 4258 +Ключи: 4259 + 4260 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4261 +|**history**|В значении передавать файл с историей 4262 + 4263 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4264 + 4265 +Ответ: 4266 + 4267 +{ 4268 + "results": [ 4269 + { 4270 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4271 + "vehicleId": 0, 4272 + "errors": [ 4273 + "string" 4274 + ], 4275 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4276 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4277 + "producedCount": 0, 4278 + "msgCount": 0 4279 + } 4280 + ] 4281 +} 4282 + 4283 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4284 +|results|Результаты импорта в разрезе ТС 4285 +|vehicleGuid|Guid ТС 4286 +|vehicleId|ID ТС 4287 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4288 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4289 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4290 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4291 +|msgCount|Кол-во обработанных сообщений всего 4292 + 4293 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4294 + 4295 +(% class="box infomessage" %) 4296 +((( 4297 +**GET /api/v3/vehicles/import/history/status** 4298 +))) 4299 + 4300 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4301 + 4302 +Ответ: 4303 + 4304 +{ 4305 + "activity": true, 4306 + "progress": 0, 4307 + "message": "string" 4308 +} 4309 + 4310 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4311 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4312 +|progress|Guid ТС 4313 + 4314 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4315 + 4316 +(% class="box infomessage" %) 4317 +((( 4318 +**POST /api/v3/vehicles/export** 4319 +))) 4320 + 4321 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4322 + 4323 +Тело запроса: 4324 + 4325 +[ 4326 + id 4327 +] 4328 + 4329 +Ответ: Success 200, получаете файлы с настройками. 4330 + 4331 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4332 + 4333 +(% class="box infomessage" %) 4334 +((( 4335 +**POST /api/v3/vehicles/export/history** 4336 +))) 4337 + 4338 +Метод возвращает список сообщений терминала объекта за выбранный период. 4339 + 4340 +Тело запроса: 4341 + 4342 +{ 4343 + "vehicleId": 0, 4344 + "asArchive": true, 4345 + "from": "2023-09-27T12:17:45.973Z", 4346 + "to": "2023-09-27T12:17:45.973Z" 4347 +} 4348 + 4349 +Ответ: 4350 + 4351 +Получаете файл. Сообщение: Code 200/Success 4352 + 4353 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4354 +|vehicleId|ID объекта 4355 +|asArchive|true - Архивировать файл, False - не архивировать 4356 +|from|Дата и время начала запроса 4357 +|to|Дата и время окончания запроса 4358 + 4359 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4360 + 4361 +(% class="box infomessage" %) 4362 +((( 4363 +**GET /api/v3/vehicles/export/history/status** 4364 +))) 4365 + 4366 +Метод возвращает список сообщений терминала объекта за выбранный период. 4367 + 4368 +Ответ: 4369 + 4370 +{ 4371 + "activity": true, 4372 + "progress": 0, 4373 + "message": "string" 4374 +} 4375 + 4376 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4377 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4378 +|progress|Прогресс экспорта, от 0 до 100% 4379 +|message|Текст описывающий статус 4380 + 4381 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4382 + 4383 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4384 + 4385 +(% class="box infomessage" %) 4386 +((( 4387 +**POST /api/v3/EcoDriving/rating** 4388 +))) 4389 + 4390 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4391 + 4392 +Тело запроса: 4393 + 4394 +{ 4395 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4396 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4397 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4398 +} 4399 + 4400 +Ответ: 4401 + 4402 +{ 4403 + "items": [ ~/~/ Список в разрезе ТС 4404 + { 4405 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4406 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4407 + "vehicleId": 0, ~/~/ ID ТС 4408 + "vehicleName": "string", ~/~/ Название ТС 4409 + "vehicleModel": "string", ~/~/ Модель ТС 4410 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4411 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4412 + "totalViolations": 0, ~/~/ Нарушений всего 4413 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4414 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4415 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4416 + "brakingViolations": 0, ~/~/ Нарушений торможения 4417 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4418 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4419 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4420 + }, 4421 + 4422 +((( 4423 + 4424 +))) 4425 + 4426 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4427 + "mileage": 0, ~/~/ Пробег, м 4428 + "tripsCount": 0, ~/~/ Кол-во рейсов 4429 + "trips": [ ~/~/ Информация по рейсу 4430 + { 4431 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4432 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4433 + "violationsCount": 0, ~/~/ Всего нарушений 4434 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4435 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4436 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4437 + "brakingViolations": 0, ~/~/ Нарушений торможения 4438 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4439 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4440 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4441 + }, 4442 + 4443 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4444 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4445 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4446 + "mileage": 0, ~/~/ Пробег, м 4447 + "motohours": 0, ~/~/ Моточасы, секунды 4448 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4449 + "startAddress": "string", ~/~/ Адрес начала рейса 4450 + "endAddress": "string", ~/~/ Адрес конца рейса 4451 + "drivers": [ ~/~/ Список водителей 4452 + { 4453 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4454 + "driverName": "string", ~/~/ФИО водителя 4455 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4456 + } 4457 + ] 4458 + } 4459 + ] 4460 + } 4461 + ] 4462 +} 4463 + 4464 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4465 + 4466 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4467 + 4468 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4469 + 4470 +(% class="box infomessage" %) 4471 +((( 4472 +**POST /api/v3/fuelcards/transactions** 4473 +))) 4474 + 4475 +Метод запроса: POST 4476 + 4477 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4478 +\\В заголовках запроса: X-Auth: Токен авторизации 4479 + 4480 +Параметры в теле запроса (JSON): 4481 + 4482 +{ 4483 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4484 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4485 + "ids": [ 4486 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4487 + ], 4488 + "timezone": 0 ~/~/ Часовой пояс 4489 +} 4490 + 4491 + 4492 +Ответ: 4493 + { 4494 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4495 + "driver": "string", ~/~/ Водители, привязанные к ТК 4496 + "object": "string", ~/~/ Наименование ТС 4497 + "amount": 0, ~/~/ Количество топлива 4498 + "amountDut": 0, ~/~/ Количество по ДУТ 4499 + "amountDiff": 0, ~/~/ Разница, л 4500 + "amountDiffPerc": 0, ~/~/ Разница, % 4501 + "summa": 0, ~/~/ Стоимость, руб 4502 + "serviceName": "string", ~/~/ Тип топлива 4503 + "price": 0, ~/~/ Цена за литр, руб 4504 + "cardName": "string", ~/~/ Наименование ТК 4505 + "cardNum": "string", ~/~/ Номер ТК 4506 + "operator": "string", ~/~/ Оператор ТК 4507 + "address": "string" ~/~/ Адрес АЗС 4508 + } 4509 + 4510 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4511 + 4512 +(% class="box infomessage" %) 4513 +((( 4514 +**GET /api/v3/fuelcards** 4515 +))) 4516 + 4517 +Метод запроса: GET 4518 + 4519 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4520 + 4521 +Ответ: 4522 + 4523 +[ 4524 + { 4525 + "Name": "string", ~/~/ Определяет наименование карты. 4526 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4527 + "Number": "string", ~/~/ Определяет № карты. 4528 + "Enabled": true, ~/~/ Определяет признак активности карты. 4529 + "Description": "string", ~/~/ Определяет описание карты. 4530 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4531 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4532 + "deleted": true ~/~/ Признак удаления 4533 + } 4534 +] 4535 + 4536 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4537 + 4538 + 4539 +== **Получение полных данных о ретрансляторе** == 4540 + 4541 +(% class="box infomessage" %) 4542 +((( 4543 +**GET ** **/api/v3/retranslations/{id}** 4544 +))) 4545 + 4546 +id - Идентификатор ретранслятора 4547 + 4548 + 4549 +Пример ответа: 4550 + 4551 +{ 4552 +"description": "", ~/~/ Поле описания ретранслятора 4553 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4554 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4555 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4556 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4557 +"objects": [ ~/~/ Объекты для ретрансляции 4558 +{ 4559 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4560 +"name": "", ~/~/ Наименование объекта ретрансляции 4561 +"imei": "", ~/~/ IMEI объекта ретрансляции 4562 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4563 +} 4564 + ], 4565 +"id": "", ~/~/ Идентификатор ретранслятора 4566 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4567 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4568 +} 4569 + 4570 + 4571 +== **Удаление данных ретранслятора** == 4572 + 4573 +(% class="box infomessage" %) 4574 +((( 4575 +**DELETE** **/api/v3/retranslations/{id}** 4576 +))) 4577 + 4578 +id - Идентификатор ретранслятора 4579 + 4580 + 4581 +== **Создание ретранслятора** == 4582 + 4583 +(% class="box infomessage" %) 4584 +((( 4585 +**POST ** **/api/v3/retranslations/{id}** 4586 +))) 4587 + 4588 +Запрос: 4589 + 4590 +{ 4591 +"description": "", ~/~/ Поле описания ретранслятора 4592 +"subscriberId": "", ~/~/ Идентификатор подписчика 4593 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4594 +"address": "", ~/~/ Адрес и порт принимающего сервера 4595 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4596 +"objects": [ ~/~/Объекты для ретрансляции 4597 +{ 4598 +"id": "", ~/~/ Идентификатор ретранслятора 4599 +"imei": "", ~/~/ IMEI объекта ретрансляции 4600 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4601 +} 4602 + ] 4603 +} 4604 + 4605 + 4606 +Ответ: 4607 + 4608 +{ 4609 +"description": "", ~/~/ Поле описания ретранслятора 4610 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4611 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4612 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4613 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4614 +"objects": [ ~/~/ Объекты для ретрансляции 4615 +{ 4616 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4617 +"name": "string", ~/~/ Наименование объекта ретрансляции 4618 +"imei": "", ~/~/ IMEI объекта ретрансляции 4619 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4620 +} 4621 + ], 4622 +"id": "", ~/~/ Идентификатор ретранслятора 4623 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4624 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4625 +} 4626 + 4627 + 4628 +== **Редактирование ретранслятора** == 4629 + 4630 +(% class="box infomessage" %) 4631 +((( 4632 +**PUT** **/api/v3/retranslations** 4633 +))) 4634 + 4635 +Пример запроса: 4636 + 4637 +{ 4638 +"id": "", ~/~/ Идентификатор ретранслятора 4639 +"description": "string", ~/~/ Поле описания ретранслятора 4640 +"subscriberId": "", ~/~/ Идентификатор подписчика 4641 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4642 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4643 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4644 +"objects": ~/~/ Объекты для ретрансляции 4645 +[ 4646 +{ 4647 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4648 +"imei": "", ~/~/ IMEI объекта ретрансляции 4649 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4650 +} 4651 + ] 4652 +} 4653 + 4654 + 4655 +Пример ответа: 4656 + 4657 +{ 4658 +"description": "", ~/~/ Поле описания ретранслятора 4659 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4660 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4661 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4662 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4663 +"objects": [ ~/~/ Объекты для ретрансляции 4664 +{ 4665 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4666 +"name": "string", ~/~/ Наименование объекта ретрансляции 4667 +"imei": "", ~/~/ IMEI объекта ретрансляции 4668 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4669 +} 4670 + ], 4671 +"id": "", ~/~/ Идентификатор ретранслятора 4672 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4673 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4674 +} 4675 + 4676 + 4677 +== **Получение списка ретранслятора клиента** == 4678 + 4679 +(% class="box infomessage" %) 4680 +((( 4681 +**POST /api/v3/retranslations/find** 4682 +))) 4683 + 4684 +Пример запроса: 4685 + 4686 +{ 4687 +"id": "", ~/~/ Идентификатор ретранслятора 4688 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4689 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4690 +} 4691 + 4692 +Ответ: 4693 + 4694 +[ 4695 +{ 4696 +"description": "", ~/~/ Поле описания ретранслятора 4697 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4698 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4699 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4700 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4701 +"id": "", ~/~/ Идентификатор ретранслятора 4702 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4703 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4704 +} 4705 +] 4706 + 4707 + 4708 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4709 + 4710 +== **API для отчета по выгрузке комбайнов** == 4711 + 4712 +(% class="box infomessage" %) 4713 +((( 4714 +**POST /api/v3/Reports/harvesterUnloading** 4715 +))) 4716 + 4717 +Пример запроса: 4718 + 4719 +{ 4720 + "byTime": 0, ~/~/ Объединение событий по времени 4721 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4722 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4723 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4724 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4725 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4726 + 0 4727 + ], 4728 + "from": "", ~/~/ Дата и время начало запроса 4729 + "to": "", ~/~/ Дата и время окончания запроса 4730 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4731 +} 4732 + 4733 +Пример ответа: 4734 + 4735 +[ 4736 + { 4737 + "harvesterName": "", ~/~/Комбайн, номер 4738 + "harvesterId": 0, ~/~/Комбайн, id 4739 +"harvesterModel": "", ~/~/ Модель комбайна 4740 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4741 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4742 + "events": [ ~/~/Список событий в разрезе комбайна 4743 + { 4744 + "driverId": "", ~/~/Идентификатор водителя 4745 + "driverName": "", ~/~/Водитель комбайна, ФИО 4746 + "RFID": "", ~/~/ идентификатор карты-метки 4747 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4748 + "vehicleId": 0, ~/~/идентификатор объекта 4749 + "vehicleName": "string", ~/~/ Имя объекта 4750 + "modelName": "string", ~/~/ Имя модели объекта 4751 + "nearestVehicles": [ ~/~/Объекты рядом 4752 + { 4753 + "vehicleId": 0, ~/~/идентификатор объекта 4754 + "vehicleName": "string" ~/~/ Имя объекта 4755 + } 4756 + ], 4757 + "fields": [ ~/~/Поля, где происходила выгрузка 4758 + { 4759 + "id": 0, ~/~/ идентификатор пользователя 4760 + "name": "string" ~/~/ имя пользователя 4761 + } 4762 + ], 4763 + "event": "string", ~/~/Событие 4764 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4765 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4766 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4767 + "cultureName": "string", ~/~/ название культуры 4768 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4769 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4770 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4771 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4772 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4773 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4774 + "issued": 0, ~/~/Выдано, бункеров 4775 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4776 + "latitude": 0, ~/~/Широта 4777 + "longitude": 0, ~/~/ Долгота 4778 + "litresAway": 0, ~/~/Отдано, л 4779 + "m3Away": 0 ~/~/Отдано, м3 4780 + } 4781 + ] 4782 + } 4783 +] 4784 + 4785 + 4786 +== **Отчет трек-датчики** == 4787 + 4788 +(% class="box infomessage" %) 4789 +((( 4790 +**POST /api/v3/Reports/sensorsWorks** 4791 +))) 4792 + 4793 +**Пример запроса:** 4794 + 4795 +{ 4796 + "vehicleIds": [ ~/~/ Список ID объектов 4797 + 0 4798 + ], 4799 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4800 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4801 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4802 +} 4803 + 4804 +**Пример ответа:** 4805 + 4806 +((( 4807 +{ 4808 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4809 + { 4810 + "vehicleId": 0, ~/~/ Идентификатор ТС 4811 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4812 + { 4813 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4814 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4815 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4816 + "name": "string", ~/~/ Наименование оборудования. 4817 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4818 + "totalMileage": 0, ~/~/ Общий пробег. 4819 + "avgSpeed": 0 ~/~/ Средняя скорость. 4820 + } 4821 + ] 4822 + } 4823 + ] 4824 +} 4825 + 4826 + 4827 +== **Превышение скорости** == 4828 + 4829 +(% class="box infomessage" %) 4830 +((( 4831 +**POST /api/v3/Reports/overSpeedDuration** 4832 +))) 4833 + 4834 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4835 + 4836 +Пример запроса: 4837 + 4838 +((( 4839 +{ 4840 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4841 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4842 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4843 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4844 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение; 2-фиксированный;) 4845 +} 4846 +))) 4847 + 4848 +((( 4849 + 4850 +))) 4851 + 4852 +((( 4853 +Пример ответа: 4854 +))) 4855 + 4856 +((( 4857 +((( 4858 +[ 4859 + { 4860 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4861 + "duration": 0, ~/~/ Продолжительность события в секундах 4862 + "maxSpeed": 0, ~/~/ Максимальная скорость 4863 + "speedLimit": 0 ~/~/ Ограничение скорости 4864 + } 4865 +] 4866 +))) 4867 +))) 4868 +))) 4869 + 4870 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4871 + 4872 + 4873 +== **Запрос списка полей** == 4874 + 4875 +(% class="box successmessage" %) 4876 +((( 4877 +**POST /api/v3/agroLands/find** 4878 +))) 4879 + 4880 +Пример запроса: 4881 + 4882 +((( 4883 +((( 4884 +((( 4885 +{ 4886 + "year": 0, ~/~/ Фильтр по году 4887 + "name": "string", ~/~/ Фильтр по названию 4888 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4889 +} 4890 +))) 4891 +))) 4892 + 4893 + 4894 +))) 4895 + 4896 +Пример ответа: 4897 + 4898 +((( 4899 +[ 4900 + { 4901 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4902 + "year": 0, ~/~/ Год поля 4903 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 4904 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 4905 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 4906 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4907 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4908 + "counts": { ~/~/ Счётчики с/х поля 4909 + "fieldOperations": 0, ~/~/ Количество операций на поле 4910 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4911 + "facts": 0 ~/~/ Счётчик факта 4912 + }, 4913 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4914 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4915 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4916 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4917 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4918 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4919 + "planComment": "string", ~/~/ Комментарий к полю 4920 + "productivity": 0, ~/~/ Урожайность. 4921 + "id": 0, ~/~/ Идентификатор объекта геозоны 4922 + "name": "string", ~/~/ Название объекта геозоны 4923 + "type": 0, ~/~/ Тип объекта геозоны 4924 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4925 + "fname": "string", ~/~/ Имя файла 4926 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4927 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 4928 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 4929 + "description": "string", ~/~/ Описание объекта геозоны 4930 + "area": 0, ~/~/ Площадь, м2 4931 + "perimetr": 0, ~/~/ Периметр, м 4932 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 4933 + } 4934 +] 4935 + 4936 + 4937 +== **Создание нового поля ** == 4938 + 4939 +(% class="box successmessage" %) 4940 +((( 4941 +**POST /api/v3/agroLands** 4942 +))) 4943 + 4944 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4945 +X-agent - ID клиента 4946 + 4947 +Пример запроса: 4948 + 4949 +((( 4950 +{ 4951 + "extId": "string", 4952 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 4953 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4954 + "display": "string", ~/~/ Настройки отображения 4955 + "year": 0, ~/~/ Год поля 4956 + "name": "string", ~/~/ Наименование 4957 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4958 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 4959 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 4960 + "planComment": "string", ~/~/ Комментарий к полю 4961 + "cropRotations": [ ~/~/ Данные по севообороту 4962 + { 4963 + "landId": 0, ~/~/ ID поля 4964 + "landName": "string", ~/~/ Название поля 4965 + "year": 0, ~/~/ Год урожая 4966 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4967 + "cultureName": "string", ~/~/ Название культуры 4968 + "productivity": 0, ~/~/ Урожайность 4969 + "area": 0, ~/~/ Площадь поля, Га 4970 + "total": 0, ~/~/ Валовый сбор 4971 + "productivityFact": 0, ~/~/ Фактическая урожайность 4972 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4973 + "totalFact": 0, ~/~/ Фактический валовый сбор 4974 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 4975 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 4976 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 4977 + "isyearplan": true, ~/~/ Годовой план 4978 + "comment": "string" ~/~/ Комментарий 4979 + } 4980 + ] 4981 +} 4982 +))) 4983 + 4984 +((( 4985 + 4986 +))) 4987 + 4988 +Пример ответа: 4989 + 4990 +((( 4991 +((( 4992 +{ 4993 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4994 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4995 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4996 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4997 + "cropRotations": [ ~/~/ Данные по севообороту 4998 + { 4999 + "landId": 0, ~/~/ ID поля 5000 + "landName": "string", ~/~/ Название поля 5001 + "year": 0, ~/~/ Год урожая 5002 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5003 + "cultureName": "string", ~/~/ Название культуры 5004 + "productivity": 0, ~/~/ Урожайность 5005 + "area": 0, ~/~/ Площадь поля, Га. 5006 + "total": 0, ~/~/ Валовый сбор 5007 + "productivityFact": 0, ~/~/ Фактическая урожайность 5008 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5009 + "totalFact": 0, ~/~/ Фактический валовый сбор 5010 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5011 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5012 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5013 + "isyearplan": true, ~/~/ годовой план 5014 + "comment": "string" ~/~/ Комментарий 5015 + } 5016 + ], 5017 + "cropVegetation": [ ~/~/ История вегетации поля 5018 + { 5019 + "values": [ ~/~/ Данные вегетации и состояния посева 5020 + { 5021 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5022 + "ndvi": 0 ~/~/ Индекс вегетации 5023 + } 5024 + ], 5025 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5026 + { 5027 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5028 + "type": "string", ~/~/ Тип 5029 + "pictureid": "string" ~/~/ Идентификатор ресурса 5030 + } 5031 + ], 5032 + "states": [ ~/~/ Ключевые даты развития поля 5033 + { 5034 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5035 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5036 + } 5037 + ] 5038 + } 5039 + ], 5040 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5041 + "counts": { 5042 + "fieldOperations": 0, ~/~/ Количество операций на поле 5043 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5044 + "facts": 0 ~/~/ Счётчик факта 5045 + }, 5046 + "planComment": "string", ~/~/ Комментарий к полю 5047 +))) 5048 + 5049 +((( 5050 + "productivity": 0, ~/~/ Урожайность. 5051 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5052 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5053 + "year": 0, ~/~/ Год поля 5054 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5055 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5056 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5057 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5058 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5059 + "id": 0, ~/~/ Идентификатор объекта геозоны 5060 + "name": "string", ~/~/ Название объекта геозоны 5061 + "type": 0, ~/~/ Тип объекта геозоны 5062 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5063 + "fname": "string", ~/~/ Имя файла 5064 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5065 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5066 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5067 + "description": "string", ~/~/ Описание объекта геозоны 5068 + "area": 0, ~/~/ Площадь, м2 5069 + "perimetr": 0, ~/~/ Периметр, м 5070 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5071 +} 5072 + 5073 + 5074 +))) 5075 +))) 5076 +))) 5077 + 5078 +== **Получение поля по id** == 5079 + 5080 +(% class="box infomessage" %) 5081 +((( 5082 +**GET /api/v3/agroLands/{id}** 5083 +))) 5084 + 5085 +Пример запроса: 5086 +id ~/~/ Идентификатор поля 5087 + 5088 +Пример ответа: 5089 + 5090 +((( 5091 +{ 5092 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5093 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5094 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5095 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5096 + "cropRotations": [ ~/~/ Данные по севообороту 5097 + { 5098 + "landId": 0, ~/~/ ID поля 5099 + "landName": "string", ~/~/ Название поля 5100 + "year": 0, ~/~/ Год урожая 5101 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5102 + "cultureName": "string", ~/~/ Название культуры 5103 + "productivity": 0, ~/~/ Урожайность 5104 + "area": 0, ~/~/ Площадь поля, Га 5105 + "total": 0, ~/~/ Валовый сбор 5106 + "productivityFact": 0, ~/~/ Фактическая урожайность 5107 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5108 + "totalFact": 0, ~/~/ Фактический валовый сбор 5109 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5110 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5111 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5112 + "isyearplan": true, ~/~/ План года 5113 + "comment": "string" ~/~/ Комментарий 5114 + } 5115 + ], 5116 + "cropVegetation": [ ~/~/ История вегетации поля 5117 + { 5118 + "values": [ ~/~/ Данные вегетации и состояния посева 5119 + { 5120 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5121 + "ndvi": 0 ~/~/ Индекс вегетации 5122 + } 5123 + ], 5124 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5125 + { 5126 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5127 + "type": "string", ~/~/ Тип 5128 + "pictureid": "string" ~/~/ Идентификатор ресурса 5129 + } 5130 + ], 5131 + "states": [ ~/~/ Ключевые даты развития поля 5132 + { 5133 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5134 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5135 + } 5136 + ] 5137 + } 5138 + ], 5139 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5140 + "counts": { 5141 + "fieldOperations": 0, ~/~/ Количество операций на поле 5142 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5143 + "facts": 0 ~/~/ Счётчик факта 5144 + }, 5145 + "planComment": "string", ~/~/ Комментарий к полю 5146 + "productivity": 0, ~/~/ Урожайность. 5147 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5148 +))) 5149 + 5150 +((( 5151 +((( 5152 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5153 + "year": 0, ~/~/ Год поля 5154 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5155 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5156 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5157 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5158 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5159 + "id": 0, ~/~/ Идентификатор объекта геозоны 5160 + "name": "string", ~/~/ Название объекта геозоны 5161 + "type": 0, ~/~/ Тип объекта геозоны 5162 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5163 + "fname": "string", ~/~/ Имя файла 5164 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5165 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5166 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5167 + "description": "string", ~/~/ Описание объекта геозоны 5168 + "area": 0, ~/~/ Площадь, м2 5169 + "perimetr": 0, ~/~/ Периметр, м 5170 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5171 +} 5172 +))) 5173 + 5174 + 5175 +== **Удаление существующего поля** == 5176 + 5177 +(% class="box errormessage" %) 5178 +((( 5179 +**DELETE /api/v3/agroLands/{id}** 5180 +))) 5181 + 5182 +Пример запроса: 5183 +id ~/~/ Идентификатор поля 5184 + 5185 +Пример ответа: 5186 + 5187 +((( 5188 +200 ~/~/ Успех 5189 +))) 5190 + 5191 +((( 5192 + 5193 +))) 5194 + 5195 +((( 5196 +((( 5197 +((( 5198 + 5199 +))) 5200 + 5201 +((( 5202 +== **Изменение поля** == 5203 + 5204 +(% class="box infomessage" %) 5205 +((( 5206 +**PUT /api/v3/agroLands** 5207 +))) 5208 + 5209 +Пример запроса: 5210 + 5211 +((( 5212 +((( 5213 +{ 5214 + "id": 0, ~/~/ Идентификатор поля 5215 + "extId": "string", ~/~/ ExtId 5216 + "shape": "string", ~/~/ Форма поля 5217 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5218 + "display": "string", ~/~/ Настройки отображения 5219 + "year": 0, ~/~/ Год поля 5220 + "name": "string", ~/~/ Наименование 5221 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5222 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5223 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5224 + "planComment": "string", ~/~/Комментарий к полю 5225 + "cropRotations": [ ~/~/ Данные по севообороту 5226 + { 5227 + "landId": 0, ~/~/ ID поля 5228 + "landName": "string", ~/~/ Название поля 5229 + "year": 0, ~/~/ Год урожая 5230 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5231 + "cultureName": "string", ~/~/ Название культуры 5232 + "productivity": 0, ~/~/ Урожайность 5233 + "area": 0, ~/~/ Площадь поля, Га. 5234 + "total": 0, ~/~/ Валовый сбор 5235 + "productivityFact": 0, ~/~/ Фактическая урожайность 5236 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5237 + "totalFact": 0, ~/~/ Фактический валовый сбор 5238 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5239 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5240 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5241 + "isyearplan": true, 5242 + "comment": "string" ~/~/ Комментарий 5243 + } 5244 + ], 5245 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5246 +} 5247 +))) 5248 +))) 5249 + 5250 +((( 5251 + 5252 +))) 5253 + 5254 +Пример ответа: 5255 + 5256 +((( 5257 +((( 5258 +((( 5259 +{ 5260 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5261 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5262 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5263 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5264 + "cropRotations": [ ~/~/ Данные по севообороту 5265 + { 5266 + "landId": 0, ~/~/ ID поля 5267 + "landName": "string", ~/~/ Название поля 5268 + "year": 0, ~/~/ Год урожая 5269 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5270 + "cultureName": "string", ~/~/ Название культуры 5271 + "productivity": 0, ~/~/ Урожайность 5272 + "area": 0, ~/~/ Площадь поля, Га 5273 + "total": 0, ~/~/ Валовый сбор 5274 + "productivityFact": 0, ~/~/ Фактическая урожайность 5275 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5276 + "totalFact": 0, ~/~/ Фактический валовый сбор 5277 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5278 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5279 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5280 + "isyearplan": true, ~/~/ 5281 + "comment": "string" ~/~/ Комментарий 5282 + } 5283 + ], 5284 + "cropVegetation": [ ~/~/ История вегетации поля 5285 + { 5286 + "values": [ ~/~/ Данные вегетации и состояния посева 5287 + { 5288 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5289 + "ndvi": 0 ~/~/ Индекс вегетации 5290 + } 5291 + ], 5292 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5293 + { 5294 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5295 + "type": "string", ~/~/ Тип 5296 + "pictureid": "string" ~/~/ Идентификатор ресурса 5297 + } 5298 + ], 5299 + "states": [ ~/~/ Ключевые даты развития поля 5300 + { 5301 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5302 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5303 + } 5304 + ] 5305 + } 5306 + ], 5307 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5308 + "counts": { 5309 + "fieldOperations": 0, ~/~/ Количество операций на поле 5310 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5311 + "facts": 0 ~/~/ Счётчик факта 5312 + }, 5313 + "planComment": "string", ~/~/ Комментарий к полю 5314 + "productivity": 0, ~/~/ Урожайность. 5315 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5316 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5317 + "year": 0, ~/~/ Год поля 5318 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5319 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5320 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5321 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5322 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5323 + "id": 0, ~/~/ Идентификатор объекта геозоны 5324 + "name": "string", ~/~/ Название объекта геозоны 5325 + "type": 0, ~/~/ Тип объекта геозоны 5326 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5327 + "fname": "string", ~/~/ Имя файла 5328 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5329 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5330 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5331 + "description": "string", ~/~/ Описание объекта геозоны 5332 + "area": 0, ~/~/ Площадь, м2 5333 + "perimetr": 0, ~/~/ Периметр, м 5334 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5335 +} 5336 +))) 5337 +))) 5338 +))) 5339 +))) 5340 +))) 5341 + 5342 + 5343 +== **Редактирование года урожая ** == 5344 + 5345 +(% class="box successmessage" %) 5346 +((( 5347 +**POST /api/v3/agroLands/updateOpenCloseYear** 5348 +))) 5349 + 5350 +Пример запроса: 5351 + 5352 +((( 5353 +((( 5354 +{ 5355 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5356 + 0 5357 + ], 5358 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5359 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5360 +} 5361 +))) 5362 + 5363 + 5364 +))) 5365 + 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-20T11:43:44.091Z", ~/~/ Дата начала работ 5389 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5390 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5391 + "isyearplan": true, ~/~/ 5392 + "comment": "string" ~/~/ Комментарий 5393 + } 5394 + ], 5395 + "cropVegetation": [ ~/~/ История вегетации поля 5396 + { 5397 + "values": [ ~/~/ Данные вегетации и состояния посева 5398 + { 5399 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5400 + "ndvi": 0 ~/~/ Индекс вегетации 5401 + } 5402 + ], 5403 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5404 + { 5405 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5406 + "type": "string", ~/~/ Тип 5407 + "pictureid": "string" ~/~/ Идентификатор ресурса 5408 + } 5409 + ], 5410 + "states": [ ~/~/ Ключевые даты развития поля 5411 + { 5412 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5413 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5414 + } 5415 + ] 5416 + } 5417 + ], 5418 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5419 + "counts": { 5420 + "fieldOperations": 0, ~/~/ Количество операций на поле 5421 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5422 + "facts": 0 ~/~/ Счётчик факта 5423 + }, 5424 + "planComment": "string", ~/~/ Комментарий к полю 5425 + "productivity": 0, ~/~/ Урожайность. 5426 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5427 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5428 + "year": 0, ~/~/ Год поля 5429 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5430 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5431 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5432 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5433 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5434 + "id": 0, ~/~/ Идентификатор объекта геозоны 5435 + "name": "string", ~/~/ Название объекта геозоны 5436 + "type": 0, ~/~/ Тип объекта геозоны 5437 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5438 + "fname": "string", ~/~/ Имя файла 5439 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5440 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5441 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5442 + "description": "string", ~/~/ Описание объекта геозоны 5443 + "area": 0, ~/~/ Площадь, м2 5444 + "perimetr": 0, ~/~/ ериметр, м 5445 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5446 +} 5447 +))) 5448 + 5449 + 5450 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5451 +))) 5452 +))) 5453 +))) 5454 + 5455 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5456 + 5457 + 5458 +(% class="box infomessage" %) 5459 +((( 5460 +**GET api/v3/Vehicles/recyclebin/all** 5461 +))) 5462 + 5463 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5464 + 5465 +Параметр запроса: {parentId} - идентификатор агента 5466 + 5467 +В заголовках запроса: X-Auth: Токен авторизации 5468 + 5469 +Ответ: 5470 + 5471 +[ 5472 + { 5473 + "recordTime": "", ~/~/Время записи 5474 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5475 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5476 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5477 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5478 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5479 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5480 + "items": [ ~/~/ 5481 +nullable: true ~/~/Детали 5482 + { 5483 + "name": "string", ~/~/наименование столбца 5484 + "value": "string" ~/~/содержание столбца 5485 + } 5486 + ] 5487 + }, 5488 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5489 + "string" 5490 + ] 5491 + } 5492 +] 5493 + 5494 + 5495 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5496 + 5497 +(% class="box infomessage" %) 5498 +((( 5499 +**POST api/v3/Vehicles/recyclebin/erase** 5500 +))) 5501 + 5502 +В заголовках запроса: X-Auth: Токен авторизации 5503 + 5504 +Пример запроса: 5505 + 5506 +[ 5507 +0 5508 +] 5509 + 5510 + 5511 +Пример ответа: 5512 + 5513 +[ 5514 +{ 5515 + "recordTime": "", ~/~/Время записи 5516 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5517 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5518 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5519 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5520 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5521 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5522 + "items": [ ~/~/Детали 5523 + { 5524 + "name": "", ~/~/Имя свойства 5525 + "value": "" ~/~/Значение свойства 5526 + } 5527 + ] 5528 + }, 5529 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5530 + "" 5531 + ] 5532 + } 5533 +] 5534 + 5535 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5536 + 5537 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5538 + 5539 +(% class="box infomessage" %) 5540 +((( 5541 +**POST api/v3/Vehicles/recyclebin/restore** 5542 +))) 5543 + 5544 +В заголовках запроса: X-Auth: Токен авторизации 5545 + 5546 +Параметры в теле запроса (JSON): 5547 + 5548 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5549 + 5550 +В заголовках запроса: X-Auth: Токен авторизации 5551 + 5552 + 5553 +Пример запроса: 5554 + 5555 +((( 5556 +[ 5557 +))) 5558 + 5559 +((( 5560 + 0 5561 +))) 5562 + 5563 +((( 5564 +] 5565 +))) 5566 + 5567 + 5568 +Пример ответа: 5569 + 5570 +[ 5571 +{ 5572 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5573 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5574 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5575 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5576 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5577 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5578 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5579 + "items": [ ~/~/Детали 5580 + { 5581 + "name": "string", ~/~/Имя свойства 5582 + "value": "string" ~/~/Значение свойства 5583 + } 5584 + ] 5585 + }, 5586 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5587 + "string" 5588 + ] 5589 + } 5590 +] 5591 + 5592 + 5593 += **Раздел: Журнал заданий ** = 5594 + 5595 + 5596 +== **Создание задания в Журнале заданий** == 5597 + 5598 +(% class="box infomessage" %) 5599 +((( 5600 +**POST /api/v3/vehicletasks** 5601 +))) 5602 + 5603 +Пример запроса: 5604 + 5605 +((( 5606 +{ 5607 + "vehicleId": 0, ~/~/ Идентификатор ТС 5608 + "description": "string", ~/~/ Описание 5609 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5610 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5611 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5612 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5613 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5614 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5615 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5616 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5617 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5618 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5619 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5620 + "cost": { 5621 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5622 + "Name": "string", ~/~/ Наименование 5623 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5624 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5625 + "Norm": 0 ~/~/ Норма внесения 5626 + }, 5627 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5628 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5629 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5630 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5631 + "deleted": true, ~/~/ Признак удаления 5632 + "extId": "string", 5633 + "GeoIds": [ ~/~/ Cвязанные поля 5634 + 0 5635 + ] 5636 +} 5637 +))) 5638 + 5639 + 5640 +Пример ответа: 5641 + 5642 +{ 5643 + "vehicleId": 0, ~/~/ Идентификатор ТС 5644 + "description": "string", ~/~/ Описание 5645 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5646 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5647 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5648 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5649 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5650 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5651 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5652 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5653 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5654 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5655 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5656 + "cost": { 5657 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5658 + "Name": "string", ~/~/ Наименование 5659 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5660 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5661 + "Norm": 0 ~/~/ Норма внесения 5662 + }, 5663 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5664 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5665 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5666 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5667 + "deleted": true, ~/~/ Признак удаления 5668 + "extId": "string", ~/~/ ExtId 5669 + "GeoIds": [ ~/~/ Связанные поля 5670 + 0 5671 + ] 5672 +} 5673 + 5674 + 5675 +== **Редактирование задания в Журнале заданий** == 5676 + 5677 +(% class="box successmessage" %) 5678 +((( 5679 +**PUT /api/v3/vehicletasks** 5680 +))) 5681 + 5682 +Пример запроса: 5683 + 5684 +((( 5685 +{ 5686 + "vehicleId": 0, ~/~/ Идентификатор ТС 5687 + "description": "string", ~/~/ Описание 5688 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5689 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5690 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5691 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5692 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5693 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5694 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5695 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5696 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5697 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5698 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5699 + "cost": { 5700 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5701 + "Name": "string", ~/~/ Наименование 5702 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5703 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5704 + "Norm": 0 ~/~/ Норма внесения 5705 + }, 5706 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5707 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5708 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5709 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5710 + "deleted": true, ~/~/ Признак удаления 5711 + "extId": "string", ~/~/ ExtId 5712 + "GeoIds": [ ~/~/ Связанные поля 5713 + 0 5714 + ] 5715 +} 5716 +))) 5717 + 5718 + 5719 +Пример ответа: 5720 + 5721 +{ 5722 + "vehicleId": 0, ~/~/ Идентификатор ТС 5723 + "description": "string", ~/~/ Описание 5724 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5725 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5726 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5727 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5728 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5729 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5730 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5731 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5732 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5733 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5734 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5735 + "cost": { 5736 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5737 + "Name": "string", ~/~/ Наименование 5738 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5739 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5740 + "Norm": 0 ~/~/ Норма внесения 5741 + }, 5742 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5743 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5744 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5745 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5746 + "deleted": true, ~/~/ Признак удаления 5747 + "extId": "string", ~/~/ ExtId 5748 + "GeoIds": [ ~/~/ Связанные поля 5749 + 0 5750 + ] 5751 +} 5752 + 5753 + 5754 +== **Удаление задания в Журнале заданий** == 5755 + 5756 +(% class="box warningmessage" %) 5757 +((( 5758 +**DELETE /api/v3/vehicletasks** 5759 +))) 5760 + 5761 +Пример запроса: 5762 + 5763 +((( 5764 +[ 5765 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5766 +] 5767 +))) 5768 + 5769 +((( 5770 + 5771 +))) 5772 + 5773 +Пример ответа: 5774 + 5775 +{ 5776 + "vehicleId": 0, ~/~/ Идентификатор ТС 5777 + "description": "string", ~/~/ Описание 5778 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5779 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5780 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5781 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5782 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5783 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5784 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5785 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5786 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5787 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5788 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5789 + "cost": { 5790 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5791 + "Name": "string", ~/~/ Наименование 5792 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5793 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5794 + "Norm": 0 ~/~/ Норма внесения 5795 + }, 5796 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5797 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5798 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5799 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5800 + "deleted": true, ~/~/ Признак удаления 5801 + "extId": "string", ~/~/ ExtId 5802 + "GeoIds": [ ~/~/ Связанные поля 5803 + 0 5804 + ] 5805 +} 5806 + 5807 + 5808 +== **Получение списка Журнала заданий** == 5809 + 5810 +(% class="box infomessage" %) 5811 +((( 5812 +**POST /api/v3/vehicletasks/getbyperiod** 5813 +))) 5814 + 5815 +Пример запроса: 5816 + 5817 +((( 5818 +{ 5819 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5820 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 5821 + "TimeZone": 0, ~/~/ Часовой пояс. 5822 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 5823 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 5824 + ], 5825 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 5826 + 0 5827 + ], 5828 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 5829 + 0 5830 + ], 5831 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 5832 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 5833 +} 5834 +))) 5835 + 5836 + 5837 +Пример ответа: 5838 + 5839 +((( 5840 +{ 5841 + "total": 0, ~/~/ Общее количество записей 5842 + "pages": 0, ~/~/ Общее количество страниц 5843 + "currentPage": 0, ~/~/ Текущая страница 5844 + "items": [ ~/~/ Записи 5845 + { 5846 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5847 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 5848 + "name": "string", ~/~/ Название задания. 5849 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 5850 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 5851 + "workKind": "string", ~/~/ Вид работ 5852 + "techOp": "string", ~/~/ Тех. операция 5853 + "trailerModel": "string", ~/~/ Модель агрегата 5854 + "width": "string", ~/~/ Ширина, м 5855 + "speed": "string", ~/~/ Тех. скорость 5856 + "fields": "string", ~/~/ Поля 5857 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 5858 + "vehicles": "string", ~/~/ Объект-модель 5859 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 5860 + "drivers": "string", ~/~/ Водители 5861 + "tmc": "string", ~/~/ ТМЦ 5862 + "client": "string", ~/~/ Клиент 5863 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5864 + "dep": "string", ~/~/ Подразделение 5865 + "geoIds": [ ~/~/ Связанные поля 5866 + 0 5867 + ] 5868 + } 5869 + ] 5870 +} 5871 +))) 5872 + 5873 + 5874 += **Раздел: Локатор ** = 5875 + 5876 + 5877 +== **Получение списка локаторов, доступных пользователю ** == 5878 + 5879 +(% class="box infomessage" %) 5880 +((( 5881 +**GET /api/v3/locators** 5882 +))) 5883 + 5884 +В заголовках запроса: X-Auth: Токен авторизации 5885 + 5886 + 5887 +Пример ответа: 5888 + 5889 +((( 5890 +[ 5891 + { 5892 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5893 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5894 + "agentName": "string", ~/~/ Наименование агента. 5895 + "isEnabled": true, ~/~/ Активен 5896 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5897 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5898 + "name": "string", ~/~/ Наименование 5899 + "status": 0, ~/~/ 5900 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5901 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5902 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5903 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5904 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5905 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5906 + "url": "string", ~/~/ Ссылка 5907 + "language": 0, ~/~/ Язык. 5908 + "vehiclesCount": 0, ~/~/ Количество объектов. 5909 + "geozonesCount": 0, ~/~/ Количество геозон. 5910 + "fieldsCount": 0 ~/~/ Количество полей. 5911 + } 5912 +] 5913 +))) 5914 + 5915 + 5916 + 5917 +== **Создание локатора** == 5918 + 5919 +(% class="box successmessage" %) 5920 +((( 5921 +**POST /api/v3/locators** 5922 +))) 5923 + 5924 +Пример запроса: 5925 + 5926 +((( 5927 +{ 5928 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5929 + "isEnabled": true, ~/~/ Активность 5930 + "name": "string", ~/~/ Наименование локатора 5931 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 5932 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5933 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5934 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5935 + "url": "string", ~/~/ Ссылка 5936 + "language": 0 ~/~/ Язык 5937 +} 5938 +))) 5939 + 5940 + 5941 +Пример ответа: 5942 + 5943 +((( 5944 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 5945 +))) 5946 + 5947 + 5948 + 5949 +== **Изменение локатора** == 5950 + 5951 +(% class="box infomessage" %) 5952 +((( 5953 +**PUT /api/v3/locators** 5954 +))) 5955 + 5956 +Пример запроса: 5957 + 5958 +((( 5959 +{ 5960 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5961 + "isEnabled": true, ~/~/ Активность 5962 + "name": "string", ~/~/ Наименование 5963 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 5964 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5965 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5966 + "autoProlongation": true, ~/~/ Автопродление срока действия 5967 + "url": "string", ~/~/ Ссылка 5968 + "language": 0 ~/~/ Язык 5969 +} 5970 +))) 5971 + 5972 + 5973 +Пример ответа: 5974 + 5975 +200 ~/~/ Success 5976 + 5977 + 5978 +== **Удалить локатор** == 5979 + 5980 +(% class="box warningmessage" %) 5981 +((( 5982 +**DELETE /api/v3/locators** 5983 +))) 5984 + 5985 +Пример запроса: 5986 + 5987 +((( 5988 +[ 5989 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 5990 +] 5991 +))) 5992 + 5993 + 5994 + 5995 += **Раздел: Яндекс Маршруты** = 5996 + 5997 + 5998 +== **Возвращение списка маршрутов** == 5999 + 6000 +(% class="box infomessage" %) 6001 +((( 6002 +**GET /api/v3/TransportRoutes** 6003 +))) 6004 + 6005 +Пример запроса: 6006 +Id ~/~/ Идентификатор поля 6007 + 6008 + 6009 +Пример ответа: 6010 + 6011 +((( 6012 +[ 6013 + { 6014 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6015 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6016 + "name": "string", ~/~/ Наименование маршрута. 6017 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6018 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6019 + 0 6020 + ] 6021 + } 6022 +] 6023 +))) 6024 + 6025 + 6026 + 6027 +== **Добавить маршрут** == 6028 + 6029 +(% class="box infomessage" %) 6030 +((( 6031 +**POST /api/v3/TransportRoutes** 6032 +))) 6033 + 6034 +Пример запроса: 6035 +{ 6036 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6037 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6038 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6039 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6040 + 0 6041 + ] 6042 +} 6043 + 6044 + 6045 +Пример ответа: 6046 + 6047 +((( 6048 +{ 6049 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6050 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6051 + "name": "string", ~/~/ Определяет наименование маршрута 6052 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6053 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6054 + 0 6055 + ] 6056 +} 6057 +))) 6058 + 6059 + 6060 +== **Обновление маршрута** == 6061 + 6062 +(% class="box successmessage" %) 6063 +((( 6064 +**PUT /api/v3/TransportRoutes** 6065 +))) 6066 + 6067 +Пример запроса: 6068 + 6069 +((( 6070 +{ 6071 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6072 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6073 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6074 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6075 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6076 + 0 6077 + ] 6078 +} 6079 +))) 6080 + 6081 + 6082 +Пример ответа: 6083 + 6084 +((( 6085 +{ 6086 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6087 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6088 + "name": "string", ~/~/ Определяет наименование маршрута 6089 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6090 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6091 + 0 6092 + ] 6093 +} 6094 +))) 6095 + 6096 + 6097 +== **Получить связки маршрутов ТС** == 6098 + 6099 +(% class="box infomessage" %) 6100 +((( 6101 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6102 +))) 6103 + 6104 +Пример запроса: 6105 + 6106 +((( 6107 +[ 6108 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6109 +] 6110 +))) 6111 + 6112 + 6113 +Пример ответа: 6114 + 6115 +((( 6116 +[ 6117 + { 6118 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6119 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6120 + } 6121 +] 6122 +))) 6123 + 6124 + 6125 +== **Удалить маршрут** == 6126 + 6127 +(% class="box warningmessage" %) 6128 +((( 6129 +**DELETE /api/v3/TransportRoutes/{id}** 6130 +))) 6131 + 6132 +Пример запроса: 6133 +Id ~/~/ Идентификатор поля 6134 + 6135 + 6136 +==== ==== 6137 + 6138 +==== **Раздел: Управление доступа к машинам** ==== 6139 + 6140 + 6141 +== Получение списка ID == 6142 + 6143 +(% class="box infomessage" %) 6144 +((( 6145 +**GET /api/v3/UserVisibleVehicles/{userId}** 6146 +))) 6147 + 6148 + 6149 + 6150 + 6151 + 6152 + 6153 + 6154 + 6155 + 6156 + 1407 1407 (% class="box" lang="en-US" style="text-align: center;" %) 1408 1408 ((( 1409 1409 (% 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