Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/04/24 15:46
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,5 +1,22 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 8 + 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 11 + 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 + 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 19 + 3 3 **Содержание страницы:** 4 4 ))) 5 5 ... ... @@ -14,13 +14,22 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!34 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 36 + 37 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 38 + 39 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 40 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 43 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 44 +((( 45 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 46 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 47 +))) 22 22 23 -(% class="box infomessage" %)49 +(% class="box successmessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».60 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,21 +40,25 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) 47 47 (% style="color:#000000" %){ 48 - 49 -(% lang="en-US" %) 50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 - "User": "testuser" , ~/~/ имя пользователя 52 - 53 -(% lang="en-US" %) 73 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 74 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 79 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 80 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 81 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 82 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 83 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 84 + 85 +(% class="wikigeneratedid" %) 86 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 87 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,63 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 126 + 127 +((( 97 97 { 98 - "agentId": "", ~/~/ идентификатор клиента (%%) 99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 - "isForeign": true/false, ~/~/ Иностранный контрагент 105 - "district": "string", ~/~/ округ 106 - "region": "string", ~/~/ регион 107 - "city": "string", ~/~/ город 108 - "inn": "string", ~/~/ ИНН клиента 109 - "kpp": "string", ~/~/ КПП клиента 110 - "address": "string", ~/~/ юридический адрес 111 - "addressFact": "string", ~/~/ фактический адрес 112 - "email": "string", ~/~/ почта 113 - "director": "string", ~/~/ ФИО руководителя 114 - "bankName": "string", ~/~/ Банк 115 - "bankBIK": "string", ~/~/ БИК 116 - "bankRS": "string", ~/~/ Номер счета 117 - "bankKS": "string" ~/~/ Корр. счет 118 - } 129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента 130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя 131 + "parentName": "string", ~/~/ Наименование агента 132 + "name": "string", ~/~/ Имя клиента 133 + "fullName": "string", ~/~/ ФИО клиента 134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%)) 135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент" 136 + "district": "string", ~/~/ Район 137 + "region": "string", ~/~/ Область 138 + "city": "string", ~/~/ Город 139 + "email": "string", ~/~/ Email 140 + "director": "string", ~/~/ Руководитель 141 + "RegionalData": [ ~/~/ Определяет региональные сведения. 142 + { 143 + "Country": 0, ~/~/ Страна 144 + "groups": [ ~/~/ Список групп 145 + { 146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 147 + "fields": [ ~/~/ Список значений полей 148 + { 149 + "name": "string", ~/~/ Имя поля формы 150 + "value": "string" ~/~/ Значение поля формы 151 + } 152 + ] 153 + } 154 + ] 155 + } 156 + ] 157 +} 158 +))) 119 119 160 + 161 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 162 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 163 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 164 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 165 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 166 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 167 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 168 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 169 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 170 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 171 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 172 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 173 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 174 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 175 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 176 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 177 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 178 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 179 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 180 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 181 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 182 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».196 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,23 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 211 + "agentId": "",(% style="color:#000000" %) (%%) 212 + "parentId": "", 213 + "name": "string", 214 + "fullName": "string", 215 + "agentInfoType": 0, 216 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 219 + 220 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 221 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 222 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 223 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 224 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 225 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 226 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 227 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 246 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -192,7 +192,6 @@ 192 192 "bankKS": "string" ~/~/ корр. счёт 193 193 } 194 194 195 - 196 196 Ответ: 197 197 198 198 { ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 291 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 292 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 293 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 294 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 295 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 296 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 297 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 298 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 299 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 300 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 301 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 302 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 303 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 304 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 305 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 306 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 307 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 308 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 309 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 310 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 311 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 393 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 394 + 395 +(% class="box warningmessage" %) 396 +((( 397 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 398 +))) 399 + 400 +Метод позволяет изменить статус клиента, указанного в запросе. 401 + 402 +В пути указывается GUID клиента и статус клиента. 403 + 404 +**status **- значение 0 - заблокирован, 1 - активен. 405 + 406 +Ответ: Code 204 407 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -351,7 +351,6 @@ 351 351 ], 352 352 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 - 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 - 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 472 +{ 473 + "id": "" , ~/~/ ID пользователя 375 375 "lastName": "" , ~/~/ Фамилия , 376 376 "firstName": "" , ~/~/ Имя 377 377 "position": "" , ~/~/ Должность ... ... @@ -388,9 +388,8 @@ 388 388 "kind": "" , ~/~/ тип аутентификации 389 389 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 390 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 490 +} 391 391 392 -(% style="text-align:left" %) 393 -(% style="color:#000000; font-weight:normal" %)} 394 394 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 ... ... @@ -411,19 +411,16 @@ 411 411 412 412 (% style="color:#000000" %)Параметры в теле запроса (JSON): 413 413 414 -(% style="color:#000000" %){ 415 - 512 +(% style="color:#000000" %){(%%) 416 416 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 417 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 418 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 419 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 423 (% style="color:#000000" %)Ответ: 424 424 425 425 (% style="color:#000000" %){ (%%) 426 - 427 427 "id": "" , ~/~/ идентификатор пользователя 428 428 "lastName": "" , ~/~/ фамилия 429 429 "firstName": "" , ~/~/ имя ... ... @@ -437,7 +437,6 @@ 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 439 "lastLogged": "", ~/~/ дата/время последней авторизации 440 - 441 441 (% style="color:#000000" %)} 442 442 443 443 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -511,10 +511,8 @@ 511 511 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 512 512 513 513 (% lang="en-US" style="text-align:left" %) 514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 - 516 -(% lang="en-US" style="text-align:left" %) 517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 608 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 609 + "id": "" , ~/~/ ID пользователя 518 518 "lastName": "" , ~/~/ фамилия 519 519 "firstName": "" , ~/~/ имя 520 520 "position": "" , ~/~/ должность ... ... @@ -536,9 +536,7 @@ 536 536 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 537 }, 538 538 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 - 541 -(% lang="en-US" style="text-align:left" %) 631 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 542 542 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 543 543 544 544 (% lang="en-US" style="text-align:left" %) ... ... @@ -545,10 +545,8 @@ 545 545 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 546 546 547 547 (% lang="en-US" style="text-align:left" %) 548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 549 - 550 -(% lang="en-US" style="text-align:left" %) 551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 638 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 639 + "id": "" , ~/~/ идентификатор пользователя 552 552 "lastName": "" , ~/~/ фамилия 553 553 "firstName": "" , ~/~/ имя 554 554 "position": "" , ~/~/ должность ... ... @@ -569,10 +569,8 @@ 569 569 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 570 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 571 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 660 +} 572 572 573 -(% lang="en-US" style="text-align:left" %) 574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 - 576 576 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 577 577 578 578 (% class="box warningmessage" %) ... ... @@ -592,12 +592,10 @@ 592 592 593 593 (% style="color:#000000" %)Параметры в теле запроса (JSON): 594 594 595 -(% style="color:#000000" %){ 596 - 681 +(% style="color:#000000" %){(%%) 597 597 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 598 "description": "" , ~/~/ описание 599 599 "data": "" , ~/~/ данные, связанные со сменой статуса 600 - 601 601 (% style="color:#000000" %)} 602 602 603 603 (% style="text-align:left" %) ... ... @@ -619,7 +619,7 @@ 619 619 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 620 621 621 [ 622 - 706 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -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" %) ... ... @@ -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 объекта ... ... @@ -718,19 +718,15 @@ 718 718 "deviceTypeName": "", ~/~/ Название типа устройства 719 719 "sim1": "", ~/~/ Номер SIM1 720 720 "sim2": "", ~/~/ Номер SIM2 721 - 722 722 "parentId": "", ~/~/ ID клиента-родителя 723 723 "parentName": "", ~/~/ Наименование клиента-родителя 724 724 "modelId": "", ~/~/ ID модели объекта 725 725 "modelName": "", ~/~/ Имя модели объекта 726 - 727 727 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 728 "unitName": "string", ~/~/ Наименование подразделения 729 729 "status": 0, ~/~/ Статус объекта 730 - 731 731 "createdAt": "", ~/~/ Дата создания объекта 732 732 }, 733 - 734 734 "customFields": [ ~/~/ Произвольные поля 735 735 { 736 736 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -753,8 +753,7 @@ 753 753 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 754 754 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 755 755 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 757 - 1090 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 758 758 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 759 759 "mileageCoeff": 0, ~/~/ коэффициент пробега 760 760 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -784,7 +784,6 @@ 784 784 "retries": 0 ~/~/ Количество попыток 785 785 } 786 786 ], 787 - 788 788 "sensors": [ ~/~/ Датчики 789 789 { 790 790 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -811,6 +811,7 @@ 811 811 ], 812 812 "showInTooltip": true, ~/~/ Отображать в подсказке 813 813 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 814 814 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 815 815 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 816 816 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -825,31 +825,19 @@ 825 825 }, 826 826 827 827 ~/~/ Характерные для произвольного: 828 - 829 829 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 830 - 831 831 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 832 - 833 833 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 834 - 835 835 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 836 - 837 837 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 838 - 839 839 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 840 - 841 841 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 842 - 843 843 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 844 - 845 845 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 846 - 847 847 ~/~/ "ValueOn": "Вкл.", 848 - 849 849 ~/~/ "ValueOff": "Выкл." 850 850 "summaryMaxValue": 0 ~/~/ Макс. значение 851 851 } 852 - 853 853 "drivers": [ ~/~/ Водители 854 854 { 855 855 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -858,7 +858,6 @@ 858 858 "isDefault": true ~/~/ По умолчанию 859 859 } 860 860 ], 861 - 862 862 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 863 863 { 864 864 "id": "", ~/~/ ID задания ... ... @@ -875,19 +875,27 @@ 875 875 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 876 876 } 877 877 ], 878 - 879 - "statusHistory": [ ~/~/ История статусов 1198 +"statusHistory": [ ~/~/ История статусов 880 880 { 881 881 "status": 0, 882 882 "date": "2023-05-22T09:57:39.562Z", 883 883 "description": "string", 884 884 "additionalInfo": "string" 885 - } 886 - ] 887 887 1205 +((( 888 888 } 1207 + ], 1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 889 889 ))) 890 890 1212 +((( 1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1214 +} 1215 + 1216 +))) 1217 +))) 1218 + 891 891 (% style="text-align:left" %) 892 892 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 893 893 ... ... @@ -894,6 +894,75 @@ 894 894 (% style="text-align:left" %) 895 895 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 896 896 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 + 897 897 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 898 898 899 899 (% class="box successmessage" %) ... ... @@ -913,6 +913,11 @@ 913 913 914 914 (% style="color:#000000" %){ 915 915 1313 + 1314 +((( 1315 + "vehicleId": 0, ~/~/ ID ТС 1316 +))) 1317 + 916 916 "parentId": "" , ~/~/ ID клиента 917 917 "name": "" , ~/~/ имя ТС 918 918 "imei": "" , ~/~/ IMEI ... ... @@ -933,7 +933,6 @@ 933 933 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 934 934 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 935 935 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 936 - 937 937 "mileageCalcMethod": 0, 938 938 "mileageCoeff": 0, 939 939 "locationByCellId": true, ... ... @@ -966,7 +966,6 @@ 966 966 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 967 967 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 968 968 } 969 - 970 970 "drivers": [ ~/~/ Водители 971 971 { 972 972 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -981,8 +981,7 @@ 981 981 "retries": 0 982 982 } 983 983 ], 984 - 985 - "sensors": [ ~/~/ Датчики 1384 +"sensors": [ ~/~/ Датчики 986 986 { 987 987 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 988 988 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1008,6 +1008,7 @@ 1008 1008 ], 1009 1009 "showInTooltip": true, ~/~/ Отображать в подсказке 1010 1010 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1011 1011 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1012 1012 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1013 1013 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1020,103 +1020,293 @@ 1020 1020 "additionalProp2": "string", 1021 1021 "additionalProp3": "string" 1022 1022 }, 1023 - 1024 1024 ~/~/ Характерные для произвольного: 1025 - 1026 1026 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1027 - 1028 1028 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1029 - 1030 1030 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1031 - 1032 1032 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1033 - 1034 1034 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1035 - 1036 1036 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1037 - 1038 1038 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1039 - 1040 1040 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1041 - 1042 1042 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1043 - 1044 1044 ~/~/ "ValueOn": "Вкл.", 1045 - 1046 1046 ~/~/ "ValueOff": "Выкл." 1047 - "summaryMaxValue": 0 ~/~/ Макс. значение 1435 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1436 + 1437 +((( 1438 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1439 + { 1440 + "from": 0, ~/~/ С какого значения 1441 + "color": "string", ~/~/ Каким цветом 1442 + "text": "string" ~/~/ Текст подписи к этому интервалу 1443 + } 1444 + ] 1048 1048 } 1049 1049 ], 1447 +))) 1448 + 1449 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1450 + 1451 + 1050 1050 "customFields": [ ~/~/ Произвольные поля 1051 1051 { 1052 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1053 - "name": "string", 1054 - "value": "string", 1055 - "forClient": true, 1056 - "forTooltip": true, 1057 - "forReport": true 1058 - } 1059 - ] 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 - По датчику относительных Моточасов 1060 1060 } 1470 +))) 1061 1061 1472 + 1062 1062 (% style="color:#000000" %)Ответ: 1063 1063 1064 -(% style="color:#000000" %){ 1065 1065 1066 - "vehicleId": "", ~/~/ID ТС 1067 - "parentId": "", ~/~/Guid владельца ТС 1068 - "name": "", ~/~/Имя объекта 1069 - "imei": "", ~/~/IMEI 1070 - "deviceTypeId": "", ~/~/ID типа устройства 1071 - "modelId": "", ~/~/ID модели 1072 - "unitId": "", ~/~/ID подразделения 1073 - "sim1": "", ~/~/SIM1 1074 - "sim2": "", ~/~/SIM2 1075 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1076 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1077 - "counters": { ~/~/Счётчики 1078 - "mileageEnabled": true, 1079 - "motohoursEnabled": true, 1080 - "mileage": "", 1081 - "motohours": 345.0 1082 - }, 1083 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1084 - "id": null, 1085 - "enabled": true, ~/~/флаг включения 1086 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1087 - "login": "", ~/~/ имя учетной записи 1088 - "password": "" ~/~/ пароль учетной записи 1089 - }, 1090 - "inspectionTasks": { ~/~/ задания на ТО 1091 - "id": "", ~/~/ ID задачи 1092 - "enabled": false, ~/~/ Признак включения 1093 - "name": "", ~/~/ Имя задания 1094 - "description": "", ~/~/ Описание задания 1095 - "mileageCondition": "", ~/~/ Условие по пробегу 1096 - "lastMileage": "", ~/~/ Пробег (в метрах) 1097 - "motohoursCondition": "", ~/~/ Условие по моточасам 1098 - "lastMotohours": "", ~/~/ Моточасы 1099 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1100 - "kind": "", ~/~/ Вид периодичности по времени 1101 - "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 ~/~/ Условие по количеству записей для деактивации 1102 1102 } 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 +))) 1103 1103 1104 -(% style="text-align:left" %) 1105 -(% 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 +))) 1106 1106 1624 + 1107 1107 **Валидация:** 1108 1108 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1109 1109 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1110 1110 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1111 1111 1112 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1113 1113 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 + 1114 1114 (% class="box infomessage" %) 1115 1115 ((( 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 +((( 1116 1116 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1117 1117 ))) 1118 1118 1119 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1709 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1120 1120 1121 1121 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1122 1122 ... ... @@ -1150,9 +1150,12 @@ 1150 1150 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1151 1151 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1152 1152 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1153 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1154 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1155 - "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" ~/~/ Идентификатор агента, для которого надо получить данные 1156 1156 } 1157 1157 1158 1158 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1159,8 +1159,14 @@ 1159 1159 1160 1160 (% style="color:#000000" %)Ответ: 1161 1161 1162 -(% style="color:#000000" %){ 1755 +(% style="color:#000000" %)[ 1756 +{ 1163 1163 1758 +((( 1759 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1760 +))) 1761 + 1762 +((( 1164 1164 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1165 1165 "name": "" ~/~/ наименование объекта 1166 1166 "imei": "" ~/~/ IMEI объекта ... ... @@ -1186,9 +1186,21 @@ 1186 1186 "forClient": true, ~/~/ право на отображение у клиента 1187 1187 "forTooltip": false, ~/~/ право на отображение в подсказке 1188 1188 "forReport": false ~/~/ право на отображение в отчетах 1189 - }(%%) 1190 -(% style="color:#000000" %)} 1788 +))) 1191 1191 1790 +((( 1791 + } 1792 + ], 1793 + "vehicleGroups": [ ~/~/ Группы ТС 1794 + { 1795 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1796 + "name": "string" ~/~/ Наименование группы ТС 1797 + } 1798 + ] 1799 + } 1800 +] 1801 +))) 1802 + 1192 1192 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1193 1193 1194 1194 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1220,13 +1220,11 @@ 1220 1220 "data": "", ~/~/ Данные 1221 1221 "overwrite": false, ~/~/ Флаг перезаписи 1222 1222 "stage": "", ~/~/ Состояние, может быть null 1223 - 1224 1224 (% style="color:#000000" %)} 1225 1225 1226 1226 (% style="color:#000000" %)Ответ: 1227 1227 1228 -(% style="color:#000000" %){ 1229 - 1838 +(% style="color:#000000" %){(%%) 1230 1230 "status": "", ~/~/ значение статуса 1231 1231 "date": "", ~/~/ Дата смены статуса 1232 1232 "description": "", ~/~/ Описание ... ... @@ -1233,10 +1233,10 @@ 1233 1233 "data": "", ~/~/ Данные 1234 1234 "overwrite": false, ~/~/ Флаг перезаписи 1235 1235 "stage": "", ~/~/ Состояние 1236 - 1237 -(% style="text-align:left" %) 1238 1238 (% style="color:#000000" %) } 1239 1239 1847 +== == 1848 + 1240 1240 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1241 1241 1242 1242 (% class="box warningmessage" %) ... ... @@ -1255,7 +1255,7 @@ 1255 1255 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1256 1256 1257 1257 (% style="color:#000000" %){ 1258 - 1867 + "vehicleId": , ~/~/ ID объекта 1259 1259 "parentId": "" , ~/~/ ID клиента 1260 1260 "name": "" , ~/~/ имя ТС 1261 1261 "imei": "" , ~/~/ IMEI ... ... @@ -1312,9 +1312,19 @@ 1312 1312 1313 1313 "drivers": [ ~/~/ Водители 1314 1314 { 1315 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1316 - "isDefault": true 1317 - } 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" ~/~/ Момент времени окончания назначения. 1934 +))) 1935 + 1936 + } 1318 1318 ], 1319 1319 "commandTemplates": [ ~/~/ Шаблон команды 1320 1320 { ... ... @@ -1324,8 +1324,7 @@ 1324 1324 "retries": 0 1325 1325 } 1326 1326 ], 1327 - 1328 - "sensors": [ ~/~/ Датчики 1946 +"sensors": [ ~/~/ Датчики 1329 1329 { 1330 1330 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1331 1331 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1351,6 +1351,11 @@ 1351 1351 ], 1352 1352 "showInTooltip": true, ~/~/ Отображать в подсказке 1353 1353 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1972 + 1973 +((( 1974 + "color": "string",** ~/~/ **Цвет датчика 1975 +))) 1976 + 1354 1354 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1355 1355 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1356 1356 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1363,95 +1363,225 @@ 1363 1363 "additionalProp2": "string", 1364 1364 "additionalProp3": "string" 1365 1365 }, 1366 - 1367 1367 ~/~/ Характерные для произвольного: 1368 - 1369 1369 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1370 - 1371 1371 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1372 - 1373 1373 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1374 - 1375 1375 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1376 - 1377 1377 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1378 - 1379 1379 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1380 - 1381 1381 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1382 - 1383 1383 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1384 - 1385 1385 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1386 - 1387 1387 ~/~/ "ValueOn": "Вкл.", 1388 - 1389 1389 ~/~/ "ValueOff": "Выкл." 1390 1390 "summaryMaxValue": 0 ~/~/ Макс. значение 2002 + 2003 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2004 + { 2005 + "from": 0, ~/~/ С какого значения 2006 + "color": "string", ~/~/ Каким цветом 2007 + "text": "string" ~/~/ Текст подписи к этому интервалу 2008 + } 2009 + ] 1391 1391 } 1392 1392 ], 2012 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2013 + 1393 1393 "customFields": [ ~/~/ Произвольные поля 1394 - { 1395 - 1396 - "name": "string", 1397 - "value": "string", 1398 - "forClient": true, 1399 - "forTooltip": true, 1400 - "forReport": true 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 ~/~/ Отобразить произвольное поле в отчете 1401 1401 } 1402 - ] 2023 + 2024 +((( 2025 + ], 2026 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 2027 +))) 2028 + 1403 1403 } 1404 1404 2031 + 1405 1405 (% style="color:#000000" %)Ответ: 1406 1406 1407 -(% lang="en-US" style="text-align:left" %) 1408 -(% 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 +))) 1409 1409 1410 -(% lang="en-US" style="text-align:left" %) 1411 - "vehicleId": "", ~/~/ ID ТС 1412 - "parentId": "", ~/~/ ID клиента 1413 - "name": "", ~/~/ имя ТС 1414 - "imei": "", ~/~/ IMEI 1415 - "deviceTypeId": "", ~/~/ типа устройства 1416 - "modelId": "", ~/~/ ID модели 1417 - "unitId": "", ~/~/ ID подразделения 1418 - "sim1": "", ~/~/ SIM 1 1419 - "sim2": "", ~/~/ SIM2 1420 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1421 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1422 - "counters": 1423 - { 1424 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1425 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1426 - "mileage": "", ~/~/ пробег 1427 - "motohours": "", ~/~/ моточасы 1428 - } 1429 - "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": [ ~/~/ Тарировка 1430 1430 { 1431 - "id": ~/~/ идентификатор 1432 - "enabled": true, ~/~/ флаг включения 1433 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1434 - "login": "", ~/~/ имя учетной записи 1435 - "password": "", ~/~/ пароль учетной записи 1436 - } 1437 - "inspectionTasks": ~/~/ задания на ТО 1438 - { 1439 - "id": "", ~/~/ ID задания 1440 - "enabled": false, ~/~/ Признак включения 1441 - "name": "", ~/~/ Имя задания 1442 - "description": "", ~/~/ Описание задания 1443 - "mileageCondition": "", ~/~/ Условие по пробегу 1444 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1445 - "motohoursCondition": "", ~/~/ Условие по моточасам 1446 - "lastMotohours": "", ~/~/ Моточасы 1447 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1448 - "kind": "", ~/~/ Вид периодичности по времени 1449 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2155 + "grades": [ ~/~/ Таблицы тарировки 2156 + { 2157 + "input": 0, ~/~/ Вход 2158 + "output": 0 ~/~/ Выход 2159 + } 2160 + ], 2161 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1450 1450 } 2163 + ], 2164 + "showInTooltip": true, ~/~/ Отображение в подсказке 2165 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1451 1451 1452 -(% lang="en-US" style="text-align:left" %) 1453 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2167 +((( 2168 + "color": "string", ~/~/ цвет уведомлений 2169 +))) 1454 1454 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 + 1455 1455 **Валидация:** 1456 1456 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1457 1457 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1490,18 +1490,15 @@ 1490 1490 1491 1491 (% style="color:#000000" %)Метод запроса: **GET** 1492 1492 1493 -(% 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]] 1494 1494 1495 1495 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1496 1496 1497 1497 (% style="color:#000000" %)Ответ: 1498 1498 1499 -(% style="color:#000000" %){ 1500 - 2252 +(% style="color:#000000" %){(%%) 1501 1501 "deviceTypeId" : "", ~/~/ ID типа устройства 1502 1502 "deviceTypeName" : "" ~/~/ Название типа устройства 1503 - 1504 -(% style="text-align:left" %) 1505 1505 (% style="color:#000000" %)} 1506 1506 1507 1507 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1523,13 +1523,10 @@ 1523 1523 1524 1524 (% style="color:#000000" %)Ответ: 1525 1525 1526 -(% style="color:#000000" %){ 1527 - 2276 +(% style="color:#000000" %){(%%) 1528 1528 "id": "", ~/~/ ID типа датчика 1529 1529 "name": "", ~/~/ Название 1530 1530 "description": "", ~/~/ Описание 1531 - 1532 -(% style="text-align:left" %) 1533 1533 (% style="color:#000000" %)} 1534 1534 1535 1535 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1573,6 +1573,56 @@ 1573 1573 } 1574 1574 ] 1575 1575 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 + 1576 1576 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1577 1577 1578 1578 (% class="box infomessage" %) ... ... @@ -1597,6 +1597,11 @@ 1597 1597 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1598 1598 } 1599 1599 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 + 1600 1600 Ответ: 1601 1601 1602 1602 [ ... ... @@ -1603,25 +1603,436 @@ 1603 1603 { 1604 1604 "messages": [ 1605 1605 { 1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1608 - "speed": 0, ~/~/ Скорость, км/ч 1609 - "altitude": 0, ~/~/ Высота, м 1610 - "latitude": 0, ~/~/ Широта [-90°;90°] 1611 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1612 - "satellites": 0, ~/~/ Кол-во спутников 1613 - "voltage": 0, ~/~/ Напряжение 1614 - "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": { 1615 1615 "additionalProp1": "string", 1616 1616 "additionalProp2": "string", 1617 1617 "additionalProp3": "string" 1618 1618 }, 1619 - "photoCount": 0 ~/~/ Кол-во фото 2422 + "photoCount": 0, 2423 + "lbsCorrectedCoords": true, 2424 + "protocolType": 0 1620 1620 } 1621 1621 ] 1622 1622 } 1623 1623 ] 1624 1624 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 + 2809 + 2810 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2811 + 2812 +(% class="box successmessage" %) 2813 +((( 2814 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2815 +))) 2816 + 2817 +(% style="color:#000000" %)Метод запроса: **PUT** 2818 + 2819 +Пример запроса: 2820 + 2821 +((( 2822 +{ 2823 + "id": 0, ~/~/ Идентификатор объекта геозоны 2824 + "name": "string", ~/~/ Наименование объекта геозоны 2825 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2826 + "description": "string", ~/~/ Описание объекта геозоны 2827 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2828 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2829 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2830 +} 2831 +))) 2832 + 2833 + 2834 +Пример ответа: 2835 + 2836 +200 ~/~/ Success 2837 + 1625 1625 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1626 1626 1627 1627 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -1801,6 +1801,32 @@ 1801 1801 1802 1802 Success 1803 1803 3017 + 3018 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 3019 + 3020 +(% class="box warningmessage" %) 3021 +((( 3022 +**PUT** /api/v3/notifications/prolongation 3023 +))) 3024 + 3025 +Метод позволяет продлить уведомления. 3026 + 3027 +Метод запроса **PUT** 3028 + 3029 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 3030 + 3031 +В заголовках запроса: X-Auth: Токен авторизации. 3032 + 3033 +Тело запроса: 3034 + 3035 +[ 3036 + 3037 +0 3038 + 3039 +] 3040 + 3041 +где 0 идентификатор ids. 3042 + 1804 1804 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1805 1805 1806 1806 (% class="box errormessage" %) ... ... @@ -1827,7 +1827,10 @@ 1827 1827 1828 1828 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 1829 1829 1830 -POST /api/v3/Drivers/find 3069 +(% class="box infomessage" %) 3070 +((( 3071 +**POST /api/v3/Drivers/find** 3072 +))) 1831 1831 1832 1832 Передается параметр: parentId - ID клиента-родителя 1833 1833 ... ... @@ -1835,20 +1835,23 @@ 1835 1835 1836 1836 [ 1837 1837 { 1838 - "name": "string", //Определяет наименование 1839 - "description": "string", // Определяет описание 1840 - "hiredate": "2023-06-30T09:37:58.407Z", // Определяет дату найма 1841 - "chopdate": "2023-06-30T09:37:58.407Z", // Определяет дату увольнения 1842 - "exclusive": true, // Определяет признак "Исключительный" 1843 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя 1844 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя 1845 - "deleted": true // Признак удаления 3080 + "name": "string", ~/~/ Определяет наименование 3081 + "description": "string", ~/~/ Определяет описание 3082 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 3083 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 3084 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3085 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3086 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3087 + "deleted": true ~/~/ Признак удаления 1846 1846 } 1847 1847 ] 1848 1848 1849 1849 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 1850 1850 1851 -GET /api/v3/Drivers/{driverGuid} 3093 +(% class="box infomessage" %) 3094 +((( 3095 +**GET /api/v3/Drivers/{driverGuid}** 3096 +))) 1852 1852 1853 1853 Передается параметр: ID водителя 1854 1854 ... ... @@ -1855,19 +1855,22 @@ 1855 1855 Ответ: 1856 1856 1857 1857 { 1858 - "name": "string", // Определяет наименование 1859 - "description": "string", // Определяет описание 1860 - "hiredate": "2023-06-30T09:33:33.083Z", // Определяет дату найма 1861 - "chopdate": "2023-06-30T09:33:33.083Z", // Определяет дату увольнения 1862 - "exclusive": true, // Определяет признак "Исключительный" 1863 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя 1864 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя 1865 - "deleted": true // Признак удаления 3103 + "name": "string", ~/~/ Определяет наименование 3104 + "description": "string", ~/~/ Определяет описание 3105 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 3106 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 3107 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3108 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3109 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3110 + "deleted": true ~/~/ Признак удаления 1866 1866 } 1867 1867 1868 1868 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 1869 1869 1870 -POST /api/v3/Drivers 3115 +(% class="box successmessage" %) 3116 +((( 3117 +**POST /api/v3/Drivers** 3118 +))) 1871 1871 1872 1872 Запрос: 1873 1873 ... ... @@ -1898,7 +1898,10 @@ 1898 1898 1899 1899 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 1900 1900 1901 -PUT /api/v3/Drivers 3149 +(% class="box warningmessage" %) 3150 +((( 3151 +**PUT /api/v3/Drivers** 3152 +))) 1902 1902 1903 1903 Запрос: 1904 1904 ... ... @@ -1929,7 +1929,10 @@ 1929 1929 1930 1930 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 1931 1931 1932 -DELETE /api/v3/Drivers/{driverGuid} 3183 +(% class="box errormessage" %) 3184 +((( 3185 +**DELETE /api/v3/Drivers/{driverGuid}** 3186 +))) 1933 1933 1934 1934 Передается параметр: ID водителя 1935 1935 ... ... @@ -1944,7 +1944,10 @@ 1944 1944 1945 1945 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 1946 1946 1947 -POST /api/v3/DriversVehiclesAssignments/GetByDrivers 3201 +(% class="box infomessage" %) 3202 +((( 3203 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3204 +))) 1948 1948 1949 1949 Запрос: 1950 1950 ... ... @@ -1972,7 +1972,10 @@ 1972 1972 1973 1973 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 1974 1974 1975 -POST /api/v3/DriversVehiclesAssignments/GetByVehicles 3232 +(% class="box infomessage" %) 3233 +((( 3234 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3235 +))) 1976 1976 1977 1977 Запрос: 1978 1978 ... ... @@ -2000,7 +2000,10 @@ 2000 2000 2001 2001 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 2002 2002 2003 -POST /api/v3/DriversVehiclesAssignments 3263 +(% class="box successmessage" %) 3264 +((( 3265 +**POST /api/v3/DriversVehiclesAssignments** 3266 +))) 2004 2004 2005 2005 Передается массив назначений 2006 2006 ... ... @@ -2008,11 +2008,11 @@ 2008 2008 2009 2009 [ 2010 2010 { 2011 - "VehicleId": 0, // Идентификатор объекта 2012 - "CreateTime": "2023-06-30T11:04:46.902Z", // Момент времени создания назначения 2013 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя 2014 - "BeginTime": "2023-06-30T11:04:46.902Z", // Момент времени начала назначения 2015 - "EndTime": "2023-06-30T11:04:46.902Z" // Момент времени окончания назначения. Необязательно. 3274 + "VehicleId": 0, ~/~/ Идентификатор объекта 3275 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3276 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3277 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3278 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 2016 2016 } 2017 2017 ] 2018 2018 ... ... @@ -2032,7 +2032,10 @@ 2032 2032 2033 2033 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 2034 2034 2035 -PUT /api/v3/DriversVehiclesAssignments 3298 +(% class="box warningmessage" %) 3299 +((( 3300 +**PUT /api/v3/DriversVehiclesAssignments** 3301 +))) 2036 2036 2037 2037 Запрос: 2038 2038 ... ... @@ -2040,7 +2040,7 @@ 2040 2040 { 2041 2041 "VehicleId": 0, 2042 2042 "CreateTime": "2023-06-30T11:14:08.117Z", 2043 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения 3309 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 2044 2044 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2045 2045 "BeginTime": "2023-06-30T11:14:08.117Z", 2046 2046 "EndTime": "2023-06-30T11:14:08.117Z" ... ... @@ -2063,33 +2063,20 @@ 2063 2063 2064 2064 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2065 2065 2066 -DELETE /api/v3/DriversVehiclesAssignments 3332 +(% class="box errormessage" %) 3333 +((( 3334 +**DELETE /api/v3/DriversVehiclesAssignments** 3335 +))) 2067 2067 2068 2068 Запрос: 2069 2069 2070 2070 [ 2071 - { 2072 - "VehicleId": 0, 2073 - "CreateTime": "2023-06-30T11:16:08.341Z", 2074 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2075 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2076 - "BeginTime": "2023-06-30T11:16:08.342Z", 2077 - "EndTime": "2023-06-30T11:16:08.342Z" 2078 - } 3340 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2079 2079 ] 2080 2080 2081 2081 Ответ: 2082 2082 2083 -[ 2084 - { 2085 - "VehicleId": 0, 2086 - "CreateTime": "2023-06-30T11:16:08.344Z", 2087 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2088 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2089 - "BeginTime": "2023-06-30T11:16:08.344Z", 2090 - "EndTime": "2023-06-30T11:16:08.344Z" 2091 - } 2092 -] 3345 +Success 2093 2093 2094 2094 2095 2095 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == ... ... @@ -2096,7 +2096,10 @@ 2096 2096 2097 2097 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2098 2098 2099 -POST /api/v3/DriversRfidsAssignments/GetByDrivers 3352 +(% class="box infomessage" %) 3353 +((( 3354 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3355 +))) 2100 2100 2101 2101 Запрос: 2102 2102 ... ... @@ -2112,9 +2112,9 @@ 2112 2112 2113 2113 [ 2114 2114 { 2115 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки 2116 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения 2117 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя 3371 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3372 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3373 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2118 2118 "BeginTime": "2023-06-30T11:19:40.703Z", 2119 2119 "EndTime": "2023-06-30T11:19:40.703Z" 2120 2120 } ... ... @@ -2123,7 +2123,10 @@ 2123 2123 2124 2124 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2125 2125 2126 -POST /api/v3/DriversRfidsAssignments/GetByRfids 3382 +(% class="box infomessage" %) 3383 +((( 3384 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3385 +))) 2127 2127 2128 2128 Запрос: 2129 2129 ... ... @@ -2139,9 +2139,9 @@ 2139 2139 2140 2140 [ 2141 2141 { 2142 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки 2143 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения 2144 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя 3401 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3402 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3403 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2145 2145 "BeginTime": "2023-06-30T11:19:40.703Z", 2146 2146 "EndTime": "2023-06-30T11:19:40.703Z" 2147 2147 } ... ... @@ -2150,7 +2150,10 @@ 2150 2150 2151 2151 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2152 2152 2153 -POST /api/v3/DriversRfidsAssignments 3412 +(% class="box successmessage" %) 3413 +((( 3414 +**POST /api/v3/DriversRfidsAssignments** 3415 +))) 2154 2154 2155 2155 Запрос: 2156 2156 ... ... @@ -2178,7 +2178,10 @@ 2178 2178 2179 2179 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2180 2180 2181 -PUT /api/v3/DriversRfidsAssignments 3443 +(% class="box warningmessage" %) 3444 +((( 3445 +**PUT /api/v3/DriversRfidsAssignments** 3446 +))) 2182 2182 2183 2183 Запрос: 2184 2184 ... ... @@ -2207,31 +2207,20 @@ 2207 2207 2208 2208 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2209 2209 2210 -DELETE /api/v3/DriversRfidsAssignments 3475 +(% class="box errormessage" %) 3476 +((( 3477 +**DELETE /api/v3/DriversRfidsAssignments** 3478 +))) 2211 2211 2212 2212 Запрос: 2213 2213 2214 2214 [ 2215 - { 2216 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2217 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2218 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2219 - "BeginTime": "2023-06-30T11:28:43.330Z", 2220 - "EndTime": "2023-06-30T11:28:43.330Z" 2221 - } 3483 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2222 2222 ] 2223 2223 2224 2224 Ответ: 2225 2225 2226 -[ 2227 - { 2228 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2229 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2230 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2231 - "BeginTime": "2023-06-30T11:28:43.331Z", 2232 - "EndTime": "2023-06-30T11:28:43.331Z" 2233 - } 2234 -] 3488 +Success 2235 2235 2236 2236 2237 2237 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == ... ... @@ -2238,7 +2238,10 @@ 2238 2238 2239 2239 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2240 2240 2241 -POST /api/v3/DriversFuelCardsAssignments/GetByDrivers 3495 +(% class="box infomessage" %) 3496 +((( 3497 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3498 +))) 2242 2242 2243 2243 Запрос: 2244 2244 ... ... @@ -2265,7 +2265,10 @@ 2265 2265 2266 2266 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2267 2267 2268 -POST /api/v3/DriversFuelCardsAssignments/GetByCards 3525 +(% class="box infomessage" %) 3526 +((( 3527 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3528 +))) 2269 2269 2270 2270 Запрос: 2271 2271 ... ... @@ -2292,7 +2292,10 @@ 2292 2292 2293 2293 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2294 2294 2295 -POST /api/v3/DriversFuelCardsAssignments 3555 +(% class="box successmessage" %) 3556 +((( 3557 +**POST /api/v3/DriversFuelCardsAssignments** 3558 +))) 2296 2296 2297 2297 Запрос: 2298 2298 ... ... @@ -2320,7 +2320,10 @@ 2320 2320 2321 2321 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2322 2322 2323 -PUT /api/v3/DriversFuelCardsAssignments 3586 +(% class="box warningmessage" %) 3587 +((( 3588 +**PUT /api/v3/DriversFuelCardsAssignments** 3589 +))) 2324 2324 2325 2325 Запрос: 2326 2326 ... ... @@ -2327,9 +2327,10 @@ 2327 2327 [ 2328 2328 { 2329 2329 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3596 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2330 2330 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2331 - "BeginTime": "2023-06-30T12:09:53.1 75Z",2332 - "EndTime": "2023-06-30T12:09:53.1 75Z"3598 + "BeginTime": "2023-06-30T12:09:53.201Z", 3599 + "EndTime": "2023-06-30T12:09:53.201Z" 2333 2333 } 2334 2334 ] 2335 2335 ... ... @@ -2348,42 +2348,112 @@ 2348 2348 2349 2349 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 2350 2350 2351 -DELETE /api/v3/DriversFuelCardsAssignments 3618 +(% class="box errormessage" %) 3619 +((( 3620 +**DELETE /api/v3/DriversFuelCardsAssignments** 3621 +))) 2352 2352 2353 2353 Запрос: 2354 2354 2355 2355 [ 2356 - { 2357 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2358 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2359 - "BeginTime": "2023-06-30T12:09:53.175Z", 2360 - "EndTime": "2023-06-30T12:09:53.175Z" 2361 - } 3626 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2362 2362 ] 2363 2363 2364 2364 Ответ: 2365 2365 3631 +Success 3632 + 3633 + 3634 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3635 + 3636 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3637 + 3638 +(% class="box infomessage" %) 3639 +((( 3640 +**POST /api/v3/Trailers** 3641 +))) 3642 + 3643 +Пример запроса: 3644 + 3645 +{ 3646 + "startDate": "2023-11-14T10:48:03.671Z", 3647 + "endDate": "2023-11-14T10:48:03.671Z", 3648 + "ids": [ 0 ], 3649 + "timezone": 0 3650 +} 3651 + 3652 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3653 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3654 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3655 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3656 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3657 + 3658 +Пример ответа: 3659 + 2366 2366 [ 2367 2367 { 2368 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2369 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2370 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2371 - "BeginTime": "2023-06-30T12:09:53.201Z", 2372 - "EndTime": "2023-06-30T12:09:53.201Z" 3662 + "SD": "2023-11-14T10:48:03.717Z", 3663 + "ED": "2023-11-14T10:48:03.717Z", 3664 + "id": 0, 3665 + "SLat": 0, 3666 + "SLon": 0, 3667 + "ELat": 0, 3668 + "ELon": 0, 3669 + "mileage": 0 3670 + "Duration": 0 3671 + "Address": "string", 3672 + "Address2": "string", 3673 + "name": "string", 3674 + "rid": "string", 3675 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3676 + "trailer": { 3677 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3678 + "Number": "string", 3679 + "Description": "string", 3680 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3681 + "ExternalID": "string", 3682 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3683 + "CreateTime": "2023-11-14T10:48:03.717Z", 3684 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3685 + "IsDeleted": true 3686 + }, 3687 + "filesCount": 0, 2373 2373 } 2374 2374 ] 2375 2375 3691 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3692 +|SD|Дата и время начала события 3693 +|ED|Дата и время окончания события 3694 +|id|ID объекта 3695 +|SLat|Широта начальной координаты 3696 +|SLon|Долгота начальной координаты 3697 +|ELat|Широта конечной координаты 3698 +|ELon|Долгота конечной координаты 3699 +|mileage|Пробег 3700 +|Duration|Продолжительность 3701 +|Address|Адрес начального местоположения 3702 +|Address2|Адрес конечного местоположения 3703 +|name|Имя радиометки 3704 +|rid|Номер радиометки 3705 +|rguid|ID радиометки 3706 +|trailer|Информация об агрегате 3707 +|ModelGuid|ID агрегата 3708 +|Number|Название/номер агрегата 3709 +|Description|Текст примечания агрегата 2376 2376 2377 2377 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2378 2378 2379 2379 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 2380 2380 2381 -POST /api/v3/Rfids/find 3715 +(% class="box infomessage" %) 3716 +((( 3717 +**POST /api/v3/Rfids/find** 3718 +))) 2382 2382 2383 2383 Запрос: 2384 2384 2385 -{ 2386 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3722 +{ 3723 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2387 2387 } 2388 2388 2389 2389 Ответ: ... ... @@ -2392,17 +2392,25 @@ 2392 2392 { 2393 2393 "name": "string", 2394 2394 "number": 0, 2395 - "period": 0, // Частота трансляции радиометки3732 + "period": 0, 2396 2396 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2397 2397 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2398 - "deleted": true 2399 2399 } 2400 2400 ] 2401 2401 3738 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3739 +|parentId|ID клиента 3740 +|name|Название карты-метки 3741 +|number|Номер 3742 +|period|Период запросов в секундах (работает только для агрегатов) 3743 +|id|ID карты-метки 2402 2402 2403 2403 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2404 2404 2405 -GET /api/v3/Rfids/{rfidGuid} 3747 +(% class="box infomessage" %) 3748 +((( 3749 +**GET /api/v3/Rfids/{rfidGuid}** 3750 +))) 2406 2406 2407 2407 Передаем параметр rfidGuid - идентификатор карты-метки 2408 2408 ... ... @@ -2412,17 +2412,25 @@ 2412 2412 { 2413 2413 "name": "string", 2414 2414 "number": 0, 2415 - "period": 0, // Частота трансляции радиометки3760 + "period": 0, 2416 2416 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2417 2417 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2418 - "deleted": true 2419 2419 } 2420 2420 ] 2421 2421 3766 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3767 +|name|Название карты-метки 3768 +|number|Номер 3769 +|period|Период запросов в секундах (работает только для агрегатов) 3770 +|id|ID карты-метки 3771 +|parentId|ID клиента 2422 2422 2423 2423 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2424 2424 2425 -POST /api/v3/Rfids 3775 +(% class="box successmessage" %) 3776 +((( 3777 +**POST /api/v3/Rfids** 3778 +))) 2426 2426 2427 2427 Запрос: 2428 2428 ... ... @@ -2431,7 +2431,6 @@ 2431 2431 "number": 0, 2432 2432 "period": 0, 2433 2433 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2434 - "deleted": true 2435 2435 } 2436 2436 2437 2437 Ответ: ... ... @@ -2442,13 +2442,21 @@ 2442 2442 "period": 0, 2443 2443 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2444 2444 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2445 - "deleted": true 2446 2446 } 2447 2447 3799 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3800 +|name|Название карты-метки 3801 +|number|Номер 3802 +|period|Период запросов в секундах (работает только для агрегатов) 3803 +|id|ID карты-метки 3804 +|parentId|ID клиента 2448 2448 2449 2449 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2450 2450 2451 -PUT /api/v3/Rfids 3808 +(% class="box warningmessage" %) 3809 +((( 3810 +**PUT /api/v3/Rfids** 3811 +))) 2452 2452 2453 2453 Запрос: 2454 2454 ... ... @@ -2458,7 +2458,6 @@ 2458 2458 "period": 0, 2459 2459 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2460 2460 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2461 - "deleted": true 2462 2462 } 2463 2463 2464 2464 Ответ: ... ... @@ -2469,15 +2469,23 @@ 2469 2469 "period": 0, 2470 2470 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2471 2471 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2472 - "deleted": true 2473 2473 } 2474 2474 3833 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3834 +|name|Название карты-метки 3835 +|number|Номер 3836 +|period|Период запросов в секундах (работает только для агрегатов) 3837 +|id|ID карты-метки 3838 +|parentId|ID клиента 2475 2475 2476 2476 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2477 2477 3842 +(% class="box errormessage" %) 3843 +((( 2478 2478 **DELETE /api/v3/Rfids/{rfidGuid}** 3845 +))) 2479 2479 2480 -Передаем параметр rfidGuid - идентификатор карты-метки 3847 +Передаем параметр **rfidGuid** - идентификатор карты-метки 2481 2481 2482 2482 Ответ: 2483 2483 ... ... @@ -2484,6 +2484,2386 @@ 2484 2484 Success 2485 2485 2486 2486 3854 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3855 + 3856 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3857 + 3858 +(% class="box infomessage" %) 3859 +((( 3860 +**GET /api/v3/Billing/client/balance/{clientId}** 3861 +))) 3862 + 3863 +Параметр запроса: **clientId **- идентификатор клиента. 3864 + 3865 +Ответ: 3866 + 3867 +{ 3868 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3869 + "Balance": 0 3870 +} 3871 + 3872 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3873 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3874 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3875 + 3876 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3877 + 3878 +(% class="box infomessage" %) 3879 +((( 3880 +**GET /api/v3/Billing/client/constraint/{clientId}** 3881 +))) 3882 + 3883 +Параметр запроса: **clientId **- идентификатор клиента. 3884 + 3885 +Ответ: 3886 + 3887 +{ 3888 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3889 + "CalculationType": 0, 3890 + "PermissibleBalance": 0, 3891 + "DefermentDays": 0, 3892 + "SendUiNotifications": true, 3893 + "SendEmailNotifications": true, 3894 + "IsPrivate": true, 3895 +} 3896 + 3897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3898 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3899 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3900 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3901 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3902 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3903 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3904 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3905 + 3906 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3907 + 3908 +(% class="box infomessage" %) 3909 +((( 3910 +**GET /api/v3/Billing/client/plan/{clientId}** 3911 +))) 3912 + 3913 +Параметры запроса: 3914 + 3915 +**clientId **- идентификатор клиента. 3916 + 3917 +**planId **- идентификатор тарифного плана. 3918 + 3919 +Ответ: 3920 + 3921 +{ 3922 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3923 + "Plan": { **~/~/ Описание тарифного плана** 3924 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3925 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3926 + "Name": "string", 3927 + "IsArchived": true, 3928 + "Constraint": { 3929 + "CalculationType": 0, 3930 + "PermissibleBalance": 0, 3931 + "DefermentDays": 0 3932 + }, 3933 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3934 + { 3935 + "Feature": "string", 3936 + "IsFactual": true, 3937 + "Limit": 0, 3938 + "Price": 0, 3939 + "PeriodValue": 0, 3940 + "PeriodType": 0 3941 + } 3942 + ] 3943 + }, 3944 + "DebitDate": "2023-10-18T12:46:24.213Z", 3945 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3946 + { 3947 + "Feature": "string", 3948 + "IsEnabled": true, 3949 + "IsPrivate": true, 3950 + "IsFactual": true, 3951 + "Limit": 0, 3952 + "Price": 0, 3953 + "DebitDate": "2023-10-18T12:46:24.213Z", 3954 + "PeriodValue": 0, 3955 + "PeriodType": 0 3956 + } 3957 + ] 3958 +} 3959 + 3960 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3961 +|ClientId|Идентификатор клиента 3962 +|Id|Идентификатор тарифного плана 3963 +|OwnerId|Идентификатор клиента-владельца 3964 +|Name|Наименование тарифного плана 3965 +|IsArchived|Признак, определяющий архивный тарифный план 3966 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3967 +|PermissibleBalance|Допустимый баланс 3968 +|DefermentDays|Отсрочка, количество дней 3969 +|Feature|Код услуги 3970 +|IsEnabled|Признак, определяющий активирована ли услуга 3971 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3972 +|IsFactual|Признак, определяющий расчёт по факту 3973 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3974 +|Price|Цена за единицу. 3975 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3976 +|PeriodValue|Значение периода. 3977 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3978 + 3979 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3980 + 3981 +(% class="box infomessage" %) 3982 +((( 3983 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3984 +))) 3985 + 3986 +Параметр запроса: **clientId **- идентификатор клиента. 3987 + 3988 +Ответ: 3989 + 3990 +[ 3991 + { 3992 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3993 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3994 + "Name": "string", 3995 + "IsArchived": true, 3996 + "Constraint": { 3997 + "CalculationType": 0, 3998 + "PermissibleBalance": 0, 3999 + "DefermentDays": 0 4000 + }, 4001 + "Features": [ 4002 + { 4003 + "Feature": "string", 4004 + "IsFactual": true, 4005 + "Limit": 0, 4006 + "Price": 0, 4007 + "PeriodValue": 0, 4008 + "PeriodType": 0 4009 + } 4010 + ] 4011 + } 4012 +] 4013 + 4014 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4015 +|ClientId|Идентификатор клиента 4016 +|Id|Идентификатор тарифного плана 4017 +|OwnerId|Идентификатор клиента-владельца 4018 +|Name|Наименование тарифного плана 4019 +|IsArchived|Признак, определяющий архивный тарифный план 4020 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4021 +|PermissibleBalance|Допустимый баланс 4022 +|DefermentDays|Отсрочка, количество дней 4023 +|Feature|Код услуги 4024 +|IsFactual|Признак, определяющий расчёт по факту 4025 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4026 +|Price|Цена за единицу. 4027 +|PeriodValue|Значение периода. 4028 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4029 + 4030 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 4031 + 4032 +(% class="box infomessage" %) 4033 +((( 4034 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 4035 +))) 4036 + 4037 +Параметр запроса: **clientId **- идентификатор клиента. 4038 + 4039 +Ответ: 4040 + 4041 +[ 4042 + { 4043 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4044 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4045 + "Name": "string", 4046 + "IsArchived": true, 4047 + "Constraint": { 4048 + "CalculationType": 0, 4049 + "PermissibleBalance": 0, 4050 + "DefermentDays": 0 4051 + }, 4052 + "Features": [ 4053 + { 4054 + "Feature": "string", 4055 + "IsFactual": true, 4056 + "Limit": 0, 4057 + "Price": 0, 4058 + "PeriodValue": 0, 4059 + "PeriodType": 0 4060 + } 4061 + ] 4062 + } 4063 +] 4064 + 4065 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4066 +|ClientId|Идентификатор клиента 4067 +|Id|Идентификатор тарифного плана 4068 +|OwnerId|Идентификатор клиента-владельца 4069 +|Name|Наименование тарифного плана 4070 +|IsArchived|Признак, определяющий архивный тарифный план 4071 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4072 +|PermissibleBalance|Допустимый баланс 4073 +|DefermentDays|Отсрочка, количество дней 4074 +|Feature|Код услуги 4075 +|IsFactual|Признак, определяющий расчёт по факту 4076 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4077 +|Price|Цена за единицу. 4078 +|PeriodValue|Значение периода. 4079 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4080 + 4081 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4082 + 4083 +(% class="box warningmessage" %) 4084 +((( 4085 +**PUT /api/v3/Billing/client/balance** 4086 +))) 4087 + 4088 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4089 + 4090 +Тело запроса: 4091 + 4092 +{ 4093 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4094 + "Balance": 0 4095 +} 4096 + 4097 +Ответ: Success 4098 + 4099 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4100 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4101 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4102 + 4103 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4104 + 4105 +(% class="box warningmessage" %) 4106 +((( 4107 +**PUT /api/v3/billing/client/balance/deposit** 4108 +))) 4109 + 4110 +Создает операцию **Пополнение **с указанной суммой 4111 + 4112 +Тело запроса: 4113 + 4114 +{ 4115 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4116 + "Balance": 0 4117 +} 4118 + 4119 +Ответ: Success 4120 + 4121 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4122 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4123 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4124 + 4125 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4126 + 4127 +Создает операцию **Списание **с указанной суммой 4128 + 4129 +(% class="box warningmessage" %) 4130 +((( 4131 +**PUT /api/v3/billing/client/balance/withdraw** 4132 +))) 4133 + 4134 +Тело запроса: 4135 + 4136 +{ 4137 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4138 + "Balance": 0 4139 +} 4140 + 4141 +Ответ: Success 4142 + 4143 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4144 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4145 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4146 + 4147 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4148 + 4149 +(% class="box warningmessage" %) 4150 +((( 4151 +**PUT /api/v3/Billing/client/constraint** 4152 +))) 4153 + 4154 +Тело запроса: 4155 + 4156 +{ 4157 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4158 + "CalculationType": 0, 4159 + "PermissibleBalance": 0, 4160 + "DefermentDays": 0, 4161 + "SendUiNotifications": true, 4162 + "SendEmailNotifications": true, 4163 + "IsPrivate": true, 4164 +} 4165 + 4166 +Ответ: Success 4167 + 4168 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4169 +|ClientId|Идентификатор клиента 4170 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4171 +|PermissibleBalance|Допустимый баланс 4172 +|DefermentDays|((( 4173 +Отсрочка, количество дней 4174 +))) 4175 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4176 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4177 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4178 + 4179 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4180 + 4181 +(% class="box warningmessage" %) 4182 +((( 4183 +**PUT /api/v3/Billing/client/plan** 4184 +))) 4185 + 4186 +Тело запроса: 4187 + 4188 +{ 4189 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4190 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4191 + "Features": [ 4192 + { 4193 + "Feature": "string", 4194 + "IsEnabled": true, 4195 + "IsFactual": true, 4196 + "Limit": 0, 4197 + "Price": 0, 4198 + "DebitDate": "2023-10-18T13:26:58.987Z", 4199 + "PeriodValue": 0, 4200 + "PeriodType": 0 4201 + } 4202 + ] 4203 +} 4204 + 4205 +Ответ: Success 4206 + 4207 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4208 +|ClientId|Идентификатор клиента 4209 +|PlanId|Идентификатор тарифного плана 4210 +|Feature|Код услуги 4211 +|IsEnabled|Признак, определяющий активирована ли услуга 4212 +|IsFactual|Признак, определяющий расчёт по факту 4213 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4214 +|Price|Цена за единицу. 4215 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4216 +|PeriodValue|Значение периода. 4217 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4218 + 4219 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4220 + 4221 +(% class="box warningmessage" %) 4222 +((( 4223 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4224 +))) 4225 + 4226 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4227 + 4228 +(% class="box infomessage" %) 4229 +((( 4230 +**POST /api/v3/vehicles/import/{agentId}** 4231 +))) 4232 + 4233 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4234 + 4235 +В пути указывается **agentId** - id клиента. 4236 + 4237 +**Заголовок** 4238 + 4239 +**X-Auth: [токен авторизации]** 4240 + 4241 +**Параметры** 4242 + 4243 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4244 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4245 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4246 + 4247 +В теле использовать тип **form-data,** тип значения** file** 4248 + 4249 +**Ключи** 4250 + 4251 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4252 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4253 +|csv|В значении передаем файл датчиков, формат **csv** 4254 + 4255 +Ответ: 4256 + 4257 +{ 4258 + "vehicleId": 0, 4259 + "name": "string", 4260 + "errors": ["string"] 4261 +} 4262 + 4263 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4264 +|vehicleId|ID созданного объекта 4265 +|name|Имя созданного объекта 4266 +|errors|Ошибки и их описание 4267 + 4268 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4269 + 4270 +(% class="box infomessage" %) 4271 +((( 4272 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4273 +))) 4274 + 4275 +(% class="wikigeneratedid" %) 4276 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4277 + 4278 +(% class="wikigeneratedid" %) 4279 +В пути указывается **vehicleId **- id объекта. 4280 + 4281 +**Заголовок** 4282 + 4283 +**X-Auth: [токен авторизации]** 4284 + 4285 +В теле использовать тип **form-data.** 4286 + 4287 +Ключи: 4288 + 4289 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4290 +|**history**|В значении передавать файл с историей 4291 + 4292 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4293 + 4294 +Ответ: 4295 + 4296 +{ 4297 + "results": [ 4298 + { 4299 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4300 + "vehicleId": 0, 4301 + "errors": [ 4302 + "string" 4303 + ], 4304 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4305 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4306 + "producedCount": 0, 4307 + "msgCount": 0 4308 + } 4309 + ] 4310 +} 4311 + 4312 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4313 +|results|Результаты импорта в разрезе ТС 4314 +|vehicleGuid|Guid ТС 4315 +|vehicleId|ID ТС 4316 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4317 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4318 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4319 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4320 +|msgCount|Кол-во обработанных сообщений всего 4321 + 4322 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4323 + 4324 +(% class="box infomessage" %) 4325 +((( 4326 +**GET /api/v3/vehicles/import/history/status** 4327 +))) 4328 + 4329 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4330 + 4331 +Ответ: 4332 + 4333 +{ 4334 + "activity": true, 4335 + "progress": 0, 4336 + "message": "string" 4337 +} 4338 + 4339 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4340 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4341 +|progress|Guid ТС 4342 + 4343 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4344 + 4345 +(% class="box infomessage" %) 4346 +((( 4347 +**POST /api/v3/vehicles/export** 4348 +))) 4349 + 4350 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4351 + 4352 +Тело запроса: 4353 + 4354 +[ 4355 + id 4356 +] 4357 + 4358 +Ответ: Success 200, получаете файлы с настройками. 4359 + 4360 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4361 + 4362 +(% class="box infomessage" %) 4363 +((( 4364 +**POST /api/v3/vehicles/export/history** 4365 +))) 4366 + 4367 +Метод возвращает список сообщений терминала объекта за выбранный период. 4368 + 4369 +Тело запроса: 4370 + 4371 +{ 4372 + "vehicleId": 0, 4373 + "asArchive": true, 4374 + "from": "2023-09-27T12:17:45.973Z", 4375 + "to": "2023-09-27T12:17:45.973Z" 4376 +} 4377 + 4378 +Ответ: 4379 + 4380 +Получаете файл. Сообщение: Code 200/Success 4381 + 4382 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4383 +|vehicleId|ID объекта 4384 +|asArchive|true - Архивировать файл, False - не архивировать 4385 +|from|Дата и время начала запроса 4386 +|to|Дата и время окончания запроса 4387 + 4388 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4389 + 4390 +(% class="box infomessage" %) 4391 +((( 4392 +**GET /api/v3/vehicles/export/history/status** 4393 +))) 4394 + 4395 +Метод возвращает список сообщений терминала объекта за выбранный период. 4396 + 4397 +Ответ: 4398 + 4399 +{ 4400 + "activity": true, 4401 + "progress": 0, 4402 + "message": "string" 4403 +} 4404 + 4405 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4406 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4407 +|progress|Прогресс экспорта, от 0 до 100% 4408 +|message|Текст описывающий статус 4409 + 4410 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4411 + 4412 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4413 + 4414 +(% class="box infomessage" %) 4415 +((( 4416 +**POST /api/v3/EcoDriving/rating** 4417 +))) 4418 + 4419 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4420 + 4421 +Тело запроса: 4422 + 4423 +{ 4424 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4425 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4426 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4427 +} 4428 + 4429 +Ответ: 4430 + 4431 +{ 4432 + "items": [ ~/~/ Список в разрезе ТС 4433 + { 4434 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4435 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4436 + "vehicleId": 0, ~/~/ ID ТС 4437 + "vehicleName": "string", ~/~/ Название ТС 4438 + "vehicleModel": "string", ~/~/ Модель ТС 4439 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4440 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4441 + "totalViolations": 0, ~/~/ Нарушений всего 4442 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4443 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4444 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4445 + "brakingViolations": 0, ~/~/ Нарушений торможения 4446 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4447 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4448 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4449 + }, 4450 + 4451 +((( 4452 + 4453 +))) 4454 + 4455 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4456 + "mileage": 0, ~/~/ Пробег, м 4457 + "tripsCount": 0, ~/~/ Кол-во рейсов 4458 + "trips": [ ~/~/ Информация по рейсу 4459 + { 4460 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4461 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4462 + "violationsCount": 0, ~/~/ Всего нарушений 4463 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4464 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4465 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4466 + "brakingViolations": 0, ~/~/ Нарушений торможения 4467 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4468 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4469 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4470 + }, 4471 + 4472 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4473 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4474 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4475 + "mileage": 0, ~/~/ Пробег, м 4476 + "motohours": 0, ~/~/ Моточасы, секунды 4477 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4478 + "startAddress": "string", ~/~/ Адрес начала рейса 4479 + "endAddress": "string", ~/~/ Адрес конца рейса 4480 + "drivers": [ ~/~/ Список водителей 4481 + { 4482 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4483 + "driverName": "string", ~/~/ФИО водителя 4484 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4485 + } 4486 + ] 4487 + } 4488 + ] 4489 + } 4490 + ] 4491 +} 4492 + 4493 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4494 + 4495 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4496 + 4497 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4498 + 4499 +(% class="box infomessage" %) 4500 +((( 4501 +**POST /api/v3/fuelcards/transactions** 4502 +))) 4503 + 4504 +Метод запроса: POST 4505 + 4506 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4507 +\\В заголовках запроса: X-Auth: Токен авторизации 4508 + 4509 +Параметры в теле запроса (JSON): 4510 + 4511 +{ 4512 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4513 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4514 + "ids": [ 4515 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4516 + ], 4517 + "timezone": 0 ~/~/ Часовой пояс 4518 +} 4519 + 4520 + 4521 +Ответ: 4522 + { 4523 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4524 + "driver": "string", ~/~/ Водители, привязанные к ТК 4525 + "object": "string", ~/~/ Наименование ТС 4526 + "amount": 0, ~/~/ Количество топлива 4527 + "amountDut": 0, ~/~/ Количество по ДУТ 4528 + "amountDiff": 0, ~/~/ Разница, л 4529 + "amountDiffPerc": 0, ~/~/ Разница, % 4530 + "summa": 0, ~/~/ Стоимость, руб 4531 + "serviceName": "string", ~/~/ Тип топлива 4532 + "price": 0, ~/~/ Цена за литр, руб 4533 + "cardName": "string", ~/~/ Наименование ТК 4534 + "cardNum": "string", ~/~/ Номер ТК 4535 + "operator": "string", ~/~/ Оператор ТК 4536 + "address": "string" ~/~/ Адрес АЗС 4537 + } 4538 + 4539 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4540 + 4541 +(% class="box infomessage" %) 4542 +((( 4543 +**GET /api/v3/fuelcards** 4544 +))) 4545 + 4546 +Метод запроса: GET 4547 + 4548 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4549 + 4550 +Ответ: 4551 + 4552 +[ 4553 + { 4554 + "Name": "string", ~/~/ Определяет наименование карты. 4555 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4556 + "Number": "string", ~/~/ Определяет № карты. 4557 + "Enabled": true, ~/~/ Определяет признак активности карты. 4558 + "Description": "string", ~/~/ Определяет описание карты. 4559 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4560 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4561 + "deleted": true ~/~/ Признак удаления 4562 + } 4563 +] 4564 + 4565 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4566 + 4567 + 4568 +== **Получение полных данных о ретрансляторе** == 4569 + 4570 +(% class="box infomessage" %) 4571 +((( 4572 +**GET ** **/api/v3/retranslations/{id}** 4573 +))) 4574 + 4575 +id - Идентификатор ретранслятора 4576 + 4577 + 4578 +Пример ответа: 4579 + 4580 +{ 4581 +"description": "", ~/~/ Поле описания ретранслятора 4582 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4583 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4584 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4585 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4586 +"objects": [ ~/~/ Объекты для ретрансляции 4587 +{ 4588 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4589 +"name": "", ~/~/ Наименование объекта ретрансляции 4590 +"imei": "", ~/~/ IMEI объекта ретрансляции 4591 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4592 +} 4593 + ], 4594 +"id": "", ~/~/ Идентификатор ретранслятора 4595 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4596 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4597 +} 4598 + 4599 + 4600 +== **Удаление данных ретранслятора** == 4601 + 4602 +(% class="box infomessage" %) 4603 +((( 4604 +**DELETE** **/api/v3/retranslations/{id}** 4605 +))) 4606 + 4607 +id - Идентификатор ретранслятора 4608 + 4609 + 4610 +== **Создание ретранслятора** == 4611 + 4612 +(% class="box infomessage" %) 4613 +((( 4614 +**POST ** **/api/v3/retranslations/{id}** 4615 +))) 4616 + 4617 +Запрос: 4618 + 4619 +{ 4620 +"description": "", ~/~/ Поле описания ретранслятора 4621 +"subscriberId": "", ~/~/ Идентификатор подписчика 4622 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4623 +"address": "", ~/~/ Адрес и порт принимающего сервера 4624 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4625 +"objects": [ ~/~/Объекты для ретрансляции 4626 +{ 4627 +"id": "", ~/~/ Идентификатор ретранслятора 4628 +"imei": "", ~/~/ IMEI объекта ретрансляции 4629 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4630 +} 4631 + ] 4632 +} 4633 + 4634 + 4635 +Ответ: 4636 + 4637 +{ 4638 +"description": "", ~/~/ Поле описания ретранслятора 4639 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4640 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4641 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4642 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4643 +"objects": [ ~/~/ Объекты для ретрансляции 4644 +{ 4645 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4646 +"name": "string", ~/~/ Наименование объекта ретрансляции 4647 +"imei": "", ~/~/ IMEI объекта ретрансляции 4648 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4649 +} 4650 + ], 4651 +"id": "", ~/~/ Идентификатор ретранслятора 4652 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4653 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4654 +} 4655 + 4656 + 4657 +== **Редактирование ретранслятора** == 4658 + 4659 +(% class="box infomessage" %) 4660 +((( 4661 +**PUT** **/api/v3/retranslations** 4662 +))) 4663 + 4664 +Пример запроса: 4665 + 4666 +{ 4667 +"id": "", ~/~/ Идентификатор ретранслятора 4668 +"description": "string", ~/~/ Поле описания ретранслятора 4669 +"subscriberId": "", ~/~/ Идентификатор подписчика 4670 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4671 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4672 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4673 +"objects": ~/~/ Объекты для ретрансляции 4674 +[ 4675 +{ 4676 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4677 +"imei": "", ~/~/ IMEI объекта ретрансляции 4678 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4679 +} 4680 + ] 4681 +} 4682 + 4683 + 4684 +Пример ответа: 4685 + 4686 +{ 4687 +"description": "", ~/~/ Поле описания ретранслятора 4688 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4689 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4690 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4691 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4692 +"objects": [ ~/~/ Объекты для ретрансляции 4693 +{ 4694 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4695 +"name": "string", ~/~/ Наименование объекта ретрансляции 4696 +"imei": "", ~/~/ IMEI объекта ретрансляции 4697 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4698 +} 4699 + ], 4700 +"id": "", ~/~/ Идентификатор ретранслятора 4701 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4702 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4703 +} 4704 + 4705 + 4706 +== **Получение списка ретранслятора клиента** == 4707 + 4708 +(% class="box infomessage" %) 4709 +((( 4710 +**POST /api/v3/retranslations/find** 4711 +))) 4712 + 4713 +Пример запроса: 4714 + 4715 +{ 4716 +"id": "", ~/~/ Идентификатор ретранслятора 4717 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4718 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4719 +} 4720 + 4721 +Ответ: 4722 + 4723 +[ 4724 +{ 4725 +"description": "", ~/~/ Поле описания ретранслятора 4726 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4727 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4728 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4729 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4730 +"id": "", ~/~/ Идентификатор ретранслятора 4731 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4732 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4733 +} 4734 +] 4735 + 4736 + 4737 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4738 + 4739 +== **API для отчета по выгрузке комбайнов** == 4740 + 4741 +(% class="box infomessage" %) 4742 +((( 4743 +**POST /api/v3/Reports/harvesterUnloading** 4744 +))) 4745 + 4746 +Пример запроса: 4747 + 4748 +{ 4749 + "byTime": 0, ~/~/ Объединение событий по времени 4750 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4751 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4752 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4753 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4754 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4755 + 0 4756 + ], 4757 + "from": "", ~/~/ Дата и время начало запроса 4758 + "to": "", ~/~/ Дата и время окончания запроса 4759 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4760 +} 4761 + 4762 +Пример ответа: 4763 + 4764 +[ 4765 + { 4766 + "harvesterName": "", ~/~/Комбайн, номер 4767 + "harvesterId": 0, ~/~/Комбайн, id 4768 +"harvesterModel": "", ~/~/ Модель комбайна 4769 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4770 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4771 + "events": [ ~/~/Список событий в разрезе комбайна 4772 + { 4773 + "driverId": "", ~/~/Идентификатор водителя 4774 + "driverName": "", ~/~/Водитель комбайна, ФИО 4775 + "RFID": "", ~/~/ идентификатор карты-метки 4776 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4777 + "vehicleId": 0, ~/~/идентификатор объекта 4778 + "vehicleName": "string", ~/~/ Имя объекта 4779 + "modelName": "string", ~/~/ Имя модели объекта 4780 + "nearestVehicles": [ ~/~/Объекты рядом 4781 + { 4782 + "vehicleId": 0, ~/~/идентификатор объекта 4783 + "vehicleName": "string" ~/~/ Имя объекта 4784 + } 4785 + ], 4786 + "fields": [ ~/~/Поля, где происходила выгрузка 4787 + { 4788 + "id": 0, ~/~/ идентификатор пользователя 4789 + "name": "string" ~/~/ имя пользователя 4790 + } 4791 + ], 4792 + "event": "string", ~/~/Событие 4793 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4794 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4795 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4796 + "cultureName": "string", ~/~/ название культуры 4797 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4798 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4799 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4800 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4801 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4802 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4803 + "issued": 0, ~/~/Выдано, бункеров 4804 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4805 + "latitude": 0, ~/~/Широта 4806 + "longitude": 0, ~/~/ Долгота 4807 + "litresAway": 0, ~/~/Отдано, л 4808 + "m3Away": 0 ~/~/Отдано, м3 4809 + } 4810 + ] 4811 + } 4812 +] 4813 + 4814 + 4815 +== **Отчет трек-датчики** == 4816 + 4817 +(% class="box infomessage" %) 4818 +((( 4819 +**POST /api/v3/Reports/sensorsWorks** 4820 +))) 4821 + 4822 +**Пример запроса:** 4823 + 4824 +{ 4825 + "vehicleIds": [ ~/~/ Список ID объектов 4826 + 0 4827 + ], 4828 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4829 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4830 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4831 +} 4832 + 4833 +**Пример ответа:** 4834 + 4835 +((( 4836 +{ 4837 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4838 + { 4839 + "vehicleId": 0, ~/~/ Идентификатор ТС 4840 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4841 + { 4842 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4843 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4844 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4845 + "name": "string", ~/~/ Наименование оборудования. 4846 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4847 + "totalMileage": 0, ~/~/ Общий пробег. 4848 + "avgSpeed": 0 ~/~/ Средняя скорость. 4849 + } 4850 + ] 4851 + } 4852 + ] 4853 +} 4854 + 4855 + 4856 +== **Превышение скорости** == 4857 + 4858 +(% class="box infomessage" %) 4859 +((( 4860 +**POST /api/v3/Reports/overSpeedDuration** 4861 +))) 4862 + 4863 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4864 + 4865 +Пример запроса: 4866 + 4867 +((( 4868 +{ 4869 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4870 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4871 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4872 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4873 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4874 +} 4875 +))) 4876 + 4877 +((( 4878 + 4879 +))) 4880 + 4881 +((( 4882 +Пример ответа: 4883 +))) 4884 + 4885 +((( 4886 +((( 4887 +[ 4888 + { 4889 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4890 + "duration": 0, ~/~/ Продолжительность события в секундах 4891 + "maxSpeed": 0, ~/~/ Максимальная скорость 4892 + "speedLimit": 0 ~/~/ Ограничение скорости 4893 + } 4894 +] 4895 +))) 4896 +))) 4897 +))) 4898 + 4899 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4900 + 4901 + 4902 +== **Запрос списка полей** == 4903 + 4904 +(% class="box successmessage" %) 4905 +((( 4906 +**POST /api/v3/agroLands/find** 4907 +))) 4908 + 4909 +Пример запроса: 4910 + 4911 +((( 4912 +((( 4913 +((( 4914 +{ 4915 + "year": 0, ~/~/ Фильтр по году 4916 + "name": "string", ~/~/ Фильтр по названию 4917 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4918 +} 4919 +))) 4920 +))) 4921 + 4922 + 4923 +))) 4924 + 4925 +Пример ответа: 4926 + 4927 +((( 4928 +[ 4929 + { 4930 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4931 + "year": 0, ~/~/ Год поля 4932 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 4933 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 4934 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 4935 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4936 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4937 + "counts": { ~/~/ Счётчики с/х поля 4938 + "fieldOperations": 0, ~/~/ Количество операций на поле 4939 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4940 + "facts": 0 ~/~/ Счётчик факта 4941 + }, 4942 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4943 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4944 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4945 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4946 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4947 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4948 + "planComment": "string", ~/~/ Комментарий к полю 4949 + "productivity": 0, ~/~/ Урожайность. 4950 + "id": 0, ~/~/ Идентификатор объекта геозоны 4951 + "name": "string", ~/~/ Название объекта геозоны 4952 + "type": 0, ~/~/ Тип объекта геозоны 4953 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4954 + "fname": "string", ~/~/ Имя файла 4955 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4956 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 4957 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 4958 + "description": "string", ~/~/ Описание объекта геозоны 4959 + "area": 0, ~/~/ Площадь, м2 4960 + "perimetr": 0, ~/~/ Периметр, м 4961 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 4962 + } 4963 +] 4964 + 4965 + 4966 +== **Создание нового поля ** == 4967 + 4968 +(% class="box successmessage" %) 4969 +((( 4970 +**POST /api/v3/agroLands** 4971 +))) 4972 + 4973 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4974 +X-agent - ID клиента 4975 + 4976 +Пример запроса: 4977 + 4978 +((( 4979 +{ 4980 + "extId": "string", 4981 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 4982 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4983 + "display": "string", ~/~/ Настройки отображения 4984 + "year": 0, ~/~/ Год поля 4985 + "name": "string", ~/~/ Наименование 4986 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4987 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 4988 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 4989 + "planComment": "string", ~/~/ Комментарий к полю 4990 + "cropRotations": [ ~/~/ Данные по севообороту 4991 + { 4992 + "landId": 0, ~/~/ ID поля 4993 + "landName": "string", ~/~/ Название поля 4994 + "year": 0, ~/~/ Год урожая 4995 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4996 + "cultureName": "string", ~/~/ Название культуры 4997 + "productivity": 0, ~/~/ Урожайность 4998 + "area": 0, ~/~/ Площадь поля, Га 4999 + "total": 0, ~/~/ Валовый сбор 5000 + "productivityFact": 0, ~/~/ Фактическая урожайность 5001 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5002 + "totalFact": 0, ~/~/ Фактический валовый сбор 5003 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5004 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5005 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5006 + "isyearplan": true, ~/~/ Годовой план 5007 + "comment": "string" ~/~/ Комментарий 5008 + } 5009 + ] 5010 +} 5011 +))) 5012 + 5013 +((( 5014 + 5015 +))) 5016 + 5017 +Пример ответа: 5018 + 5019 +((( 5020 +((( 5021 +{ 5022 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5023 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5024 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5025 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5026 + "cropRotations": [ ~/~/ Данные по севообороту 5027 + { 5028 + "landId": 0, ~/~/ ID поля 5029 + "landName": "string", ~/~/ Название поля 5030 + "year": 0, ~/~/ Год урожая 5031 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5032 + "cultureName": "string", ~/~/ Название культуры 5033 + "productivity": 0, ~/~/ Урожайность 5034 + "area": 0, ~/~/ Площадь поля, Га. 5035 + "total": 0, ~/~/ Валовый сбор 5036 + "productivityFact": 0, ~/~/ Фактическая урожайность 5037 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5038 + "totalFact": 0, ~/~/ Фактический валовый сбор 5039 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5040 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5041 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5042 + "isyearplan": true, ~/~/ годовой план 5043 + "comment": "string" ~/~/ Комментарий 5044 + } 5045 + ], 5046 + "cropVegetation": [ ~/~/ История вегетации поля 5047 + { 5048 + "values": [ ~/~/ Данные вегетации и состояния посева 5049 + { 5050 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5051 + "ndvi": 0 ~/~/ Индекс вегетации 5052 + } 5053 + ], 5054 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5055 + { 5056 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5057 + "type": "string", ~/~/ Тип 5058 + "pictureid": "string" ~/~/ Идентификатор ресурса 5059 + } 5060 + ], 5061 + "states": [ ~/~/ Ключевые даты развития поля 5062 + { 5063 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5064 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5065 + } 5066 + ] 5067 + } 5068 + ], 5069 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5070 + "counts": { 5071 + "fieldOperations": 0, ~/~/ Количество операций на поле 5072 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5073 + "facts": 0 ~/~/ Счётчик факта 5074 + }, 5075 + "planComment": "string", ~/~/ Комментарий к полю 5076 +))) 5077 + 5078 +((( 5079 + "productivity": 0, ~/~/ Урожайность. 5080 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5081 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5082 + "year": 0, ~/~/ Год поля 5083 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5084 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5085 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5086 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5087 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5088 + "id": 0, ~/~/ Идентификатор объекта геозоны 5089 + "name": "string", ~/~/ Название объекта геозоны 5090 + "type": 0, ~/~/ Тип объекта геозоны 5091 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5092 + "fname": "string", ~/~/ Имя файла 5093 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5094 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5095 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5096 + "description": "string", ~/~/ Описание объекта геозоны 5097 + "area": 0, ~/~/ Площадь, м2 5098 + "perimetr": 0, ~/~/ Периметр, м 5099 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5100 +} 5101 + 5102 + 5103 +))) 5104 +))) 5105 +))) 5106 + 5107 +== **Получение поля по id** == 5108 + 5109 +(% class="box infomessage" %) 5110 +((( 5111 +**GET /api/v3/agroLands/{id}** 5112 +))) 5113 + 5114 +Пример запроса: 5115 +id ~/~/ Идентификатор поля 5116 + 5117 +Пример ответа: 5118 + 5119 +((( 5120 +{ 5121 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5122 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5123 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5124 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5125 + "cropRotations": [ ~/~/ Данные по севообороту 5126 + { 5127 + "landId": 0, ~/~/ ID поля 5128 + "landName": "string", ~/~/ Название поля 5129 + "year": 0, ~/~/ Год урожая 5130 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5131 + "cultureName": "string", ~/~/ Название культуры 5132 + "productivity": 0, ~/~/ Урожайность 5133 + "area": 0, ~/~/ Площадь поля, Га 5134 + "total": 0, ~/~/ Валовый сбор 5135 + "productivityFact": 0, ~/~/ Фактическая урожайность 5136 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5137 + "totalFact": 0, ~/~/ Фактический валовый сбор 5138 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5139 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5140 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5141 + "isyearplan": true, ~/~/ План года 5142 + "comment": "string" ~/~/ Комментарий 5143 + } 5144 + ], 5145 + "cropVegetation": [ ~/~/ История вегетации поля 5146 + { 5147 + "values": [ ~/~/ Данные вегетации и состояния посева 5148 + { 5149 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5150 + "ndvi": 0 ~/~/ Индекс вегетации 5151 + } 5152 + ], 5153 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5154 + { 5155 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5156 + "type": "string", ~/~/ Тип 5157 + "pictureid": "string" ~/~/ Идентификатор ресурса 5158 + } 5159 + ], 5160 + "states": [ ~/~/ Ключевые даты развития поля 5161 + { 5162 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5163 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5164 + } 5165 + ] 5166 + } 5167 + ], 5168 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5169 + "counts": { 5170 + "fieldOperations": 0, ~/~/ Количество операций на поле 5171 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5172 + "facts": 0 ~/~/ Счётчик факта 5173 + }, 5174 + "planComment": "string", ~/~/ Комментарий к полю 5175 + "productivity": 0, ~/~/ Урожайность. 5176 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5177 +))) 5178 + 5179 +((( 5180 +((( 5181 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5182 + "year": 0, ~/~/ Год поля 5183 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5184 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5185 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5186 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5187 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5188 + "id": 0, ~/~/ Идентификатор объекта геозоны 5189 + "name": "string", ~/~/ Название объекта геозоны 5190 + "type": 0, ~/~/ Тип объекта геозоны 5191 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5192 + "fname": "string", ~/~/ Имя файла 5193 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5194 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5195 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5196 + "description": "string", ~/~/ Описание объекта геозоны 5197 + "area": 0, ~/~/ Площадь, м2 5198 + "perimetr": 0, ~/~/ Периметр, м 5199 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5200 +} 5201 +))) 5202 + 5203 + 5204 +== **Удаление существующего поля** == 5205 + 5206 +(% class="box errormessage" %) 5207 +((( 5208 +**DELETE /api/v3/agroLands/{id}** 5209 +))) 5210 + 5211 +Пример запроса: 5212 +id ~/~/ Идентификатор поля 5213 + 5214 +Пример ответа: 5215 + 5216 +((( 5217 +200 ~/~/ Успех 5218 +))) 5219 + 5220 +((( 5221 + 5222 +))) 5223 + 5224 +((( 5225 +((( 5226 +((( 5227 + 5228 +))) 5229 + 5230 +((( 5231 +== **Изменение поля** == 5232 + 5233 +(% class="box infomessage" %) 5234 +((( 5235 +**PUT /api/v3/agroLands** 5236 +))) 5237 + 5238 +Пример запроса: 5239 + 5240 +((( 5241 +((( 5242 +{ 5243 + "id": 0, ~/~/ Идентификатор поля 5244 + "extId": "string", ~/~/ ExtId 5245 + "shape": "string", ~/~/ Форма поля 5246 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5247 + "display": "string", ~/~/ Настройки отображения 5248 + "year": 0, ~/~/ Год поля 5249 + "name": "string", ~/~/ Наименование 5250 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5251 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5252 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5253 + "planComment": "string", ~/~/Комментарий к полю 5254 + "cropRotations": [ ~/~/ Данные по севообороту 5255 + { 5256 + "landId": 0, ~/~/ ID поля 5257 + "landName": "string", ~/~/ Название поля 5258 + "year": 0, ~/~/ Год урожая 5259 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5260 + "cultureName": "string", ~/~/ Название культуры 5261 + "productivity": 0, ~/~/ Урожайность 5262 + "area": 0, ~/~/ Площадь поля, Га. 5263 + "total": 0, ~/~/ Валовый сбор 5264 + "productivityFact": 0, ~/~/ Фактическая урожайность 5265 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5266 + "totalFact": 0, ~/~/ Фактический валовый сбор 5267 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5268 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5269 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5270 + "isyearplan": true, 5271 + "comment": "string" ~/~/ Комментарий 5272 + } 5273 + ], 5274 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5275 +} 5276 +))) 5277 +))) 5278 + 5279 +((( 5280 + 5281 +))) 5282 + 5283 +Пример ответа: 5284 + 5285 +((( 5286 +((( 5287 +((( 5288 +{ 5289 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5290 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5291 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5292 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5293 + "cropRotations": [ ~/~/ Данные по севообороту 5294 + { 5295 + "landId": 0, ~/~/ ID поля 5296 + "landName": "string", ~/~/ Название поля 5297 + "year": 0, ~/~/ Год урожая 5298 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5299 + "cultureName": "string", ~/~/ Название культуры 5300 + "productivity": 0, ~/~/ Урожайность 5301 + "area": 0, ~/~/ Площадь поля, Га 5302 + "total": 0, ~/~/ Валовый сбор 5303 + "productivityFact": 0, ~/~/ Фактическая урожайность 5304 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5305 + "totalFact": 0, ~/~/ Фактический валовый сбор 5306 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5307 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5308 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5309 + "isyearplan": true, ~/~/ 5310 + "comment": "string" ~/~/ Комментарий 5311 + } 5312 + ], 5313 + "cropVegetation": [ ~/~/ История вегетации поля 5314 + { 5315 + "values": [ ~/~/ Данные вегетации и состояния посева 5316 + { 5317 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5318 + "ndvi": 0 ~/~/ Индекс вегетации 5319 + } 5320 + ], 5321 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5322 + { 5323 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5324 + "type": "string", ~/~/ Тип 5325 + "pictureid": "string" ~/~/ Идентификатор ресурса 5326 + } 5327 + ], 5328 + "states": [ ~/~/ Ключевые даты развития поля 5329 + { 5330 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5331 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5332 + } 5333 + ] 5334 + } 5335 + ], 5336 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5337 + "counts": { 5338 + "fieldOperations": 0, ~/~/ Количество операций на поле 5339 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5340 + "facts": 0 ~/~/ Счётчик факта 5341 + }, 5342 + "planComment": "string", ~/~/ Комментарий к полю 5343 + "productivity": 0, ~/~/ Урожайность. 5344 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5345 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5346 + "year": 0, ~/~/ Год поля 5347 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5348 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5349 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5350 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5351 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5352 + "id": 0, ~/~/ Идентификатор объекта геозоны 5353 + "name": "string", ~/~/ Название объекта геозоны 5354 + "type": 0, ~/~/ Тип объекта геозоны 5355 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5356 + "fname": "string", ~/~/ Имя файла 5357 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5358 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5359 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5360 + "description": "string", ~/~/ Описание объекта геозоны 5361 + "area": 0, ~/~/ Площадь, м2 5362 + "perimetr": 0, ~/~/ Периметр, м 5363 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5364 +} 5365 +))) 5366 +))) 5367 +))) 5368 +))) 5369 +))) 5370 + 5371 + 5372 +== **Редактирование года урожая ** == 5373 + 5374 +(% class="box successmessage" %) 5375 +((( 5376 +**POST /api/v3/agroLands/updateOpenCloseYear** 5377 +))) 5378 + 5379 +Пример запроса: 5380 + 5381 +((( 5382 +((( 5383 +{ 5384 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5385 + 0 5386 + ], 5387 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5388 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5389 +} 5390 +))) 5391 + 5392 + 5393 +))) 5394 + 5395 +Пример ответа: 5396 + 5397 +((( 5398 +((( 5399 +{ 5400 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5401 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5402 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5403 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5404 + "cropRotations": [ ~/~/ Данные по севообороту 5405 + { 5406 + "landId": 0, ~/~/ ID поля 5407 + "landName": "string", ~/~/ Название поля 5408 + "year": 0, ~/~/ Год урожая 5409 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5410 + "cultureName": "string", ~/~/ Название культуры 5411 + "productivity": 0, ~/~/ Урожайность 5412 + "area": 0, ~/~/ Площадь поля, Га. 5413 + "total": 0, ~/~/ Валовый сбор 5414 + "productivityFact": 0, ~/~/ Фактическая урожайность 5415 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5416 + "totalFact": 0, ~/~/ Фактический валовый сбор 5417 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5418 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5419 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5420 + "isyearplan": true, ~/~/ 5421 + "comment": "string" ~/~/ Комментарий 5422 + } 5423 + ], 5424 + "cropVegetation": [ ~/~/ История вегетации поля 5425 + { 5426 + "values": [ ~/~/ Данные вегетации и состояния посева 5427 + { 5428 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5429 + "ndvi": 0 ~/~/ Индекс вегетации 5430 + } 5431 + ], 5432 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5433 + { 5434 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5435 + "type": "string", ~/~/ Тип 5436 + "pictureid": "string" ~/~/ Идентификатор ресурса 5437 + } 5438 + ], 5439 + "states": [ ~/~/ Ключевые даты развития поля 5440 + { 5441 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5442 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5443 + } 5444 + ] 5445 + } 5446 + ], 5447 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5448 + "counts": { 5449 + "fieldOperations": 0, ~/~/ Количество операций на поле 5450 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5451 + "facts": 0 ~/~/ Счётчик факта 5452 + }, 5453 + "planComment": "string", ~/~/ Комментарий к полю 5454 + "productivity": 0, ~/~/ Урожайность. 5455 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5456 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5457 + "year": 0, ~/~/ Год поля 5458 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5459 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5460 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5461 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5462 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5463 + "id": 0, ~/~/ Идентификатор объекта геозоны 5464 + "name": "string", ~/~/ Название объекта геозоны 5465 + "type": 0, ~/~/ Тип объекта геозоны 5466 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5467 + "fname": "string", ~/~/ Имя файла 5468 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5469 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5470 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5471 + "description": "string", ~/~/ Описание объекта геозоны 5472 + "area": 0, ~/~/ Площадь, м2 5473 + "perimetr": 0, ~/~/ ериметр, м 5474 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5475 +} 5476 +))) 5477 + 5478 + 5479 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5480 +))) 5481 +))) 5482 +))) 5483 + 5484 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5485 + 5486 + 5487 +(% class="box infomessage" %) 5488 +((( 5489 +**GET api/v3/Vehicles/recyclebin/all** 5490 +))) 5491 + 5492 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5493 + 5494 +Параметр запроса: {parentId} - идентификатор агента 5495 + 5496 +В заголовках запроса: X-Auth: Токен авторизации 5497 + 5498 +Ответ: 5499 + 5500 +[ 5501 + { 5502 + "recordTime": "", ~/~/Время записи 5503 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5504 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5505 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5506 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5507 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5508 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5509 + "items": [ ~/~/ 5510 +nullable: true ~/~/Детали 5511 + { 5512 + "name": "string", ~/~/наименование столбца 5513 + "value": "string" ~/~/содержание столбца 5514 + } 5515 + ] 5516 + }, 5517 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5518 + "string" 5519 + ] 5520 + } 5521 +] 5522 + 5523 + 5524 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5525 + 5526 +(% class="box infomessage" %) 5527 +((( 5528 +**POST api/v3/Vehicles/recyclebin/erase** 5529 +))) 5530 + 5531 +В заголовках запроса: X-Auth: Токен авторизации 5532 + 5533 +Пример запроса: 5534 + 5535 +[ 5536 +0 5537 +] 5538 + 5539 + 5540 +Пример ответа: 5541 + 5542 +[ 5543 +{ 5544 + "recordTime": "", ~/~/Время записи 5545 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5546 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5547 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5548 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5549 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5550 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5551 + "items": [ ~/~/Детали 5552 + { 5553 + "name": "", ~/~/Имя свойства 5554 + "value": "" ~/~/Значение свойства 5555 + } 5556 + ] 5557 + }, 5558 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5559 + "" 5560 + ] 5561 + } 5562 +] 5563 + 5564 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5565 + 5566 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5567 + 5568 +(% class="box infomessage" %) 5569 +((( 5570 +**POST api/v3/Vehicles/recyclebin/restore** 5571 +))) 5572 + 5573 +В заголовках запроса: X-Auth: Токен авторизации 5574 + 5575 +Параметры в теле запроса (JSON): 5576 + 5577 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5578 + 5579 +В заголовках запроса: X-Auth: Токен авторизации 5580 + 5581 + 5582 +Пример запроса: 5583 + 5584 +((( 5585 +[ 5586 +))) 5587 + 5588 +((( 5589 + 0 5590 +))) 5591 + 5592 +((( 5593 +] 5594 +))) 5595 + 5596 + 5597 +Пример ответа: 5598 + 5599 +[ 5600 +{ 5601 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5602 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5603 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5604 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5605 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5606 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5607 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5608 + "items": [ ~/~/Детали 5609 + { 5610 + "name": "string", ~/~/Имя свойства 5611 + "value": "string" ~/~/Значение свойства 5612 + } 5613 + ] 5614 + }, 5615 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5616 + "string" 5617 + ] 5618 + } 5619 +] 5620 + 5621 + 5622 += **Раздел: Журнал заданий ** = 5623 + 5624 + 5625 +== **Создание задания в Журнале заданий** == 5626 + 5627 +(% class="box infomessage" %) 5628 +((( 5629 +**POST /api/v3/vehicletasks** 5630 +))) 5631 + 5632 +Пример запроса: 5633 + 5634 +((( 5635 +{ 5636 + "vehicleId": 0, ~/~/ Идентификатор ТС 5637 + "description": "string", ~/~/ Описание 5638 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5639 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5640 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5641 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5642 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5643 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5644 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5645 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5646 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5647 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5648 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5649 + "cost": { 5650 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5651 + "Name": "string", ~/~/ Наименование 5652 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5653 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5654 + "Norm": 0 ~/~/ Норма внесения 5655 + }, 5656 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5657 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5658 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5659 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5660 + "deleted": true, ~/~/ Признак удаления 5661 + "extId": "string", 5662 + "GeoIds": [ ~/~/ Cвязанные поля 5663 + 0 5664 + ] 5665 +} 5666 +))) 5667 + 5668 + 5669 +Пример ответа: 5670 + 5671 +{ 5672 + "vehicleId": 0, ~/~/ Идентификатор ТС 5673 + "description": "string", ~/~/ Описание 5674 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5675 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5676 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5677 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5678 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5679 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5680 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5681 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5682 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5683 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5684 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5685 + "cost": { 5686 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5687 + "Name": "string", ~/~/ Наименование 5688 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5689 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5690 + "Norm": 0 ~/~/ Норма внесения 5691 + }, 5692 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5693 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5694 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5695 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5696 + "deleted": true, ~/~/ Признак удаления 5697 + "extId": "string", ~/~/ ExtId 5698 + "GeoIds": [ ~/~/ Связанные поля 5699 + 0 5700 + ] 5701 +} 5702 + 5703 + 5704 +== **Редактирование задания в Журнале заданий** == 5705 + 5706 +(% class="box successmessage" %) 5707 +((( 5708 +**PUT /api/v3/vehicletasks** 5709 +))) 5710 + 5711 +Пример запроса: 5712 + 5713 +((( 5714 +{ 5715 + "vehicleId": 0, ~/~/ Идентификатор ТС 5716 + "description": "string", ~/~/ Описание 5717 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5718 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5719 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5720 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5721 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5722 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5723 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5724 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5725 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5726 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5727 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5728 + "cost": { 5729 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5730 + "Name": "string", ~/~/ Наименование 5731 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5732 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5733 + "Norm": 0 ~/~/ Норма внесения 5734 + }, 5735 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5736 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5737 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5738 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5739 + "deleted": true, ~/~/ Признак удаления 5740 + "extId": "string", ~/~/ ExtId 5741 + "GeoIds": [ ~/~/ Связанные поля 5742 + 0 5743 + ] 5744 +} 5745 +))) 5746 + 5747 + 5748 +Пример ответа: 5749 + 5750 +{ 5751 + "vehicleId": 0, ~/~/ Идентификатор ТС 5752 + "description": "string", ~/~/ Описание 5753 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5754 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5755 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5756 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5757 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5758 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5759 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5760 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5761 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5762 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5763 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5764 + "cost": { 5765 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5766 + "Name": "string", ~/~/ Наименование 5767 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5768 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5769 + "Norm": 0 ~/~/ Норма внесения 5770 + }, 5771 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5772 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5773 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5774 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5775 + "deleted": true, ~/~/ Признак удаления 5776 + "extId": "string", ~/~/ ExtId 5777 + "GeoIds": [ ~/~/ Связанные поля 5778 + 0 5779 + ] 5780 +} 5781 + 5782 + 5783 +== **Удаление задания в Журнале заданий** == 5784 + 5785 +(% class="box warningmessage" %) 5786 +((( 5787 +**DELETE /api/v3/vehicletasks** 5788 +))) 5789 + 5790 +Пример запроса: 5791 + 5792 +((( 5793 +[ 5794 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5795 +] 5796 +))) 5797 + 5798 +((( 5799 + 5800 +))) 5801 + 5802 +Пример ответа: 5803 + 5804 +{ 5805 + "vehicleId": 0, ~/~/ Идентификатор ТС 5806 + "description": "string", ~/~/ Описание 5807 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5808 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5809 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5810 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5811 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5812 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5813 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5814 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5815 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5816 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5817 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5818 + "cost": { 5819 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5820 + "Name": "string", ~/~/ Наименование 5821 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5822 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5823 + "Norm": 0 ~/~/ Норма внесения 5824 + }, 5825 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5826 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5827 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5828 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5829 + "deleted": true, ~/~/ Признак удаления 5830 + "extId": "string", ~/~/ ExtId 5831 + "GeoIds": [ ~/~/ Связанные поля 5832 + 0 5833 + ] 5834 +} 5835 + 5836 + 5837 +== **Получение списка Журнала заданий** == 5838 + 5839 +(% class="box infomessage" %) 5840 +((( 5841 +**POST /api/v3/vehicletasks/getbyperiod** 5842 +))) 5843 + 5844 +Пример запроса: 5845 + 5846 +((( 5847 +{ 5848 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5849 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 5850 + "TimeZone": 0, ~/~/ Часовой пояс. 5851 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 5852 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 5853 + ], 5854 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 5855 + 0 5856 + ], 5857 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 5858 + 0 5859 + ], 5860 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 5861 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 5862 +} 5863 +))) 5864 + 5865 + 5866 +Пример ответа: 5867 + 5868 +((( 5869 +{ 5870 + "total": 0, ~/~/ Общее количество записей 5871 + "pages": 0, ~/~/ Общее количество страниц 5872 + "currentPage": 0, ~/~/ Текущая страница 5873 + "items": [ ~/~/ Записи 5874 + { 5875 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5876 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 5877 + "name": "string", ~/~/ Название задания. 5878 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 5879 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 5880 + "workKind": "string", ~/~/ Вид работ 5881 + "techOp": "string", ~/~/ Тех. операция 5882 + "trailerModel": "string", ~/~/ Модель агрегата 5883 + "width": "string", ~/~/ Ширина, м 5884 + "speed": "string", ~/~/ Тех. скорость 5885 + "fields": "string", ~/~/ Поля 5886 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 5887 + "vehicles": "string", ~/~/ Объект-модель 5888 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 5889 + "drivers": "string", ~/~/ Водители 5890 + "tmc": "string", ~/~/ ТМЦ 5891 + "client": "string", ~/~/ Клиент 5892 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5893 + "dep": "string", ~/~/ Подразделение 5894 + "geoIds": [ ~/~/ Связанные поля 5895 + 0 5896 + ] 5897 + } 5898 + ] 5899 +} 5900 +))) 5901 + 5902 + 5903 += **Раздел: Локатор ** = 5904 + 5905 + 5906 +== **Получение списка локаторов, доступных пользователю ** == 5907 + 5908 +(% class="box infomessage" %) 5909 +((( 5910 +**GET /api/v3/locators** 5911 +))) 5912 + 5913 +В заголовках запроса: X-Auth: Токен авторизации 5914 + 5915 + 5916 +Пример ответа: 5917 + 5918 +((( 5919 +[ 5920 + { 5921 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5922 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5923 + "agentName": "string", ~/~/ Наименование агента. 5924 + "isEnabled": true, ~/~/ Активен 5925 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5926 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5927 + "name": "string", ~/~/ Наименование 5928 + "status": 0, ~/~/ 5929 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5930 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5931 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5932 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5933 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5934 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5935 + "url": "string", ~/~/ Ссылка 5936 + "language": 0, ~/~/ Язык. 5937 + "vehiclesCount": 0, ~/~/ Количество объектов. 5938 + "geozonesCount": 0, ~/~/ Количество геозон. 5939 + "fieldsCount": 0 ~/~/ Количество полей. 5940 + } 5941 +] 5942 +))) 5943 + 5944 + 5945 + 5946 +== **Создание локатора** == 5947 + 5948 +(% class="box successmessage" %) 5949 +((( 5950 +**POST /api/v3/locators** 5951 +))) 5952 + 5953 +Пример запроса: 5954 + 5955 +((( 5956 +{ 5957 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5958 + "isEnabled": true, ~/~/ Активность 5959 + "name": "string", ~/~/ Наименование локатора 5960 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 5961 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5962 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5963 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5964 + "url": "string", ~/~/ Ссылка 5965 + "language": 0 ~/~/ Язык 5966 +} 5967 +))) 5968 + 5969 + 5970 +Пример ответа: 5971 + 5972 +((( 5973 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 5974 +))) 5975 + 5976 + 5977 + 5978 +== **Изменение локатора** == 5979 + 5980 +(% class="box infomessage" %) 5981 +((( 5982 +**PUT /api/v3/locators** 5983 +))) 5984 + 5985 +Пример запроса: 5986 + 5987 +((( 5988 +{ 5989 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5990 + "isEnabled": true, ~/~/ Активность 5991 + "name": "string", ~/~/ Наименование 5992 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 5993 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5994 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5995 + "autoProlongation": true, ~/~/ Автопродление срока действия 5996 + "url": "string", ~/~/ Ссылка 5997 + "language": 0 ~/~/ Язык 5998 +} 5999 +))) 6000 + 6001 + 6002 +Пример ответа: 6003 + 6004 +200 ~/~/ Success 6005 + 6006 + 6007 +== **Удалить локатор** == 6008 + 6009 +(% class="box warningmessage" %) 6010 +((( 6011 +**DELETE /api/v3/locators** 6012 +))) 6013 + 6014 +Пример запроса: 6015 + 6016 +((( 6017 +[ 6018 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6019 +] 6020 +))) 6021 + 6022 + 6023 + 6024 += **Раздел: Яндекс Маршруты** = 6025 + 6026 + 6027 +== **Возвращение списка маршрутов** == 6028 + 6029 +(% class="box infomessage" %) 6030 +((( 6031 +**GET /api/v3/TransportRoutes** 6032 +))) 6033 + 6034 +Пример запроса: 6035 +Id ~/~/ Идентификатор поля 6036 + 6037 + 6038 +Пример ответа: 6039 + 6040 +((( 6041 +[ 6042 + { 6043 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6044 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6045 + "name": "string", ~/~/ Наименование маршрута. 6046 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6047 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6048 + 0 6049 + ] 6050 + } 6051 +] 6052 +))) 6053 + 6054 + 6055 + 6056 +== **Добавить маршрут** == 6057 + 6058 +(% class="box infomessage" %) 6059 +((( 6060 +**POST /api/v3/TransportRoutes** 6061 +))) 6062 + 6063 +Пример запроса: 6064 +{ 6065 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6066 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6067 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6068 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6069 + 0 6070 + ] 6071 +} 6072 + 6073 + 6074 +Пример ответа: 6075 + 6076 +((( 6077 +{ 6078 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6079 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6080 + "name": "string", ~/~/ Определяет наименование маршрута 6081 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6082 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6083 + 0 6084 + ] 6085 +} 6086 +))) 6087 + 6088 + 6089 +== **Обновление маршрута** == 6090 + 6091 +(% class="box successmessage" %) 6092 +((( 6093 +**PUT /api/v3/TransportRoutes** 6094 +))) 6095 + 6096 +Пример запроса: 6097 + 6098 +((( 6099 +{ 6100 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6101 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6102 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6103 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6104 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6105 + 0 6106 + ] 6107 +} 6108 +))) 6109 + 6110 + 6111 +Пример ответа: 6112 + 6113 +((( 6114 +{ 6115 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6116 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6117 + "name": "string", ~/~/ Определяет наименование маршрута 6118 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6119 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6120 + 0 6121 + ] 6122 +} 6123 +))) 6124 + 6125 + 6126 +== **Получить связки маршрутов ТС** == 6127 + 6128 +(% class="box infomessage" %) 6129 +((( 6130 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6131 +))) 6132 + 6133 +Пример запроса: 6134 + 6135 +((( 6136 +[ 6137 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6138 +] 6139 +))) 6140 + 6141 + 6142 +Пример ответа: 6143 + 6144 +((( 6145 +[ 6146 + { 6147 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6148 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6149 + } 6150 +] 6151 +))) 6152 + 6153 + 6154 +== **Удалить маршрут** == 6155 + 6156 +(% class="box warningmessage" %) 6157 +((( 6158 +**DELETE /api/v3/TransportRoutes/{id}** 6159 +))) 6160 + 6161 +Пример запроса: 6162 +Id ~/~/ Идентификатор поля 6163 + 6164 + 6165 +==== ==== 6166 + 6167 +==== **Раздел: Управление доступа к машинам** ==== 6168 + 6169 + 6170 +== Получение списка транспортных средств видимых пользователю == 6171 + 6172 +(% class="box infomessage" %) 6173 +((( 6174 +**GET /api/v3/UserVisibleVehicles/{userId}** 6175 +))) 6176 + 6177 +Пример ответа: 6178 + 6179 +((( 6180 +{ 6181 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6182 + 0 6183 + ] 6184 +} 6185 +))) 6186 + 6187 + 6188 + 6189 +== Задает видимость транспортных средств пользователю == 6190 + 6191 +(% class="box infomessage" %) 6192 +((( 6193 +**POST /api/v3/UserVisibleVehicles** 6194 +))) 6195 + 6196 +Пример запроса: 6197 + 6198 +((( 6199 +((( 6200 +{ 6201 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6202 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6203 + 0 6204 + ] 6205 +} 6206 +))) 6207 + 6208 +((( 6209 + 6210 +))) 6211 + 6212 +((( 6213 + 6214 +))) 6215 + 6216 +((( 6217 +Пример ответа : 6218 +))) 6219 + 6220 +((( 6221 + 6222 +))) 6223 + 6224 +((( 6225 +200 ~/~/ Success 6226 +))) 6227 +))) 6228 + 6229 + 6230 + 6231 + 6232 + 6233 + 2487 2487 (% class="box" lang="en-US" style="text-align: center;" %) 2488 2488 ((( 2489 2489 (% 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