Редактировал(а) Михаил Жучков 2025/10/30 11:26

<
От версии < 109.1 >
отредактировано Илья Крайнов
на 2023/10/17 11:01
К версии < 266.1
отредактировано Михаил Жучков
на 2025/10/30 11:26
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.SupportZhuchkov
Содержимое
... ... @@ -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  
... ... @@ -139,21 +139,29 @@
139 139  (% style="color:#000000" %)Параметр запроса:
140 140  
141 141  (% style="color:#000000" %){
142 - "parentId": "string"
205 + "parentId": "(%%)string(% style="color:#000000" %)" ~/~/ для получение собственного parentId отправьте пустой запрос (пример "parentId": "" ) 
143 143  }
144 144  
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 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
246 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 178   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -192,7 +192,6 @@
192 192   "bankKS": "string" ~/~/ корр. счёт
193 193  }
194 194  
195 -
196 196  Ответ:
197 197  
198 198  {
... ... @@ -232,7 +232,6 @@
232 232  
233 233  В заголовках запроса: X-Auth: Токен авторизации
234 234  
235 -
236 236  Параметры в теле запроса (JSON):
237 237  
238 238  {
... ... @@ -257,7 +257,6 @@
257 257   "bankKS": "string" ~/~/ корр. счёт
258 258  }
259 259  
260 -
261 261  Ответ:
262 262  
263 263  {
... ... @@ -300,6 +300,21 @@
300 300  
301 301  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 302  
371 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
372 +
373 +(% class="box warningmessage" %)
374 +(((
375 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
376 +)))
377 +
378 +Метод позволяет изменить статус клиента, указанного в запросе.
379 +
380 +В пути указывается GUID клиента и статус клиента.
381 +
382 +**status **- значение 0 - заблокирован, 1 - активен.
383 +
384 +Ответ: Code 204
385 +
303 303  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 304  
305 305  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -349,9 +349,8 @@
349 349   [
350 350   "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
351 351   ],
352 - "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
353 353  }
354 -
355 355  {
356 356   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 357   "lastName": "string",
... ... @@ -363,15 +363,10 @@
363 363   "password": "string",
364 364   "email": "string",
365 365  
366 -
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)Ответ:
369 -
370 -(% style="text-align:left" %)
371 -(% style="color:#000000; font-weight:normal" %){    
372 -
373 -(% style="text-align:left" %)
374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
450 +{     
451 + "id": "" , ~/~/ ID пользователя
375 375   "lastName": "" , ~/~/ Фамилия ,
376 376   "firstName": "" , ~/~/ Имя
377 377   "position": "" , ~/~/ Должность
... ... @@ -388,9 +388,8 @@
388 388   "kind": "" , ~/~/ тип аутентификации
389 389   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
390 390   "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
468 +}
391 391  
392 -(% style="text-align:left" %)
393 -(% style="color:#000000; font-weight:normal" %)}
394 394  
395 395  == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
396 396  
... ... @@ -411,19 +411,16 @@
411 411  
412 412  (% style="color:#000000" %)Параметры в теле запроса (JSON):
413 413  
414 -(% style="color:#000000" %){
415 -
490 +(% style="color:#000000" %){(%%)
416 416   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
417 417   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
418 418   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
419 419   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 -
421 421  (% style="color:#000000" %)}
422 422  
423 423  (% style="color:#000000" %)Ответ:
424 424  
425 425  (% style="color:#000000" %){         (%%)
426 -
427 427   "id": "" , ~/~/ идентификатор пользователя
428 428   "lastName": "" , ~/~/ фамилия
429 429   "firstName": "" , ~/~/ имя
... ... @@ -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 пользователя 
586 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
587 + "id": "" , ~/~/ ID пользователя 
518 518   "lastName": "" , ~/~/ фамилия
519 519   "firstName": "" , ~/~/ имя
520 520   "position": "" , ~/~/ должность
... ... @@ -536,9 +536,7 @@
536 536   "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
537 537   },
538 538   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
540 -
541 -(% lang="en-US" style="text-align:left" %)
609 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
542 542  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
543 543  
544 544  (% lang="en-US" style="text-align:left" %)
... ... @@ -545,10 +545,8 @@
545 545  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
546 546  
547 547  (% lang="en-US" style="text-align:left" %)
548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
549 -
550 -(% lang="en-US" style="text-align:left" %)
551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
616 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
617 + "id": "" , ~/~/ идентификатор пользователя
552 552   "lastName": "" , ~/~/ фамилия
553 553   "firstName": "" , ~/~/ имя
554 554   "position": "" , ~/~/ должность
... ... @@ -569,10 +569,8 @@
569 569   "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
570 570   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
571 571   "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
638 +}
572 572  
573 -(% lang="en-US" style="text-align:left" %)
574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
575 -
576 576  == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
577 577  
578 578  (% class="box warningmessage" %)
... ... @@ -592,12 +592,10 @@
592 592  
593 593  (% style="color:#000000" %)Параметры в теле запроса (JSON):
594 594  
595 -(% style="color:#000000" %){
596 -
659 +(% style="color:#000000" %){(%%)
597 597   "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
598 598   "description": "" , ~/~/ описание
599 599   "data": "" , ~/~/ данные, связанные со сменой статуса
600 -
601 601  (% style="color:#000000" %)}
602 602  
603 603  (% style="text-align:left" %)
... ... @@ -619,7 +619,7 @@
619 619  (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
620 620  
621 621   [ 
622 - "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
684 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
623 623   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
624 624   ]
625 625  
... ... @@ -682,6 +682,11 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
747 +(% class="wikigeneratedid" id="H" %)
748 +(((
749 +
750 +)))
751 +
685 685  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
686 686  
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
... ... @@ -711,7 +711,6 @@
711 711   "maxspeed": 0,
712 712   "width": 0,
713 713   "imbeddedtrailer": true,
714 - "fueloutlay": 0,
715 715   "hoppercapacity": 0,
716 716   "hopperdischargespeed": 0,
717 717   "modelType": 0,
... ... @@ -720,7 +720,7 @@
720 720   "deleted": true
721 721  }
722 722  
723 -|(% style="width:215px" %)Параметр|(% style="width:861px" %)Описание
789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
724 724  |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
725 725  |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
726 726  |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
... ... @@ -728,9 +728,8 @@
728 728  |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
729 729  |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
730 730  |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)-
732 732  |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
798 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
734 734  |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
735 735  |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
736 736  |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
... ... @@ -751,10 +751,9 @@
751 751  
752 752  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
753 753  
754 -(% style="color:#000000" %)Параметры в теле запроса (JSON):
819 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
755 755  
756 -(% style="color:#000000" %){
757 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
821 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
758 758  }
759 759  
760 760  (% style="color:#000000" %)Ответ:
... ... @@ -769,6 +769,13 @@
769 769   }
770 770  ]
771 771  
836 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
837 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
838 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
839 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
840 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
841 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
842 +
772 772  == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
773 773  
774 774  (% class="box successmessage" %)
... ... @@ -789,7 +789,7 @@
789 789  {
790 790   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
791 791   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
792 - "deleted": true,
863 + "deleted": false,
793 793   "extId": "string",
794 794   "name": "string",
795 795   "picture": "string",
... ... @@ -808,7 +808,7 @@
808 808  {
809 809   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
810 810   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
811 - "deleted": true,
882 + "deleted": false,
812 812   "extId": "string",
813 813   "name": "string",
814 814   "picture": "string",
... ... @@ -816,12 +816,25 @@
816 816   "maxspeed": 0,
817 817   "width": 0,
818 818   "imbeddedtrailer": true,
819 - "fueloutlay": 0,
820 820   "hoppercapacity": 0,
821 821   "hopperdischargespeed": 0,
822 822   "modelType": 0
823 823  }
824 824  
895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
896 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
897 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
898 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
899 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
900 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
901 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
902 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
903 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
904 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
905 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
906 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
907 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
908 +
825 825  == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
826 826  
827 827  (% class="box warningmessage" %)
... ... @@ -829,7 +829,7 @@
829 829  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
830 830  )))
831 831  
832 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
833 833  
834 834  (% style="color:#000000" %)Метод запроса: **PUT**
835 835  
... ... @@ -875,6 +875,20 @@
875 875   "modelType": 0
876 876  }
877 877  
962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
963 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
964 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
965 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
966 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
967 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
968 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
969 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
970 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
971 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
972 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
973 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
974 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
975 +
878 878  == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
879 879  
880 880  (% class="box errormessage" %)
... ... @@ -882,7 +882,7 @@
882 882  (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
883 883  )))
884 884  
885 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
886 886  
887 887  (% style="color:#000000" %)Метод запроса: **DELETE**
888 888  
... ... @@ -894,7 +894,7 @@
894 894  
895 895  Ответ: В случае успеха **Success 200**
896 896  
897 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
898 898  
899 899  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
900 900  
... ... @@ -923,6 +923,17 @@
923 923  
924 924  (((
925 925  {
1024 +
1025 +(((
1026 + "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1027 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1028 +)))
1029 +
1030 +(((
1031 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1032 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1033 +)))
1034 +
926 926   "vehicleId": "", ~/~/ ID объекта
927 927   "name": "", ~/~/ Имя объекта
928 928   "imei": "", ~/~/ IMEI объекта
... ... @@ -930,19 +930,15 @@
930 930   "deviceTypeName": "", ~/~/ Название типа устройства
931 931   "sim1": "", ~/~/ Номер SIM1
932 932   "sim2": "", ~/~/ Номер SIM2
933 -
934 934   "parentId": "", ~/~/ ID клиента-родителя
935 935   "parentName": "", ~/~/ Наименование клиента-родителя
936 936   "modelId": "", ~/~/ ID модели объекта
937 937   "modelName": "", ~/~/ Имя модели объекта
938 -
939 939   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
940 940   "unitName": "string", ~/~/ Наименование подразделения
941 941   "status": 0, ~/~/ Статус объекта
942 -
943 943   "createdAt": "", ~/~/ Дата создания объекта
944 944   },
945 -
946 946  "customFields": [ ~/~/ Произвольные поля
947 947   {
948 948   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -952,6 +952,12 @@
952 952   "forTooltip": true, ~/~/ Отображать в подсказке
953 953   "forReport": true ~/~/ Отображать в отчете
954 954   }
1060 + ],
1061 + "vehicleGroups": [  ~/~/ Группы ТС
1062 + {
1063 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1064 + "name": "string" ~/~/ Наименование группы ТС
1065 + }
955 955  
956 956  ], ~/~/ Данные с вкладки нормы
957 957   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
... ... @@ -965,8 +965,7 @@
965 965   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
966 966   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
967 967   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
968 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
969 -
1079 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
970 970   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
971 971   "mileageCoeff": 0, ~/~/ коэффициент пробега
972 972   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -996,7 +996,6 @@
996 996   "retries": 0 ~/~/ Количество попыток
997 997   }
998 998   ],
999 -
1000 1000   "sensors": [ ~/~/ Датчики
1001 1001   {
1002 1002   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -1004,7 +1004,7 @@
1004 1004   "type": 0, ~/~/ Тип датчика
1005 1005   "name": "string", ~/~/ Имя датчика
1006 1006   "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1007 - "inputNumber": 0, ~/~/ Номер входа
1116 + "parameterName": "string", ~/~/ Имя параметра (взамен связки Input type + port number)
1008 1008   "pseudonym": "string", ~/~/ Псевдоним
1009 1009   "medianDegree": 0, ~/~/ Медианная фильтрация
1010 1010   "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
... ... @@ -1023,6 +1023,7 @@
1023 1023   ],
1024 1024   "showInTooltip": true, ~/~/ Отображать в подсказке
1025 1025   "showLastValid": true, ~/~/ Отображать последнее валидное значение
1135 + "color": "string", ~/~/ Код цвета датчиков
1026 1026   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1027 1027   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1028 1028   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -1036,41 +1036,32 @@
1036 1036   "additionalProp3": "string"
1037 1037   },
1038 1038  
1039 -~/~/ Характерные для произвольного:
1040 -
1041 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1042 -
1043 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1044 -
1045 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1046 -
1047 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1048 -
1049 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1050 -
1051 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1052 -
1053 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1054 -
1055 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1056 -
1057 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1058 -
1059 -~/~/ "ValueOn": "Вкл.",
1060 -
1061 -~/~/ "ValueOff": "Выкл."
1062 - "summaryMaxValue": 0 ~/~/ Макс. значение
1063 - }
1064 -
1149 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1150 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1151 + {
1152 + "from": 0, ~/~/ С какого значения
1153 + "color": "string", ~/~/ Каким цветом
1154 + "text": "string" ~/~/ Текст подписи к этому интервалу
1155 + }
1156 + ],
1157 + "disableEmissionsValidation": true, ~/~/ Нужно ли валидировать выбросы значений. Применяется для датчиков с типом "Накопительный"
1158 + "unitOfMeasure": 0 ~/~/ Единица измерения значений датчика. (0 - по умолчанию, 1 - секунды, 2 - часы)
1159 + } 
1160 + ],
1065 1065   "drivers": [ ~/~/ Водители
1066 1066   {
1067 1067   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1068 1068   "name": "string", ~/~/ Наименование
1069 - "description": "string",
1070 - "isDefault": true ~/~/ По умолчанию
1165 + "description": "string", ~/~/ Описание
1166 + "assignments": [  ~/~/ Информация по назначениям
1167 + {
1168 + "beginTime": "2025-10-21T12:28:41.021Z", ~/~/Момент времени начала назначения.
1169 + "endTime": "2025-10-21T12:28:41.021Z", ~/~/ Момент времени окончания назначения.
1170 + "createTime": "2025-10-21T12:28:41.021Z" ~/~/ Момент времени создания назначения.
1071 1071   }
1172 + ]
1173 + }
1072 1072   ],
1073 -
1074 1074   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1075 1075   {
1076 1076   "id": "", ~/~/ ID  задания
... ... @@ -1087,19 +1087,27 @@
1087 1087   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1088 1088   }
1089 1089   ],
1090 -
1091 - "statusHistory": [ ~/~/ История статусов
1191 +"statusHistory": [ ~/~/ История статусов
1092 1092   {
1093 1093   "status": 0,
1094 1094   "date": "2023-05-22T09:57:39.562Z",
1095 1095   "description": "string",
1096 1096   "additionalInfo": "string"
1097 - }
1098 - ]
1099 1099  
1198 +(((
1100 1100  }
1200 + ],
1201 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1202 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1101 1101  )))
1102 1102  
1205 +(((
1206 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1207 +}
1208 +
1209 +)))
1210 +)))
1211 +
1103 1103  (% style="text-align:left" %)
1104 1104  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1105 1105  
... ... @@ -1106,6 +1106,75 @@
1106 1106  (% style="text-align:left" %)
1107 1107  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1108 1108  
1218 +
1219 +== **Отправить команду на терминал** ==
1220 +
1221 +(% class="box successmessage" %)
1222 +(((
1223 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1224 +)))
1225 +
1226 +Команда для отправки на тс.
1227 +
1228 +{  
1229 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1230 +"command": "", ~/~/ Текст отправляемой команды
1231 +"retries": "", ~/~/ Количество попыток отправки на терминал
1232 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1233 +}
1234 +
1235 +В ответ получаем cmdid
1236 +
1237 +
1238 +== **Получить ответ на отправленную на ТС команду** ==
1239 +
1240 +(% class="box infomessage" %)
1241 +(((
1242 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1243 +)))
1244 +
1245 +Идентификатор команды: cmdId
1246 +
1247 +Запрос от терминала на ответ команды
1248 +
1249 +Пример ответ от терминала:
1250 +
1251 +ID= "" ~/~/ идентификатор объекта
1252 +Soft="" ~/~/ версия софта
1253 +GPS=4 ~/~/ тип трекера
1254 +Time=11:05:43 28.06.24 ~/~/ время запроса
1255 +Lat=45.056221 ~/~/ широта
1256 +Lon=39.035938 ~/~/ долгота
1257 +Speed=0.0 ~/~/ скорость
1258 +Course=181.4 ~/~/направление
1259 +
1260 +(((
1261 +== **Список отправленных объекту команд с ответами** ==
1262 +
1263 +(% class="box infomessage" %)
1264 +(((
1265 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1266 +)))
1267 +
1268 +Идентификатор ТС: vehicleId
1269 +
1270 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1271 +
1272 +Пример ответа терминала
1273 +
1274 +[ 
1275 +{    
1276 +"id": "", ~/~/ идентификатор пользователя
1277 +"commandText": "", ~/~/Текст команды.
1278 +"templateId": "", ~/~/Идентификатор шаблона
1279 +"updated": "", ~/~/ Время отправки  
1280 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1281 +"answer": "", ~/~/ Ответ терминала.
1282 +"status": "" ~/~/ Статус отправки
1283 +}
1284 +]
1285 +)))
1286 +
1109 1109  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1110 1110  
1111 1111  (% class="box successmessage" %)
... ... @@ -1125,6 +1125,11 @@
1125 1125  
1126 1126  (% style="color:#000000" %){
1127 1127  
1306 +
1307 +(((
1308 + "vehicleId": 0, ~/~/ ID ТС
1309 +)))
1310 +
1128 1128   "parentId": "" , ~/~/ ID клиента
1129 1129   "name": "" , ~/~/ имя ТС
1130 1130   "imei": "" , ~/~/ IMEI
... ... @@ -1145,7 +1145,6 @@
1145 1145   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1146 1146   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1147 1147   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1148 -
1149 1149   "mileageCalcMethod": 0,
1150 1150   "mileageCoeff": 0,
1151 1151   "locationByCellId": true,
... ... @@ -1178,7 +1178,6 @@
1178 1178   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1179 1179   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1180 1180   }
1181 -
1182 1182  "drivers": [ ~/~/ Водители
1183 1183   {
1184 1184   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1193,8 +1193,7 @@
1193 1193   "retries": 0
1194 1194   }
1195 1195   ],
1196 -
1197 - "sensors": [ ~/~/ Датчики
1377 +"sensors": [ ~/~/ Датчики
1198 1198   {
1199 1199   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1200 1200   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1220,6 +1220,7 @@
1220 1220   ],
1221 1221   "showInTooltip": true, ~/~/ Отображать в подсказке
1222 1222   "showLastValid": true, ~/~/ Отображать последнее валидное значение
1403 + "color": "string", ~/~/ код цвета датчиков
1223 1223   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1224 1224   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1225 1225   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -1232,103 +1232,222 @@
1232 1232   "additionalProp2": "string",
1233 1233   "additionalProp3": "string"
1234 1234   },
1235 -
1236 1236  ~/~/ Характерные для произвольного:
1237 -
1238 1238  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1239 -
1240 1240  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1241 -
1242 1242  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1243 -
1244 1244  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1245 -
1246 1246  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1247 -
1248 1248  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1249 -
1250 1250  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1251 -
1252 1252  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1253 -
1254 1254  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1255 -
1256 1256  ~/~/ "ValueOn": "Вкл.",
1257 -
1258 1258  ~/~/ "ValueOff": "Выкл."
1259 - "summaryMaxValue": 0 ~/~/ Макс. значение
1428 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1429 +
1430 +(((
1431 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1432 + {
1433 + "from": 0, ~/~/ С какого значения
1434 + "color": "string", ~/~/ Каким цветом
1435 + "text": "string" ~/~/ Текст подписи к этому интервалу
1436 + }
1437 + ]
1260 1260   }
1261 1261   ],
1440 +)))
1441 +
1442 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1443 +
1444 +
1262 1262   "customFields": [ ~/~/ Произвольные поля
1263 1263   {
1264 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1265 - "name": "string",
1266 - "value": "string",
1267 - "forClient": true,
1268 - "forTooltip": true,
1269 - "forReport": true
1270 - }
1271 - ]
1447 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1448 + "name": "string", ~/~/ Наименование произвольного поля
1449 + "value": "string", ~/~/ Значение произвольного поля
1450 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1451 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1452 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1453 +
1454 +(((
1455 + }
1456 + ],
1457 + "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1458 +)))
1459 +
1460 +(((
1461 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1272 1272  }
1463 +)))
1273 1273  
1465 +
1274 1274  (% style="color:#000000" %)Ответ:
1275 1275  
1276 -(% style="color:#000000" %){
1277 1277  
1278 - "vehicleId": "", ~/~/ID ТС 
1279 - "parentId": "", ~/~/Guid владельца ТС
1280 - "name": "", ~/~/Имя объекта
1281 - "imei": "", ~/~/IMEI
1282 - "deviceTypeId": "", ~/~/ID типа устройства
1283 - "modelId": "", ~/~/ID модели
1284 - "unitId": "", ~/~/ID подразделения
1285 - "sim1": "", ~/~/SIM1
1286 - "sim2": "", ~/~/SIM2
1287 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1288 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1289 - "counters": { ~/~/Счётчики
1290 - "mileageEnabled": true,
1291 - "motohoursEnabled": true,
1292 - "mileage": "",
1293 - "motohours": 345.0
1294 - },
1295 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1296 - "id": null,
1297 - "enabled": true, ~/~/флаг включения
1298 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1299 - "login": "", ~/~/ имя учетной записи
1300 - "password": "" ~/~/ пароль учетной записи
1301 - },
1302 - "inspectionTasks": { ~/~/ задания на ТО
1303 - "id": "", ~/~/ ID задачи
1304 - "enabled": false, ~/~/ Признак включения
1305 - "name": "", ~/~/ Имя задания
1306 - "description": "", ~/~/ Описание задания
1307 - "mileageCondition": "", ~/~/ Условие по пробегу
1308 - "lastMileage": "", ~/~/ Пробег (в метрах)
1309 - "motohoursCondition": "", ~/~/ Условие по моточасам
1310 - "lastMotohours": "", ~/~/ Моточасы
1311 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1312 - "kind": "", ~/~/ Вид периодичности по времени 
1313 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1469 +(((
1470 +(((
1471 +(((
1472 +{
1473 + "vehicleId": 0,  ~/~/ ID ТС
1474 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1475 + "name": "string", ~/~/ Имя объекта
1476 + "imei": "string", ~/~/ IMEI
1477 + "deviceTypeId": 0, ~/~/ ID типа устройства
1478 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1479 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1480 + "sim1": "string", ~/~/ SIM1
1481 + "sim2": "string", ~/~/ SIM2
1482 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1483 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1484 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1485 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1486 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1487 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1488 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1489 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1490 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1491 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1492 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1493 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1494 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1495 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1496 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1497 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1498 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1499 + "counters": {  ~/~/ Dto для состояний счётчиков
1500 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1501 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1502 + "mileage": 0, ~/~/ Пробег
1503 + "motohours": 0 ~/~/ Моточасы
1504 + },
1505 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1506 + "id": "string", ~/~/ CMSV6 Идентификатор
1507 + "enabled": true, ~/~/ Признак включения
1508 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1509 + "login": "string", ~/~/ CMSV6 имя учетной записи
1510 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1511 + },
1512 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1513 + {
1514 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1515 + "enabled": true, ~/~/ Признак включения
1516 + "name": "string", ~/~/ Имя задания
1517 + "description": "string", ~/~/ Описание задания
1518 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1519 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1520 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1521 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1522 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1523 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1524 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1525 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1314 1314   }
1527 + ],
1528 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1529 + {
1530 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1531 + "inputNumber": 0, ~/~/ № входа.
1532 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1533 + "comment": "string", ~/~/ Комментарий
1534 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1535 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1536 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1537 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1538 + }
1539 + ],
1540 + "commandTemplates": [  ~/~/ Список шаблонов команд
1541 + {
1542 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1543 + "name": "string", ~/~/ Название шаблона команд
1544 + "command": "string", ~/~/ Команда на выполнение
1545 + "retries": 0 ~/~/ Лимит попыток отправки
1546 + }
1547 + ],
1548 + "sensors": [ ~/~/ Список датчиков
1549 + {
1550 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1551 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1552 + "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
1553 + "name": "string",  ~/~/ Имя датчика
1554 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1555 + "inputNumber": 0, ~/~/ Номер входа
1556 + "pseudonym": "string", ~/~/ Псевдоним
1557 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1558 + "isInverted": true, ~/~/  Признак инверсии
1559 + "disabled": true, ~/~/ Датчик не участвует в обработке
1560 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1561 + "gradesTables": [ ~/~/ Тарировка
1562 + {
1563 + "grades": [ ~/~/ Таблицы тарировки
1564 + {
1565 + "input": 0, ~/~/ Вход
1566 + "output": 0 ~/~/ Выход
1567 + }
1568 + ],
1569 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1570 + }
1571 + ],
1572 + "showInTooltip": true, ~/~/ Отображение в подсказке
1573 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1574 + "color": "string", ~/~/ код цвета датчиков
1575 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1576 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1577 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1578 + "expr": "string", ~/~/ Выражение
1579 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1580 + "string"
1581 + ],
1582 + "customParams": {
1583 + "additionalProp1": "string",
1584 + "additionalProp2": "string",
1585 + "additionalProp3": "string"
1586 + },
1587 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1588 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1589 + {
1590 + "from": 0, ~/~/ С какого значения
1591 + "color": "string", ~/~/ Каким цветом
1592 +)))
1315 1315  
1316 -(% style="text-align:left" %)
1317 -(% style="color:#000000" %)}
1594 +(((
1595 + "text": "string" ~/~/ Текст подписи к этому интервалу
1596 + }
1597 + ]
1598 + }
1599 + ],
1600 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1601 + "customFields": [ ~/~/ Список произвольных полей
1602 + {
1603 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1604 + "name": "string", ~/~/ Наименование произвольного поля
1605 + "value": "string", ~/~/ Значение произвольного поля
1606 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1607 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1608 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1609 + }
1610 + ],
1611 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1612 +}
1613 +)))
1614 +)))
1615 +)))
1318 1318  
1617 +
1319 1319  **Валидация:**
1320 1320  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1321 1321  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1322 1322  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1323 1323  
1324 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1325 1325  
1624 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1625 +
1326 1326  (% class="box infomessage" %)
1327 1327  (((
1328 1328  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1329 1329  )))
1330 1330  
1331 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1631 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1332 1332  
1333 1333  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1334 1334  
... ... @@ -1362,9 +1362,12 @@
1362 1362   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1363 1363   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1364 1364   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1365 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1366 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1367 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1665 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1666 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1667 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1668 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1669 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1670 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1368 1368  }
1369 1369  
1370 1370  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1371,8 +1371,14 @@
1371 1371  
1372 1372  (% style="color:#000000" %)Ответ:
1373 1373  
1374 -(% style="color:#000000" %){
1677 +(% style="color:#000000" %)[
1678 +{
1375 1375  
1680 +(((
1681 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1682 +)))
1683 +
1684 +(((
1376 1376  (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1377 1377   "name": "" ~/~/ наименование объекта
1378 1378   "imei": "" ~/~/ IMEI объекта
... ... @@ -1398,9 +1398,21 @@
1398 1398   "forClient": true, ~/~/ право на отображение у клиента
1399 1399   "forTooltip": false, ~/~/ право на отображение в подсказке
1400 1400   "forReport": false ~/~/ право на отображение в отчетах
1401 - }(%%)
1402 -(% style="color:#000000" %)}
1710 +)))
1403 1403  
1712 +(((
1713 + }
1714 + ],
1715 + "vehicleGroups": [  ~/~/ Группы ТС
1716 + {
1717 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1718 + "name": "string" ~/~/ Наименование группы ТС
1719 + }
1720 + ]
1721 + }
1722 +]
1723 +)))
1724 +
1404 1404  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1405 1405  
1406 1406  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -1432,13 +1432,11 @@
1432 1432   "data": "", ~/~/ Данные
1433 1433   "overwrite": false, ~/~/ Флаг перезаписи
1434 1434   "stage": "", ~/~/ Состояние, может быть null
1435 -
1436 1436  (% style="color:#000000" %)}
1437 1437  
1438 1438  (% style="color:#000000" %)Ответ:
1439 1439  
1440 -(% style="color:#000000" %){
1441 -
1760 +(% style="color:#000000" %){(%%)
1442 1442   "status": "", ~/~/ значение статуса
1443 1443   "date": "", ~/~/ Дата смены статуса 
1444 1444   "description": "", ~/~/ Описание
... ... @@ -1445,10 +1445,9 @@
1445 1445   "data": "", ~/~/ Данные
1446 1446   "overwrite": false, ~/~/ Флаг перезаписи
1447 1447   "stage": "", ~/~/ Состояние
1448 -
1449 -(% style="text-align:left" %)
1450 1450  (% style="color:#000000" %) }
1451 1451  
1769 +
1452 1452  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1453 1453  
1454 1454  (% class="box warningmessage" %)
... ... @@ -1524,9 +1524,19 @@
1524 1524  
1525 1525  "drivers": [ ~/~/ Водители
1526 1526   {
1527 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1528 - "isDefault": true
1529 - }
1845 +
1846 +(((
1847 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1848 + "inputNumber": 0, ~/~/ № входа.
1849 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1850 + "comment": "string", ~/~/ Комментарий.
1851 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1852 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1853 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1854 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1855 +)))
1856 +
1857 + } 
1530 1530   ],
1531 1531   "commandTemplates": [ ~/~/ Шаблон команды
1532 1532   {
... ... @@ -1536,8 +1536,7 @@
1536 1536   "retries": 0
1537 1537   }
1538 1538   ],
1539 -
1540 - "sensors": [ ~/~/ Датчики
1867 +"sensors": [ ~/~/ Датчики
1541 1541   {
1542 1542   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1543 1543   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1563,6 +1563,11 @@
1563 1563   ],
1564 1564   "showInTooltip": true, ~/~/ Отображать в подсказке
1565 1565   "showLastValid": true, ~/~/ Отображать последнее валидное значение
1893 +
1894 +(((
1895 + "color": "string",** ~/~/ **Цвет датчика
1896 +)))
1897 +
1566 1566   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1567 1567   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1568 1568   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -1575,95 +1575,225 @@
1575 1575   "additionalProp2": "string",
1576 1576   "additionalProp3": "string"
1577 1577   },
1578 -
1579 1579  ~/~/ Характерные для произвольного:
1580 -
1581 1581  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1582 -
1583 1583  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1584 -
1585 1585  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1586 -
1587 1587  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1588 -
1589 1589  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1590 -
1591 1591  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1592 -
1593 1593  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1594 -
1595 1595  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1596 -
1597 1597  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1598 -
1599 1599  ~/~/ "ValueOn": "Вкл.",
1600 -
1601 1601  ~/~/ "ValueOff": "Выкл."
1602 1602   "summaryMaxValue": 0 ~/~/ Макс. значение
1923 +
1924 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1925 + {
1926 + "from": 0, ~/~/ С какого значения
1927 + "color": "string", ~/~/ Каким цветом
1928 + "text": "string" ~/~/ Текст подписи к этому интервалу
1929 + }
1930 + ]
1603 1603   }
1604 1604   ],
1933 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1934 +
1605 1605   "customFields": [ ~/~/ Произвольные поля
1606 - {
1607 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1608 - "name": "string",
1609 - "value": "string",
1610 - "forClient": true,
1611 - "forTooltip": true,
1612 - "forReport": true
1936 + {     
1937 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1938 + "name": "string", ~/~/ Наименование произвольного поля
1939 + "value": "string", ~/~/ Значение произвольного поля
1940 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1941 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1942 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1613 1613   }
1614 - ]
1944 +
1945 +(((
1946 + ],
1947 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1948 +)))
1949 +
1615 1615  }
1616 1616  
1952 +
1617 1617  (% style="color:#000000" %)Ответ:
1618 1618  
1619 -(% lang="en-US" style="text-align:left" %)
1620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1955 +(((
1956 +{
1957 + "vehicleId": 0, ~/~/ ID ТС
1958 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1959 + "name": "string", ~/~/ Имя объекта
1960 + "imei": "string", ~/~/ IMEI
1961 + "deviceTypeId": 0, ~/~/ ID типа устройства
1962 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1963 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1964 + "sim1": "string", ~/~/ SIM1
1965 + "sim2": "string", ~/~/ SIM2
1966 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1967 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1968 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1969 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1970 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1971 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1972 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1973 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1974 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1975 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1976 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1977 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1978 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1979 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1980 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1981 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1982 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1983 + "counters": { ~/~/ состояний счётчиков
1984 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1985 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1986 + "mileage": 0, ~/~/ Пробег
1987 + "motohours": 0 ~/~/ Моточасы 
1988 + },
1989 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1990 + "id": "string", ~/~/ CMSV6 Идентификатор
1991 + "enabled": true, ~/~/ Признак включения
1992 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1993 +)))
1621 1621  
1622 -(% lang="en-US" style="text-align:left" %)
1623 - "vehicleId": "", ~/~/ ID ТС
1624 - "parentId": "", ~/~/ ID клиента
1625 - "name": "", ~/~/ имя ТС
1626 - "imei": "", ~/~/ IMEI
1627 - "deviceTypeId": "", ~/~/ типа устройства
1628 - "modelId": "", ~/~/ ID модели
1629 - "unitId": "", ~/~/ ID подразделения
1630 - "sim1": "", ~/~/ SIM 1
1631 - "sim2": "", ~/~/ SIM2
1632 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1633 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1634 - "counters": 
1635 - {
1636 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1637 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1638 - "mileage": "", ~/~/ пробег
1639 - "motohours": "", ~/~/ моточасы
1640 - }
1641 - "cmsv6Parameters": ~/~/ параметры CMSv6
1995 +
1996 +(((
1997 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1998 + "login": "string", ~/~/ CMSV6 имя учетной записи
1999 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
2000 + },
2001 + "inspectionTasks": [ ~/~/ Задания на ТО
2002 + {
2003 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2004 + "enabled": true, ~/~/ Признак включения
2005 + "name": "string", ~/~/ Имя задания
2006 + "description": "string", ~/~/ Описание задания
2007 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2008 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2009 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2010 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2011 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
2012 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2013 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2014 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2015 + }
2016 + ],
2017 + "drivers": [  ~/~/ Список водителей
2018 + {
2019 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2020 + "inputNumber": 0, ~/~/ № входа.
2021 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2022 + "comment": "string", ~/~/ Комментарий.
2023 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2024 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2025 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2026 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2027 + }
2028 + ],
2029 + "commandTemplates": [ ~/~/ Список шаблонов команд
2030 + {
2031 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2032 + "name": "string", ~/~/ Название шаблона команд
2033 + "command": "string", ~/~/ Команда на выполнение
2034 + "retries": 0 ~/~/ Лимит попыток отправки
2035 + }
2036 + ],
2037 + "sensors": [  ~/~/ Список датчиков 
2038 + {
2039 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2040 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2041 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2042 +)))
2043 +
2044 +(((
2045 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2046 +)))
2047 +
2048 +(((
2049 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2050 +)))
2051 +
2052 +(((
2053 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2054 +)))
2055 +
2056 +(((
2057 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2058 +)))
2059 +
2060 +(((
2061 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2062 + "name": "string", ~/~/ Имя датчика
2063 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2064 +)))
2065 +
2066 +(((
2067 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2068 + "inputNumber": 0, ~/~/ Номер входа
2069 + "pseudonym": "string", ~/~/ Псевдоним
2070 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
2071 + "isInverted": true, ~/~/ Признак инверсии
2072 + "disabled": true, ~/~/ Датчик не участвует в обработке
2073 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2074 + "gradesTables": [ ~/~/ Тарировка
1642 1642   {
1643 - "id": ~/~/ идентификатор
1644 - "enabled": true, ~/~/ флаг включения
1645 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1646 - "login": "", ~/~/ имя учетной записи
1647 - "password": "", ~/~/ пароль учетной записи
1648 - }
1649 - "inspectionTasks": ~/~/ задания на ТО
1650 - {
1651 - "id": "", ~/~/ ID задания
1652 - "enabled": false, ~/~/ Признак включения
1653 - "name": "", ~/~/ Имя задания
1654 - "description": "", ~/~/ Описание задания
1655 - "mileageCondition": "", ~/~/ Условие по пробегу
1656 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1657 - "motohoursCondition": "", ~/~/ Условие по моточасам
1658 - "lastMotohours": "", ~/~/ Моточасы
1659 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1660 - "kind": "", ~/~/ Вид периодичности по времени
1661 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2076 + "grades": [ ~/~/ Таблицы тарировки
2077 + {
2078 + "input": 0, ~/~/ Вход
2079 + "output": 0 ~/~/ Выход
2080 + }
2081 + ],
2082 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
1662 1662   }
2084 + ],
2085 + "showInTooltip": true, ~/~/ Отображение в подсказке
2086 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1663 1663  
1664 -(% lang="en-US" style="text-align:left" %)
1665 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
2088 +(((
2089 + "color": "string", ~/~/ цвет уведомлений
2090 +)))
1666 1666  
2092 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2093 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2094 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2095 + "expr": "string", ~/~/ Выражение
2096 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2097 + "string" 
2098 + ],
2099 + "customParams": { ~/~/ Дополнительные настройки
2100 + "additionalProp1": "string",
2101 + "additionalProp2": "string",
2102 + "additionalProp3": "string"
2103 + },
2104 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2105 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2106 + {
2107 + "from": 0, ~/~/ С какого значения
2108 + "color": "string", ~/~/ Каким цветом
2109 + "text": "string" ~/~/ Текст подписи к этому интервалу
2110 + }
2111 + ]
2112 + }
2113 + ],
2114 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2115 + "customFields": [ ~/~/ Список произвольных полей
2116 + {
2117 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2118 + "name": "string", ~/~/ Наименование произвольного поля
2119 + "value": "string", ~/~/ Значение произвольного поля
2120 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2121 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2122 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2123 + }
2124 + ],
2125 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2126 +}
2127 +)))
2128 +
1667 1667  **Валидация:**
1668 1668  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1669 1669  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
... ... @@ -1702,18 +1702,15 @@
1702 1702  
1703 1703  (% style="color:#000000" %)Метод запроса: **GET**
1704 1704  
1705 -(% 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]]
2167 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1706 1706  
1707 1707  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1708 1708  
1709 1709  (% style="color:#000000" %)Ответ:
1710 1710  
1711 -(% style="color:#000000" %){
1712 -
2173 +(% style="color:#000000" %){(%%)
1713 1713   "deviceTypeId" : "", ~/~/ ID типа устройства
1714 1714   "deviceTypeName" : "" ~/~/ Название типа устройства
1715 -
1716 -(% style="text-align:left" %)
1717 1717  (% style="color:#000000" %)}
1718 1718  
1719 1719  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1735,13 +1735,10 @@
1735 1735  
1736 1736  (% style="color:#000000" %)Ответ:
1737 1737  
1738 -(% style="color:#000000" %){
1739 -
2197 +(% style="color:#000000" %){(%%)
1740 1740   "id": "", ~/~/ ID типа датчика 
1741 1741   "name": "", ~/~/ Название
1742 1742   "description": "", ~/~/ Описание
1743 -
1744 -(% style="text-align:left" %)
1745 1745  (% style="color:#000000" %)}
1746 1746  
1747 1747  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1785,6 +1785,56 @@
1785 1785   }
1786 1786  ]
1787 1787  
2244 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2245 +
2246 +(% class="box infomessage" style="text-align: left;" %)
2247 +(((
2248 +**POST /api/v3/terminalMessages/mapping**
2249 +)))
2250 +
2251 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2252 +
2253 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2254 +
2255 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2256 +
2257 +{
2258 + "protocolType": 0,
2259 + "params": ["string"]
2260 +}
2261 +
2262 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2263 +|protocolType|ID типа протокола
2264 +|params|(((
2265 +Массив наименований параметров в сообщении
2266 +)))
2267 +
2268 +Ответ:
2269 +
2270 +{
2271 + "protocolType": 0,
2272 + "mapping": {
2273 + "additionalProp1": {
2274 + "inputType": 0,
2275 + "inputNumber": 0
2276 + },
2277 + "additionalProp2": {
2278 + "inputType": 0,
2279 + "inputNumber": 0
2280 + }
2281 + }
2282 +}
2283 +
2284 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2285 +|protocolType|Тип протокола
2286 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2287 +|inputNumber|(((
2288 +Номер входа
2289 +)))
2290 +
2291 +(% class="wikigeneratedid" %)
2292 +Перечень 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/]]
2293 +
1788 1788  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1789 1789  
1790 1790  (% class="box infomessage" %)
... ... @@ -1809,6 +1809,11 @@
1809 1809   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1810 1810  }
1811 1811  
2318 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2319 +|vehicleId|ID объекта
2320 +|from|Дата и время начала периода запроса
2321 +|to|Дата и время окончания периода запроса
2322 +
1812 1812  Ответ:
1813 1813  
1814 1814  [
... ... @@ -1815,80 +1815,43 @@
1815 1815   {
1816 1816   "messages": [
1817 1817   {
1818 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1819 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1820 - "speed": 0, ~/~/ Скорость, км/ч
1821 - "altitude": 0, ~/~/ Высота, м
1822 - "latitude": 0, ~/~/ Широта [-90°;90°]
1823 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1824 - "satellites": 0, ~/~/ Кол-во спутников
1825 - "voltage": 0, ~/~/ Напряжение
1826 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
2329 + "deviceTime": "2023-11-29T07:40:44.052Z",
2330 + "serverTime": "2023-11-29T07:40:44.052Z",
2331 + "speed": 0,
2332 + "altitude": 0,
2333 + "latitude": 0,
2334 + "longitude": 0,
2335 + "satellites": 0,
2336 + "course": 0,
2337 + "voltage": 0,
2338 + "parameters": {
1827 1827   "additionalProp1": "string",
1828 1828   "additionalProp2": "string",
1829 1829   "additionalProp3": "string"
1830 1830   },
1831 - "photoCount": 0 ~/~/ Кол-во фото
2343 + "photoCount": 0,
2344 + "lbsCorrectedCoords": true,
2345 + "protocolType": 0
1832 1832   }
1833 1833   ]
1834 1834   }
1835 1835  ]
1836 1836  
1837 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
2351 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2352 +|deviceTime|Время сообщения терминала
2353 +|serverTime|Время когда сообщение поступило на сервер
2354 +|speed|Скорость
2355 +|altitude|Высота над уровнем моря
2356 +|latitude|Широта
2357 +|longitude|Долгота
2358 +|satellites|Кол-во спутников
2359 +|course|Курс
2360 +|voltage|Бортовое напряжение
2361 +|parameters|Список параметров и их значений
2362 +|photoCount|Количество фото
2363 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2364 +|protocolType|ID типа протокола
1838 1838  
1839 -(% class="box infomessage" %)
1840 -(((
1841 -**POST /api/v3/vehicles/export/history**
1842 -)))
1843 -
1844 -Метод возвращает список сообщений терминала объекта за выбранный период.
1845 -
1846 -(% style="text-align: left;" %)
1847 -Метод запроса **POST**
1848 -
1849 -(% style="text-align: left;" %)
1850 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1851 -
1852 -(% style="text-align: left;" %)
1853 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1854 -
1855 -{
1856 - "vehicleId": 0, ~/~/ ID объекта
1857 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1858 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1859 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1860 -}
1861 -
1862 -Ответ:
1863 -
1864 -Получаете файл. Сообщение: Code 200/Success
1865 -
1866 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1867 -
1868 -(% class="box infomessage" %)
1869 -(((
1870 -**GET /api/v3/vehicles/export/history/status**
1871 -)))
1872 -
1873 -Метод возвращает список сообщений терминала объекта за выбранный период.
1874 -
1875 -(% style="text-align: left;" %)
1876 -Метод запроса **GET**
1877 -
1878 -(% style="text-align: left;" %)
1879 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1880 -
1881 -(% style="text-align: left;" %)
1882 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1883 -
1884 -Ответ:
1885 -
1886 -{
1887 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1888 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1889 - "message": "string" ~/~/ текст описывающий статус.
1890 -}
1891 -
1892 1892  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1893 1893  
1894 1894  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1908,7 +1908,7 @@
1908 1908  Тело запроса:
1909 1909  
1910 1910  {
1911 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2385 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1912 1912   "vehicleIds": [0], ~/~/ Список ID объектов
1913 1913   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1914 1914   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -1925,16 +1925,20 @@
1925 1925   {
1926 1926   "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
1927 1927   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1928 - "mileageBegin": 0, ~/~/ Пробег на начало периода
1929 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
1930 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
1931 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2402 + "mileage": 0, ~/~/ Пробег за период, километры
2403 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2404 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2405 + "motohours": 0, ~/~/ Моточасы за период, секунды
2406 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2407 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2408 + "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2409 +
1932 1932   }
1933 1933   ]
1934 1934   }
1935 1935  ]
1936 1936  
1937 -== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2415 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе топлива транспортным средством**(%%) ==
1938 1938  
1939 1939  (% class="box infomessage" %)
1940 1940  (((
... ... @@ -1951,7 +1951,8 @@
1951 1951  Тело запроса:
1952 1952  
1953 1953  {
1954 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2432 +
2433 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1955 1955   "vehicleIds": [0], ~/~/ Список ID объектов
1956 1956   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1957 1957   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -1970,13 +1970,22 @@
1970 1970   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1971 1971   "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
1972 1972   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2452 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2453 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
1973 1973   "fuelConsumption": 0, ~/~/ Расход топлива
1974 1974   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2456 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2457 +
1975 1975   }
1976 1976   ]
1977 1977   }
1978 1978  ]
1979 1979  
2463 +(% class="box warningmessage" %)
2464 +(((
2465 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2466 +)))
2467 +
1980 1980  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
1981 1981  
1982 1982  (% class="box infomessage" %)
... ... @@ -2011,145 +2011,142 @@
2011 2011   "model": "string", ~/~/ Модель объекта
2012 2012   "fuels": [ ~/~/ Массив данным по заправкам и сливам
2013 2013   {
2014 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2502 + "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
2503 +
2504 +(((
2015 2015   "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2016 2016   "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2017 2017   "valueFuel": 0, ~/~/ Количество
2018 2018   "fuelStart": 0, ~/~/ Уровень топлива на начало события
2019 2019   "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2510 +)))
2511 +
2512 +(((
2513 + "latitude": 0, ~/~/ Широта.
2514 + "longitude": 0 ~/~/ Долгота.
2515 +)))
2516 +
2020 2020   }
2021 2021   ]
2022 2022   }
2023 2023  ]
2024 2024  
2025 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2026 2026  
2027 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2523 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2028 2028  
2029 2029  (% class="box infomessage" %)
2030 2030  (((
2031 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2527 +**POST /api/v3/vehicles/moveStop**
2032 2032  )))
2033 2033  
2034 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2530 +Метод запроса: **POST**
2035 2035  
2036 -(% style="color:#000000" %)Метод запроса: **POST**
2532 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2037 2037  
2038 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2534 +В заголовках запроса: X-Auth: Токен авторизации
2039 2039  
2040 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2041 2041  
2042 -(% style="text-align:left" %)
2043 2043  Тело запроса:
2044 2044  
2045 -(% style="text-align:left" %)
2046 2046  {
2047 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2540 + "vehicleIds": [ ], ~/~/ Список ID объектов
2541 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2542 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2543 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2048 2048  }
2049 2049  
2050 -(% style="text-align:left" %)
2051 2051  Ответ:
2052 2052  
2053 -[
2548 +[ 
2054 2054   {
2055 - "id": 0, ~/~/ Идентификатор объекта геозоны
2056 - "name": "string", ~/~/ Название объекта геозоны
2057 - "type": 0, ~/~/ Тип объекта геозоны
2058 - "fname": "string", ~/~/ Имя файла
2059 - "parentId": "string", ~/~/ Идентификатор клиента
2060 - "radius": 0, ~/~/ Радиус геообъекта
2061 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2062 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2063 - "description": "string", ~/~/ Описание
2064 - "area": 0, ~/~/ Площадь, м^^2^^
2065 - "perimetr": 0, ~/~/ Периметр, м
2066 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2067 - }
2068 -]
2069 -
2070 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2071 -
2072 -(% class="box infomessage" %)
2073 -(((
2074 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2075 -)))
2076 -
2077 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2078 -
2079 -(% style="color:#000000" %)Метод запроса: **POST**
2080 -
2081 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2082 -
2083 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2084 -
2085 -(% style="text-align:left" %)
2086 -Тело запроса:
2087 -
2088 -{
2089 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2090 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2091 - "ids": [ ], ~/~/ Массив id объектов
2092 - "byTime": 0, ~/~/ Объединение событий по времени 
2093 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2094 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2095 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2096 -}
2097 -
2098 -Ответ:
2099 -[
2100 - {
2101 - "geozoneId": 0, ~/~/ ID геообъекта
2102 - "geozoneName": "string", ~/~/ Название геообъекта
2103 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2104 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2105 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2106 2106   "vehicleId": 0, ~/~/ ID объекта
2107 - "vehicleName": "string" ~/~/ Имя объекта
2551 + "vehicleName": "string", ~/~/ Имя объекта
2552 + "moves": [ ~/~/ Событие движения
2553 + {
2554 + "mileage": 0, ~/~/ Пробег, км
2555 + "eventId": 0, ~/~/ Идентификатор события
2556 + "eventName": "string", ~/~/ Название события
2557 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2558 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2559 + "duration": 0 ~/~/ Продолжительность события, секунд
2560 + }
2561 + ],
2562 + "stops": [ ~/~/ События стоянок
2563 + {
2564 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2565 + "eventId": 0, ~/~/ Идентификатор события
2566 + "eventName": "string", ~/~/ Название события
2567 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2568 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2569 + "duration": 0 ~/~/ Продолжительность события, секунд
2570 + }
2571 + ]
2108 2108   }
2109 2109  ]
2110 2110  
2111 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2112 2112  
2576 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2577 +
2113 2113  (% class="box infomessage" %)
2114 2114  (((
2115 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2580 +**POST /api/v3/vehicles/getlastdata**
2116 2116  )))
2117 2117  
2118 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2583 +Метод запроса: **POST**
2119 2119  
2120 -(% style="color:#000000" %)Метод запроса: **POST**
2585 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2121 2121  
2122 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2587 +В заголовках запроса: X-Auth: Токен авторизации
2123 2123  
2124 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2125 2125  
2126 -(% style="text-align:left" %)
2127 -Тело запроса:
2590 +В массиве указываем id объектов через запятую
2128 2128  
2129 -{
2130 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2131 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2132 - "ids": [ ], ~/~/ Массив id геообъектов
2133 - "byTime": 0, ~/~/ Объединение событий по времени 
2134 - "byDist": 0, ~/~/ Объединение событий по расстоянию
2135 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2136 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2137 -}
2138 -
2139 2139  Ответ:
2140 2140  
2141 2141  [
2142 2142   {
2143 - "geozoneId": 0, ~/~/ ID геообъекта
2144 - "geozoneName": "string", ~/~/ Название геообъекта
2145 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2146 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2147 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2148 - "vehicleId": 0, ~/~/ ID объекта
2149 - "vehicleName": "string" ~/~/ Имя объекта
2596 + "vehicleId": 55728, ~/~/ Идентификатор объекта 
2597 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2598 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2599 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2600 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2601 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2602 + "speed": 31, ~/~/ Скорость объекта 
2603 + "course": 116, ~/~/ Курс движения [0;360]
2604 + "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2605 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2606 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2607 + "geozones": [ ~/~/ Сведения по геозонам. 
2608 + {
2609 + "id": 10225647, ~/~/ ID Геозоны 
2610 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2611 + },
2612 + {
2613 + "id": 10282875, ~/~/ ID Геозоны 
2614 + "name": "Ё2" ~/~/ Наименование геозоны 
2615 + },
2616 + {
2617 + "id": 10226240, ~/~/ ID Геозоны 
2618 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2619 + },
2620 + {
2621 + "id": 9747869, ~/~/ ID Геозоны 
2622 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2623 + },
2624 + {
2625 + "id": 10221123, ~/~/ ID Геозоны 
2626 + "name": "53r" ~/~/ Наименование геозоны 
2627 + },
2628 + {
2629 + "id": 10197638, ~/~/ ID Геозоны 
2630 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2631 + }
2632 + ]
2150 2150   }
2151 -]
2634 +
2152 2152  
2636 += =
2637 +
2153 2153  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2154 2154  
2155 2155  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2181,7 +2181,7 @@
2181 2181   "id": 0, ~/~/ ID уведомления
2182 2182   "name": "string", ~/~/ Название уведомления
2183 2183   "active": true, ~/~/ Состояние true - активен, false - деактивирован
2184 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2669 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2185 2185   "userId": "", ~/~/ Пользователь, создавший уведомление
2186 2186   "parentId": "", ~/~/ Идентификатор клиента
2187 2187   "parentName": "string" ~/~/ Имя клиента
... ... @@ -2188,6 +2188,155 @@
2188 2188   }
2189 2189  ]
2190 2190  
2676 +
2677 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2678 +
2679 +(% class="box infomessage" %)
2680 +(((
2681 +**POST /api/v3/notifications**
2682 +)))
2683 +
2684 +Метод запроса **POST**
2685 +
2686 +(% style="text-align: left;" %)
2687 +(% style="color:#000000" %)Пример запроса
2688 +
2689 +(((
2690 +{
2691 + "id": 0, ~/~/ ID правила
2692 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2693 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2694 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2695 + "name": "string", ~/~/ Имя правила
2696 + "active": true, ~/~/ Активность правила
2697 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2698 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2699 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2700 + ],
2701 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2702 + 0
2703 + ],
2704 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2705 + 0
2706 + ],
2707 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2708 + 0
2709 + ],
2710 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2711 + "additionalProp1": "string",  
2712 + "additionalProp2": "string",
2713 + "additionalProp3": "string"
2714 + },
2715 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2716 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2717 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2718 + ],
2719 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2720 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2721 + "string"
2722 + ],
2723 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2724 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2725 + {
2726 + "id": 0, ~/~/ Идентификатор участника чата.
2727 + "info": "string" ~/~/ Дополнительные сведения.
2728 + }
2729 + ],
2730 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2731 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2732 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2733 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2734 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2735 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2736 + "timezone": 0, ~/~/ часовой пояс 
2737 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2738 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2739 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2740 + {
2741 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2742 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2743 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2744 + "additionalProp1": "string",
2745 + "additionalProp2": "string",
2746 + "additionalProp3": "string"
2747 + }
2748 + }
2749 + ]
2750 +}
2751 +)))
2752 +
2753 +(((
2754 +
2755 +)))
2756 +
2757 +(((
2758 +
2759 +)))
2760 +
2761 +Ответ:
2762 +
2763 +{
2764 + "id": 0, ~/~/ ID правила
2765 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2766 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2767 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2768 + "name": "string", ~/~/ Имя правила
2769 + "active": true, ~/~/ Активность правила
2770 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2771 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2772 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2773 + ],
2774 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2775 + 0
2776 + ],
2777 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2778 + 0
2779 + ],
2780 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2781 + 0
2782 + ],
2783 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2784 + "additionalProp1": "string",  
2785 + "additionalProp2": "string",
2786 + "additionalProp3": "string"
2787 + },
2788 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2789 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2790 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2791 + ],
2792 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2793 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2794 + "string"
2795 + ],
2796 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2797 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2798 + {
2799 + "id": 0, ~/~/ Идентификатор участника чата.
2800 + "info": "string" ~/~/ Дополнительные сведения.
2801 + }
2802 + ],
2803 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2804 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2805 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2806 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2807 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2808 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2809 + "timezone": 0, ~/~/ часовой пояс 
2810 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2811 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2812 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2813 + {
2814 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2815 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2816 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2817 + "additionalProp1": "string",
2818 + "additionalProp2": "string",
2819 + "additionalProp3": "string"
2820 + }
2821 + }
2822 + ]
2823 +}
2824 +
2191 2191  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2192 2192  
2193 2193  (% class="box infomessage" %)
... ... @@ -2329,6 +2329,32 @@
2329 2329  
2330 2330  Success
2331 2331  
2966 +
2967 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2968 +
2969 +(% class="box warningmessage" %)
2970 +(((
2971 +**PUT** /api/v3/notifications/prolongation
2972 +)))
2973 +
2974 +Метод позволяет продлить уведомления.
2975 +
2976 +Метод запроса **PUT**
2977 +
2978 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2979 +
2980 +В заголовках запроса: X-Auth: Токен авторизации.
2981 +
2982 +Тело запроса:
2983 +
2984 +[
2985 +
2986 +0
2987 +
2988 +]
2989 +
2990 +где 0 идентификатор ids.
2991 +
2332 2332  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2333 2333  
2334 2334  (% class="box errormessage" %)
... ... @@ -2920,6 +2920,83 @@
2920 2920  Success
2921 2921  
2922 2922  
3583 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3584 +
3585 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3586 +
3587 +(% class="box infomessage" %)
3588 +(((
3589 +**POST /api/v3/Trailers**
3590 +)))
3591 +
3592 +Пример запроса:
3593 +
3594 +{
3595 + "startDate": "2023-11-14T10:48:03.671Z",
3596 + "endDate": "2023-11-14T10:48:03.671Z",
3597 + "ids": [ 0 ],
3598 + "timezone": 0
3599 +}
3600 +
3601 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3602 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3603 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3604 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3605 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3606 +
3607 +Пример ответа:
3608 +
3609 +[
3610 + {
3611 + "SD": "2023-11-14T10:48:03.717Z",
3612 + "ED": "2023-11-14T10:48:03.717Z", 
3613 + "id": 0,
3614 + "SLat": 0,
3615 + "SLon": 0,
3616 + "ELat": 0,
3617 + "ELon": 0,
3618 + "mileage": 0
3619 + "Duration": 0
3620 + "Address": "string",
3621 + "Address2": "string",
3622 + "name": "string",
3623 + "rid": "string",
3624 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3625 + "trailer": {
3626 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3627 + "Number": "string",
3628 + "Description": "string",
3629 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3630 + "ExternalID": "string",
3631 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3632 + "CreateTime": "2023-11-14T10:48:03.717Z",
3633 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3634 + "IsDeleted": true
3635 + },
3636 + "filesCount": 0,
3637 + }
3638 +]
3639 +
3640 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3641 +|SD|Дата и время начала события
3642 +|ED|Дата и время окончания события
3643 +|id|ID объекта
3644 +|SLat|Широта начальной координаты
3645 +|SLon|Долгота начальной координаты
3646 +|ELat|Широта конечной координаты
3647 +|ELon|Долгота конечной координаты
3648 +|mileage|Пробег
3649 +|Duration|Продолжительность
3650 +|Address|Адрес начального местоположения
3651 +|Address2|Адрес конечного местоположения
3652 +|name|Имя радиометки
3653 +|rid|Номер радиометки
3654 +|rguid|ID радиометки
3655 +|trailer|Информация об агрегате
3656 +|ModelGuid|ID агрегата
3657 +|Number|Название/номер агрегата
3658 +|Description|Текст примечания агрегата
3659 +
2923 2923  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2924 2924  
2925 2925  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2941,13 +2941,18 @@
2941 2941   {
2942 2942   "name": "string",
2943 2943   "number": 0,
2944 - "period": 0, ~/~/ Частота трансляции радиометки
3681 + "period": 0,
2945 2945   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2946 2946   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2947 - "deleted": true
2948 2948   }
2949 2949  ]
2950 2950  
3687 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3688 +|parentId|ID клиента
3689 +|name|Название карты-метки
3690 +|number|Номер
3691 +|period|Период запросов в секундах (работает только для агрегатов)
3692 +|id|ID карты-метки
2951 2951  
2952 2952  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2953 2953  
... ... @@ -2964,13 +2964,18 @@
2964 2964   {
2965 2965   "name": "string",
2966 2966   "number": 0,
2967 - "period": 0, ~/~/ Частота трансляции радиометки
3709 + "period": 0,
2968 2968   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2969 2969   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2970 - "deleted": true
2971 2971   }
2972 2972  ]
2973 2973  
3715 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3716 +|name|Название карты-метки
3717 +|number|Номер
3718 +|period|Период запросов в секундах (работает только для агрегатов)
3719 +|id|ID карты-метки
3720 +|parentId|ID клиента
2974 2974  
2975 2975  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2976 2976  
... ... @@ -2986,7 +2986,6 @@
2986 2986   "number": 0,
2987 2987   "period": 0,
2988 2988   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2989 - "deleted": true
2990 2990  }
2991 2991  
2992 2992  Ответ:
... ... @@ -2997,9 +2997,14 @@
2997 2997   "period": 0,
2998 2998   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2999 2999   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3000 - "deleted": true
3001 3001  }
3002 3002  
3748 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3749 +|name|Название карты-метки
3750 +|number|Номер
3751 +|period|Период запросов в секундах (работает только для агрегатов)
3752 +|id|ID карты-метки
3753 +|parentId|ID клиента
3003 3003  
3004 3004  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3005 3005  
... ... @@ -3016,7 +3016,6 @@
3016 3016   "period": 0,
3017 3017   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3018 3018   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3019 - "deleted": true
3020 3020  }
3021 3021  
3022 3022  Ответ:
... ... @@ -3027,9 +3027,14 @@
3027 3027   "period": 0,
3028 3028   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3029 3029   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3030 - "deleted": true
3031 3031  }
3032 3032  
3782 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3783 +|name|Название карты-метки
3784 +|number|Номер
3785 +|period|Период запросов в секундах (работает только для агрегатов)
3786 +|id|ID карты-метки
3787 +|parentId|ID клиента
3033 3033  
3034 3034  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3035 3035  
... ... @@ -3038,7 +3038,7 @@
3038 3038  **DELETE /api/v3/Rfids/{rfidGuid}**
3039 3039  )))
3040 3040  
3041 -Передаем параметр rfidGuid - идентификатор карты-метки
3796 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3042 3042  
3043 3043  Ответ:
3044 3044  
... ... @@ -3045,6 +3045,2763 @@
3045 3045  Success
3046 3046  
3047 3047  
3803 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3804 +
3805 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3806 +
3807 +(% class="box infomessage" %)
3808 +(((
3809 +**GET /api/v3/Billing/client/balance/{clientId}**
3810 +)))
3811 +
3812 +Параметр запроса: **clientId **- идентификатор клиента.
3813 +
3814 +Ответ:
3815 +
3816 +{
3817 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3818 + "Balance": 0
3819 +}
3820 +
3821 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3822 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3823 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3824 +
3825 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3826 +
3827 +(% class="box infomessage" %)
3828 +(((
3829 +**GET /api/v3/Billing/client/constraint/{clientId}**
3830 +)))
3831 +
3832 +Параметр запроса: **clientId **- идентификатор клиента.
3833 +
3834 +Ответ:
3835 +
3836 +{
3837 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3838 + "CalculationType": 0,
3839 + "PermissibleBalance": 0,
3840 + "DefermentDays": 0,
3841 + "SendUiNotifications": true,
3842 + "SendEmailNotifications": true,
3843 + "IsPrivate": true,
3844 +}
3845 +
3846 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3847 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3848 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3849 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3850 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3851 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3852 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3853 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3854 +
3855 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3856 +
3857 +(% class="box infomessage" %)
3858 +(((
3859 +**GET /api/v3/Billing/client/plan/{clientId}**
3860 +)))
3861 +
3862 +Параметры запроса:
3863 +
3864 +**clientId **- идентификатор клиента.
3865 +
3866 +**planId **- идентификатор тарифного плана.
3867 +
3868 +Ответ:
3869 +
3870 +{
3871 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3872 + "Plan": { **~/~/ Описание тарифного плана**
3873 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3874 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3875 + "Name": "string",
3876 + "IsArchived": true,
3877 + "Constraint": {
3878 + "CalculationType": 0,
3879 + "PermissibleBalance": 0,
3880 + "DefermentDays": 0
3881 + },
3882 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3883 + {
3884 + "Feature": "string",
3885 + "IsFactual": true,
3886 + "Limit": 0,
3887 + "Price": 0,
3888 + "PeriodValue": 0,
3889 + "PeriodType": 0
3890 + }
3891 + ]
3892 + },
3893 + "DebitDate": "2023-10-18T12:46:24.213Z",
3894 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3895 + {
3896 + "Feature": "string",
3897 + "IsEnabled": true,
3898 + "IsPrivate": true,
3899 + "IsFactual": true,
3900 + "Limit": 0,
3901 + "Price": 0,
3902 + "DebitDate": "2023-10-18T12:46:24.213Z",
3903 + "PeriodValue": 0,
3904 + "PeriodType": 0
3905 + }
3906 + ]
3907 +}
3908 +
3909 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3910 +|ClientId|Идентификатор клиента
3911 +|Id|Идентификатор тарифного плана
3912 +|OwnerId|Идентификатор клиента-владельца
3913 +|Name|Наименование тарифного плана
3914 +|IsArchived|Признак, определяющий архивный тарифный план
3915 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3916 +|PermissibleBalance|Допустимый баланс
3917 +|DefermentDays|Отсрочка, количество дней
3918 +|Feature|Код услуги
3919 +|IsEnabled|Признак, определяющий активирована ли услуга
3920 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3921 +|IsFactual|Признак, определяющий расчёт по факту
3922 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3923 +|Price|Цена за единицу.
3924 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3925 +|PeriodValue|Значение периода.
3926 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3927 +
3928 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3929 +
3930 +(% class="box infomessage" %)
3931 +(((
3932 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3933 +)))
3934 +
3935 +Параметр запроса: **clientId **- идентификатор клиента.
3936 +
3937 +Ответ:
3938 +
3939 +[
3940 + {
3941 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3942 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3943 + "Name": "string",
3944 + "IsArchived": true,
3945 + "Constraint": {
3946 + "CalculationType": 0,
3947 + "PermissibleBalance": 0,
3948 + "DefermentDays": 0
3949 + },
3950 + "Features": [
3951 + {
3952 + "Feature": "string",
3953 + "IsFactual": true,
3954 + "Limit": 0,
3955 + "Price": 0,
3956 + "PeriodValue": 0,
3957 + "PeriodType": 0
3958 + }
3959 + ]
3960 + }
3961 +]
3962 +
3963 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3964 +|ClientId|Идентификатор клиента
3965 +|Id|Идентификатор тарифного плана
3966 +|OwnerId|Идентификатор клиента-владельца
3967 +|Name|Наименование тарифного плана
3968 +|IsArchived|Признак, определяющий архивный тарифный план
3969 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3970 +|PermissibleBalance|Допустимый баланс
3971 +|DefermentDays|Отсрочка, количество дней
3972 +|Feature|Код услуги
3973 +|IsFactual|Признак, определяющий расчёт по факту
3974 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3975 +|Price|Цена за единицу.
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 warningmessage" %)
4033 +(((
4034 +**PUT /api/v3/Billing/client/balance**
4035 +)))
4036 +
4037 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4038 +
4039 +Тело запроса:
4040 +
4041 +{
4042 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4043 + "Balance": 0 ~/~/ Значение баланса.
4044 +}
4045 +
4046 +Ответ: Success
4047 +
4048 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4049 +
4050 +(% class="box warningmessage" %)
4051 +(((
4052 +**PUT /api/v3/billing/client/balance/deposit**
4053 +)))
4054 +
4055 +Создает операцию **Пополнение **с указанной суммой
4056 +
4057 +Тело запроса:
4058 +
4059 +(((
4060 +{
4061 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4062 + "amount": 0 ~/~/ Сумма пополнения баланса 
4063 +}
4064 +)))
4065 +
4066 +(((
4067 +
4068 +)))
4069 +
4070 +Ответ: Success
4071 +
4072 +(((
4073 +{
4074 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4075 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4076 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4077 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4078 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4079 + "Description": "string" ~/~/ Описание корректировки.
4080 +}
4081 +)))
4082 +
4083 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4084 +
4085 +Создает операцию **Списание **с указанной суммой
4086 +
4087 +(% class="box warningmessage" %)
4088 +(((
4089 +**PUT /api/v3/billing/client/balance/withdraw**
4090 +)))
4091 +
4092 +Тело запроса:
4093 +
4094 +(((
4095 +{
4096 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4097 + "amount": 0 ~/~/ Сумма списания с баланса
4098 +}
4099 +)))
4100 +
4101 +Ответ: Success
4102 +
4103 +(((
4104 +{
4105 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4106 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4107 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4108 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4109 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4110 + "Description": "string" ~/~/ Описание корректировки
4111 +}
4112 +)))
4113 +
4114 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4115 +
4116 +(% class="box warningmessage" %)
4117 +(((
4118 +**PUT /api/v3/Billing/client/constraint**
4119 +)))
4120 +
4121 +Тело запроса:
4122 +
4123 +(((
4124 +{
4125 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4126 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4127 + "PermissibleBalance": 0, ~/~/ Допустимый баланс
4128 + "DefermentDays": 0, ~/~/ Отсрочка (дни).
4129 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4130 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4131 +}
4132 +)))
4133 +
4134 +(((
4135 +
4136 +)))
4137 +
4138 +Ответ: Success
4139 +
4140 +(((
4141 +{
4142 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4143 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4144 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4145 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4146 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4147 + "DefermentDays": 0, ~/~/ Отсрочка (дни)
4148 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4149 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4150 +}
4151 +)))
4152 +
4153 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4154 +
4155 +(% class="box warningmessage" %)
4156 +(((
4157 +**PUT /api/v3/Billing/client/plan**
4158 +)))
4159 +
4160 +Тело запроса:
4161 +
4162 +{
4163 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4164 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4165 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4166 + {
4167 + "Feature": "string", ~/~/ Код услуги.
4168 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4169 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4170 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4171 + "Price": 0, ~/~/ Цена за единицу.
4172 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4173 + "PeriodValue": 0, ~/~/ Значение периода.
4174 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4175 + }
4176 + ]
4177 +}
4178 +
4179 +
4180 +Ответ: Success
4181 +
4182 +(((
4183 +{
4184 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4185 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4186 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4187 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4188 + "Name": "string", ~/~/ Наименование.
4189 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4190 + "Constraint": { ~/~/ Ограничения по тарифу 
4191 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4192 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4193 + "DefermentDays": 0 ~/~/ Отсрочка (дни)
4194 + },
4195 + "Features": [ ~/~/ Набор услуг по тарифному плану.
4196 + {
4197 + "Feature": "string", ~/~/Код услуги.
4198 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4199 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4200 + "Price": 0, ~/~/ Цена за единицу.
4201 + "PeriodValue": 0, ~/~/ Значение периода.
4202 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4203 + }
4204 + ],
4205 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4206 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4207 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4208 + },
4209 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4210 + {
4211 + "Feature": "string", ~/~/ Код услуги.
4212 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4213 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4214 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4215 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4216 + "Price": 0, ~/~/ Цена за единицу.
4217 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4218 + "PeriodValue": 0, ~/~/ Значение периода.
4219 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4220 + "Quantity": 0 ~/~/ Количество использования услуги.
4221 + }
4222 + ]
4223 +}
4224 +)))
4225 +
4226 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4227 +
4228 +(% class="box warningmessage" %)
4229 +(((
4230 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4231 +)))
4232 +
4233 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4234 +
4235 +(% class="box infomessage" %)
4236 +(((
4237 +**POST /api/v3/vehicles/import/{agentId}**
4238 +)))
4239 +
4240 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4241 +
4242 +В пути указывается **agentId** - id клиента.
4243 +
4244 +**Заголовок**
4245 +
4246 +**X-Auth: [токен авторизации]**
4247 +
4248 +**Параметры**
4249 +
4250 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4251 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4252 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4253 +
4254 +В теле использовать тип **form-data,** тип значения** file**
4255 +
4256 +**Ключи**
4257 +
4258 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4259 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
4260 +|csv|В значении передаем файл датчиков, формат **csv**
4261 +
4262 +Ответ:
4263 +
4264 +{
4265 + "vehicleId": 0,
4266 + "name": "string",
4267 + "errors": ["string"]
4268 +}
4269 +
4270 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4271 +|vehicleId|ID созданного объекта
4272 +|name|Имя созданного объекта
4273 +|errors|Ошибки и их описание
4274 +
4275 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4276 +
4277 +(% class="box infomessage" %)
4278 +(((
4279 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4280 +)))
4281 +
4282 +(% class="wikigeneratedid" %)
4283 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4284 +
4285 +(% class="wikigeneratedid" %)
4286 +В пути указывается **vehicleId **- id объекта.
4287 +
4288 +**Заголовок**
4289 +
4290 +**X-Auth: [токен авторизации]**
4291 +
4292 +В теле использовать тип **form-data.**
4293 +
4294 +Ключи:
4295 +
4296 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4297 +|**history**|В значении передавать файл с историей
4298 +
4299 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4300 +
4301 +Ответ:
4302 +
4303 +{
4304 + "results": [
4305 + {
4306 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4307 + "vehicleId": 0,
4308 + "errors": [
4309 + "string"
4310 + ],
4311 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
4312 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
4313 + "producedCount": 0,
4314 + "msgCount": 0
4315 + }
4316 + ]
4317 +}
4318 +
4319 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4320 +|results|Результаты импорта в разрезе ТС
4321 +|vehicleGuid|Guid ТС
4322 +|vehicleId|ID ТС
4323 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4324 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
4325 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4326 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
4327 +|msgCount|Кол-во обработанных сообщений всего
4328 +
4329 +== **Импортировать историю ТС (Асинхронный запрос)** ==
4330 +
4331 +(% class="box successmessage" %)
4332 +(((
4333 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4334 +)))
4335 +
4336 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4337 +
4338 +Метод запроса: **POST**
4339 +
4340 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4341 +
4342 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4343 +
4344 +
4345 +Ответ:
4346 +
4347 +{
4348 +
4349 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4350 +
4351 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4352 +
4353 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4354 +
4355 + "Message": "string", ~/~/ Информация о выполнении запроса
4356 +
4357 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4358 +
4359 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4360 +
4361 + "Data": "string" ~/~/ Данные
4362 +
4363 +}
4364 +
4365 +
4366 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4367 +
4368 +(% class="box infomessage" %)
4369 +(((
4370 +**GET /api/v3/vehicles/import/history/status**
4371 +)))
4372 +
4373 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4374 +
4375 +Ответ:
4376 +
4377 +{
4378 + "activity": true,
4379 + "progress": 0,
4380 + "message": "string"
4381 +}
4382 +
4383 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4384 +**Параметр**
4385 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4386 +**Описание**
4387 +)))
4388 +|(((
4389 +activity
4390 +)))|(((
4391 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4392 +)))
4393 +|(((
4394 +progress
4395 +)))|(((
4396 +Guid ТС
4397 +)))
4398 +
4399 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4400 +
4401 +(% class="box infomessage" %)
4402 +(((
4403 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4404 +)))
4405 +
4406 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4407 +
4408 +Метод запроса: **GET**
4409 +
4410 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4411 +
4412 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4413 +
4414 +
4415 +Ответ:
4416 +
4417 +{
4418 +
4419 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4420 +
4421 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4422 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4423 +
4424 + "Message": "string", ~/~/ Информация о выполнении запроса
4425 +
4426 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4427 +
4428 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4429 +
4430 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4431 +
4432 + "Data": "string" ~/~/ Данные
4433 +
4434 +}
4435 +
4436 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4437 +
4438 +(% class="box infomessage" %)
4439 +(((
4440 +**POST /api/v3/vehicles/export**
4441 +)))
4442 +
4443 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4444 +
4445 +Тело запроса:
4446 +
4447 +[
4448 + id
4449 +]
4450 +
4451 +Ответ: Success 200, получаете файлы с настройками.
4452 +
4453 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4454 +
4455 +(% class="box infomessage" %)
4456 +(((
4457 +**POST /api/v3/vehicles/export/history**
4458 +)))
4459 +
4460 +Метод возвращает список сообщений терминала объекта за выбранный период.
4461 +
4462 +Тело запроса:
4463 +
4464 +{
4465 + "vehicleId": 0,
4466 + "asArchive": true,
4467 + "from": "2023-09-27T12:17:45.973Z",
4468 + "to": "2023-09-27T12:17:45.973Z"
4469 +}
4470 +
4471 +Ответ:
4472 +
4473 +Получаете файл. Сообщение: Code 200/Success
4474 +
4475 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4476 +|vehicleId|ID объекта
4477 +|asArchive|true - Архивировать файл, False - не архивировать
4478 +|from|Дата и время начала запроса
4479 +|to|Дата и время окончания запроса
4480 +
4481 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4482 +
4483 +(% class="box infomessage" %)
4484 +(((
4485 +**GET /api/v3/vehicles/export/history/status**
4486 +)))
4487 +
4488 +Метод возвращает список сообщений терминала объекта за выбранный период.
4489 +
4490 +Ответ:
4491 +
4492 +{
4493 + "activity": true,
4494 + "progress": 0,
4495 + "message": "string"
4496 +}
4497 +
4498 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4499 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4500 +|progress|Прогресс экспорта, от 0 до 100%
4501 +|message|Текст описывающий статус
4502 +
4503 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4504 +
4505 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4506 +
4507 +(% class="box infomessage" %)
4508 +(((
4509 +**POST /api/v3/EcoDriving/rating**
4510 +)))
4511 +
4512 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4513 +
4514 +Тело запроса:
4515 +
4516 +{
4517 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4518 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4519 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4520 +}
4521 +
4522 +Ответ:
4523 +
4524 +{
4525 + "items": [  ~/~/ Список в разрезе ТС
4526 + {
4527 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4528 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4529 + "vehicleId": 0, ~/~/ ID ТС
4530 + "vehicleName": "string", ~/~/ Название ТС
4531 + "vehicleModel": "string", ~/~/ Модель ТС
4532 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4533 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4534 + "totalViolations": 0, ~/~/ Нарушений всего
4535 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4536 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4537 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4538 + "brakingViolations": 0, ~/~/ Нарушений торможения
4539 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4540 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4541 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4542 + },
4543 +
4544 +(((
4545 +
4546 +)))
4547 +
4548 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4549 + "mileage": 0, ~/~/ Пробег, м
4550 + "tripsCount": 0, ~/~/ Кол-во рейсов
4551 + "trips": [  ~/~/ Информация по рейсу
4552 + {
4553 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4554 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4555 + "violationsCount": 0, ~/~/ Всего нарушений
4556 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4557 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4558 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4559 + "brakingViolations": 0, ~/~/ Нарушений торможения
4560 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4561 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4562 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4563 + },
4564 +
4565 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4566 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4567 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4568 + "mileage": 0, ~/~/ Пробег, м
4569 + "motohours": 0, ~/~/ Моточасы, секунды
4570 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4571 + "startAddress": "string", ~/~/ Адрес начала рейса
4572 + "endAddress": "string", ~/~/ Адрес конца рейса
4573 + "drivers": [  ~/~/ Список водителей
4574 + {
4575 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4576 + "driverName": "string", ~/~/ФИО водителя
4577 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4578 + }
4579 + ]
4580 + }
4581 + ]
4582 + }
4583 + ]
4584 +}
4585 +
4586 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4587 +
4588 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4589 +
4590 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4591 +
4592 +(% class="box infomessage" %)
4593 +(((
4594 +**POST /api/v3/fuelcards/transactions**
4595 +)))
4596 +
4597 +Метод запроса: POST
4598 +
4599 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4600 +\\В заголовках запроса: X-Auth: Токен авторизации
4601 +
4602 +Параметры в теле запроса (JSON):
4603 +
4604 +{
4605 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4606 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4607 + "ids": [ 
4608 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4609 + ],
4610 + "timezone": 0 ~/~/ Часовой пояс
4611 +}
4612 +
4613 +
4614 +Ответ:
4615 + {
4616 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4617 + "driver": "string", ~/~/ Водители, привязанные к ТК
4618 + "object": "string", ~/~/ Наименование ТС
4619 + "amount": 0, ~/~/ Количество топлива
4620 + "amountDut": 0, ~/~/ Количество по ДУТ
4621 + "amountDiff": 0, ~/~/ Разница, л
4622 + "amountDiffPerc": 0, ~/~/ Разница, %
4623 + "summa": 0, ~/~/ Стоимость, руб
4624 + "serviceName": "string", ~/~/ Тип топлива
4625 + "price": 0, ~/~/ Цена за литр, руб
4626 + "cardName": "string", ~/~/ Наименование ТК
4627 + "cardNum": "string", ~/~/ Номер ТК
4628 + "operator": "string", ~/~/ Оператор ТК
4629 + "address": "string" ~/~/ Адрес АЗС
4630 + }
4631 +
4632 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4633 +
4634 +(% class="box infomessage" %)
4635 +(((
4636 +**GET /api/v3/fuelcards**
4637 +)))
4638 +
4639 +Метод запроса: GET
4640 +
4641 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4642 +
4643 +Ответ:
4644 +
4645 +[
4646 + {
4647 + "Name": "string", ~/~/ Определяет наименование карты.
4648 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4649 + "Number": "string", ~/~/ Определяет № карты.
4650 + "Enabled": true, ~/~/ Определяет признак активности карты.
4651 + "Description": "string", ~/~/ Определяет описание карты.
4652 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4653 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4654 + "deleted": true ~/~/ Признак удаления
4655 + }
4656 +]
4657 +
4658 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4659 +
4660 +
4661 +== **Получение полных данных о ретрансляторе** ==
4662 +
4663 +(% class="box infomessage" %)
4664 +(((
4665 +**GET ** **/api/v3/retranslations/{id}**
4666 +)))
4667 +
4668 +id - Идентификатор ретранслятора
4669 +
4670 +
4671 +Пример ответа:
4672 +
4673 +{  
4674 +"description": "", ~/~/ Поле описания ретранслятора
4675 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4676 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4677 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4678 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4679 +"objects": [ ~/~/ Объекты для ретрансляции
4680 +{      
4681 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4682 +"name": "", ~/~/ Наименование объекта ретрансляции
4683 +"imei": "", ~/~/ IMEI объекта  ретрансляции
4684 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4685 +}
4686 + ],  
4687 +"id": "", ~/~/ Идентификатор ретранслятора 
4688 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4689 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4690 +}
4691 +
4692 +
4693 +== **Удаление данных ретранслятора** ==
4694 +
4695 +(% class="box infomessage" %)
4696 +(((
4697 +**DELETE** **/api/v3/retranslations/{id}**
4698 +)))
4699 +
4700 +id - Идентификатор ретранслятора
4701 +
4702 +
4703 +== **Создание ретранслятора** ==
4704 +
4705 +(% class="box infomessage" %)
4706 +(((
4707 +**POST ** **/api/v3/retranslations/{id}**
4708 +)))
4709 +
4710 +Запрос:
4711 +
4712 +{  
4713 +"description": "", ~/~/ Поле описания ретранслятора
4714 +"subscriberId": "", ~/~/ Идентификатор подписчика
4715 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4716 +"address": "", ~/~/ Адрес и порт принимающего сервера
4717 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4718 +"objects": [ ~/~/Объекты для ретрансляции
4719 +{      
4720 +"id": "", ~/~/ Идентификатор ретранслятора 
4721 +"imei": "", ~/~/ IMEI объекта ретрансляции
4722 +"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4723 +}
4724 + ]
4725 +}
4726 +
4727 +
4728 +Ответ:
4729 +
4730 +{  
4731 +"description": "", ~/~/ Поле описания ретранслятора
4732 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4733 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4734 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4735 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4736 +"objects": [ ~/~/ Объекты для ретрансляции
4737 +{      
4738 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4739 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4740 +"imei": "", ~/~/ IMEI объекта ретрансляции
4741 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4742 +}
4743 + ],
4744 +"id": "", ~/~/ Идентификатор ретранслятора   
4745 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4746 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4747 +}
4748 +
4749 +
4750 +== **Редактирование ретранслятора** ==
4751 +
4752 +(% class="box infomessage" %)
4753 +(((
4754 +**PUT** **/api/v3/retranslations**
4755 +)))
4756 +
4757 +Пример запроса:
4758 +
4759 +{  
4760 +"id": "", ~/~/ Идентификатор ретранслятора   
4761 +"description": "string", ~/~/ Поле описания ретранслятора
4762 +"subscriberId": "", ~/~/ Идентификатор подписчика
4763 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4764 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4765 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4766 +"objects": ~/~/ Объекты для ретрансляции
4767 +[    
4768 +{      
4769 +"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4770 +"imei": "", ~/~/ IMEI объекта ретрансляции
4771 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4772 +}
4773 + ]
4774 +}
4775 +
4776 +
4777 +Пример ответа:
4778 +
4779 +{  
4780 +"description": "", ~/~/ Поле описания ретранслятора
4781 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4782 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4783 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4784 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4785 +"objects": [ ~/~/ Объекты для ретрансляции
4786 +{      
4787 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4788 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4789 +"imei": "", ~/~/ IMEI объекта ретрансляции
4790 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4791 +}
4792 + ],
4793 +"id": "", ~/~/ Идентификатор ретранслятора   
4794 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4795 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4796 +}
4797 +
4798 +
4799 +== **Получение списка ретранслятора клиента** ==
4800 +
4801 +(% class="box infomessage" %)
4802 +(((
4803 +**POST /api/v3/retranslations/find**
4804 +)))
4805 +
4806 +Пример запроса:
4807 +
4808 +{  
4809 +"id": "", ~/~/ Идентификатор ретранслятора   
4810 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4811 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4812 +}
4813 +
4814 +Ответ:
4815 +
4816 +[ 
4817 +{    
4818 +"description": "", ~/~/ Поле описания ретранслятора
4819 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4820 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4821 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4822 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4823 +"id": "", ~/~/ Идентификатор ретранслятора   
4824 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4825 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4826 +}
4827 +]
4828 +
4829 +
4830 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4831 +
4832 +== **API для отчета по выгрузке комбайнов** ==
4833 +
4834 +(% class="box infomessage" %)
4835 +(((
4836 +**POST /api/v3/Reports/harvesterUnloading**
4837 +)))
4838 +
4839 +Пример запроса:
4840 +
4841 +{
4842 + "byTime": 0, ~/~/ Объединение событий по времени
4843 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4844 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4845 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4846 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4847 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4848 + 0
4849 + ],
4850 + "from": "", ~/~/ Дата и время начало запроса
4851 + "to": "", ~/~/ Дата и время окончания запроса
4852 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4853 +}
4854 +
4855 +Пример ответа:
4856 +
4857 +[ 
4858 + {
4859 + "harvesterName": "", ~/~/Комбайн, номер
4860 + "harvesterId": 0, ~/~/Комбайн, id
4861 +"harvesterModel": "", ~/~/ Модель комбайна
4862 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4863 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4864 + "events": [ ~/~/Список событий в разрезе комбайна
4865 + {
4866 + "driverId": "", ~/~/Идентификатор водителя
4867 + "driverName": "", ~/~/Водитель комбайна, ФИО
4868 + "RFID": "", ~/~/ идентификатор карты-метки
4869 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4870 + "vehicleId": 0, ~/~/идентификатор объекта
4871 + "vehicleName": "string", ~/~/ Имя объекта
4872 + "modelName": "string", ~/~/ Имя модели объекта
4873 + "nearestVehicles": [ ~/~/Объекты рядом
4874 + {
4875 + "vehicleId": 0, ~/~/идентификатор объекта
4876 + "vehicleName": "string" ~/~/ Имя объекта
4877 + }
4878 + ],
4879 + "fields": [ ~/~/Поля, где происходила выгрузка
4880 + {
4881 + "id": 0, ~/~/ идентификатор пользователя 
4882 + "name": "string" ~/~/ имя пользователя 
4883 + }
4884 + ],
4885 + "event": "string", ~/~/Событие
4886 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4887 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4888 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4889 + "cultureName": "string", ~/~/ название культуры
4890 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4891 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4892 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4893 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4894 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4895 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4896 + "issued": 0, ~/~/Выдано, бункеров
4897 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4898 + "latitude": 0, ~/~/Широта
4899 + "longitude": 0, ~/~/ Долгота
4900 + "litresAway": 0, ~/~/Отдано, л
4901 + "m3Away": 0 ~/~/Отдано, м3
4902 + }
4903 + ]
4904 + }
4905 +]
4906 +
4907 +
4908 +== **Отчет трек-датчики** ==
4909 +
4910 +(% class="box infomessage" %)
4911 +(((
4912 +**POST /api/v3/Reports/sensorsWorks**
4913 +)))
4914 +
4915 +**Пример запроса:**
4916 +
4917 +{
4918 + "vehicleIds": [ ~/~/ Список ID объектов
4919 + 0
4920 + ],
4921 + "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4922 + "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4923 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4924 +}
4925 +
4926 +**Пример ответа:**
4927 +
4928 +(((
4929 +{
4930 + "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4931 + {
4932 + "vehicleId": 0, ~/~/ Идентификатор ТС
4933 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4934 + {
4935 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4936 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4937 + "duration": 0, ~/~/  Продолжительность интервала в секундах.
4938 + "name": "string", ~/~/ Наименование оборудования.
4939 + "mileage": 0, ~/~/ Пробег за время работы оборудования.
4940 + "totalMileage": 0, ~/~/ Общий пробег.
4941 + "avgSpeed": 0 ~/~/ Средняя скорость.
4942 + }
4943 + ]
4944 + }
4945 + ]
4946 +}
4947 +
4948 +
4949 +== **Превышение скорости** ==
4950 +
4951 +(% class="box infomessage" %)
4952 +(((
4953 +**POST /api/v3/Reports/overSpeedDuration**
4954 +)))
4955 +
4956 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4957 +
4958 +Пример запроса:
4959 +
4960 +(((
4961 +{
4962 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4963 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4964 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4965 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4966 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4967 +}
4968 +)))
4969 +
4970 +(((
4971 +
4972 +)))
4973 +
4974 +(((
4975 +Пример ответа:
4976 +)))
4977 +
4978 +(((
4979 +(((
4980 +[
4981 + {
4982 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4983 + "duration": 0, ~/~/ Продолжительность события в секундах 
4984 + "maxSpeed": 0, ~/~/ Максимальная скорость 
4985 + "speedLimit": 0 ~/~/ Ограничение скорости 
4986 + }
4987 +]
4988 +)))
4989 +)))
4990 +)))
4991 +
4992 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4993 +
4994 +
4995 +== **Запрос списка полей** ==
4996 +
4997 +(% class="box successmessage" %)
4998 +(((
4999 +**POST /api/v3/agroLands/find**
5000 +)))
5001 +
5002 +Пример запроса:
5003 +
5004 +(((
5005 +(((
5006 +(((
5007 +{
5008 + "year": 0, ~/~/ Фильтр по году
5009 + "name": "string", ~/~/ Фильтр по названию
5010 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
5011 +}
5012 +)))
5013 +)))
5014 +
5015 +
5016 +)))
5017 +
5018 +Пример ответа:
5019 +
5020 +(((
5021 +[
5022 + {
5023 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5024 + "year": 0, ~/~/ Год поля
5025 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
5026 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
5027 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5028 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5029 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5030 + "counts": { ~/~/ Счётчики с/х поля 
5031 + "fieldOperations": 0, ~/~/ Количество операций на поле
5032 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5033 + "facts": 0 ~/~/ Счётчик факта
5034 + },
5035 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5036 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5037 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5038 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5039 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5040 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5041 + "planComment": "string", ~/~/ Комментарий к полю
5042 + "productivity": 0, ~/~/ Урожайность.
5043 + "id": 0, ~/~/ Идентификатор объекта геозоны
5044 + "name": "string", ~/~/ Название объекта геозоны
5045 + "type": 0, ~/~/ Тип объекта геозоны
5046 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5047 + "fname": "string", ~/~/ Имя файла
5048 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5049 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
5050 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
5051 + "description": "string", ~/~/ Описание объекта геозоны
5052 + "area": 0, ~/~/ Площадь, м2
5053 + "perimetr": 0, ~/~/ Периметр, м
5054 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
5055 + }
5056 +]
5057 +
5058 +
5059 +== **Создание нового поля ** ==
5060 +
5061 +(% class="box successmessage" %)
5062 +(((
5063 +**POST /api/v3/agroLands**
5064 +)))
5065 +
5066 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5067 +X-agent  - ID клиента
5068 +
5069 +Пример запроса:
5070 +
5071 +(((
5072 +{
5073 + "extId": "string", 
5074 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5075 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5076 + "display": "string", ~/~/ Настройки отображения
5077 + "year": 0, ~/~/ Год поля
5078 + "name": "string", ~/~/ Наименование
5079 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5080 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5081 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5082 + "planComment": "string", ~/~/ Комментарий к полю
5083 + "cropRotations": [ ~/~/ Данные по севообороту
5084 + {
5085 + "landId": 0, ~/~/ ID поля
5086 + "landName": "string", ~/~/ Название поля
5087 + "year": 0, ~/~/ Год урожая
5088 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5089 + "cultureName": "string", ~/~/ Название культуры
5090 + "productivity": 0, ~/~/ Урожайность
5091 + "area": 0, ~/~/ Площадь поля, Га
5092 + "total": 0, ~/~/ Валовый сбор
5093 + "productivityFact": 0, ~/~/ Фактическая урожайность
5094 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5095 + "totalFact": 0, ~/~/ Фактический валовый сбор
5096 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5097 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5098 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5099 + "isyearplan": true, ~/~/ Годовой план 
5100 + "comment": "string" ~/~/ Комментарий
5101 + }
5102 + ]
5103 +}
5104 +)))
5105 +
5106 +(((
5107 +
5108 +)))
5109 +
5110 +Пример ответа:
5111 +
5112 +(((
5113 +(((
5114 +{
5115 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5116 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5117 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5118 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5119 + "cropRotations": [ ~/~/ Данные по севообороту
5120 + {
5121 + "landId": 0, ~/~/ ID поля
5122 + "landName": "string", ~/~/ Название поля
5123 + "year": 0, ~/~/ Год урожая 
5124 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5125 + "cultureName": "string", ~/~/ Название культуры
5126 + "productivity": 0, ~/~/ Урожайность
5127 + "area": 0, ~/~/ Площадь поля, Га.
5128 + "total": 0, ~/~/ Валовый сбор
5129 + "productivityFact": 0, ~/~/ Фактическая урожайность
5130 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5131 + "totalFact": 0, ~/~/ Фактический валовый сбор
5132 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5133 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5134 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5135 + "isyearplan": true, ~/~/ годовой план 
5136 + "comment": "string" ~/~/ Комментарий
5137 + }
5138 + ],
5139 + "cropVegetation": [ ~/~/ История вегетации поля
5140 + {
5141 + "values": [  ~/~/ Данные вегетации и состояния посева
5142 + {
5143 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5144 + "ndvi": 0 ~/~/ Индекс вегетации
5145 + }
5146 + ],
5147 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5148 + {
5149 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5150 + "type": "string", ~/~/ Тип
5151 + "pictureid": "string" ~/~/ Идентификатор ресурса
5152 + }
5153 + ],
5154 + "states": [ ~/~/ Ключевые даты развития поля
5155 + {
5156 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5157 + "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5158 + }
5159 + ]
5160 + }
5161 + ],
5162 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5163 + "counts": {
5164 + "fieldOperations": 0, ~/~/ Количество операций на поле
5165 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5166 + "facts": 0 ~/~/ Счётчик факта
5167 + },
5168 + "planComment": "string", ~/~/ Комментарий к полю
5169 +)))
5170 +
5171 +(((
5172 + "productivity": 0, ~/~/ Урожайность.
5173 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5174 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5175 + "year": 0, ~/~/ Год поля
5176 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5177 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5178 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5179 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5180 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5181 + "id": 0, ~/~/ Идентификатор объекта геозоны
5182 + "name": "string", ~/~/ Название объекта геозоны
5183 + "type": 0, ~/~/ Тип объекта геозоны
5184 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5185 + "fname": "string", ~/~/ Имя файла
5186 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5187 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5188 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5189 + "description": "string", ~/~/ Описание объекта геозоны
5190 + "area": 0, ~/~/ Площадь, м2
5191 + "perimetr": 0, ~/~/ Периметр, м
5192 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5193 +}
5194 +
5195 +
5196 +)))
5197 +)))
5198 +)))
5199 +
5200 +== **Получение поля по id** ==
5201 +
5202 +(% class="box infomessage" %)
5203 +(((
5204 +**GET /api/v3/agroLands/{id}**
5205 +)))
5206 +
5207 +Пример запроса:
5208 +id  ~/~/ Идентификатор поля
5209 +
5210 +Пример ответа:
5211 +
5212 +(((
5213 +{
5214 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5215 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5216 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5217 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5218 + "cropRotations": [ ~/~/ Данные по севообороту
5219 + {
5220 + "landId": 0, ~/~/ ID поля
5221 + "landName": "string", ~/~/ Название поля
5222 + "year": 0, ~/~/ Год урожая
5223 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5224 + "cultureName": "string", ~/~/ Название культуры
5225 + "productivity": 0, ~/~/ Урожайность
5226 + "area": 0, ~/~/ Площадь поля, Га
5227 + "total": 0, ~/~/ Валовый сбор
5228 + "productivityFact": 0, ~/~/ Фактическая урожайность
5229 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5230 + "totalFact": 0, ~/~/ Фактический валовый сбор
5231 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5232 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5233 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5234 + "isyearplan": true, ~/~/ План года 
5235 + "comment": "string" ~/~/ Комментарий
5236 + }
5237 + ],
5238 + "cropVegetation": [ ~/~/ История вегетации поля
5239 + {
5240 + "values": [ ~/~/ Данные вегетации и состояния посева
5241 + {
5242 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5243 + "ndvi": 0 ~/~/ Индекс вегетации
5244 + }
5245 + ],
5246 + "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5247 + {
5248 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5249 + "type": "string", ~/~/ Тип 
5250 + "pictureid": "string" ~/~/ Идентификатор ресурса
5251 + }
5252 + ],
5253 + "states": [ ~/~/ Ключевые даты развития поля
5254 + {
5255 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5256 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5257 + }
5258 + ]
5259 + }
5260 + ],
5261 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5262 + "counts": {
5263 + "fieldOperations": 0, ~/~/ Количество операций на поле
5264 + "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5265 + "facts": 0 ~/~/ Счётчик факта
5266 + },
5267 + "planComment": "string", ~/~/ Комментарий к полю
5268 + "productivity": 0, ~/~/ Урожайность.
5269 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5270 +)))
5271 +
5272 +(((
5273 +(((
5274 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5275 + "year": 0, ~/~/ Год поля
5276 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5277 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5278 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5279 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5280 + "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5281 + "id": 0, ~/~/ Идентификатор объекта геозоны
5282 + "name": "string", ~/~/ Название объекта геозоны
5283 + "type": 0, ~/~/ Тип объекта геозоны 
5284 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5285 + "fname": "string", ~/~/ Имя файла
5286 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5287 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5288 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5289 + "description": "string", ~/~/ Описание объекта геозоны
5290 + "area": 0, ~/~/ Площадь, м2
5291 + "perimetr": 0, ~/~/ Периметр, м
5292 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5293 +}
5294 +)))
5295 +
5296 +
5297 +(((
5298 +(((
5299 +(((
5300 +== **Изменение поля** ==
5301 +
5302 +(% class="box infomessage" %)
5303 +(((
5304 +**PUT /api/v3/agroLands**
5305 +)))
5306 +
5307 +Пример запроса:
5308 +
5309 +(((
5310 +(((
5311 +{
5312 + "id": 0, ~/~/ Идентификатор поля
5313 + "extId": "string", ~/~/ ExtId
5314 + "shape": "string", ~/~/ Форма поля
5315 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5316 + "display": "string", ~/~/ Настройки отображения
5317 + "year": 0, ~/~/ Год поля
5318 + "name": "string", ~/~/ Наименование
5319 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5320 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5321 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5322 + "planComment": "string", ~/~/Комментарий к полю
5323 + "cropRotations": [  ~/~/ Данные по севообороту
5324 + {
5325 + "landId": 0, ~/~/ ID поля
5326 + "landName": "string", ~/~/ Название поля
5327 + "year": 0, ~/~/ Год урожая
5328 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5329 + "cultureName": "string", ~/~/ Название культуры
5330 + "productivity": 0, ~/~/ Урожайность
5331 + "area": 0, ~/~/ Площадь поля, Га.
5332 + "total": 0, ~/~/ Валовый сбор
5333 + "productivityFact": 0, ~/~/ Фактическая урожайность
5334 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5335 + "totalFact": 0, ~/~/ Фактический валовый сбор
5336 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5337 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5338 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5339 + "isyearplan": true, 
5340 + "comment": "string" ~/~/ Комментарий
5341 + }
5342 + ],
5343 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5344 +}
5345 +)))
5346 +)))
5347 +
5348 +(((
5349 +
5350 +)))
5351 +
5352 +Пример ответа:
5353 +
5354 +(((
5355 +(((
5356 +(((
5357 +{
5358 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5359 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5360 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5361 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5362 + "cropRotations": [ ~/~/ Данные по севообороту
5363 + {
5364 + "landId": 0, ~/~/ ID поля
5365 + "landName": "string", ~/~/ Название поля
5366 + "year": 0, ~/~/  Год урожая
5367 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5368 + "cultureName": "string", ~/~/ Название культуры
5369 + "productivity": 0, ~/~/ Урожайность
5370 + "area": 0, ~/~/ Площадь поля, Га
5371 + "total": 0, ~/~/ Валовый сбор
5372 + "productivityFact": 0, ~/~/ Фактическая урожайность
5373 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5374 + "totalFact": 0, ~/~/ Фактический валовый сбор
5375 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5376 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5377 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5378 + "isyearplan": true, ~/~/ 
5379 + "comment": "string" ~/~/ Комментарий
5380 + }
5381 + ],
5382 + "cropVegetation": [ ~/~/ История вегетации поля
5383 + {
5384 + "values": [ ~/~/ Данные вегетации и состояния посева
5385 + {
5386 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5387 + "ndvi": 0 ~/~/ Индекс вегетации
5388 + }
5389 + ],
5390 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5391 + {
5392 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5393 + "type": "string", ~/~/ Тип
5394 + "pictureid": "string" ~/~/ Идентификатор ресурса
5395 + }
5396 + ],
5397 + "states": [ ~/~/ Ключевые даты развития поля 
5398 + {
5399 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5400 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5401 + }
5402 + ]
5403 + }
5404 + ],
5405 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5406 + "counts": { 
5407 + "fieldOperations": 0, ~/~/ Количество операций на поле
5408 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5409 + "facts": 0 ~/~/ Счётчик факта
5410 + },
5411 + "planComment": "string", ~/~/ Комментарий к полю
5412 + "productivity": 0, ~/~/ Урожайность.
5413 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5414 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5415 + "year": 0, ~/~/ Год поля
5416 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5417 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5418 + "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5419 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5420 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5421 + "id": 0, ~/~/ Идентификатор объекта геозоны
5422 + "name": "string", ~/~/ Название объекта геозоны
5423 + "type": 0, ~/~/ Тип объекта геозоны
5424 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5425 + "fname": "string", ~/~/ Имя файла
5426 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5427 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5428 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5429 + "description": "string", ~/~/ Описание объекта геозоны
5430 + "area": 0, ~/~/ Площадь, м2
5431 + "perimetr": 0, ~/~/ Периметр, м
5432 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5433 +}
5434 +)))
5435 +)))
5436 +)))
5437 +)))
5438 +)))
5439 +
5440 +
5441 +== **Редактирование года урожая ** ==
5442 +
5443 +(% class="box successmessage" %)
5444 +(((
5445 +**POST /api/v3/agroLands/updateOpenCloseYear**
5446 +)))
5447 +
5448 +Пример запроса:
5449 +
5450 +(((
5451 +(((
5452 +{
5453 + "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5454 + 0
5455 + ],
5456 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5457 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5458 +}
5459 +)))
5460 +
5461 +
5462 +)))
5463 +
5464 +Пример ответа:
5465 +
5466 +(((
5467 +(((
5468 +{
5469 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5470 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5471 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5472 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5473 + "cropRotations": [ ~/~/ Данные по севообороту
5474 + {
5475 + "landId": 0, ~/~/ ID поля
5476 + "landName": "string", ~/~/ Название поля
5477 + "year": 0, ~/~/ Год урожая
5478 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5479 + "cultureName": "string", ~/~/ Название культуры
5480 + "productivity": 0, ~/~/ Урожайность
5481 + "area": 0, ~/~/ Площадь поля, Га.
5482 + "total": 0, ~/~/ Валовый сбор
5483 + "productivityFact": 0, ~/~/ Фактическая урожайность
5484 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5485 + "totalFact": 0, ~/~/ Фактический валовый сбор
5486 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5487 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5488 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5489 + "isyearplan": true, ~/~/ 
5490 + "comment": "string" ~/~/ Комментарий
5491 + }
5492 + ],
5493 + "cropVegetation": [ ~/~/ История вегетации поля
5494 + {
5495 + "values": [ ~/~/ Данные вегетации и состояния посева
5496 + {
5497 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5498 + "ndvi": 0 ~/~/ Индекс вегетации
5499 + }
5500 + ],
5501 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5502 + {
5503 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5504 + "type": "string", ~/~/ Тип
5505 + "pictureid": "string" ~/~/ Идентификатор ресурса
5506 + }
5507 + ],
5508 + "states": [ ~/~/ Ключевые даты развития поля
5509 + {
5510 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5511 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5512 + }
5513 + ]
5514 + }
5515 + ],
5516 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5517 + "counts": { 
5518 + "fieldOperations": 0, ~/~/ Количество операций на поле
5519 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5520 + "facts": 0 ~/~/ Счётчик факта
5521 + },
5522 + "planComment": "string", ~/~/ Комментарий к полю
5523 + "productivity": 0, ~/~/ Урожайность.
5524 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5525 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5526 + "year": 0, ~/~/ Год поля
5527 + "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5528 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5529 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5530 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5531 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5532 + "id": 0, ~/~/ Идентификатор объекта геозоны
5533 + "name": "string", ~/~/ Название объекта геозоны
5534 + "type": 0, ~/~/ Тип объекта геозоны
5535 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5536 + "fname": "string", ~/~/ Имя файла
5537 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5538 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5539 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5540 + "description": "string", ~/~/ Описание объекта геозоны
5541 + "area": 0, ~/~/ Площадь, м2
5542 + "perimetr": 0, ~/~/ ериметр, м
5543 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5544 +}
5545 +
5546 +
5547 +== **Какие поля посещал объект** ==
5548 +
5549 +(% class="box successmessage" %)
5550 +(((
5551 +**POST /api/v3/agroLands/visitingByVehicle**
5552 +)))
5553 +
5554 +Пример запроса:
5555 +
5556 +{
5557 + "vehicleId": 0, ~/~/ id объекта 
5558 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5559 + "byTime": 0, ~/~/ Объединение событий по времени
5560 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5561 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5562 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5563 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5564 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5565 +}
5566 +
5567 +Пример ответа:
5568 +
5569 +[
5570 + {
5571 + "fieldId": 0, ~/~/ id объекта 
5572 + "vehicleName": "string", ~/~/ Наименование объекта 
5573 + "fieldName": "string", ~/~/ Наименование поля 
5574 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5575 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5576 + "vehicleId": 0, ~/~/ Идентификатор ТС
5577 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5578 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5579 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5580 + "mileage": 0 ~/~/ Пробег 
5581 + }
5582 +]
5583 +)))
5584 +
5585 +
5586 +== **Посещение поля объектами ** ==
5587 +
5588 +(% class="box successmessage" %)
5589 +(((
5590 +**POST /api/v3/agroLands/visitingByField**
5591 +)))
5592 +
5593 +Пример запроса:
5594 +{
5595 + "fieldId": 0, ~/~/ ID поля
5596 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5597 + "byTime": 0, ~/~/ Объединение событий по времени
5598 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5599 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5600 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5601 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5602 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5603 +}
5604 +
5605 +Пример ответа:
5606 +
5607 +[
5608 + {
5609 + "fieldId": 0, ~/~/ ID поля
5610 + "vehicleName": "string", ~/~/ Наименование объекта 
5611 + "fieldName": "string", ~/~/ Имя поля
5612 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5613 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5614 + "vehicleId": 0, ~/~/ Идентификатор ТС
5615 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5616 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5617 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5618 + "mileage": 0 ~/~/ Пробег
5619 + }
5620 +]
5621 +
5622 +
5623 +== **Удаление существующего поля** ==
5624 +
5625 +(% class="box errormessage" %)
5626 +(((
5627 +**DELETE /api/v3/agroLands/{id}**
5628 +)))
5629 +
5630 +Пример запроса:
5631 +id  ~/~/ Идентификатор поля
5632 +
5633 +Пример ответа:
5634 +
5635 +(((
5636 +200 ~/~/ Успех
5637 +
5638 +
5639 +)))
5640 +
5641 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5642 +)))
5643 +)))
5644 +)))
5645 +
5646 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5647 +
5648 +
5649 +(% class="box infomessage" %)
5650 +(((
5651 +**GET api/v3/Vehicles/recyclebin/all**
5652 +)))
5653 +
5654 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5655 +
5656 +Параметр запроса: {parentId} - идентификатор агента
5657 +
5658 +В заголовках запроса: X-Auth: Токен авторизации
5659 +
5660 +Ответ:
5661 +
5662 +[ 
5663 + {
5664 + "recordTime": "", ~/~/Время записи
5665 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5666 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5667 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5668 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5669 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5670 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5671 + "items": [ ~/~/ 
5672 +nullable: true ~/~/Детали
5673 + {
5674 + "name": "string", ~/~/наименование столбца
5675 + "value": "string" ~/~/содержание столбца
5676 + }
5677 + ]
5678 + },
5679 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5680 + "string"
5681 + ]
5682 + }
5683 +]
5684 +
5685 +
5686 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5687 +
5688 +(% class="box infomessage" %)
5689 +(((
5690 +**POST api/v3/Vehicles/recyclebin/erase**
5691 +)))
5692 +
5693 +В заголовках запроса: X-Auth: Токен авторизации
5694 +
5695 +Пример запроса:
5696 +
5697 +[
5698 +0
5699 +]
5700 +
5701 +
5702 +Пример ответа:
5703 +
5704 +[ 
5705 +{
5706 + "recordTime": "", ~/~/Время записи
5707 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5708 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5709 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
5710 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5711 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5712 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5713 + "items": [ ~/~/Детали
5714 + {
5715 + "name": "", ~/~/Имя свойства
5716 + "value": "" ~/~/Значение свойства
5717 + }
5718 + ]
5719 + },
5720 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5721 + ""
5722 + ]
5723 + }
5724 +]
5725 +
5726 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5727 +
5728 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5729 +
5730 +(% class="box infomessage" %)
5731 +(((
5732 +**POST api/v3/Vehicles/recyclebin/restore**
5733 +)))
5734 +
5735 +В заголовках запроса: X-Auth: Токен авторизации
5736 +
5737 +Параметры в теле запроса (JSON):
5738 +
5739 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5740 +
5741 +В заголовках запроса: X-Auth: Токен авторизации
5742 +
5743 +
5744 +Пример запроса:
5745 +
5746 +(((
5747 +[
5748 +)))
5749 +
5750 +(((
5751 + 0
5752 +)))
5753 +
5754 +(((
5755 +]
5756 +)))
5757 +
5758 +
5759 +Пример ответа:
5760 +
5761 +[
5762 +{
5763 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5764 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5765 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5766 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5767 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5768 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5769 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5770 + "items": [ ~/~/Детали
5771 + {
5772 + "name": "string", ~/~/Имя свойства
5773 + "value": "string" ~/~/Значение свойства
5774 + }
5775 + ]
5776 + },
5777 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5778 + "string"
5779 + ]
5780 + }
5781 +]
5782 +
5783 +
5784 += **Раздел: Журнал заданий ** =
5785 +
5786 +
5787 +== **Создание задания в Журнале заданий** ==
5788 +
5789 +(% class="box infomessage" %)
5790 +(((
5791 +**POST /api/v3/vehicletasks**
5792 +)))
5793 +
5794 +Пример запроса:
5795 +
5796 +(((
5797 +{
5798 + "vehicleId": 0, ~/~/ Идентификатор ТС
5799 + "description": "string", ~/~/ Описание
5800 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5801 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5802 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5803 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5804 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5805 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5806 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5807 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5808 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5809 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5810 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5811 + "cost": { 
5812 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5813 + "Name": "string", ~/~/ Наименование
5814 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5815 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5816 + "Norm": 0 ~/~/ Норма внесения
5817 + },
5818 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5819 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5820 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5821 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5822 + "deleted": true, ~/~/ Признак удаления
5823 + "extId": "string", 
5824 + "GeoIds": [ ~/~/ Cвязанные поля
5825 + 0
5826 + ]
5827 +}
5828 +)))
5829 +
5830 +
5831 +Пример ответа:
5832 +
5833 +{
5834 + "vehicleId": 0, ~/~/ Идентификатор ТС
5835 + "description": "string", ~/~/ Описание
5836 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5837 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5838 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5839 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5840 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5841 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5842 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5843 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5844 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5845 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5846 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5847 + "cost": { 
5848 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5849 + "Name": "string", ~/~/ Наименование
5850 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5851 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5852 + "Norm": 0 ~/~/ Норма внесения
5853 + },
5854 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5855 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5856 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5857 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5858 + "deleted": true, ~/~/ Признак удаления
5859 + "extId": "string", ~/~/ ExtId
5860 + "GeoIds": [ ~/~/ Связанные поля
5861 + 0
5862 + ]
5863 +}
5864 +
5865 +
5866 +== **Редактирование задания в Журнале заданий** ==
5867 +
5868 +(% class="box successmessage" %)
5869 +(((
5870 +**PUT /api/v3/vehicletasks**
5871 +)))
5872 +
5873 +Пример запроса:
5874 +
5875 +(((
5876 +{
5877 + "vehicleId": 0, ~/~/ Идентификатор ТС
5878 + "description": "string", ~/~/ Описание
5879 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5880 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5881 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5882 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5883 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5884 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5885 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5886 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5887 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5888 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5889 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5890 + "cost": { 
5891 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5892 + "Name": "string", ~/~/ Наименование
5893 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5894 + "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5895 + "Norm": 0 ~/~/ Норма внесения
5896 + },
5897 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5898 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5899 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5900 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5901 + "deleted": true, ~/~/ Признак удаления
5902 + "extId": "string", ~/~/ ExtId
5903 + "GeoIds": [ ~/~/ Связанные поля
5904 + 0
5905 + ]
5906 +}
5907 +)))
5908 +
5909 +
5910 +Пример ответа:
5911 +
5912 +{
5913 + "vehicleId": 0, ~/~/ Идентификатор ТС
5914 + "description": "string", ~/~/ Описание
5915 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5916 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5917 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5918 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5919 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5920 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5921 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5922 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5923 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5924 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5925 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5926 + "cost": { 
5927 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5928 + "Name": "string", ~/~/ Наименование
5929 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5930 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5931 + "Norm": 0 ~/~/ Норма внесения
5932 + },
5933 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5934 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5935 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5936 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5937 + "deleted": true, ~/~/ Признак удаления
5938 + "extId": "string", ~/~/ ExtId
5939 + "GeoIds": [ ~/~/ Связанные поля
5940 + 0
5941 + ]
5942 +}
5943 +
5944 +
5945 +== **Удаление задания в Журнале заданий** ==
5946 +
5947 +(% class="box warningmessage" %)
5948 +(((
5949 +**DELETE /api/v3/vehicletasks**
5950 +)))
5951 +
5952 +Пример запроса:
5953 +
5954 +(((
5955 +[
5956 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5957 +]
5958 +)))
5959 +
5960 +(((
5961 +
5962 +)))
5963 +
5964 +Пример ответа:
5965 +
5966 +{
5967 + "vehicleId": 0, ~/~/ Идентификатор ТС
5968 + "description": "string", ~/~/ Описание
5969 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5970 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5971 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5972 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5973 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5974 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5975 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5976 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5977 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5978 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5979 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5980 + "cost": { 
5981 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5982 + "Name": "string", ~/~/ Наименование
5983 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5984 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5985 + "Norm": 0 ~/~/ Норма внесения
5986 + },
5987 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5988 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5989 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5990 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5991 + "deleted": true, ~/~/ Признак удаления
5992 + "extId": "string", ~/~/ ExtId
5993 + "GeoIds": [ ~/~/ Связанные поля
5994 + 0
5995 + ]
5996 +}
5997 +
5998 +
5999 +== **Получение списка Журнала заданий** ==
6000 +
6001 +(% class="box infomessage" %)
6002 +(((
6003 +**POST /api/v3/vehicletasks/getbyperiod**
6004 +)))
6005 +
6006 +Пример запроса:
6007 +
6008 +(((
6009 +{
6010 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
6011 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
6012 + "TimeZone": 0, ~/~/ Часовой пояс.
6013 + "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
6014 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
6015 + ],
6016 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
6017 + 0
6018 + ],
6019 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
6020 + 0
6021 + ],
6022 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
6023 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
6024 +}
6025 +)))
6026 +
6027 +
6028 +Пример ответа:
6029 +
6030 +(((
6031 +{
6032 + "total": 0,  ~/~/ Общее количество записей
6033 + "pages": 0,  ~/~/ Общее количество страниц
6034 + "currentPage": 0, ~/~/ Текущая страница
6035 + "items": [  ~/~/ Записи 
6036 + {
6037 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6038 + "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
6039 + "name": "string", ~/~/ Название задания.
6040 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
6041 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
6042 + "workKind": "string", ~/~/ Вид работ
6043 + "techOp": "string", ~/~/ Тех. операция
6044 + "trailerModel": "string", ~/~/ Модель агрегата
6045 + "width": "string", ~/~/ Ширина, м
6046 + "speed": "string", ~/~/ Тех. скорость
6047 + "fields": "string", ~/~/ Поля
6048 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
6049 + "vehicles": "string", ~/~/ Объект-модель
6050 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
6051 + "drivers": "string", ~/~/ Водители
6052 + "tmc": "string", ~/~/ ТМЦ
6053 + "client": "string", ~/~/  Клиент
6054 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6055 + "dep": "string", ~/~/ Подразделение
6056 + "geoIds": [ ~/~/  Связанные поля
6057 + 0
6058 + ]
6059 + }
6060 + ]
6061 +}
6062 +)))
6063 +
6064 +
6065 += **Раздел: Роли** =
6066 +
6067 +== **Получение списка клиентских и системных ролей пользователя ** ==
6068 +
6069 +(% class="box successmessage" %)
6070 +(((
6071 +**POST /api/v3/groups/find**
6072 +)))
6073 +
6074 +Пример запроса:
6075 +
6076 +(((
6077 +{
6078 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6079 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6080 +}
6081 +)))
6082 +
6083 +(((
6084 +
6085 +)))
6086 +
6087 +(((
6088 +Пример ответа:
6089 +)))
6090 +
6091 +(((
6092 +(((
6093 +{
6094 + "groups": [  ~/~/ Системные роли пользователя
6095 + {
6096 + "code": "string", ~/~/ Код роли.
6097 + "name": "string", ~/~/ Имя  
6098 + "shortName": "string" ~/~/ Короткое имя 
6099 + }
6100 + ],
6101 + "customGroups": [ ~/~/ Системные роли пользователя
6102 + {
6103 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6104 + "name": "string", ~/~/ Наименование 
6105 + "shortName": "string", ~/~/ Короткое наименование 
6106 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6107 + }
6108 + ]
6109 +}
6110 +)))
6111 +)))
6112 +
6113 +(((
6114 +
6115 +)))
6116 +
6117 +(((
6118 +
6119 +)))
6120 +
6121 += **Раздел: Локатор ** =
6122 +
6123 +
6124 +== **Получение данных по локатору** ==
6125 +
6126 +(% class="box infomessage" %)
6127 +(((
6128 +**GET /api/v3/locators/{locatorId}**
6129 +)))
6130 +
6131 +В запросе указывается locatorid - идентификатор локатора
6132 +
6133 +
6134 +Пример ответа:
6135 +
6136 +(((
6137 +(((
6138 +{
6139 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6140 + 0
6141 + ],
6142 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6143 + 0
6144 + ],
6145 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6146 + 0
6147 + ],
6148 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6149 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6150 + "agentName": "string", ~/~/ Наименование агента.
6151 + "isEnabled": true, ~/~/ Активность 
6152 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6153 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6154 + "name": "string", ~/~/ Наименование.
6155 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6156 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6157 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6158 + "validity": 0, ~/~/ Значение срока действия
6159 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6160 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6161 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6162 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6163 + "url": "string", ~/~/ Ссылка
6164 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6165 +
6166 + "showVehicleName": true, ~/~/ Наименование объекта
6167 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6168 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6169 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6170 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6171 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6172 +
6173 + 1
6174 +
6175 + ]
6176 +}
6177 +)))
6178 +)))
6179 +
6180 +
6181 +(((
6182 +(((
6183 +
6184 +)))
6185 +)))
6186 +
6187 +
6188 +== **Создание локатора** ==
6189 +
6190 +(% class="box successmessage" %)
6191 +(((
6192 +**POST /api/v3/locators**
6193 +)))
6194 +
6195 +Пример запроса:
6196 +
6197 +(((
6198 +{
6199 + "isEnabled": true, ~/~/ Активность
6200 + "name": "string", ~/~/ Наименование локатора
6201 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
6202 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
6203 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6204 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6205 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6206 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6207 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6208 + 0
6209 + ],
6210 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6211 + 0
6212 + ],
6213 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6214 + 0
6215 + ],
6216 +
6217 + "showVehicleName": true, ~/~/ Наименование объекта
6218 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6219 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6220 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6221 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6222 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6223 +
6224 + 1
6225 +
6226 + ]
6227 +}
6228 +)))
6229 +
6230 +
6231 +Пример ответа:
6232 +
6233 +(((
6234 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
6235 +)))
6236 +
6237 +
6238 +== **Выводит список локаторов ** ==
6239 +
6240 +(% class="box successmessage" %)
6241 +(((
6242 +**POST /api/v3/locators/find**
6243 +)))
6244 +
6245 +Пример запроса:
6246 +
6247 +(((
6248 +{
6249 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6250 +}
6251 +)))
6252 +
6253 +(((
6254 +
6255 +)))
6256 +
6257 +(((
6258 +
6259 +)))
6260 +
6261 +
6262 +Пример ответа:
6263 +
6264 +(((
6265 +[
6266 + {
6267 + "vehiclesCount": 0, ~/~/ Количество объектов.
6268 + "geozonesCount": 0, ~/~/ Количество геозон.
6269 + "fieldsCount": 0, ~/~/ Количество полей.
6270 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6271 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6272 + "agentName": "string", ~/~/ Наименование агента.
6273 + "isEnabled": true, ~/~/ Активность локатора
6274 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6275 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6276 + "name": "string", ~/~/ Наименование локатора 
6277 + "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6278 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6279 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6280 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6281 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6282 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6283 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6284 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6285 + "url": "string", ~/~/ ссылка на локатор 
6286 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6287 + "showVehicleName": true, ~/~/ Наименование объекта
6288 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6289 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6290 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6291 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6292 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6293 +
6294 + 0
6295 + ]
6296 + }
6297 +]
6298 +)))
6299 +
6300 +
6301 +== **Изменение локатора** ==
6302 +
6303 +(% class="box infomessage" %)
6304 +(((
6305 +**PUT /api/v3/locators**
6306 +)))
6307 +
6308 +Пример запроса:
6309 +
6310 +(((
6311 +{
6312 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6313 + "isEnabled": true, ~/~/ Активность 
6314 + "name": "string", ~/~/ Наименование
6315 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6316 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6317 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6318 + "autoProlongation": true, ~/~/ Автопродление срока действия
6319 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6320 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6321 + 0
6322 + ],
6323 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6324 + 0
6325 + ],
6326 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6327 + 0
6328 + ],
6329 + "showVehicleName": true, ~/~/ Наименование объекта
6330 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6331 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6332 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6333 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6334 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6335 +
6336 + 0
6337 +
6338 + ]
6339 +}
6340 +
6341 +
6342 +)))
6343 +
6344 +Пример ответа:
6345 +
6346 +200 ~/~/ Success
6347 +
6348 +
6349 +== **Удалить локатор** ==
6350 +
6351 +(% class="box warningmessage" %)
6352 +(((
6353 +**DELETE /api/v3/locators**
6354 +)))
6355 +
6356 +Пример запроса:
6357 +
6358 +(((
6359 +[
6360 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6361 +]
6362 +)))
6363 +
6364 +
6365 += **Раздел: Яндекс Маршруты** =
6366 +
6367 +
6368 +== **Возвращение списка маршрутов** ==
6369 +
6370 +(% class="box infomessage" %)
6371 +(((
6372 +**GET /api/v3/TransportRoutes**
6373 +)))
6374 +
6375 +Пример запроса:
6376 +Id  ~/~/ Идентификатор поля
6377 +
6378 +Пример ответа:
6379 +
6380 +(((
6381 +[
6382 + {
6383 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6384 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6385 + "name": "string", ~/~/ Наименование маршрута.
6386 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6387 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6388 + 0
6389 + ]
6390 + }
6391 +]
6392 +)))
6393 +
6394 +
6395 +== **Добавить маршрут** ==
6396 +
6397 +(% class="box infomessage" %)
6398 +(((
6399 +**POST /api/v3/TransportRoutes**
6400 +)))
6401 +
6402 +Пример запроса: 
6403 +{
6404 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6405 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6406 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6407 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6408 + 0
6409 + ]
6410 +}
6411 +
6412 +
6413 +Пример ответа:
6414 +
6415 +(((
6416 +{
6417 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6418 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6419 + "name": "string", ~/~/ Определяет наименование маршрута 
6420 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6421 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6422 + 0
6423 + ]
6424 +}
6425 +)))
6426 +
6427 +
6428 +== **Обновление маршрута** ==
6429 +
6430 +(% class="box successmessage" %)
6431 +(((
6432 +**PUT /api/v3/TransportRoutes**
6433 +)))
6434 +
6435 +Пример запроса:
6436 +
6437 +(((
6438 +{
6439 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6440 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6441 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6442 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6443 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6444 + 0
6445 + ]
6446 +}
6447 +)))
6448 +
6449 +Пример ответа:
6450 +
6451 +(((
6452 +{
6453 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6454 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6455 + "name": "string", ~/~/ Определяет наименование маршрута 
6456 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6457 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6458 + 0
6459 + ]
6460 +}
6461 +)))
6462 +
6463 +
6464 +== **Получить связки маршрутов ТС** ==
6465 +
6466 +(% class="box infomessage" %)
6467 +(((
6468 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6469 +)))
6470 +
6471 +Пример запроса:
6472 +
6473 +(((
6474 +[
6475 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6476 +]
6477 +)))
6478 +
6479 +Пример ответа:
6480 +
6481 +(((
6482 +[
6483 + {
6484 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6485 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6486 + }
6487 +]
6488 +)))
6489 +
6490 +
6491 +== **Удалить маршрут** ==
6492 +
6493 +(% class="box warningmessage" %)
6494 +(((
6495 +**DELETE /api/v3/TransportRoutes/{id}**
6496 +)))
6497 +
6498 +Пример запроса:
6499 +Id  ~/~/ Идентификатор поля
6500 +
6501 +
6502 += **Раздел: Управление доступа к машинам** =
6503 +
6504 +
6505 +== Получение списка транспортных средств видимых пользователю ==
6506 +
6507 +(% class="box infomessage" %)
6508 +(((
6509 +**GET /api/v3/UserVisibleVehicles/{userId}**
6510 +)))
6511 +
6512 +Пример ответа:
6513 +
6514 +(((
6515 +{
6516 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6517 + 0
6518 + ]
6519 +}
6520 +)))
6521 +
6522 +
6523 +== Задает видимость транспортных средств пользователю ==
6524 +
6525 +(% class="box infomessage" %)
6526 +(((
6527 +**POST /api/v3/UserVisibleVehicles**
6528 +)))
6529 +
6530 +Пример запроса:
6531 +
6532 +(((
6533 +(((
6534 +{
6535 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6536 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6537 + 0
6538 + ]
6539 +}
6540 +)))
6541 +
6542 +(((
6543 +
6544 +)))
6545 +
6546 +(((
6547 +Пример ответа :
6548 +)))
6549 +
6550 +(((
6551 +
6552 +)))
6553 +
6554 +(((
6555 +200 ~/~/ Success
6556 +)))
6557 +)))
6558 +
6559 +
3048 3048  (% class="box" lang="en-US" style="text-align: center;" %)
3049 3049  (((
3050 3050  (% 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]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Размер
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Содержимое Icon

Меню

ГЛОНАССSoft wiki - 2025 г.