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

<
От версии < 107.1 >
отредактировано Илья Крайнов
на 2023/08/30 15:15
К версии < 264.2 >
отредактировано Андрей Калиновский
на 2025/10/23 09:54
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Содержимое
... ... @@ -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,8 +682,256 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
747 +(% class="wikigeneratedid" id="H" %)
748 +(((
749 +
750 +)))
686 686  
752 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
753 +
754 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
755 +
756 +(% class="box infomessage" %)
757 +(((
758 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
759 +)))
760 +
761 +Метод возвращает полную информацию о модели объекта.
762 +
763 +(% style="color:#000000" %)Метод запроса: **GET**
764 +
765 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
766 +
767 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
768 +
769 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
770 +
771 +(% style="color:#000000" %)Ответ:
772 +
773 +(% style="color:#000000" %){
774 + "parentName": "string",
775 + "name": "string",
776 + "picture": "string",
777 + "minspeed": 0,
778 + "maxspeed": 0,
779 + "width": 0,
780 + "imbeddedtrailer": true,
781 + "hoppercapacity": 0,
782 + "hopperdischargespeed": 0,
783 + "modelType": 0,
784 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
785 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
786 + "deleted": true
787 +}
788 +
789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
790 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
791 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
792 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
793 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
794 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
795 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
796 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
797 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
798 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
799 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
800 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
801 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
802 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
803 +
804 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
805 +
806 +(% class="box successmessage" %)
807 +(((
808 +(% lang="en-US" %)**POST /api/v3/models/find**
809 +)))
810 +
811 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
812 +
813 +(% style="color:#000000" %)Метод запроса: **POST**
814 +
815 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
816 +
817 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
818 +
819 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
820 +
821 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
822 +}
823 +
824 +(% style="color:#000000" %)Ответ:
825 +
826 +(% style="color:#000000" %)[
827 + {
828 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
829 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
830 + "parentName": "string",
831 + "name": "string",
832 + "modelType": 0
833 + }
834 +]
835 +
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 +
843 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
844 +
845 +(% class="box successmessage" %)
846 +(((
847 +(% lang="en-US" %)**POST /api/v3/models**
848 +)))
849 +
850 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
851 +
852 +(% style="color:#000000" %)Метод запроса: **POST**
853 +
854 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
855 +
856 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
857 +
858 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
859 +
860 +{
861 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 + "deleted": false,
864 + "extId": "string",
865 + "name": "string",
866 + "picture": "string",
867 + "minspeed": 0,
868 + "maxspeed": 0,
869 + "width": 0,
870 + "imbeddedtrailer": true,
871 + "fueloutlay": 0,
872 + "hoppercapacity": 0,
873 + "hopperdischargespeed": 0,
874 + "modelType": 0
875 +}
876 +
877 +Ответ:
878 +
879 +{
880 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882 + "deleted": false,
883 + "extId": "string",
884 + "name": "string",
885 + "picture": "string",
886 + "minspeed": 0,
887 + "maxspeed": 0,
888 + "width": 0,
889 + "imbeddedtrailer": true,
890 + "hoppercapacity": 0,
891 + "hopperdischargespeed": 0,
892 + "modelType": 0
893 +}
894 +
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 +
909 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
910 +
911 +(% class="box warningmessage" %)
912 +(((
913 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
914 +)))
915 +
916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
917 +
918 +(% style="color:#000000" %)Метод запроса: **PUT**
919 +
920 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
921 +
922 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
923 +
924 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
925 +
926 +{
927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
928 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
929 + "deleted": true,
930 + "extId": "string",
931 + "name": "string",
932 + "picture": "string",
933 + "minspeed": 0,
934 + "maxspeed": 0,
935 + "width": 0,
936 + "imbeddedtrailer": true,
937 + "fueloutlay": 0,
938 + "hoppercapacity": 0,
939 + "hopperdischargespeed": 0,
940 + "modelType": 0
941 +}
942 +
943 +Ответ:
944 +
945 +{
946 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
947 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
948 + "deleted": true,
949 + "extId": "string",
950 + "name": "string",
951 + "picture": "string",
952 + "minspeed": 0,
953 + "maxspeed": 0,
954 + "width": 0,
955 + "imbeddedtrailer": true,
956 + "fueloutlay": 0,
957 + "hoppercapacity": 0,
958 + "hopperdischargespeed": 0,
959 + "modelType": 0
960 +}
961 +
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 +
976 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
977 +
978 +(% class="box errormessage" %)
979 +(((
980 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
981 +)))
982 +
983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
984 +
985 +(% style="color:#000000" %)Метод запроса: **DELETE**
986 +
987 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
988 +
989 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
990 +
991 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
992 +
993 +Ответ: В случае успеха **Success 200**
994 +
995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
996 +
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
688 688  
689 689  (% class="box infomessage" %)
... ... @@ -711,6 +711,17 @@
711 711  
712 712  (((
713 713  {
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 +
714 714   "vehicleId": "", ~/~/ ID объекта
715 715   "name": "", ~/~/ Имя объекта
716 716   "imei": "", ~/~/ IMEI объекта
... ... @@ -718,19 +718,15 @@
718 718   "deviceTypeName": "", ~/~/ Название типа устройства
719 719   "sim1": "", ~/~/ Номер SIM1
720 720   "sim2": "", ~/~/ Номер SIM2
721 -
722 722   "parentId": "", ~/~/ ID клиента-родителя
723 723   "parentName": "", ~/~/ Наименование клиента-родителя
724 724   "modelId": "", ~/~/ ID модели объекта
725 725   "modelName": "", ~/~/ Имя модели объекта
726 -
727 727   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 728   "unitName": "string", ~/~/ Наименование подразделения
729 729   "status": 0, ~/~/ Статус объекта
730 -
731 731   "createdAt": "", ~/~/ Дата создания объекта
732 732   },
733 -
734 734  "customFields": [ ~/~/ Произвольные поля
735 735   {
736 736   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -740,6 +740,12 @@
740 740   "forTooltip": true, ~/~/ Отображать в подсказке
741 741   "forReport": true ~/~/ Отображать в отчете
742 742   }
1060 + ],
1061 + "vehicleGroups": [  ~/~/ Группы ТС
1062 + {
1063 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1064 + "name": "string" ~/~/ Наименование группы ТС
1065 + }
743 743  
744 744  ], ~/~/ Данные с вкладки нормы
745 745   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
... ... @@ -753,8 +753,7 @@
753 753   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 754   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 755   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 -
1079 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
758 758   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 759   "mileageCoeff": 0, ~/~/ коэффициент пробега
760 760   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -784,7 +784,6 @@
784 784   "retries": 0 ~/~/ Количество попыток
785 785   }
786 786   ],
787 -
788 788   "sensors": [ ~/~/ Датчики
789 789   {
790 790   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -792,7 +792,7 @@
792 792   "type": 0, ~/~/ Тип датчика
793 793   "name": "string", ~/~/ Имя датчика
794 794   "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
795 - "inputNumber": 0, ~/~/ Номер входа
1116 + "parameterName": "string", ~/~/ Имя параметра (взамен связки Input type + port number)
796 796   "pseudonym": "string", ~/~/ Псевдоним
797 797   "medianDegree": 0, ~/~/ Медианная фильтрация
798 798   "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
... ... @@ -811,6 +811,7 @@
811 811   ],
812 812   "showInTooltip": true, ~/~/ Отображать в подсказке
813 813   "showLastValid": true, ~/~/ Отображать последнее валидное значение
1135 + "color": "string", ~/~/ Код цвета датчиков
814 814   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
815 815   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
816 816   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -824,41 +824,32 @@
824 824   "additionalProp3": "string"
825 825   },
826 826  
827 -~/~/ Характерные для произвольного:
828 -
829 -~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
830 -
831 -~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
832 -
833 -~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
834 -
835 -~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
836 -
837 -~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
838 -
839 -~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
840 -
841 -~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
842 -
843 -~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
844 -
845 -~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
846 -
847 -~/~/ "ValueOn": "Вкл.",
848 -
849 -~/~/ "ValueOff": "Выкл."
850 - "summaryMaxValue": 0 ~/~/ Макс. значение
851 - }
852 -
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 + ],
853 853   "drivers": [ ~/~/ Водители
854 854   {
855 855   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
856 856   "name": "string", ~/~/ Наименование
857 - "description": "string",
858 - "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" ~/~/ Момент времени создания назначения.
859 859   }
1172 + ]
1173 + }
860 860   ],
861 -
862 862   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
863 863   {
864 864   "id": "", ~/~/ ID  задания
... ... @@ -875,19 +875,27 @@
875 875   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
876 876   }
877 877   ],
878 -
879 - "statusHistory": [ ~/~/ История статусов
1191 +"statusHistory": [ ~/~/ История статусов
880 880   {
881 881   "status": 0,
882 882   "date": "2023-05-22T09:57:39.562Z",
883 883   "description": "string",
884 884   "additionalInfo": "string"
885 - }
886 - ]
887 887  
1198 +(((
888 888  }
1200 + ],
1201 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1202 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
889 889  )))
890 890  
1205 +(((
1206 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1207 +}
1208 +
1209 +)))
1210 +)))
1211 +
891 891  (% style="text-align:left" %)
892 892  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
893 893  
... ... @@ -894,6 +894,75 @@
894 894  (% style="text-align:left" %)
895 895  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
896 896  
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 +
897 897  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
898 898  
899 899  (% class="box successmessage" %)
... ... @@ -913,6 +913,11 @@
913 913  
914 914  (% style="color:#000000" %){
915 915  
1306 +
1307 +(((
1308 + "vehicleId": 0, ~/~/ ID ТС
1309 +)))
1310 +
916 916   "parentId": "" , ~/~/ ID клиента
917 917   "name": "" , ~/~/ имя ТС
918 918   "imei": "" , ~/~/ IMEI
... ... @@ -933,7 +933,6 @@
933 933   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
934 934   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
935 935   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
936 -
937 937   "mileageCalcMethod": 0,
938 938   "mileageCoeff": 0,
939 939   "locationByCellId": true,
... ... @@ -966,7 +966,6 @@
966 966   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
967 967   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
968 968   }
969 -
970 970  "drivers": [ ~/~/ Водители
971 971   {
972 972   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -981,8 +981,7 @@
981 981   "retries": 0
982 982   }
983 983   ],
984 -
985 - "sensors": [ ~/~/ Датчики
1377 +"sensors": [ ~/~/ Датчики
986 986   {
987 987   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
988 988   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1008,6 +1008,7 @@
1008 1008   ],
1009 1009   "showInTooltip": true, ~/~/ Отображать в подсказке
1010 1010   "showLastValid": true, ~/~/ Отображать последнее валидное значение
1403 + "color": "string", ~/~/ код цвета датчиков
1011 1011   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1012 1012   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1013 1013   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -1020,103 +1020,222 @@
1020 1020   "additionalProp2": "string",
1021 1021   "additionalProp3": "string"
1022 1022   },
1023 -
1024 1024  ~/~/ Характерные для произвольного:
1025 -
1026 1026  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1027 -
1028 1028  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1029 -
1030 1030  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1031 -
1032 1032  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1033 -
1034 1034  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1035 -
1036 1036  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1037 -
1038 1038  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1039 -
1040 1040  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1041 -
1042 1042  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1043 -
1044 1044  ~/~/ "ValueOn": "Вкл.",
1045 -
1046 1046  ~/~/ "ValueOff": "Выкл."
1047 - "summaryMaxValue": 0 ~/~/ Макс. значение
1428 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1429 +
1430 +(((
1431 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1432 + {
1433 + "from": 0, ~/~/ С какого значения
1434 + "color": "string", ~/~/ Каким цветом
1435 + "text": "string" ~/~/ Текст подписи к этому интервалу
1436 + }
1437 + ]
1048 1048   }
1049 1049   ],
1440 +)))
1441 +
1442 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1443 +
1444 +
1050 1050   "customFields": [ ~/~/ Произвольные поля
1051 1051   {
1052 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1053 - "name": "string",
1054 - "value": "string",
1055 - "forClient": true,
1056 - "forTooltip": true,
1057 - "forReport": true
1058 - }
1059 - ]
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 - По датчику относительных Моточасов
1060 1060  }
1463 +)))
1061 1061  
1465 +
1062 1062  (% style="color:#000000" %)Ответ:
1063 1063  
1064 -(% style="color:#000000" %){
1065 1065  
1066 - "vehicleId": "", ~/~/ID ТС 
1067 - "parentId": "", ~/~/Guid владельца ТС
1068 - "name": "", ~/~/Имя объекта
1069 - "imei": "", ~/~/IMEI
1070 - "deviceTypeId": "", ~/~/ID типа устройства
1071 - "modelId": "", ~/~/ID модели
1072 - "unitId": "", ~/~/ID подразделения
1073 - "sim1": "", ~/~/SIM1
1074 - "sim2": "", ~/~/SIM2
1075 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1076 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1077 - "counters": { ~/~/Счётчики
1078 - "mileageEnabled": true,
1079 - "motohoursEnabled": true,
1080 - "mileage": "",
1081 - "motohours": 345.0
1082 - },
1083 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1084 - "id": null,
1085 - "enabled": true, ~/~/флаг включения
1086 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1087 - "login": "", ~/~/ имя учетной записи
1088 - "password": "" ~/~/ пароль учетной записи
1089 - },
1090 - "inspectionTasks": { ~/~/ задания на ТО
1091 - "id": "", ~/~/ ID задачи
1092 - "enabled": false, ~/~/ Признак включения
1093 - "name": "", ~/~/ Имя задания
1094 - "description": "", ~/~/ Описание задания
1095 - "mileageCondition": "", ~/~/ Условие по пробегу
1096 - "lastMileage": "", ~/~/ Пробег (в метрах)
1097 - "motohoursCondition": "", ~/~/ Условие по моточасам
1098 - "lastMotohours": "", ~/~/ Моточасы
1099 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1100 - "kind": "", ~/~/ Вид периодичности по времени 
1101 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
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 ~/~/ Условие по количеству записей для деактивации
1102 1102   }
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 +)))
1103 1103  
1104 -(% style="text-align:left" %)
1105 -(% 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 +)))
1106 1106  
1617 +
1107 1107  **Валидация:**
1108 1108  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1109 1109  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1110 1110  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1111 1111  
1112 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1113 1113  
1624 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1625 +
1114 1114  (% class="box infomessage" %)
1115 1115  (((
1116 1116  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1117 1117  )))
1118 1118  
1119 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1631 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1120 1120  
1121 1121  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1122 1122  
... ... @@ -1150,9 +1150,12 @@
1150 1150   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1151 1151   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1152 1152   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1153 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1154 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1155 - "customFields": null ~/~/ значение любого из произвольных полей ТС
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" ~/~/ Идентификатор агента, для которого надо получить данные
1156 1156  }
1157 1157  
1158 1158  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1159,8 +1159,14 @@
1159 1159  
1160 1160  (% style="color:#000000" %)Ответ:
1161 1161  
1162 -(% style="color:#000000" %){
1677 +(% style="color:#000000" %)[
1678 +{
1163 1163  
1680 +(((
1681 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1682 +)))
1683 +
1684 +(((
1164 1164  (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1165 1165   "name": "" ~/~/ наименование объекта
1166 1166   "imei": "" ~/~/ IMEI объекта
... ... @@ -1186,9 +1186,21 @@
1186 1186   "forClient": true, ~/~/ право на отображение у клиента
1187 1187   "forTooltip": false, ~/~/ право на отображение в подсказке
1188 1188   "forReport": false ~/~/ право на отображение в отчетах
1189 - }(%%)
1190 -(% style="color:#000000" %)}
1710 +)))
1191 1191  
1712 +(((
1713 + }
1714 + ],
1715 + "vehicleGroups": [  ~/~/ Группы ТС
1716 + {
1717 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1718 + "name": "string" ~/~/ Наименование группы ТС
1719 + }
1720 + ]
1721 + }
1722 +]
1723 +)))
1724 +
1192 1192  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1193 1193  
1194 1194  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -1220,13 +1220,11 @@
1220 1220   "data": "", ~/~/ Данные
1221 1221   "overwrite": false, ~/~/ Флаг перезаписи
1222 1222   "stage": "", ~/~/ Состояние, может быть null
1223 -
1224 1224  (% style="color:#000000" %)}
1225 1225  
1226 1226  (% style="color:#000000" %)Ответ:
1227 1227  
1228 -(% style="color:#000000" %){
1229 -
1760 +(% style="color:#000000" %){(%%)
1230 1230   "status": "", ~/~/ значение статуса
1231 1231   "date": "", ~/~/ Дата смены статуса 
1232 1232   "description": "", ~/~/ Описание
... ... @@ -1233,10 +1233,9 @@
1233 1233   "data": "", ~/~/ Данные
1234 1234   "overwrite": false, ~/~/ Флаг перезаписи
1235 1235   "stage": "", ~/~/ Состояние
1236 -
1237 -(% style="text-align:left" %)
1238 1238  (% style="color:#000000" %) }
1239 1239  
1769 +
1240 1240  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1241 1241  
1242 1242  (% class="box warningmessage" %)
... ... @@ -1312,9 +1312,19 @@
1312 1312  
1313 1313  "drivers": [ ~/~/ Водители
1314 1314   {
1315 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1316 - "isDefault": true
1317 - }
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 + } 
1318 1318   ],
1319 1319   "commandTemplates": [ ~/~/ Шаблон команды
1320 1320   {
... ... @@ -1324,8 +1324,7 @@
1324 1324   "retries": 0
1325 1325   }
1326 1326   ],
1327 -
1328 - "sensors": [ ~/~/ Датчики
1867 +"sensors": [ ~/~/ Датчики
1329 1329   {
1330 1330   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1331 1331   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1351,6 +1351,11 @@
1351 1351   ],
1352 1352   "showInTooltip": true, ~/~/ Отображать в подсказке
1353 1353   "showLastValid": true, ~/~/ Отображать последнее валидное значение
1893 +
1894 +(((
1895 + "color": "string",** ~/~/ **Цвет датчика
1896 +)))
1897 +
1354 1354   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1355 1355   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1356 1356   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -1363,95 +1363,225 @@
1363 1363   "additionalProp2": "string",
1364 1364   "additionalProp3": "string"
1365 1365   },
1366 -
1367 1367  ~/~/ Характерные для произвольного:
1368 -
1369 1369  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1370 -
1371 1371  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1372 -
1373 1373  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1374 -
1375 1375  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1376 -
1377 1377  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1378 -
1379 1379  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1380 -
1381 1381  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1382 -
1383 1383  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1384 -
1385 1385  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1386 -
1387 1387  ~/~/ "ValueOn": "Вкл.",
1388 -
1389 1389  ~/~/ "ValueOff": "Выкл."
1390 1390   "summaryMaxValue": 0 ~/~/ Макс. значение
1923 +
1924 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1925 + {
1926 + "from": 0, ~/~/ С какого значения
1927 + "color": "string", ~/~/ Каким цветом
1928 + "text": "string" ~/~/ Текст подписи к этому интервалу
1929 + }
1930 + ]
1391 1391   }
1392 1392   ],
1933 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1934 +
1393 1393   "customFields": [ ~/~/ Произвольные поля
1394 - {
1395 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1396 - "name": "string",
1397 - "value": "string",
1398 - "forClient": true,
1399 - "forTooltip": true,
1400 - "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 ~/~/ Отобразить произвольное поле в отчете
1401 1401   }
1402 - ]
1944 +
1945 +(((
1946 + ],
1947 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1948 +)))
1949 +
1403 1403  }
1404 1404  
1952 +
1405 1405  (% style="color:#000000" %)Ответ:
1406 1406  
1407 -(% lang="en-US" style="text-align:left" %)
1408 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
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 +)))
1409 1409  
1410 -(% lang="en-US" style="text-align:left" %)
1411 - "vehicleId": "", ~/~/ ID ТС
1412 - "parentId": "", ~/~/ ID клиента
1413 - "name": "", ~/~/ имя ТС
1414 - "imei": "", ~/~/ IMEI
1415 - "deviceTypeId": "", ~/~/ типа устройства
1416 - "modelId": "", ~/~/ ID модели
1417 - "unitId": "", ~/~/ ID подразделения
1418 - "sim1": "", ~/~/ SIM 1
1419 - "sim2": "", ~/~/ SIM2
1420 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1421 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1422 - "counters": 
1423 - {
1424 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1425 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1426 - "mileage": "", ~/~/ пробег
1427 - "motohours": "", ~/~/ моточасы
1428 - }
1429 - "cmsv6Parameters": ~/~/ параметры CMSv6
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": [ ~/~/ Тарировка
1430 1430   {
1431 - "id": ~/~/ идентификатор
1432 - "enabled": true, ~/~/ флаг включения
1433 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1434 - "login": "", ~/~/ имя учетной записи
1435 - "password": "", ~/~/ пароль учетной записи
1436 - }
1437 - "inspectionTasks": ~/~/ задания на ТО
1438 - {
1439 - "id": "", ~/~/ ID задания
1440 - "enabled": false, ~/~/ Признак включения
1441 - "name": "", ~/~/ Имя задания
1442 - "description": "", ~/~/ Описание задания
1443 - "mileageCondition": "", ~/~/ Условие по пробегу
1444 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1445 - "motohoursCondition": "", ~/~/ Условие по моточасам
1446 - "lastMotohours": "", ~/~/ Моточасы
1447 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1448 - "kind": "", ~/~/ Вид периодичности по времени
1449 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2076 + "grades": [ ~/~/ Таблицы тарировки
2077 + {
2078 + "input": 0, ~/~/ Вход
2079 + "output": 0 ~/~/ Выход
2080 + }
2081 + ],
2082 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
1450 1450   }
2084 + ],
2085 + "showInTooltip": true, ~/~/ Отображение в подсказке
2086 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1451 1451  
1452 -(% lang="en-US" style="text-align:left" %)
1453 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
2088 +(((
2089 + "color": "string", ~/~/ цвет уведомлений
2090 +)))
1454 1454  
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 +
1455 1455  **Валидация:**
1456 1456  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1457 1457  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
... ... @@ -1490,18 +1490,15 @@
1490 1490  
1491 1491  (% style="color:#000000" %)Метод запроса: **GET**
1492 1492  
1493 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
2167 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1494 1494  
1495 1495  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1496 1496  
1497 1497  (% style="color:#000000" %)Ответ:
1498 1498  
1499 -(% style="color:#000000" %){
1500 -
2173 +(% style="color:#000000" %){(%%)
1501 1501   "deviceTypeId" : "", ~/~/ ID типа устройства
1502 1502   "deviceTypeName" : "" ~/~/ Название типа устройства
1503 -
1504 -(% style="text-align:left" %)
1505 1505  (% style="color:#000000" %)}
1506 1506  
1507 1507  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1523,13 +1523,10 @@
1523 1523  
1524 1524  (% style="color:#000000" %)Ответ:
1525 1525  
1526 -(% style="color:#000000" %){
1527 -
2197 +(% style="color:#000000" %){(%%)
1528 1528   "id": "", ~/~/ ID типа датчика 
1529 1529   "name": "", ~/~/ Название
1530 1530   "description": "", ~/~/ Описание
1531 -
1532 -(% style="text-align:left" %)
1533 1533  (% style="color:#000000" %)}
1534 1534  
1535 1535  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1573,6 +1573,56 @@
1573 1573   }
1574 1574  ]
1575 1575  
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 +
1576 1576  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1577 1577  
1578 1578  (% class="box infomessage" %)
... ... @@ -1597,6 +1597,11 @@
1597 1597   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1598 1598  }
1599 1599  
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 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,25 +1603,43 @@
1603 1603   {
1604 1604   "messages": [
1605 1605   {
1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 - "speed": 0, ~/~/ Скорость, км/ч
1609 - "altitude": 0, ~/~/ Высота, м
1610 - "latitude": 0, ~/~/ Широта [-90°;90°]
1611 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 - "satellites": 0, ~/~/ Кол-во спутников
1613 - "voltage": 0, ~/~/ Напряжение
1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
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": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
2343 + "photoCount": 0,
2344 + "lbsCorrectedCoords": true,
2345 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
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 типа протокола
2365 +
1625 1625  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1626 1626  
1627 1627  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1641,7 +1641,7 @@
1641 1641  Тело запроса:
1642 1642  
1643 1643  {
1644 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2385 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1645 1645   "vehicleIds": [0], ~/~/ Список ID объектов
1646 1646   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1647 1647   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -1658,10 +1658,14 @@
1658 1658   {
1659 1659   "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
1660 1660   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1661 - "mileageBegin": 0, ~/~/ Пробег на начало периода
1662 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
1663 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
1664 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2402 + "mileage": 0, ~/~/ Пробег за период, километры
2403 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2404 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2405 + "motohours": 0, ~/~/ Моточасы за период, секунды
2406 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2407 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2408 + "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2409 +
1665 1665   }
1666 1666   ]
1667 1667   }
... ... @@ -1684,7 +1684,6 @@
1684 1684  Тело запроса:
1685 1685  
1686 1686  {
1687 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
1688 1688   "vehicleIds": [0], ~/~/ Список ID объектов
1689 1689   "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
1690 1690   "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
... ... @@ -1703,13 +1703,22 @@
1703 1703   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1704 1704   "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
1705 1705   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2450 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2451 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
1706 1706   "fuelConsumption": 0, ~/~/ Расход топлива
1707 1707   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2454 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2455 +
1708 1708   }
1709 1709   ]
1710 1710   }
1711 1711  ]
1712 1712  
2461 +(% class="box warningmessage" %)
2462 +(((
2463 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2464 +)))
2465 +
1713 1713  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
1714 1714  
1715 1715  (% class="box infomessage" %)
... ... @@ -1744,145 +1744,142 @@
1744 1744   "model": "string", ~/~/ Модель объекта
1745 1745   "fuels": [ ~/~/ Массив данным по заправкам и сливам
1746 1746   {
1747 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2500 + "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
2501 +
2502 +(((
1748 1748   "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
1749 1749   "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
1750 1750   "valueFuel": 0, ~/~/ Количество
1751 1751   "fuelStart": 0, ~/~/ Уровень топлива на начало события
1752 1752   "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2508 +)))
2509 +
2510 +(((
2511 + "latitude": 0, ~/~/ Широта.
2512 + "longitude": 0 ~/~/ Долгота.
2513 +)))
2514 +
1753 1753   }
1754 1754   ]
1755 1755   }
1756 1756  ]
1757 1757  
1758 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1759 1759  
1760 -== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2521 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
1761 1761  
1762 1762  (% class="box infomessage" %)
1763 1763  (((
1764 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2525 +**POST /api/v3/vehicles/moveStop**
1765 1765  )))
1766 1766  
1767 -(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2528 +Метод запроса: **POST**
1768 1768  
1769 -(% style="color:#000000" %)Метод запроса: **POST**
2530 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
1770 1770  
1771 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2532 +В заголовках запроса: X-Auth: Токен авторизации
1772 1772  
1773 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1774 1774  
1775 -(% style="text-align:left" %)
1776 1776  Тело запроса:
1777 1777  
1778 -(% style="text-align:left" %)
1779 1779  {
1780 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2538 + "vehicleIds": [ ], ~/~/ Список ID объектов
2539 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2540 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2541 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
1781 1781  }
1782 1782  
1783 -(% style="text-align:left" %)
1784 1784  Ответ:
1785 1785  
1786 -[
2546 +[ 
1787 1787   {
1788 - "id": 0, ~/~/ Идентификатор объекта геозоны
1789 - "name": "string", ~/~/ Название объекта геозоны
1790 - "type": 0, ~/~/ Тип объекта геозоны
1791 - "fname": "string", ~/~/ Имя файла
1792 - "parentId": "string", ~/~/ Идентификатор клиента
1793 - "radius": 0, ~/~/ Радиус геообъекта
1794 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
1795 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
1796 - "description": "string", ~/~/ Описание
1797 - "area": 0, ~/~/ Площадь, м^^2^^
1798 - "perimetr": 0, ~/~/ Периметр, м
1799 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
1800 - }
1801 -]
1802 -
1803 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
1804 -
1805 -(% class="box infomessage" %)
1806 -(((
1807 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
1808 -)))
1809 -
1810 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
1811 -
1812 -(% style="color:#000000" %)Метод запроса: **POST**
1813 -
1814 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
1815 -
1816 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1817 -
1818 -(% style="text-align:left" %)
1819 -Тело запроса:
1820 -
1821 -{
1822 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
1823 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
1824 - "ids": [ ], ~/~/ Массив id объектов
1825 - "byTime": 0, ~/~/ Объединение событий по времени 
1826 - "byDist": 0, ~/~/ Объединение событий по расстоянию
1827 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
1828 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
1829 -}
1830 -
1831 -Ответ:
1832 -[
1833 - {
1834 - "geozoneId": 0, ~/~/ ID геообъекта
1835 - "geozoneName": "string", ~/~/ Название геообъекта
1836 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
1837 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
1838 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
1839 1839   "vehicleId": 0, ~/~/ ID объекта
1840 - "vehicleName": "string" ~/~/ Имя объекта
2549 + "vehicleName": "string", ~/~/ Имя объекта
2550 + "moves": [ ~/~/ Событие движения
2551 + {
2552 + "mileage": 0, ~/~/ Пробег, км
2553 + "eventId": 0, ~/~/ Идентификатор события
2554 + "eventName": "string", ~/~/ Название события
2555 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2556 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2557 + "duration": 0 ~/~/ Продолжительность события, секунд
2558 + }
2559 + ],
2560 + "stops": [ ~/~/ События стоянок
2561 + {
2562 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2563 + "eventId": 0, ~/~/ Идентификатор события
2564 + "eventName": "string", ~/~/ Название события
2565 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2566 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2567 + "duration": 0 ~/~/ Продолжительность события, секунд
2568 + }
2569 + ]
1841 1841   }
1842 1842  ]
1843 1843  
1844 -== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
1845 1845  
2574 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2575 +
1846 1846  (% class="box infomessage" %)
1847 1847  (((
1848 -(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2578 +**POST /api/v3/vehicles/getlastdata**
1849 1849  )))
1850 1850  
1851 -(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2581 +Метод запроса: **POST**
1852 1852  
1853 -(% style="color:#000000" %)Метод запроса: **POST**
2583 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
1854 1854  
1855 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2585 +В заголовках запроса: X-Auth: Токен авторизации
1856 1856  
1857 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1858 1858  
1859 -(% style="text-align:left" %)
1860 -Тело запроса:
2588 +В массиве указываем id объектов через запятую
1861 1861  
1862 -{
1863 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
1864 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
1865 - "ids": [ ], ~/~/ Массив id геообъектов
1866 - "byTime": 0, ~/~/ Объединение событий по времени 
1867 - "byDist": 0, ~/~/ Объединение событий по расстоянию
1868 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
1869 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
1870 -}
1871 -
1872 1872  Ответ:
1873 1873  
1874 1874  [
1875 1875   {
1876 - "geozoneId": 0, ~/~/ ID геообъекта
1877 - "geozoneName": "string", ~/~/ Название геообъекта
1878 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
1879 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
1880 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
1881 - "vehicleId": 0, ~/~/ ID объекта
1882 - "vehicleName": "string" ~/~/ Имя объекта
2594 + "vehicleId": 55728, ~/~/ Идентификатор объекта 
2595 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2596 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2597 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2598 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2599 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2600 + "speed": 31, ~/~/ Скорость объекта 
2601 + "course": 116, ~/~/ Курс движения [0;360]
2602 + "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2603 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2604 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2605 + "geozones": [ ~/~/ Сведения по геозонам. 
2606 + {
2607 + "id": 10225647, ~/~/ ID Геозоны 
2608 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2609 + },
2610 + {
2611 + "id": 10282875, ~/~/ ID Геозоны 
2612 + "name": "Ё2" ~/~/ Наименование геозоны 
2613 + },
2614 + {
2615 + "id": 10226240, ~/~/ ID Геозоны 
2616 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2617 + },
2618 + {
2619 + "id": 9747869, ~/~/ ID Геозоны 
2620 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2621 + },
2622 + {
2623 + "id": 10221123, ~/~/ ID Геозоны 
2624 + "name": "53r" ~/~/ Наименование геозоны 
2625 + },
2626 + {
2627 + "id": 10197638, ~/~/ ID Геозоны 
2628 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2629 + }
2630 + ]
1883 1883   }
1884 -]
2632 +
1885 1885  
2634 += =
2635 +
1886 1886  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1887 1887  
1888 1888  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -1914,7 +1914,7 @@
1914 1914   "id": 0, ~/~/ ID уведомления
1915 1915   "name": "string", ~/~/ Название уведомления
1916 1916   "active": true, ~/~/ Состояние true - активен, false - деактивирован
1917 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2667 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
1918 1918   "userId": "", ~/~/ Пользователь, создавший уведомление
1919 1919   "parentId": "", ~/~/ Идентификатор клиента
1920 1920   "parentName": "string" ~/~/ Имя клиента
... ... @@ -1921,6 +1921,155 @@
1921 1921   }
1922 1922  ]
1923 1923  
2674 +
2675 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2676 +
2677 +(% class="box infomessage" %)
2678 +(((
2679 +**POST /api/v3/notifications**
2680 +)))
2681 +
2682 +Метод запроса **POST**
2683 +
2684 +(% style="text-align: left;" %)
2685 +(% style="color:#000000" %)Пример запроса
2686 +
2687 +(((
2688 +{
2689 + "id": 0, ~/~/ ID правила
2690 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2691 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2692 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2693 + "name": "string", ~/~/ Имя правила
2694 + "active": true, ~/~/ Активность правила
2695 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2696 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2697 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2698 + ],
2699 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2700 + 0
2701 + ],
2702 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2703 + 0
2704 + ],
2705 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2706 + 0
2707 + ],
2708 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2709 + "additionalProp1": "string",  
2710 + "additionalProp2": "string",
2711 + "additionalProp3": "string"
2712 + },
2713 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2714 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2715 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2716 + ],
2717 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2718 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2719 + "string"
2720 + ],
2721 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2722 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2723 + {
2724 + "id": 0, ~/~/ Идентификатор участника чата.
2725 + "info": "string" ~/~/ Дополнительные сведения.
2726 + }
2727 + ],
2728 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2729 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2730 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2731 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2732 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2733 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2734 + "timezone": 0, ~/~/ часовой пояс 
2735 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2736 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2737 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2738 + {
2739 + "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 - Срок действия правила истек
2740 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2741 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2742 + "additionalProp1": "string",
2743 + "additionalProp2": "string",
2744 + "additionalProp3": "string"
2745 + }
2746 + }
2747 + ]
2748 +}
2749 +)))
2750 +
2751 +(((
2752 +
2753 +)))
2754 +
2755 +(((
2756 +
2757 +)))
2758 +
2759 +Ответ:
2760 +
2761 +{
2762 + "id": 0, ~/~/ ID правила
2763 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2764 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2765 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2766 + "name": "string", ~/~/ Имя правила
2767 + "active": true, ~/~/ Активность правила
2768 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2769 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2770 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2771 + ],
2772 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2773 + 0
2774 + ],
2775 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2776 + 0
2777 + ],
2778 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2779 + 0
2780 + ],
2781 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2782 + "additionalProp1": "string",  
2783 + "additionalProp2": "string",
2784 + "additionalProp3": "string"
2785 + },
2786 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2787 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2788 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2789 + ],
2790 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2791 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2792 + "string"
2793 + ],
2794 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2795 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2796 + {
2797 + "id": 0, ~/~/ Идентификатор участника чата.
2798 + "info": "string" ~/~/ Дополнительные сведения.
2799 + }
2800 + ],
2801 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2802 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2803 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2804 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2805 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2806 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2807 + "timezone": 0, ~/~/ часовой пояс 
2808 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2809 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2810 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2811 + {
2812 + "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 - Срок действия правила истек
2813 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2814 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2815 + "additionalProp1": "string",
2816 + "additionalProp2": "string",
2817 + "additionalProp3": "string"
2818 + }
2819 + }
2820 + ]
2821 +}
2822 +
1924 1924  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1925 1925  
1926 1926  (% class="box infomessage" %)
... ... @@ -2062,6 +2062,32 @@
2062 2062  
2063 2063  Success
2064 2064  
2964 +
2965 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2966 +
2967 +(% class="box warningmessage" %)
2968 +(((
2969 +**PUT** /api/v3/notifications/prolongation
2970 +)))
2971 +
2972 +Метод позволяет продлить уведомления.
2973 +
2974 +Метод запроса **PUT**
2975 +
2976 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2977 +
2978 +В заголовках запроса: X-Auth: Токен авторизации.
2979 +
2980 +Тело запроса:
2981 +
2982 +[
2983 +
2984 +0
2985 +
2986 +]
2987 +
2988 +где 0 идентификатор ids.
2989 +
2065 2065  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2066 2066  
2067 2067  (% class="box errormessage" %)
... ... @@ -2653,6 +2653,83 @@
2653 2653  Success
2654 2654  
2655 2655  
3581 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3582 +
3583 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3584 +
3585 +(% class="box infomessage" %)
3586 +(((
3587 +**POST /api/v3/Trailers**
3588 +)))
3589 +
3590 +Пример запроса:
3591 +
3592 +{
3593 + "startDate": "2023-11-14T10:48:03.671Z",
3594 + "endDate": "2023-11-14T10:48:03.671Z",
3595 + "ids": [ 0 ],
3596 + "timezone": 0
3597 +}
3598 +
3599 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3600 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3601 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3602 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3603 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3604 +
3605 +Пример ответа:
3606 +
3607 +[
3608 + {
3609 + "SD": "2023-11-14T10:48:03.717Z",
3610 + "ED": "2023-11-14T10:48:03.717Z", 
3611 + "id": 0,
3612 + "SLat": 0,
3613 + "SLon": 0,
3614 + "ELat": 0,
3615 + "ELon": 0,
3616 + "mileage": 0
3617 + "Duration": 0
3618 + "Address": "string",
3619 + "Address2": "string",
3620 + "name": "string",
3621 + "rid": "string",
3622 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3623 + "trailer": {
3624 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3625 + "Number": "string",
3626 + "Description": "string",
3627 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3628 + "ExternalID": "string",
3629 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3630 + "CreateTime": "2023-11-14T10:48:03.717Z",
3631 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3632 + "IsDeleted": true
3633 + },
3634 + "filesCount": 0,
3635 + }
3636 +]
3637 +
3638 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3639 +|SD|Дата и время начала события
3640 +|ED|Дата и время окончания события
3641 +|id|ID объекта
3642 +|SLat|Широта начальной координаты
3643 +|SLon|Долгота начальной координаты
3644 +|ELat|Широта конечной координаты
3645 +|ELon|Долгота конечной координаты
3646 +|mileage|Пробег
3647 +|Duration|Продолжительность
3648 +|Address|Адрес начального местоположения
3649 +|Address2|Адрес конечного местоположения
3650 +|name|Имя радиометки
3651 +|rid|Номер радиометки
3652 +|rguid|ID радиометки
3653 +|trailer|Информация об агрегате
3654 +|ModelGuid|ID агрегата
3655 +|Number|Название/номер агрегата
3656 +|Description|Текст примечания агрегата
3657 +
2656 2656  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2657 2657  
2658 2658  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2674,13 +2674,18 @@
2674 2674   {
2675 2675   "name": "string",
2676 2676   "number": 0,
2677 - "period": 0, ~/~/ Частота трансляции радиометки
3679 + "period": 0,
2678 2678   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2679 2679   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2680 - "deleted": true
2681 2681   }
2682 2682  ]
2683 2683  
3685 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3686 +|parentId|ID клиента
3687 +|name|Название карты-метки
3688 +|number|Номер
3689 +|period|Период запросов в секундах (работает только для агрегатов)
3690 +|id|ID карты-метки
2684 2684  
2685 2685  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2686 2686  
... ... @@ -2697,13 +2697,18 @@
2697 2697   {
2698 2698   "name": "string",
2699 2699   "number": 0,
2700 - "period": 0, ~/~/ Частота трансляции радиометки
3707 + "period": 0,
2701 2701   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2702 2702   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2703 - "deleted": true
2704 2704   }
2705 2705  ]
2706 2706  
3713 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3714 +|name|Название карты-метки
3715 +|number|Номер
3716 +|period|Период запросов в секундах (работает только для агрегатов)
3717 +|id|ID карты-метки
3718 +|parentId|ID клиента
2707 2707  
2708 2708  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2709 2709  
... ... @@ -2719,7 +2719,6 @@
2719 2719   "number": 0,
2720 2720   "period": 0,
2721 2721   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2722 - "deleted": true
2723 2723  }
2724 2724  
2725 2725  Ответ:
... ... @@ -2730,9 +2730,14 @@
2730 2730   "period": 0,
2731 2731   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2732 2732   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2733 - "deleted": true
2734 2734  }
2735 2735  
3746 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3747 +|name|Название карты-метки
3748 +|number|Номер
3749 +|period|Период запросов в секундах (работает только для агрегатов)
3750 +|id|ID карты-метки
3751 +|parentId|ID клиента
2736 2736  
2737 2737  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2738 2738  
... ... @@ -2749,7 +2749,6 @@
2749 2749   "period": 0,
2750 2750   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2751 2751   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2752 - "deleted": true
2753 2753  }
2754 2754  
2755 2755  Ответ:
... ... @@ -2760,9 +2760,14 @@
2760 2760   "period": 0,
2761 2761   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2762 2762   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2763 - "deleted": true
2764 2764  }
2765 2765  
3780 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3781 +|name|Название карты-метки
3782 +|number|Номер
3783 +|period|Период запросов в секундах (работает только для агрегатов)
3784 +|id|ID карты-метки
3785 +|parentId|ID клиента
2766 2766  
2767 2767  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2768 2768  
... ... @@ -2771,7 +2771,7 @@
2771 2771  **DELETE /api/v3/Rfids/{rfidGuid}**
2772 2772  )))
2773 2773  
2774 -Передаем параметр rfidGuid - идентификатор карты-метки
3794 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2775 2775  
2776 2776  Ответ:
2777 2777  
... ... @@ -2778,6 +2778,2763 @@
2778 2778  Success
2779 2779  
2780 2780  
3801 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3802 +
3803 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3804 +
3805 +(% class="box infomessage" %)
3806 +(((
3807 +**GET /api/v3/Billing/client/balance/{clientId}**
3808 +)))
3809 +
3810 +Параметр запроса: **clientId **- идентификатор клиента.
3811 +
3812 +Ответ:
3813 +
3814 +{
3815 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3816 + "Balance": 0
3817 +}
3818 +
3819 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3820 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3821 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3822 +
3823 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3824 +
3825 +(% class="box infomessage" %)
3826 +(((
3827 +**GET /api/v3/Billing/client/constraint/{clientId}**
3828 +)))
3829 +
3830 +Параметр запроса: **clientId **- идентификатор клиента.
3831 +
3832 +Ответ:
3833 +
3834 +{
3835 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3836 + "CalculationType": 0,
3837 + "PermissibleBalance": 0,
3838 + "DefermentDays": 0,
3839 + "SendUiNotifications": true,
3840 + "SendEmailNotifications": true,
3841 + "IsPrivate": true,
3842 +}
3843 +
3844 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3845 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3846 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3847 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3848 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3849 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3850 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3851 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3852 +
3853 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3854 +
3855 +(% class="box infomessage" %)
3856 +(((
3857 +**GET /api/v3/Billing/client/plan/{clientId}**
3858 +)))
3859 +
3860 +Параметры запроса:
3861 +
3862 +**clientId **- идентификатор клиента.
3863 +
3864 +**planId **- идентификатор тарифного плана.
3865 +
3866 +Ответ:
3867 +
3868 +{
3869 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3870 + "Plan": { **~/~/ Описание тарифного плана**
3871 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3872 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3873 + "Name": "string",
3874 + "IsArchived": true,
3875 + "Constraint": {
3876 + "CalculationType": 0,
3877 + "PermissibleBalance": 0,
3878 + "DefermentDays": 0
3879 + },
3880 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3881 + {
3882 + "Feature": "string",
3883 + "IsFactual": true,
3884 + "Limit": 0,
3885 + "Price": 0,
3886 + "PeriodValue": 0,
3887 + "PeriodType": 0
3888 + }
3889 + ]
3890 + },
3891 + "DebitDate": "2023-10-18T12:46:24.213Z",
3892 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3893 + {
3894 + "Feature": "string",
3895 + "IsEnabled": true,
3896 + "IsPrivate": true,
3897 + "IsFactual": true,
3898 + "Limit": 0,
3899 + "Price": 0,
3900 + "DebitDate": "2023-10-18T12:46:24.213Z",
3901 + "PeriodValue": 0,
3902 + "PeriodType": 0
3903 + }
3904 + ]
3905 +}
3906 +
3907 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3908 +|ClientId|Идентификатор клиента
3909 +|Id|Идентификатор тарифного плана
3910 +|OwnerId|Идентификатор клиента-владельца
3911 +|Name|Наименование тарифного плана
3912 +|IsArchived|Признак, определяющий архивный тарифный план
3913 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3914 +|PermissibleBalance|Допустимый баланс
3915 +|DefermentDays|Отсрочка, количество дней
3916 +|Feature|Код услуги
3917 +|IsEnabled|Признак, определяющий активирована ли услуга
3918 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3919 +|IsFactual|Признак, определяющий расчёт по факту
3920 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3921 +|Price|Цена за единицу.
3922 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3923 +|PeriodValue|Значение периода.
3924 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3925 +
3926 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3927 +
3928 +(% class="box infomessage" %)
3929 +(((
3930 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3931 +)))
3932 +
3933 +Параметр запроса: **clientId **- идентификатор клиента.
3934 +
3935 +Ответ:
3936 +
3937 +[
3938 + {
3939 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3940 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3941 + "Name": "string",
3942 + "IsArchived": true,
3943 + "Constraint": {
3944 + "CalculationType": 0,
3945 + "PermissibleBalance": 0,
3946 + "DefermentDays": 0
3947 + },
3948 + "Features": [
3949 + {
3950 + "Feature": "string",
3951 + "IsFactual": true,
3952 + "Limit": 0,
3953 + "Price": 0,
3954 + "PeriodValue": 0,
3955 + "PeriodType": 0
3956 + }
3957 + ]
3958 + }
3959 +]
3960 +
3961 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3962 +|ClientId|Идентификатор клиента
3963 +|Id|Идентификатор тарифного плана
3964 +|OwnerId|Идентификатор клиента-владельца
3965 +|Name|Наименование тарифного плана
3966 +|IsArchived|Признак, определяющий архивный тарифный план
3967 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3968 +|PermissibleBalance|Допустимый баланс
3969 +|DefermentDays|Отсрочка, количество дней
3970 +|Feature|Код услуги
3971 +|IsFactual|Признак, определяющий расчёт по факту
3972 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3973 +|Price|Цена за единицу.
3974 +|PeriodValue|Значение периода.
3975 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3976 +
3977 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3978 +
3979 +(% class="box infomessage" %)
3980 +(((
3981 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3982 +)))
3983 +
3984 +Параметр запроса: **clientId **- идентификатор клиента.
3985 +
3986 +Ответ:
3987 +
3988 +[
3989 + {
3990 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3991 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3992 + "Name": "string",
3993 + "IsArchived": true,
3994 + "Constraint": {
3995 + "CalculationType": 0,
3996 + "PermissibleBalance": 0,
3997 + "DefermentDays": 0
3998 + },
3999 + "Features": [
4000 + {
4001 + "Feature": "string",
4002 + "IsFactual": true,
4003 + "Limit": 0,
4004 + "Price": 0,
4005 + "PeriodValue": 0,
4006 + "PeriodType": 0
4007 + }
4008 + ]
4009 + }
4010 +]
4011 +
4012 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4013 +|ClientId|Идентификатор клиента
4014 +|Id|Идентификатор тарифного плана
4015 +|OwnerId|Идентификатор клиента-владельца
4016 +|Name|Наименование тарифного плана
4017 +|IsArchived|Признак, определяющий архивный тарифный план
4018 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4019 +|PermissibleBalance|Допустимый баланс
4020 +|DefermentDays|Отсрочка, количество дней
4021 +|Feature|Код услуги
4022 +|IsFactual|Признак, определяющий расчёт по факту
4023 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4024 +|Price|Цена за единицу.
4025 +|PeriodValue|Значение периода.
4026 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4027 +
4028 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4029 +
4030 +(% class="box warningmessage" %)
4031 +(((
4032 +**PUT /api/v3/Billing/client/balance**
4033 +)))
4034 +
4035 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4036 +
4037 +Тело запроса:
4038 +
4039 +{
4040 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4041 + "Balance": 0 ~/~/ Значение баланса.
4042 +}
4043 +
4044 +Ответ: Success
4045 +
4046 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4047 +
4048 +(% class="box warningmessage" %)
4049 +(((
4050 +**PUT /api/v3/billing/client/balance/deposit**
4051 +)))
4052 +
4053 +Создает операцию **Пополнение **с указанной суммой
4054 +
4055 +Тело запроса:
4056 +
4057 +(((
4058 +{
4059 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4060 + "amount": 0 ~/~/ Сумма пополнения баланса 
4061 +}
4062 +)))
4063 +
4064 +(((
4065 +
4066 +)))
4067 +
4068 +Ответ: Success
4069 +
4070 +(((
4071 +{
4072 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4073 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4074 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4075 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4076 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4077 + "Description": "string" ~/~/ Описание корректировки.
4078 +}
4079 +)))
4080 +
4081 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4082 +
4083 +Создает операцию **Списание **с указанной суммой
4084 +
4085 +(% class="box warningmessage" %)
4086 +(((
4087 +**PUT /api/v3/billing/client/balance/withdraw**
4088 +)))
4089 +
4090 +Тело запроса:
4091 +
4092 +(((
4093 +{
4094 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4095 + "amount": 0 ~/~/ Сумма списания с баланса
4096 +}
4097 +)))
4098 +
4099 +Ответ: Success
4100 +
4101 +(((
4102 +{
4103 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4104 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4105 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4106 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4107 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4108 + "Description": "string" ~/~/ Описание корректировки
4109 +}
4110 +)))
4111 +
4112 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4113 +
4114 +(% class="box warningmessage" %)
4115 +(((
4116 +**PUT /api/v3/Billing/client/constraint**
4117 +)))
4118 +
4119 +Тело запроса:
4120 +
4121 +(((
4122 +{
4123 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4124 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4125 + "PermissibleBalance": 0, ~/~/ Допустимый баланс
4126 + "DefermentDays": 0, ~/~/ Отсрочка (дни).
4127 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4128 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4129 +}
4130 +)))
4131 +
4132 +(((
4133 +
4134 +)))
4135 +
4136 +Ответ: Success
4137 +
4138 +(((
4139 +{
4140 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4141 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4142 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4143 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4144 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4145 + "DefermentDays": 0, ~/~/ Отсрочка (дни)
4146 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4147 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4148 +}
4149 +)))
4150 +
4151 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4152 +
4153 +(% class="box warningmessage" %)
4154 +(((
4155 +**PUT /api/v3/Billing/client/plan**
4156 +)))
4157 +
4158 +Тело запроса:
4159 +
4160 +{
4161 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4162 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4163 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4164 + {
4165 + "Feature": "string", ~/~/ Код услуги.
4166 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4167 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4168 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4169 + "Price": 0, ~/~/ Цена за единицу.
4170 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4171 + "PeriodValue": 0, ~/~/ Значение периода.
4172 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4173 + }
4174 + ]
4175 +}
4176 +
4177 +
4178 +Ответ: Success
4179 +
4180 +(((
4181 +{
4182 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4183 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4184 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4185 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4186 + "Name": "string", ~/~/ Наименование.
4187 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4188 + "Constraint": { ~/~/ Ограничения по тарифу 
4189 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4190 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4191 + "DefermentDays": 0 ~/~/ Отсрочка (дни)
4192 + },
4193 + "Features": [ ~/~/ Набор услуг по тарифному плану.
4194 + {
4195 + "Feature": "string", ~/~/Код услуги.
4196 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4197 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4198 + "Price": 0, ~/~/ Цена за единицу.
4199 + "PeriodValue": 0, ~/~/ Значение периода.
4200 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4201 + }
4202 + ],
4203 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4204 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4205 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4206 + },
4207 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4208 + {
4209 + "Feature": "string", ~/~/ Код услуги.
4210 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4211 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4212 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4213 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4214 + "Price": 0, ~/~/ Цена за единицу.
4215 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4216 + "PeriodValue": 0, ~/~/ Значение периода.
4217 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4218 + "Quantity": 0 ~/~/ Количество использования услуги.
4219 + }
4220 + ]
4221 +}
4222 +)))
4223 +
4224 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4225 +
4226 +(% class="box warningmessage" %)
4227 +(((
4228 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4229 +)))
4230 +
4231 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4232 +
4233 +(% class="box infomessage" %)
4234 +(((
4235 +**POST /api/v3/vehicles/import/{agentId}**
4236 +)))
4237 +
4238 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4239 +
4240 +В пути указывается **agentId** - id клиента.
4241 +
4242 +**Заголовок**
4243 +
4244 +**X-Auth: [токен авторизации]**
4245 +
4246 +**Параметры**
4247 +
4248 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4249 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4250 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4251 +
4252 +В теле использовать тип **form-data,** тип значения** file**
4253 +
4254 +**Ключи**
4255 +
4256 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4257 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
4258 +|csv|В значении передаем файл датчиков, формат **csv**
4259 +
4260 +Ответ:
4261 +
4262 +{
4263 + "vehicleId": 0,
4264 + "name": "string",
4265 + "errors": ["string"]
4266 +}
4267 +
4268 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4269 +|vehicleId|ID созданного объекта
4270 +|name|Имя созданного объекта
4271 +|errors|Ошибки и их описание
4272 +
4273 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4274 +
4275 +(% class="box infomessage" %)
4276 +(((
4277 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4278 +)))
4279 +
4280 +(% class="wikigeneratedid" %)
4281 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4282 +
4283 +(% class="wikigeneratedid" %)
4284 +В пути указывается **vehicleId **- id объекта.
4285 +
4286 +**Заголовок**
4287 +
4288 +**X-Auth: [токен авторизации]**
4289 +
4290 +В теле использовать тип **form-data.**
4291 +
4292 +Ключи:
4293 +
4294 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4295 +|**history**|В значении передавать файл с историей
4296 +
4297 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4298 +
4299 +Ответ:
4300 +
4301 +{
4302 + "results": [
4303 + {
4304 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4305 + "vehicleId": 0,
4306 + "errors": [
4307 + "string"
4308 + ],
4309 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
4310 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
4311 + "producedCount": 0,
4312 + "msgCount": 0
4313 + }
4314 + ]
4315 +}
4316 +
4317 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4318 +|results|Результаты импорта в разрезе ТС
4319 +|vehicleGuid|Guid ТС
4320 +|vehicleId|ID ТС
4321 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4322 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
4323 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4324 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
4325 +|msgCount|Кол-во обработанных сообщений всего
4326 +
4327 +== **Импортировать историю ТС (Асинхронный запрос)** ==
4328 +
4329 +(% class="box successmessage" %)
4330 +(((
4331 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4332 +)))
4333 +
4334 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4335 +
4336 +Метод запроса: **POST**
4337 +
4338 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4339 +
4340 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4341 +
4342 +
4343 +Ответ:
4344 +
4345 +{
4346 +
4347 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4348 +
4349 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4350 +
4351 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4352 +
4353 + "Message": "string", ~/~/ Информация о выполнении запроса
4354 +
4355 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4356 +
4357 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4358 +
4359 + "Data": "string" ~/~/ Данные
4360 +
4361 +}
4362 +
4363 +
4364 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4365 +
4366 +(% class="box infomessage" %)
4367 +(((
4368 +**GET /api/v3/vehicles/import/history/status**
4369 +)))
4370 +
4371 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4372 +
4373 +Ответ:
4374 +
4375 +{
4376 + "activity": true,
4377 + "progress": 0,
4378 + "message": "string"
4379 +}
4380 +
4381 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4382 +**Параметр**
4383 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4384 +**Описание**
4385 +)))
4386 +|(((
4387 +activity
4388 +)))|(((
4389 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4390 +)))
4391 +|(((
4392 +progress
4393 +)))|(((
4394 +Guid ТС
4395 +)))
4396 +
4397 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4398 +
4399 +(% class="box infomessage" %)
4400 +(((
4401 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4402 +)))
4403 +
4404 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4405 +
4406 +Метод запроса: **GET**
4407 +
4408 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4409 +
4410 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4411 +
4412 +
4413 +Ответ:
4414 +
4415 +{
4416 +
4417 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4418 +
4419 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4420 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4421 +
4422 + "Message": "string", ~/~/ Информация о выполнении запроса
4423 +
4424 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4425 +
4426 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4427 +
4428 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4429 +
4430 + "Data": "string" ~/~/ Данные
4431 +
4432 +}
4433 +
4434 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4435 +
4436 +(% class="box infomessage" %)
4437 +(((
4438 +**POST /api/v3/vehicles/export**
4439 +)))
4440 +
4441 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4442 +
4443 +Тело запроса:
4444 +
4445 +[
4446 + id
4447 +]
4448 +
4449 +Ответ: Success 200, получаете файлы с настройками.
4450 +
4451 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4452 +
4453 +(% class="box infomessage" %)
4454 +(((
4455 +**POST /api/v3/vehicles/export/history**
4456 +)))
4457 +
4458 +Метод возвращает список сообщений терминала объекта за выбранный период.
4459 +
4460 +Тело запроса:
4461 +
4462 +{
4463 + "vehicleId": 0,
4464 + "asArchive": true,
4465 + "from": "2023-09-27T12:17:45.973Z",
4466 + "to": "2023-09-27T12:17:45.973Z"
4467 +}
4468 +
4469 +Ответ:
4470 +
4471 +Получаете файл. Сообщение: Code 200/Success
4472 +
4473 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4474 +|vehicleId|ID объекта
4475 +|asArchive|true - Архивировать файл, False - не архивировать
4476 +|from|Дата и время начала запроса
4477 +|to|Дата и время окончания запроса
4478 +
4479 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4480 +
4481 +(% class="box infomessage" %)
4482 +(((
4483 +**GET /api/v3/vehicles/export/history/status**
4484 +)))
4485 +
4486 +Метод возвращает список сообщений терминала объекта за выбранный период.
4487 +
4488 +Ответ:
4489 +
4490 +{
4491 + "activity": true,
4492 + "progress": 0,
4493 + "message": "string"
4494 +}
4495 +
4496 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4497 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4498 +|progress|Прогресс экспорта, от 0 до 100%
4499 +|message|Текст описывающий статус
4500 +
4501 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4502 +
4503 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4504 +
4505 +(% class="box infomessage" %)
4506 +(((
4507 +**POST /api/v3/EcoDriving/rating**
4508 +)))
4509 +
4510 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4511 +
4512 +Тело запроса:
4513 +
4514 +{
4515 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4516 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4517 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4518 +}
4519 +
4520 +Ответ:
4521 +
4522 +{
4523 + "items": [  ~/~/ Список в разрезе ТС
4524 + {
4525 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4526 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4527 + "vehicleId": 0, ~/~/ ID ТС
4528 + "vehicleName": "string", ~/~/ Название ТС
4529 + "vehicleModel": "string", ~/~/ Модель ТС
4530 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4531 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4532 + "totalViolations": 0, ~/~/ Нарушений всего
4533 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4534 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4535 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4536 + "brakingViolations": 0, ~/~/ Нарушений торможения
4537 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4538 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4539 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4540 + },
4541 +
4542 +(((
4543 +
4544 +)))
4545 +
4546 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4547 + "mileage": 0, ~/~/ Пробег, м
4548 + "tripsCount": 0, ~/~/ Кол-во рейсов
4549 + "trips": [  ~/~/ Информация по рейсу
4550 + {
4551 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4552 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4553 + "violationsCount": 0, ~/~/ Всего нарушений
4554 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4555 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4556 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4557 + "brakingViolations": 0, ~/~/ Нарушений торможения
4558 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4559 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4560 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4561 + },
4562 +
4563 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4564 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4565 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4566 + "mileage": 0, ~/~/ Пробег, м
4567 + "motohours": 0, ~/~/ Моточасы, секунды
4568 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4569 + "startAddress": "string", ~/~/ Адрес начала рейса
4570 + "endAddress": "string", ~/~/ Адрес конца рейса
4571 + "drivers": [  ~/~/ Список водителей
4572 + {
4573 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4574 + "driverName": "string", ~/~/ФИО водителя
4575 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4576 + }
4577 + ]
4578 + }
4579 + ]
4580 + }
4581 + ]
4582 +}
4583 +
4584 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4585 +
4586 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4587 +
4588 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4589 +
4590 +(% class="box infomessage" %)
4591 +(((
4592 +**POST /api/v3/fuelcards/transactions**
4593 +)))
4594 +
4595 +Метод запроса: POST
4596 +
4597 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4598 +\\В заголовках запроса: X-Auth: Токен авторизации
4599 +
4600 +Параметры в теле запроса (JSON):
4601 +
4602 +{
4603 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4604 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4605 + "ids": [ 
4606 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4607 + ],
4608 + "timezone": 0 ~/~/ Часовой пояс
4609 +}
4610 +
4611 +
4612 +Ответ:
4613 + {
4614 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4615 + "driver": "string", ~/~/ Водители, привязанные к ТК
4616 + "object": "string", ~/~/ Наименование ТС
4617 + "amount": 0, ~/~/ Количество топлива
4618 + "amountDut": 0, ~/~/ Количество по ДУТ
4619 + "amountDiff": 0, ~/~/ Разница, л
4620 + "amountDiffPerc": 0, ~/~/ Разница, %
4621 + "summa": 0, ~/~/ Стоимость, руб
4622 + "serviceName": "string", ~/~/ Тип топлива
4623 + "price": 0, ~/~/ Цена за литр, руб
4624 + "cardName": "string", ~/~/ Наименование ТК
4625 + "cardNum": "string", ~/~/ Номер ТК
4626 + "operator": "string", ~/~/ Оператор ТК
4627 + "address": "string" ~/~/ Адрес АЗС
4628 + }
4629 +
4630 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4631 +
4632 +(% class="box infomessage" %)
4633 +(((
4634 +**GET /api/v3/fuelcards**
4635 +)))
4636 +
4637 +Метод запроса: GET
4638 +
4639 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4640 +
4641 +Ответ:
4642 +
4643 +[
4644 + {
4645 + "Name": "string", ~/~/ Определяет наименование карты.
4646 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4647 + "Number": "string", ~/~/ Определяет № карты.
4648 + "Enabled": true, ~/~/ Определяет признак активности карты.
4649 + "Description": "string", ~/~/ Определяет описание карты.
4650 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4651 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4652 + "deleted": true ~/~/ Признак удаления
4653 + }
4654 +]
4655 +
4656 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4657 +
4658 +
4659 +== **Получение полных данных о ретрансляторе** ==
4660 +
4661 +(% class="box infomessage" %)
4662 +(((
4663 +**GET ** **/api/v3/retranslations/{id}**
4664 +)))
4665 +
4666 +id - Идентификатор ретранслятора
4667 +
4668 +
4669 +Пример ответа:
4670 +
4671 +{  
4672 +"description": "", ~/~/ Поле описания ретранслятора
4673 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4674 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4675 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4676 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4677 +"objects": [ ~/~/ Объекты для ретрансляции
4678 +{      
4679 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4680 +"name": "", ~/~/ Наименование объекта ретрансляции
4681 +"imei": "", ~/~/ IMEI объекта  ретрансляции
4682 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4683 +}
4684 + ],  
4685 +"id": "", ~/~/ Идентификатор ретранслятора 
4686 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4687 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4688 +}
4689 +
4690 +
4691 +== **Удаление данных ретранслятора** ==
4692 +
4693 +(% class="box infomessage" %)
4694 +(((
4695 +**DELETE** **/api/v3/retranslations/{id}**
4696 +)))
4697 +
4698 +id - Идентификатор ретранслятора
4699 +
4700 +
4701 +== **Создание ретранслятора** ==
4702 +
4703 +(% class="box infomessage" %)
4704 +(((
4705 +**POST ** **/api/v3/retranslations/{id}**
4706 +)))
4707 +
4708 +Запрос:
4709 +
4710 +{  
4711 +"description": "", ~/~/ Поле описания ретранслятора
4712 +"subscriberId": "", ~/~/ Идентификатор подписчика
4713 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4714 +"address": "", ~/~/ Адрес и порт принимающего сервера
4715 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4716 +"objects": [ ~/~/Объекты для ретрансляции
4717 +{      
4718 +"id": "", ~/~/ Идентификатор ретранслятора 
4719 +"imei": "", ~/~/ IMEI объекта ретрансляции
4720 +"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4721 +}
4722 + ]
4723 +}
4724 +
4725 +
4726 +Ответ:
4727 +
4728 +{  
4729 +"description": "", ~/~/ Поле описания ретранслятора
4730 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4731 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4732 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4733 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4734 +"objects": [ ~/~/ Объекты для ретрансляции
4735 +{      
4736 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4737 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4738 +"imei": "", ~/~/ IMEI объекта ретрансляции
4739 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4740 +}
4741 + ],
4742 +"id": "", ~/~/ Идентификатор ретранслятора   
4743 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4744 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4745 +}
4746 +
4747 +
4748 +== **Редактирование ретранслятора** ==
4749 +
4750 +(% class="box infomessage" %)
4751 +(((
4752 +**PUT** **/api/v3/retranslations**
4753 +)))
4754 +
4755 +Пример запроса:
4756 +
4757 +{  
4758 +"id": "", ~/~/ Идентификатор ретранслятора   
4759 +"description": "string", ~/~/ Поле описания ретранслятора
4760 +"subscriberId": "", ~/~/ Идентификатор подписчика
4761 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4762 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4763 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4764 +"objects": ~/~/ Объекты для ретрансляции
4765 +[    
4766 +{      
4767 +"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4768 +"imei": "", ~/~/ IMEI объекта ретрансляции
4769 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4770 +}
4771 + ]
4772 +}
4773 +
4774 +
4775 +Пример ответа:
4776 +
4777 +{  
4778 +"description": "", ~/~/ Поле описания ретранслятора
4779 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4780 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4781 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4782 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4783 +"objects": [ ~/~/ Объекты для ретрансляции
4784 +{      
4785 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4786 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4787 +"imei": "", ~/~/ IMEI объекта ретрансляции
4788 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4789 +}
4790 + ],
4791 +"id": "", ~/~/ Идентификатор ретранслятора   
4792 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4793 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4794 +}
4795 +
4796 +
4797 +== **Получение списка ретранслятора клиента** ==
4798 +
4799 +(% class="box infomessage" %)
4800 +(((
4801 +**POST /api/v3/retranslations/find**
4802 +)))
4803 +
4804 +Пример запроса:
4805 +
4806 +{  
4807 +"id": "", ~/~/ Идентификатор ретранслятора   
4808 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4809 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4810 +}
4811 +
4812 +Ответ:
4813 +
4814 +[ 
4815 +{    
4816 +"description": "", ~/~/ Поле описания ретранслятора
4817 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4818 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4819 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4820 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4821 +"id": "", ~/~/ Идентификатор ретранслятора   
4822 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4823 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4824 +}
4825 +]
4826 +
4827 +
4828 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4829 +
4830 +== **API для отчета по выгрузке комбайнов** ==
4831 +
4832 +(% class="box infomessage" %)
4833 +(((
4834 +**POST /api/v3/Reports/harvesterUnloading**
4835 +)))
4836 +
4837 +Пример запроса:
4838 +
4839 +{
4840 + "byTime": 0, ~/~/ Объединение событий по времени
4841 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4842 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4843 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4844 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4845 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4846 + 0
4847 + ],
4848 + "from": "", ~/~/ Дата и время начало запроса
4849 + "to": "", ~/~/ Дата и время окончания запроса
4850 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4851 +}
4852 +
4853 +Пример ответа:
4854 +
4855 +[ 
4856 + {
4857 + "harvesterName": "", ~/~/Комбайн, номер
4858 + "harvesterId": 0, ~/~/Комбайн, id
4859 +"harvesterModel": "", ~/~/ Модель комбайна
4860 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4861 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4862 + "events": [ ~/~/Список событий в разрезе комбайна
4863 + {
4864 + "driverId": "", ~/~/Идентификатор водителя
4865 + "driverName": "", ~/~/Водитель комбайна, ФИО
4866 + "RFID": "", ~/~/ идентификатор карты-метки
4867 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4868 + "vehicleId": 0, ~/~/идентификатор объекта
4869 + "vehicleName": "string", ~/~/ Имя объекта
4870 + "modelName": "string", ~/~/ Имя модели объекта
4871 + "nearestVehicles": [ ~/~/Объекты рядом
4872 + {
4873 + "vehicleId": 0, ~/~/идентификатор объекта
4874 + "vehicleName": "string" ~/~/ Имя объекта
4875 + }
4876 + ],
4877 + "fields": [ ~/~/Поля, где происходила выгрузка
4878 + {
4879 + "id": 0, ~/~/ идентификатор пользователя 
4880 + "name": "string" ~/~/ имя пользователя 
4881 + }
4882 + ],
4883 + "event": "string", ~/~/Событие
4884 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4885 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4886 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4887 + "cultureName": "string", ~/~/ название культуры
4888 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4889 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4890 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4891 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4892 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4893 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4894 + "issued": 0, ~/~/Выдано, бункеров
4895 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4896 + "latitude": 0, ~/~/Широта
4897 + "longitude": 0, ~/~/ Долгота
4898 + "litresAway": 0, ~/~/Отдано, л
4899 + "m3Away": 0 ~/~/Отдано, м3
4900 + }
4901 + ]
4902 + }
4903 +]
4904 +
4905 +
4906 +== **Отчет трек-датчики** ==
4907 +
4908 +(% class="box infomessage" %)
4909 +(((
4910 +**POST /api/v3/Reports/sensorsWorks**
4911 +)))
4912 +
4913 +**Пример запроса:**
4914 +
4915 +{
4916 + "vehicleIds": [ ~/~/ Список ID объектов
4917 + 0
4918 + ],
4919 + "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4920 + "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4921 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4922 +}
4923 +
4924 +**Пример ответа:**
4925 +
4926 +(((
4927 +{
4928 + "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4929 + {
4930 + "vehicleId": 0, ~/~/ Идентификатор ТС
4931 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4932 + {
4933 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4934 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4935 + "duration": 0, ~/~/  Продолжительность интервала в секундах.
4936 + "name": "string", ~/~/ Наименование оборудования.
4937 + "mileage": 0, ~/~/ Пробег за время работы оборудования.
4938 + "totalMileage": 0, ~/~/ Общий пробег.
4939 + "avgSpeed": 0 ~/~/ Средняя скорость.
4940 + }
4941 + ]
4942 + }
4943 + ]
4944 +}
4945 +
4946 +
4947 +== **Превышение скорости** ==
4948 +
4949 +(% class="box infomessage" %)
4950 +(((
4951 +**POST /api/v3/Reports/overSpeedDuration**
4952 +)))
4953 +
4954 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4955 +
4956 +Пример запроса:
4957 +
4958 +(((
4959 +{
4960 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4961 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4962 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4963 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4964 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4965 +}
4966 +)))
4967 +
4968 +(((
4969 +
4970 +)))
4971 +
4972 +(((
4973 +Пример ответа:
4974 +)))
4975 +
4976 +(((
4977 +(((
4978 +[
4979 + {
4980 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4981 + "duration": 0, ~/~/ Продолжительность события в секундах 
4982 + "maxSpeed": 0, ~/~/ Максимальная скорость 
4983 + "speedLimit": 0 ~/~/ Ограничение скорости 
4984 + }
4985 +]
4986 +)))
4987 +)))
4988 +)))
4989 +
4990 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4991 +
4992 +
4993 +== **Запрос списка полей** ==
4994 +
4995 +(% class="box successmessage" %)
4996 +(((
4997 +**POST /api/v3/agroLands/find**
4998 +)))
4999 +
5000 +Пример запроса:
5001 +
5002 +(((
5003 +(((
5004 +(((
5005 +{
5006 + "year": 0, ~/~/ Фильтр по году
5007 + "name": "string", ~/~/ Фильтр по названию
5008 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
5009 +}
5010 +)))
5011 +)))
5012 +
5013 +
5014 +)))
5015 +
5016 +Пример ответа:
5017 +
5018 +(((
5019 +[
5020 + {
5021 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5022 + "year": 0, ~/~/ Год поля
5023 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
5024 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
5025 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5026 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5027 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5028 + "counts": { ~/~/ Счётчики с/х поля 
5029 + "fieldOperations": 0, ~/~/ Количество операций на поле
5030 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5031 + "facts": 0 ~/~/ Счётчик факта
5032 + },
5033 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5034 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5035 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5036 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5037 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5038 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5039 + "planComment": "string", ~/~/ Комментарий к полю
5040 + "productivity": 0, ~/~/ Урожайность.
5041 + "id": 0, ~/~/ Идентификатор объекта геозоны
5042 + "name": "string", ~/~/ Название объекта геозоны
5043 + "type": 0, ~/~/ Тип объекта геозоны
5044 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5045 + "fname": "string", ~/~/ Имя файла
5046 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5047 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
5048 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
5049 + "description": "string", ~/~/ Описание объекта геозоны
5050 + "area": 0, ~/~/ Площадь, м2
5051 + "perimetr": 0, ~/~/ Периметр, м
5052 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
5053 + }
5054 +]
5055 +
5056 +
5057 +== **Создание нового поля ** ==
5058 +
5059 +(% class="box successmessage" %)
5060 +(((
5061 +**POST /api/v3/agroLands**
5062 +)))
5063 +
5064 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5065 +X-agent  - ID клиента
5066 +
5067 +Пример запроса:
5068 +
5069 +(((
5070 +{
5071 + "extId": "string", 
5072 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5073 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5074 + "display": "string", ~/~/ Настройки отображения
5075 + "year": 0, ~/~/ Год поля
5076 + "name": "string", ~/~/ Наименование
5077 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5078 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5079 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5080 + "planComment": "string", ~/~/ Комментарий к полю
5081 + "cropRotations": [ ~/~/ Данные по севообороту
5082 + {
5083 + "landId": 0, ~/~/ ID поля
5084 + "landName": "string", ~/~/ Название поля
5085 + "year": 0, ~/~/ Год урожая
5086 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5087 + "cultureName": "string", ~/~/ Название культуры
5088 + "productivity": 0, ~/~/ Урожайность
5089 + "area": 0, ~/~/ Площадь поля, Га
5090 + "total": 0, ~/~/ Валовый сбор
5091 + "productivityFact": 0, ~/~/ Фактическая урожайность
5092 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5093 + "totalFact": 0, ~/~/ Фактический валовый сбор
5094 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5095 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5096 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5097 + "isyearplan": true, ~/~/ Годовой план 
5098 + "comment": "string" ~/~/ Комментарий
5099 + }
5100 + ]
5101 +}
5102 +)))
5103 +
5104 +(((
5105 +
5106 +)))
5107 +
5108 +Пример ответа:
5109 +
5110 +(((
5111 +(((
5112 +{
5113 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5114 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5115 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5116 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5117 + "cropRotations": [ ~/~/ Данные по севообороту
5118 + {
5119 + "landId": 0, ~/~/ ID поля
5120 + "landName": "string", ~/~/ Название поля
5121 + "year": 0, ~/~/ Год урожая 
5122 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5123 + "cultureName": "string", ~/~/ Название культуры
5124 + "productivity": 0, ~/~/ Урожайность
5125 + "area": 0, ~/~/ Площадь поля, Га.
5126 + "total": 0, ~/~/ Валовый сбор
5127 + "productivityFact": 0, ~/~/ Фактическая урожайность
5128 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5129 + "totalFact": 0, ~/~/ Фактический валовый сбор
5130 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5131 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5132 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5133 + "isyearplan": true, ~/~/ годовой план 
5134 + "comment": "string" ~/~/ Комментарий
5135 + }
5136 + ],
5137 + "cropVegetation": [ ~/~/ История вегетации поля
5138 + {
5139 + "values": [  ~/~/ Данные вегетации и состояния посева
5140 + {
5141 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5142 + "ndvi": 0 ~/~/ Индекс вегетации
5143 + }
5144 + ],
5145 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5146 + {
5147 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5148 + "type": "string", ~/~/ Тип
5149 + "pictureid": "string" ~/~/ Идентификатор ресурса
5150 + }
5151 + ],
5152 + "states": [ ~/~/ Ключевые даты развития поля
5153 + {
5154 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5155 + "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5156 + }
5157 + ]
5158 + }
5159 + ],
5160 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5161 + "counts": {
5162 + "fieldOperations": 0, ~/~/ Количество операций на поле
5163 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5164 + "facts": 0 ~/~/ Счётчик факта
5165 + },
5166 + "planComment": "string", ~/~/ Комментарий к полю
5167 +)))
5168 +
5169 +(((
5170 + "productivity": 0, ~/~/ Урожайность.
5171 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5172 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5173 + "year": 0, ~/~/ Год поля
5174 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5175 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5176 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5177 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5178 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5179 + "id": 0, ~/~/ Идентификатор объекта геозоны
5180 + "name": "string", ~/~/ Название объекта геозоны
5181 + "type": 0, ~/~/ Тип объекта геозоны
5182 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5183 + "fname": "string", ~/~/ Имя файла
5184 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5185 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5186 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5187 + "description": "string", ~/~/ Описание объекта геозоны
5188 + "area": 0, ~/~/ Площадь, м2
5189 + "perimetr": 0, ~/~/ Периметр, м
5190 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5191 +}
5192 +
5193 +
5194 +)))
5195 +)))
5196 +)))
5197 +
5198 +== **Получение поля по id** ==
5199 +
5200 +(% class="box infomessage" %)
5201 +(((
5202 +**GET /api/v3/agroLands/{id}**
5203 +)))
5204 +
5205 +Пример запроса:
5206 +id  ~/~/ Идентификатор поля
5207 +
5208 +Пример ответа:
5209 +
5210 +(((
5211 +{
5212 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5213 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5214 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5215 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5216 + "cropRotations": [ ~/~/ Данные по севообороту
5217 + {
5218 + "landId": 0, ~/~/ ID поля
5219 + "landName": "string", ~/~/ Название поля
5220 + "year": 0, ~/~/ Год урожая
5221 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5222 + "cultureName": "string", ~/~/ Название культуры
5223 + "productivity": 0, ~/~/ Урожайность
5224 + "area": 0, ~/~/ Площадь поля, Га
5225 + "total": 0, ~/~/ Валовый сбор
5226 + "productivityFact": 0, ~/~/ Фактическая урожайность
5227 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5228 + "totalFact": 0, ~/~/ Фактический валовый сбор
5229 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5230 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5231 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5232 + "isyearplan": true, ~/~/ План года 
5233 + "comment": "string" ~/~/ Комментарий
5234 + }
5235 + ],
5236 + "cropVegetation": [ ~/~/ История вегетации поля
5237 + {
5238 + "values": [ ~/~/ Данные вегетации и состояния посева
5239 + {
5240 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5241 + "ndvi": 0 ~/~/ Индекс вегетации
5242 + }
5243 + ],
5244 + "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5245 + {
5246 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5247 + "type": "string", ~/~/ Тип 
5248 + "pictureid": "string" ~/~/ Идентификатор ресурса
5249 + }
5250 + ],
5251 + "states": [ ~/~/ Ключевые даты развития поля
5252 + {
5253 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5254 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5255 + }
5256 + ]
5257 + }
5258 + ],
5259 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5260 + "counts": {
5261 + "fieldOperations": 0, ~/~/ Количество операций на поле
5262 + "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5263 + "facts": 0 ~/~/ Счётчик факта
5264 + },
5265 + "planComment": "string", ~/~/ Комментарий к полю
5266 + "productivity": 0, ~/~/ Урожайность.
5267 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5268 +)))
5269 +
5270 +(((
5271 +(((
5272 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5273 + "year": 0, ~/~/ Год поля
5274 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5275 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5276 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5277 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5278 + "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5279 + "id": 0, ~/~/ Идентификатор объекта геозоны
5280 + "name": "string", ~/~/ Название объекта геозоны
5281 + "type": 0, ~/~/ Тип объекта геозоны 
5282 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5283 + "fname": "string", ~/~/ Имя файла
5284 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5285 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5286 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5287 + "description": "string", ~/~/ Описание объекта геозоны
5288 + "area": 0, ~/~/ Площадь, м2
5289 + "perimetr": 0, ~/~/ Периметр, м
5290 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5291 +}
5292 +)))
5293 +
5294 +
5295 +(((
5296 +(((
5297 +(((
5298 +== **Изменение поля** ==
5299 +
5300 +(% class="box infomessage" %)
5301 +(((
5302 +**PUT /api/v3/agroLands**
5303 +)))
5304 +
5305 +Пример запроса:
5306 +
5307 +(((
5308 +(((
5309 +{
5310 + "id": 0, ~/~/ Идентификатор поля
5311 + "extId": "string", ~/~/ ExtId
5312 + "shape": "string", ~/~/ Форма поля
5313 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5314 + "display": "string", ~/~/ Настройки отображения
5315 + "year": 0, ~/~/ Год поля
5316 + "name": "string", ~/~/ Наименование
5317 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5318 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5319 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5320 + "planComment": "string", ~/~/Комментарий к полю
5321 + "cropRotations": [  ~/~/ Данные по севообороту
5322 + {
5323 + "landId": 0, ~/~/ ID поля
5324 + "landName": "string", ~/~/ Название поля
5325 + "year": 0, ~/~/ Год урожая
5326 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5327 + "cultureName": "string", ~/~/ Название культуры
5328 + "productivity": 0, ~/~/ Урожайность
5329 + "area": 0, ~/~/ Площадь поля, Га.
5330 + "total": 0, ~/~/ Валовый сбор
5331 + "productivityFact": 0, ~/~/ Фактическая урожайность
5332 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5333 + "totalFact": 0, ~/~/ Фактический валовый сбор
5334 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5335 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5336 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5337 + "isyearplan": true, 
5338 + "comment": "string" ~/~/ Комментарий
5339 + }
5340 + ],
5341 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5342 +}
5343 +)))
5344 +)))
5345 +
5346 +(((
5347 +
5348 +)))
5349 +
5350 +Пример ответа:
5351 +
5352 +(((
5353 +(((
5354 +(((
5355 +{
5356 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5357 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5358 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5359 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5360 + "cropRotations": [ ~/~/ Данные по севообороту
5361 + {
5362 + "landId": 0, ~/~/ ID поля
5363 + "landName": "string", ~/~/ Название поля
5364 + "year": 0, ~/~/  Год урожая
5365 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5366 + "cultureName": "string", ~/~/ Название культуры
5367 + "productivity": 0, ~/~/ Урожайность
5368 + "area": 0, ~/~/ Площадь поля, Га
5369 + "total": 0, ~/~/ Валовый сбор
5370 + "productivityFact": 0, ~/~/ Фактическая урожайность
5371 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5372 + "totalFact": 0, ~/~/ Фактический валовый сбор
5373 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5374 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5375 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5376 + "isyearplan": true, ~/~/ 
5377 + "comment": "string" ~/~/ Комментарий
5378 + }
5379 + ],
5380 + "cropVegetation": [ ~/~/ История вегетации поля
5381 + {
5382 + "values": [ ~/~/ Данные вегетации и состояния посева
5383 + {
5384 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5385 + "ndvi": 0 ~/~/ Индекс вегетации
5386 + }
5387 + ],
5388 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5389 + {
5390 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5391 + "type": "string", ~/~/ Тип
5392 + "pictureid": "string" ~/~/ Идентификатор ресурса
5393 + }
5394 + ],
5395 + "states": [ ~/~/ Ключевые даты развития поля 
5396 + {
5397 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5398 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5399 + }
5400 + ]
5401 + }
5402 + ],
5403 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5404 + "counts": { 
5405 + "fieldOperations": 0, ~/~/ Количество операций на поле
5406 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5407 + "facts": 0 ~/~/ Счётчик факта
5408 + },
5409 + "planComment": "string", ~/~/ Комментарий к полю
5410 + "productivity": 0, ~/~/ Урожайность.
5411 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5412 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5413 + "year": 0, ~/~/ Год поля
5414 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5415 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5416 + "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5417 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5418 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5419 + "id": 0, ~/~/ Идентификатор объекта геозоны
5420 + "name": "string", ~/~/ Название объекта геозоны
5421 + "type": 0, ~/~/ Тип объекта геозоны
5422 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5423 + "fname": "string", ~/~/ Имя файла
5424 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5425 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5426 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5427 + "description": "string", ~/~/ Описание объекта геозоны
5428 + "area": 0, ~/~/ Площадь, м2
5429 + "perimetr": 0, ~/~/ Периметр, м
5430 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5431 +}
5432 +)))
5433 +)))
5434 +)))
5435 +)))
5436 +)))
5437 +
5438 +
5439 +== **Редактирование года урожая ** ==
5440 +
5441 +(% class="box successmessage" %)
5442 +(((
5443 +**POST /api/v3/agroLands/updateOpenCloseYear**
5444 +)))
5445 +
5446 +Пример запроса:
5447 +
5448 +(((
5449 +(((
5450 +{
5451 + "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5452 + 0
5453 + ],
5454 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5455 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5456 +}
5457 +)))
5458 +
5459 +
5460 +)))
5461 +
5462 +Пример ответа:
5463 +
5464 +(((
5465 +(((
5466 +{
5467 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5468 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5469 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5470 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5471 + "cropRotations": [ ~/~/ Данные по севообороту
5472 + {
5473 + "landId": 0, ~/~/ ID поля
5474 + "landName": "string", ~/~/ Название поля
5475 + "year": 0, ~/~/ Год урожая
5476 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5477 + "cultureName": "string", ~/~/ Название культуры
5478 + "productivity": 0, ~/~/ Урожайность
5479 + "area": 0, ~/~/ Площадь поля, Га.
5480 + "total": 0, ~/~/ Валовый сбор
5481 + "productivityFact": 0, ~/~/ Фактическая урожайность
5482 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5483 + "totalFact": 0, ~/~/ Фактический валовый сбор
5484 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5485 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5486 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5487 + "isyearplan": true, ~/~/ 
5488 + "comment": "string" ~/~/ Комментарий
5489 + }
5490 + ],
5491 + "cropVegetation": [ ~/~/ История вегетации поля
5492 + {
5493 + "values": [ ~/~/ Данные вегетации и состояния посева
5494 + {
5495 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5496 + "ndvi": 0 ~/~/ Индекс вегетации
5497 + }
5498 + ],
5499 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5500 + {
5501 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5502 + "type": "string", ~/~/ Тип
5503 + "pictureid": "string" ~/~/ Идентификатор ресурса
5504 + }
5505 + ],
5506 + "states": [ ~/~/ Ключевые даты развития поля
5507 + {
5508 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5509 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5510 + }
5511 + ]
5512 + }
5513 + ],
5514 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5515 + "counts": { 
5516 + "fieldOperations": 0, ~/~/ Количество операций на поле
5517 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5518 + "facts": 0 ~/~/ Счётчик факта
5519 + },
5520 + "planComment": "string", ~/~/ Комментарий к полю
5521 + "productivity": 0, ~/~/ Урожайность.
5522 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5523 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5524 + "year": 0, ~/~/ Год поля
5525 + "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5526 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5527 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5528 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5529 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5530 + "id": 0, ~/~/ Идентификатор объекта геозоны
5531 + "name": "string", ~/~/ Название объекта геозоны
5532 + "type": 0, ~/~/ Тип объекта геозоны
5533 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5534 + "fname": "string", ~/~/ Имя файла
5535 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5536 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5537 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5538 + "description": "string", ~/~/ Описание объекта геозоны
5539 + "area": 0, ~/~/ Площадь, м2
5540 + "perimetr": 0, ~/~/ ериметр, м
5541 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5542 +}
5543 +
5544 +
5545 +== **Какие поля посещал объект** ==
5546 +
5547 +(% class="box successmessage" %)
5548 +(((
5549 +**POST /api/v3/agroLands/visitingByVehicle**
5550 +)))
5551 +
5552 +Пример запроса:
5553 +
5554 +{
5555 + "vehicleId": 0, ~/~/ id объекта 
5556 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5557 + "byTime": 0, ~/~/ Объединение событий по времени
5558 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5559 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5560 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5561 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5562 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5563 +}
5564 +
5565 +Пример ответа:
5566 +
5567 +[
5568 + {
5569 + "fieldId": 0, ~/~/ id объекта 
5570 + "vehicleName": "string", ~/~/ Наименование объекта 
5571 + "fieldName": "string", ~/~/ Наименование поля 
5572 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5573 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5574 + "vehicleId": 0, ~/~/ Идентификатор ТС
5575 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5576 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5577 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5578 + "mileage": 0 ~/~/ Пробег 
5579 + }
5580 +]
5581 +)))
5582 +
5583 +
5584 +== **Посещение поля объектами ** ==
5585 +
5586 +(% class="box successmessage" %)
5587 +(((
5588 +**POST /api/v3/agroLands/visitingByField**
5589 +)))
5590 +
5591 +Пример запроса:
5592 +{
5593 + "fieldId": 0, ~/~/ ID поля
5594 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5595 + "byTime": 0, ~/~/ Объединение событий по времени
5596 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5597 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5598 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5599 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5600 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5601 +}
5602 +
5603 +Пример ответа:
5604 +
5605 +[
5606 + {
5607 + "fieldId": 0, ~/~/ ID поля
5608 + "vehicleName": "string", ~/~/ Наименование объекта 
5609 + "fieldName": "string", ~/~/ Имя поля
5610 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5611 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5612 + "vehicleId": 0, ~/~/ Идентификатор ТС
5613 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5614 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5615 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5616 + "mileage": 0 ~/~/ Пробег
5617 + }
5618 +]
5619 +
5620 +
5621 +== **Удаление существующего поля** ==
5622 +
5623 +(% class="box errormessage" %)
5624 +(((
5625 +**DELETE /api/v3/agroLands/{id}**
5626 +)))
5627 +
5628 +Пример запроса:
5629 +id  ~/~/ Идентификатор поля
5630 +
5631 +Пример ответа:
5632 +
5633 +(((
5634 +200 ~/~/ Успех
5635 +
5636 +
5637 +)))
5638 +
5639 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5640 +)))
5641 +)))
5642 +)))
5643 +
5644 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5645 +
5646 +
5647 +(% class="box infomessage" %)
5648 +(((
5649 +**GET api/v3/Vehicles/recyclebin/all**
5650 +)))
5651 +
5652 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5653 +
5654 +Параметр запроса: {parentId} - идентификатор агента
5655 +
5656 +В заголовках запроса: X-Auth: Токен авторизации
5657 +
5658 +Ответ:
5659 +
5660 +[ 
5661 + {
5662 + "recordTime": "", ~/~/Время записи
5663 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5664 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5665 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5666 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5667 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5668 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5669 + "items": [ ~/~/ 
5670 +nullable: true ~/~/Детали
5671 + {
5672 + "name": "string", ~/~/наименование столбца
5673 + "value": "string" ~/~/содержание столбца
5674 + }
5675 + ]
5676 + },
5677 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5678 + "string"
5679 + ]
5680 + }
5681 +]
5682 +
5683 +
5684 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5685 +
5686 +(% class="box infomessage" %)
5687 +(((
5688 +**POST api/v3/Vehicles/recyclebin/erase**
5689 +)))
5690 +
5691 +В заголовках запроса: X-Auth: Токен авторизации
5692 +
5693 +Пример запроса:
5694 +
5695 +[
5696 +0
5697 +]
5698 +
5699 +
5700 +Пример ответа:
5701 +
5702 +[ 
5703 +{
5704 + "recordTime": "", ~/~/Время записи
5705 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5706 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5707 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
5708 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5709 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5710 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5711 + "items": [ ~/~/Детали
5712 + {
5713 + "name": "", ~/~/Имя свойства
5714 + "value": "" ~/~/Значение свойства
5715 + }
5716 + ]
5717 + },
5718 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5719 + ""
5720 + ]
5721 + }
5722 +]
5723 +
5724 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5725 +
5726 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5727 +
5728 +(% class="box infomessage" %)
5729 +(((
5730 +**POST api/v3/Vehicles/recyclebin/restore**
5731 +)))
5732 +
5733 +В заголовках запроса: X-Auth: Токен авторизации
5734 +
5735 +Параметры в теле запроса (JSON):
5736 +
5737 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5738 +
5739 +В заголовках запроса: X-Auth: Токен авторизации
5740 +
5741 +
5742 +Пример запроса:
5743 +
5744 +(((
5745 +[
5746 +)))
5747 +
5748 +(((
5749 + 0
5750 +)))
5751 +
5752 +(((
5753 +]
5754 +)))
5755 +
5756 +
5757 +Пример ответа:
5758 +
5759 +[
5760 +{
5761 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5762 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5763 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5764 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5765 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5766 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5767 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5768 + "items": [ ~/~/Детали
5769 + {
5770 + "name": "string", ~/~/Имя свойства
5771 + "value": "string" ~/~/Значение свойства
5772 + }
5773 + ]
5774 + },
5775 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5776 + "string"
5777 + ]
5778 + }
5779 +]
5780 +
5781 +
5782 += **Раздел: Журнал заданий ** =
5783 +
5784 +
5785 +== **Создание задания в Журнале заданий** ==
5786 +
5787 +(% class="box infomessage" %)
5788 +(((
5789 +**POST /api/v3/vehicletasks**
5790 +)))
5791 +
5792 +Пример запроса:
5793 +
5794 +(((
5795 +{
5796 + "vehicleId": 0, ~/~/ Идентификатор ТС
5797 + "description": "string", ~/~/ Описание
5798 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5799 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5800 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5801 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5802 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5803 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5804 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5805 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5806 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5807 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5808 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5809 + "cost": { 
5810 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5811 + "Name": "string", ~/~/ Наименование
5812 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5813 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5814 + "Norm": 0 ~/~/ Норма внесения
5815 + },
5816 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5817 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5818 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5819 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5820 + "deleted": true, ~/~/ Признак удаления
5821 + "extId": "string", 
5822 + "GeoIds": [ ~/~/ Cвязанные поля
5823 + 0
5824 + ]
5825 +}
5826 +)))
5827 +
5828 +
5829 +Пример ответа:
5830 +
5831 +{
5832 + "vehicleId": 0, ~/~/ Идентификатор ТС
5833 + "description": "string", ~/~/ Описание
5834 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5835 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5836 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5837 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5838 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5839 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5840 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5841 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5842 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5843 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5844 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5845 + "cost": { 
5846 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5847 + "Name": "string", ~/~/ Наименование
5848 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5849 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5850 + "Norm": 0 ~/~/ Норма внесения
5851 + },
5852 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5853 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5854 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5855 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5856 + "deleted": true, ~/~/ Признак удаления
5857 + "extId": "string", ~/~/ ExtId
5858 + "GeoIds": [ ~/~/ Связанные поля
5859 + 0
5860 + ]
5861 +}
5862 +
5863 +
5864 +== **Редактирование задания в Журнале заданий** ==
5865 +
5866 +(% class="box successmessage" %)
5867 +(((
5868 +**PUT /api/v3/vehicletasks**
5869 +)))
5870 +
5871 +Пример запроса:
5872 +
5873 +(((
5874 +{
5875 + "vehicleId": 0, ~/~/ Идентификатор ТС
5876 + "description": "string", ~/~/ Описание
5877 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5878 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5879 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5880 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5881 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5882 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5883 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5884 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5885 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5886 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5887 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5888 + "cost": { 
5889 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5890 + "Name": "string", ~/~/ Наименование
5891 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5892 + "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5893 + "Norm": 0 ~/~/ Норма внесения
5894 + },
5895 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5896 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5897 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5898 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5899 + "deleted": true, ~/~/ Признак удаления
5900 + "extId": "string", ~/~/ ExtId
5901 + "GeoIds": [ ~/~/ Связанные поля
5902 + 0
5903 + ]
5904 +}
5905 +)))
5906 +
5907 +
5908 +Пример ответа:
5909 +
5910 +{
5911 + "vehicleId": 0, ~/~/ Идентификатор ТС
5912 + "description": "string", ~/~/ Описание
5913 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5914 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5915 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5916 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5917 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5918 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5919 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5920 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5921 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5922 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5923 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5924 + "cost": { 
5925 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5926 + "Name": "string", ~/~/ Наименование
5927 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5928 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5929 + "Norm": 0 ~/~/ Норма внесения
5930 + },
5931 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5932 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5933 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5934 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5935 + "deleted": true, ~/~/ Признак удаления
5936 + "extId": "string", ~/~/ ExtId
5937 + "GeoIds": [ ~/~/ Связанные поля
5938 + 0
5939 + ]
5940 +}
5941 +
5942 +
5943 +== **Удаление задания в Журнале заданий** ==
5944 +
5945 +(% class="box warningmessage" %)
5946 +(((
5947 +**DELETE /api/v3/vehicletasks**
5948 +)))
5949 +
5950 +Пример запроса:
5951 +
5952 +(((
5953 +[
5954 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5955 +]
5956 +)))
5957 +
5958 +(((
5959 +
5960 +)))
5961 +
5962 +Пример ответа:
5963 +
5964 +{
5965 + "vehicleId": 0, ~/~/ Идентификатор ТС
5966 + "description": "string", ~/~/ Описание
5967 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5968 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5969 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5970 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5971 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5972 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5973 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5974 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5975 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5976 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5977 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5978 + "cost": { 
5979 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5980 + "Name": "string", ~/~/ Наименование
5981 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5982 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5983 + "Norm": 0 ~/~/ Норма внесения
5984 + },
5985 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5986 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5987 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5988 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5989 + "deleted": true, ~/~/ Признак удаления
5990 + "extId": "string", ~/~/ ExtId
5991 + "GeoIds": [ ~/~/ Связанные поля
5992 + 0
5993 + ]
5994 +}
5995 +
5996 +
5997 +== **Получение списка Журнала заданий** ==
5998 +
5999 +(% class="box infomessage" %)
6000 +(((
6001 +**POST /api/v3/vehicletasks/getbyperiod**
6002 +)))
6003 +
6004 +Пример запроса:
6005 +
6006 +(((
6007 +{
6008 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
6009 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
6010 + "TimeZone": 0, ~/~/ Часовой пояс.
6011 + "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
6012 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
6013 + ],
6014 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
6015 + 0
6016 + ],
6017 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
6018 + 0
6019 + ],
6020 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
6021 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
6022 +}
6023 +)))
6024 +
6025 +
6026 +Пример ответа:
6027 +
6028 +(((
6029 +{
6030 + "total": 0,  ~/~/ Общее количество записей
6031 + "pages": 0,  ~/~/ Общее количество страниц
6032 + "currentPage": 0, ~/~/ Текущая страница
6033 + "items": [  ~/~/ Записи 
6034 + {
6035 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6036 + "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
6037 + "name": "string", ~/~/ Название задания.
6038 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
6039 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
6040 + "workKind": "string", ~/~/ Вид работ
6041 + "techOp": "string", ~/~/ Тех. операция
6042 + "trailerModel": "string", ~/~/ Модель агрегата
6043 + "width": "string", ~/~/ Ширина, м
6044 + "speed": "string", ~/~/ Тех. скорость
6045 + "fields": "string", ~/~/ Поля
6046 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
6047 + "vehicles": "string", ~/~/ Объект-модель
6048 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
6049 + "drivers": "string", ~/~/ Водители
6050 + "tmc": "string", ~/~/ ТМЦ
6051 + "client": "string", ~/~/  Клиент
6052 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6053 + "dep": "string", ~/~/ Подразделение
6054 + "geoIds": [ ~/~/  Связанные поля
6055 + 0
6056 + ]
6057 + }
6058 + ]
6059 +}
6060 +)))
6061 +
6062 +
6063 += **Раздел: Роли** =
6064 +
6065 +== **Получение списка клиентских и системных ролей пользователя ** ==
6066 +
6067 +(% class="box successmessage" %)
6068 +(((
6069 +**POST /api/v3/groups/find**
6070 +)))
6071 +
6072 +Пример запроса:
6073 +
6074 +(((
6075 +{
6076 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6077 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6078 +}
6079 +)))
6080 +
6081 +(((
6082 +
6083 +)))
6084 +
6085 +(((
6086 +Пример ответа:
6087 +)))
6088 +
6089 +(((
6090 +(((
6091 +{
6092 + "groups": [  ~/~/ Системные роли пользователя
6093 + {
6094 + "code": "string", ~/~/ Код роли.
6095 + "name": "string", ~/~/ Имя  
6096 + "shortName": "string" ~/~/ Короткое имя 
6097 + }
6098 + ],
6099 + "customGroups": [ ~/~/ Системные роли пользователя
6100 + {
6101 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6102 + "name": "string", ~/~/ Наименование 
6103 + "shortName": "string", ~/~/ Короткое наименование 
6104 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6105 + }
6106 + ]
6107 +}
6108 +)))
6109 +)))
6110 +
6111 +(((
6112 +
6113 +)))
6114 +
6115 +(((
6116 +
6117 +)))
6118 +
6119 += **Раздел: Локатор ** =
6120 +
6121 +
6122 +== **Получение данных по локатору** ==
6123 +
6124 +(% class="box infomessage" %)
6125 +(((
6126 +**GET /api/v3/locators/{locatorId}**
6127 +)))
6128 +
6129 +В запросе указывается locatorid - идентификатор локатора
6130 +
6131 +
6132 +Пример ответа:
6133 +
6134 +(((
6135 +(((
6136 +{
6137 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6138 + 0
6139 + ],
6140 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6141 + 0
6142 + ],
6143 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6144 + 0
6145 + ],
6146 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6147 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6148 + "agentName": "string", ~/~/ Наименование агента.
6149 + "isEnabled": true, ~/~/ Активность 
6150 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6151 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6152 + "name": "string", ~/~/ Наименование.
6153 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6154 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6155 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6156 + "validity": 0, ~/~/ Значение срока действия
6157 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6158 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6159 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6160 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6161 + "url": "string", ~/~/ Ссылка
6162 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6163 +
6164 + "showVehicleName": true, ~/~/ Наименование объекта
6165 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6166 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6167 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6168 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6169 + "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ГИС)
6170 +
6171 + 1
6172 +
6173 + ]
6174 +}
6175 +)))
6176 +)))
6177 +
6178 +
6179 +(((
6180 +(((
6181 +
6182 +)))
6183 +)))
6184 +
6185 +
6186 +== **Создание локатора** ==
6187 +
6188 +(% class="box successmessage" %)
6189 +(((
6190 +**POST /api/v3/locators**
6191 +)))
6192 +
6193 +Пример запроса:
6194 +
6195 +(((
6196 +{
6197 + "isEnabled": true, ~/~/ Активность
6198 + "name": "string", ~/~/ Наименование локатора
6199 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
6200 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
6201 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6202 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6203 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6204 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6205 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6206 + 0
6207 + ],
6208 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6209 + 0
6210 + ],
6211 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6212 + 0
6213 + ],
6214 +
6215 + "showVehicleName": true, ~/~/ Наименование объекта
6216 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6217 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6218 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6219 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6220 + "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ГИС)
6221 +
6222 + 1
6223 +
6224 + ]
6225 +}
6226 +)))
6227 +
6228 +
6229 +Пример ответа:
6230 +
6231 +(((
6232 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
6233 +)))
6234 +
6235 +
6236 +== **Выводит список локаторов ** ==
6237 +
6238 +(% class="box successmessage" %)
6239 +(((
6240 +**POST /api/v3/locators/find**
6241 +)))
6242 +
6243 +Пример запроса:
6244 +
6245 +(((
6246 +{
6247 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6248 +}
6249 +)))
6250 +
6251 +(((
6252 +
6253 +)))
6254 +
6255 +(((
6256 +
6257 +)))
6258 +
6259 +
6260 +Пример ответа:
6261 +
6262 +(((
6263 +[
6264 + {
6265 + "vehiclesCount": 0, ~/~/ Количество объектов.
6266 + "geozonesCount": 0, ~/~/ Количество геозон.
6267 + "fieldsCount": 0, ~/~/ Количество полей.
6268 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6269 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6270 + "agentName": "string", ~/~/ Наименование агента.
6271 + "isEnabled": true, ~/~/ Активность локатора
6272 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6273 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6274 + "name": "string", ~/~/ Наименование локатора 
6275 + "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6276 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6277 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6278 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6279 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6280 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6281 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6282 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6283 + "url": "string", ~/~/ ссылка на локатор 
6284 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6285 + "showVehicleName": true, ~/~/ Наименование объекта
6286 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6287 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6288 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6289 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6290 + "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ГИС)
6291 +
6292 + 0
6293 + ]
6294 + }
6295 +]
6296 +)))
6297 +
6298 +
6299 +== **Изменение локатора** ==
6300 +
6301 +(% class="box infomessage" %)
6302 +(((
6303 +**PUT /api/v3/locators**
6304 +)))
6305 +
6306 +Пример запроса:
6307 +
6308 +(((
6309 +{
6310 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6311 + "isEnabled": true, ~/~/ Активность 
6312 + "name": "string", ~/~/ Наименование
6313 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6314 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6315 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6316 + "autoProlongation": true, ~/~/ Автопродление срока действия
6317 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6318 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6319 + 0
6320 + ],
6321 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6322 + 0
6323 + ],
6324 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6325 + 0
6326 + ],
6327 + "showVehicleName": true, ~/~/ Наименование объекта
6328 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6329 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6330 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6331 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6332 + "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ГИС)
6333 +
6334 + 0
6335 +
6336 + ]
6337 +}
6338 +
6339 +
6340 +)))
6341 +
6342 +Пример ответа:
6343 +
6344 +200 ~/~/ Success
6345 +
6346 +
6347 +== **Удалить локатор** ==
6348 +
6349 +(% class="box warningmessage" %)
6350 +(((
6351 +**DELETE /api/v3/locators**
6352 +)))
6353 +
6354 +Пример запроса:
6355 +
6356 +(((
6357 +[
6358 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6359 +]
6360 +)))
6361 +
6362 +
6363 += **Раздел: Яндекс Маршруты** =
6364 +
6365 +
6366 +== **Возвращение списка маршрутов** ==
6367 +
6368 +(% class="box infomessage" %)
6369 +(((
6370 +**GET /api/v3/TransportRoutes**
6371 +)))
6372 +
6373 +Пример запроса:
6374 +Id  ~/~/ Идентификатор поля
6375 +
6376 +Пример ответа:
6377 +
6378 +(((
6379 +[
6380 + {
6381 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6382 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6383 + "name": "string", ~/~/ Наименование маршрута.
6384 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6385 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6386 + 0
6387 + ]
6388 + }
6389 +]
6390 +)))
6391 +
6392 +
6393 +== **Добавить маршрут** ==
6394 +
6395 +(% class="box infomessage" %)
6396 +(((
6397 +**POST /api/v3/TransportRoutes**
6398 +)))
6399 +
6400 +Пример запроса: 
6401 +{
6402 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6403 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6404 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6405 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6406 + 0
6407 + ]
6408 +}
6409 +
6410 +
6411 +Пример ответа:
6412 +
6413 +(((
6414 +{
6415 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6416 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6417 + "name": "string", ~/~/ Определяет наименование маршрута 
6418 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6419 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6420 + 0
6421 + ]
6422 +}
6423 +)))
6424 +
6425 +
6426 +== **Обновление маршрута** ==
6427 +
6428 +(% class="box successmessage" %)
6429 +(((
6430 +**PUT /api/v3/TransportRoutes**
6431 +)))
6432 +
6433 +Пример запроса:
6434 +
6435 +(((
6436 +{
6437 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6438 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6439 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6440 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6441 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6442 + 0
6443 + ]
6444 +}
6445 +)))
6446 +
6447 +Пример ответа:
6448 +
6449 +(((
6450 +{
6451 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6452 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6453 + "name": "string", ~/~/ Определяет наименование маршрута 
6454 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6455 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6456 + 0
6457 + ]
6458 +}
6459 +)))
6460 +
6461 +
6462 +== **Получить связки маршрутов ТС** ==
6463 +
6464 +(% class="box infomessage" %)
6465 +(((
6466 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6467 +)))
6468 +
6469 +Пример запроса:
6470 +
6471 +(((
6472 +[
6473 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6474 +]
6475 +)))
6476 +
6477 +Пример ответа:
6478 +
6479 +(((
6480 +[
6481 + {
6482 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6483 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6484 + }
6485 +]
6486 +)))
6487 +
6488 +
6489 +== **Удалить маршрут** ==
6490 +
6491 +(% class="box warningmessage" %)
6492 +(((
6493 +**DELETE /api/v3/TransportRoutes/{id}**
6494 +)))
6495 +
6496 +Пример запроса:
6497 +Id  ~/~/ Идентификатор поля
6498 +
6499 +
6500 += **Раздел: Управление доступа к машинам** =
6501 +
6502 +
6503 +== Получение списка транспортных средств видимых пользователю ==
6504 +
6505 +(% class="box infomessage" %)
6506 +(((
6507 +**GET /api/v3/UserVisibleVehicles/{userId}**
6508 +)))
6509 +
6510 +Пример ответа:
6511 +
6512 +(((
6513 +{
6514 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6515 + 0
6516 + ]
6517 +}
6518 +)))
6519 +
6520 +
6521 +== Задает видимость транспортных средств пользователю ==
6522 +
6523 +(% class="box infomessage" %)
6524 +(((
6525 +**POST /api/v3/UserVisibleVehicles**
6526 +)))
6527 +
6528 +Пример запроса:
6529 +
6530 +(((
6531 +(((
6532 +{
6533 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6534 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6535 + 0
6536 + ]
6537 +}
6538 +)))
6539 +
6540 +(((
6541 +
6542 +)))
6543 +
6544 +(((
6545 +Пример ответа :
6546 +)))
6547 +
6548 +(((
6549 +
6550 +)))
6551 +
6552 +(((
6553 +200 ~/~/ Success
6554 +)))
6555 +)))
6556 +
6557 +
2781 2781  (% class="box" lang="en-US" style="text-align: center;" %)
2782 2782  (((
2783 2783  (% 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 г.