<
From version < 81.1 >
edited by Илья Крайнов
on 2023/03/29 14:17
To version < 258.1 >
edited by Андрей Калиновский
on 2025/09/03 09:05
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -1,5 +1,22 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  (((
3 +(% class="box warningmessage" %)
4 +(((
5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 +просим вас соблюдать несколько простых правил при использовании API-команд:##
7 +)))
8 +
9 +* Формировать не более 3 отчётов одновременно.
10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
11 +
12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13 +
14 +(% class="box infomessage" %)
15 +(((
16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 +)))
19 +
3 3  **Содержание страницы:**
4 4  )))
5 5  
... ... @@ -14,13 +14,22 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
34 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
36 +
37 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
38 +
39 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
40 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
43 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
44 +(((
45 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
46 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
47 +)))
22 22  
23 -(% class="box infomessage" %)
49 +(% class="box successmessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
60 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,21 +40,25 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
47 47  (% style="color:#000000" %){
48 -
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
52 -
53 -(% lang="en-US" %)
73 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
74 + "User": "testuser" , ~/~/ имя пользователя(%%)
54 54  }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
79 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
80 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
81 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
82 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
83 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
84 +
85 +(% class="wikigeneratedid" %)
86 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
87 +
58 58  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
... ... @@ -93,30 +93,63 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96
126 +
127 +(((
97 97  {
98 - "agentId": "", ~/~/ идентификатор клиента    (%%)
99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 - "isForeign": true/false, ~/~/ Иностранный контрагент
105 - "district": "string", ~/~/ округ
106 - "region": "string", ~/~/ регион
107 - "city": "string", ~/~/ город
108 - "inn": "string", ~/~/ ИНН клиента
109 - "kpp": "string", ~/~/ КПП клиента
110 - "address": "string", ~/~/ юридический адрес
111 - "addressFact": "string", ~/~/ фактический адрес
112 - "email": "string", ~/~/ почта
113 - "director": "string", ~/~/ ФИО руководителя
114 - "bankName": "string", ~/~/ Банк
115 - "bankBIK": "string", ~/~/ БИК
116 - "bankRS": "string", ~/~/ Номер счета
117 - "bankKS": "string" ~/~/ Корр. счет
118 - }
129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
131 + "parentName": "string", ~/~/ Наименование агента
132 + "name": "string", ~/~/ Имя клиента
133 + "fullName": "string", ~/~/ ФИО клиента
134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
136 + "district": "string", ~/~/ Район
137 + "region": "string", ~/~/ Область
138 + "city": "string", ~/~/ Город
139 + "email": "string", ~/~/ Email
140 + "director": "string", ~/~/ Руководитель
141 + "RegionalData": [ ~/~/ Определяет региональные сведения.
142 + {
143 + "Country": 0, ~/~/ Страна
144 + "groups": [ ~/~/ Список групп
145 + {
146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 
147 + "fields": [ ~/~/ Список значений полей
148 + {
149 + "name": "string", ~/~/ Имя поля формы
150 + "value": "string" ~/~/ Значение поля формы
151 + }
152 + ]
153 + }
154 + ]
155 + }
156 + ]
157 +}
158 +)))
119 119  
160 +
161 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
162 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
163 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
164 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
165 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
166 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
167 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
168 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
169 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
170 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
171 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
172 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
173 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
174 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
175 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
176 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
177 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
178 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
179 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
180 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
181 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
182 +
120 120  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 121  
122 122  (% class="box infomessage" %)
... ... @@ -130,7 +130,7 @@
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
196 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 135  (% style="color:#000000" %)Метод запроса: **POST**
136 136  
... ... @@ -145,15 +145,23 @@
145 145  (% style="color:#000000" %)Ответ:
146 146  
147 147  {
148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
211 + "agentId": "",(% style="color:#000000" %)   (%%)
212 + "parentId": "",
213 + "name": "string",
214 + "fullName": "string",
215 + "agentInfoType": 0,
216 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
219 +
220 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
221 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
222 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
223 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
224 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
225 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
226 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
227 +
157 157  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 159  (% class="box successmessage" %)
... ... @@ -172,7 +172,7 @@
172 172  Параметры в теле запроса (JSON):
173 173  
174 174  {
175 - "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": "" , ~/~/ имя
... ... @@ -436,8 +436,7 @@
436 436   "email": "" , ~/~/ E-mail
437 437   "sessionDuration":"", ~/~/ длительность сессии в минутах
438 438   "status": "1",  ~/~/ статус пользователя
439 - "astLogged": "", ~/~/ дата/время последней авторизации
440 -
512 + "lastLogged": "", ~/~/ дата/время последней авторизации
441 441  (% style="color:#000000" %)}
442 442  
443 443  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -511,10 +511,8 @@
511 511  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
512 512  
513 513  (% lang="en-US" style="text-align:left" %)
514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
515 -
516 -(% lang="en-US" style="text-align:left" %)
517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
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" %)
... ... @@ -701,9 +701,9 @@
701 701  
702 702  (% style="color:#000000" %)Метод запроса: **GET**
703 703  
704 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
1014 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
705 705  
706 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
1016 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
707 707  
708 708  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
709 709  
... ... @@ -711,6 +711,17 @@
711 711  
712 712  (((
713 713  {
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 объекта
... ... @@ -717,20 +717,130 @@
717 717   "deviceTypeId": , ~/~/ ID типа устройства
718 718   "deviceTypeName": "", ~/~/ Название типа устройства
719 719   "sim1": "", ~/~/ Номер SIM1
720 - "parentId": "", Номер SIM2
721 - "parentName": "", Наименование клиента-родителя
722 - "modelId": "", ID модели объекта
723 - "modelName": "", Имя модели объекта
724 - "createdAt": "", Дата создания объекта
725 - "mileageCalcMethod": "", Выбранный метод расчета пробега
726 - "counters": { ~/~/ Нормы
727 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
728 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
729 - "mileage": "", ~/~/ Пробег по нормам в метрах
730 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
1041 + "sim2": "", ~/~/ Номер SIM2
1042 + "parentId": "", ~/~/ ID клиента-родителя
1043 + "parentName": "", ~/~/ Наименование клиента-родителя
1044 + "modelId": "", ~/~/ ID модели объекта
1045 + "modelName": "", ~/~/ Имя модели объекта
1046 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1047 + "unitName": "string", ~/~/ Наименование подразделения
1048 + "status": 0, ~/~/ Статус объекта
1049 + "createdAt": "", ~/~/ Дата создания объекта
733 733   },
1051 +"customFields": [ ~/~/ Произвольные поля
1052 + {
1053 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1054 + "name": "string", ~/~/ Имя поля
1055 + "value": "string", ~/~/ Значение поля
1056 + "forClient": true, ~/~/ Не используемая функция
1057 + "forTooltip": true, ~/~/ Отображать в подсказке
1058 + "forReport": true ~/~/ Отображать в отчете
1059 + }
1060 +
1061 +], ~/~/ Данные с вкладки нормы
1062 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1063 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1064 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1065 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1066 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1067 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1068 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1069 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1070 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1071 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1072 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1073 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1074 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1075 + "mileageCoeff": 0, ~/~/ коэффициент пробега
1076 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1077 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1078 + "counters": { ~/~/ Счетчики
1079 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1080 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1081 + "mileage": 0, ~/~/ Текущий пробег
1082 + "motohours": 0, ~/~/ Текущие моточасы
1083 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1084 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1085 + },
1086 +
1087 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1088 + "id": "string", ~/~/ ID объекта
1089 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
1090 + "host": "string", ~/~/ CMSV6 Web Host
1091 + "login": "string", ~/~/ CMSV6 Account
1092 + "password": "string" ~/~/ CMSV6 Password
1093 + },
1094 +
1095 +"commandTemplates": [ ~/~/ Шаблоны команд
1096 + {
1097 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1098 + "name": "string", ~/~/ Наименование команды
1099 + "command": "string", ~/~/ Текст команды
1100 + "retries": 0 ~/~/ Количество попыток
1101 + }
1102 + ],
1103 + "sensors": [ ~/~/ Датчики
1104 + {
1105 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1106 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1107 + "type": 0, ~/~/ Тип датчика
1108 + "name": "string", ~/~/ Имя датчика
1109 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1110 + "inputNumber": 0, ~/~/ Номер входа
1111 + "pseudonym": "string", ~/~/ Псевдоним
1112 + "medianDegree": 0, ~/~/ Медианная фильтрация
1113 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1114 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1115 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1116 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1117 + {
1118 + "grades": [ ~/~/ Таблица тарировки 1
1119 + {
1120 + "input": 0, ~/~/ Входящее значение
1121 + "output": 0 ~/~/ Выходящее значение
1122 + }
1123 + ],
1124 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1125 + }
1126 + ],
1127 + "showInTooltip": true, ~/~/ Отображать в подсказке
1128 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1129 + "color": "string", ~/~/ Код цвета датчиков
1130 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1131 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1132 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1133 + "expr": "string", ~/~/ Формула
1134 + "children": [ ~/~/ массив дочерних датчиков
1135 + "string"
1136 + ],
1137 + "customParams": { ~/~/ прочие произвольные параметры
1138 + "additionalProp1": "string",
1139 + "additionalProp2": "string",
1140 + "additionalProp3": "string"
1141 + },
1142 +
1143 +~/~/ Характерные для произвольного:
1144 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1145 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1146 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1147 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1148 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1149 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1150 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1151 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1152 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1153 +~/~/ "ValueOn": "Вкл.",
1154 +~/~/ "ValueOff": "Выкл."
1155 + "summaryMaxValue": 0 ~/~/ Макс. значение
1156 + }
1157 + "drivers": [ ~/~/ Водители
1158 + {
1159 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1160 + "name": "string", ~/~/ Наименование
1161 + "description": "string",
1162 + "isDefault": true ~/~/ По умолчанию
1163 + }
1164 + ],
734 734   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
735 735   {
736 736   "id": "", ~/~/ ID  задания
... ... @@ -746,10 +746,28 @@
746 746   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
747 747   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
748 748   }
749 - ]
1180 + ],
1181 +"statusHistory": [ ~/~/ История статусов
1182 + {
1183 + "status": 0,
1184 + "date": "2023-05-22T09:57:39.562Z",
1185 + "description": "string",
1186 + "additionalInfo": "string"
1187 +
1188 +(((
750 750  }
1190 + ],
1191 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1192 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
751 751  )))
752 752  
1195 +(((
1196 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1197 +}
1198 +
1199 +)))
1200 +)))
1201 +
753 753  (% style="text-align:left" %)
754 754  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
755 755  
... ... @@ -756,6 +756,75 @@
756 756  (% style="text-align:left" %)
757 757  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
758 758  
1208 +
1209 +== **Отправить команду на терминал** ==
1210 +
1211 +(% class="box successmessage" %)
1212 +(((
1213 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1214 +)))
1215 +
1216 +Команда для отправки на тс.
1217 +
1218 +{  
1219 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1220 +"command": "", ~/~/ Текст отправляемой команды
1221 +"retries": "", ~/~/ Количество попыток отправки на терминал
1222 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1223 +}
1224 +
1225 +В ответ получаем cmdid
1226 +
1227 +
1228 +== **Получить ответ на отправленную на ТС команду** ==
1229 +
1230 +(% class="box infomessage" %)
1231 +(((
1232 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1233 +)))
1234 +
1235 +Идентификатор команды: cmdId
1236 +
1237 +Запрос от терминала на ответ команды
1238 +
1239 +Пример ответ от терминала:
1240 +
1241 +ID= "" ~/~/ идентификатор объекта
1242 +Soft="" ~/~/ версия софта
1243 +GPS=4 ~/~/ тип трекера
1244 +Time=11:05:43 28.06.24 ~/~/ время запроса
1245 +Lat=45.056221 ~/~/ широта
1246 +Lon=39.035938 ~/~/ долгота
1247 +Speed=0.0 ~/~/ скорость
1248 +Course=181.4 ~/~/направление
1249 +
1250 +(((
1251 +== **Список отправленных объекту команд с ответами** ==
1252 +
1253 +(% class="box infomessage" %)
1254 +(((
1255 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1256 +)))
1257 +
1258 +Идентификатор ТС: vehicleId
1259 +
1260 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1261 +
1262 +Пример ответа терминала
1263 +
1264 +[ 
1265 +{    
1266 +"id": "", ~/~/ идентификатор пользователя
1267 +"commandText": "", ~/~/Текст команды.
1268 +"templateId": "", ~/~/Идентификатор шаблона
1269 +"updated": "", ~/~/ Время отправки  
1270 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1271 +"answer": "", ~/~/ Ответ терминала.
1272 +"status": "" ~/~/ Статус отправки
1273 +}
1274 +]
1275 +)))
1276 +
759 759  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
760 760  
761 761  (% class="box successmessage" %)
... ... @@ -763,7 +763,7 @@
763 763  (% lang="en-US" %)**POST /api/v3/vehicles**
764 764  )))
765 765  
766 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе.
1284 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
767 767  
768 768  (% style="color:#000000" %)Метод запроса: **POST**
769 769  
... ... @@ -775,6 +775,11 @@
775 775  
776 776  (% style="color:#000000" %){
777 777  
1296 +
1297 +(((
1298 + "vehicleId": 0, ~/~/ ID ТС
1299 +)))
1300 +
778 778   "parentId": "" , ~/~/ ID клиента
779 779   "name": "" , ~/~/ имя ТС
780 780   "imei": "" , ~/~/ IMEI
... ... @@ -795,6 +795,10 @@
795 795   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
796 796   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
797 797   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1321 + "mileageCalcMethod": 0,
1322 + "mileageCoeff": 0,
1323 + "locationByCellId": true,
1324 + "dottedLineTrackWhenNoCoords": true,
798 798   "counters": ~/~/ счетчики
799 799   {
800 800   "mileage": "" , ~/~/ пробег
... ... @@ -823,67 +823,275 @@
823 823   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
824 824   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
825 825   }
1353 +"drivers": [ ~/~/ Водители
1354 + {
1355 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1356 + "isDefault": true
1357 + }
1358 + ],
1359 + "commandTemplates": [ ~/~/ Шаблон команды
1360 + {
1361 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1362 + "name": "string",
1363 + "command": "string",
1364 + "retries": 0
1365 + }
1366 + ],
1367 +"sensors": [ ~/~/ Датчики
1368 + {
1369 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1370 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1371 + "type": 0, ~/~/ Тип датчика
1372 + "name": "string", ~/~/ Имя датчика
1373 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1374 + "inputNumber": 0, ~/~/ Номер входа
1375 + "pseudonym": "string", ~/~/ Псевдоним
1376 + "medianDegree": 0, ~/~/ Медианная фильтрация
1377 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1378 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1379 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1380 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1381 + {
1382 + "grades": [ ~/~/ Таблица тарировки 1
1383 + {
1384 + "input": 0, ~/~/ Входящее значение
1385 + "output": 0 ~/~/ Выходящее значение
1386 + }
1387 + ],
1388 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1389 + }
1390 + ],
1391 + "showInTooltip": true, ~/~/ Отображать в подсказке
1392 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1393 + "color": "string", ~/~/ код цвета датчиков
1394 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1395 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1396 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1397 + "expr": "string", ~/~/ Формула
1398 + "children": [ ~/~/ массив дочерних датчиков
1399 + "string"
1400 + ],
1401 + "customParams": { ~/~/ прочие произвольные параметры
1402 + "additionalProp1": "string",
1403 + "additionalProp2": "string",
1404 + "additionalProp3": "string"
1405 + },
1406 +~/~/ Характерные для произвольного:
1407 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1408 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1409 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1410 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1411 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1412 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1413 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1414 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1415 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1416 +~/~/ "ValueOn": "Вкл.",
1417 +~/~/ "ValueOff": "Выкл."
1418 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
826 826  
827 -(% style="color:#000000" %) }
1420 +(((
1421 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1422 + {
1423 + "from": 0, ~/~/ С какого значения
1424 + "color": "string", ~/~/ Каким цветом
1425 + "text": "string" ~/~/ Текст подписи к этому интервалу
1426 + }
1427 + ]
1428 + }
1429 + ],
1430 +)))
828 828  
1432 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1433 +
1434 +
1435 + "customFields": [ ~/~/ Произвольные поля
1436 + {
1437 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1438 + "name": "string", ~/~/ Наименование произвольного поля
1439 + "value": "string", ~/~/ Значение произвольного поля
1440 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1441 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1442 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1443 +
1444 +(((
1445 + }
1446 + ],
1447 + "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1448 +)))
1449 +
1450 +(((
1451 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1452 +}
1453 +)))
1454 +
1455 +
829 829  (% style="color:#000000" %)Ответ:
830 830  
831 -(% style="color:#000000" %){
832 832  
833 - "vehicleId": "", ~/~/ID ТС 
834 - "parentId": "", ~/~/Guid владельца ТС
835 - "name": "", ~/~/Имя объекта
836 - "imei": "", ~/~/IMEI
837 - "deviceTypeId": "", ~/~/ID типа устройства
838 - "modelId": "", ~/~/ID модели
839 - "unitId": "", ~/~/ID подразделения
840 - "sim1": "", ~/~/SIM1
841 - "sim2": "", ~/~/SIM2
842 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
843 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
844 - "counters": { ~/~/Счётчики
845 - "mileageEnabled": true,
846 - "motohoursEnabled": true,
847 - "mileage": "",
848 - "motohours": 345.0
849 - },
850 - "cmsv6Parameters": { ~/~/Параметры CmsV6
851 - "id": null,
852 - "enabled": true, ~/~/флаг включения
853 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
854 - "login": "", ~/~/ имя учетной записи
855 - "password": "" ~/~/ пароль учетной записи
856 - },
857 - "inspectionTasks": { ~/~/ задания на ТО
858 - "id": "", ~/~/ ID задачи
859 - "enabled": false, ~/~/ Признак включения
860 - "name": "", ~/~/ Имя задания
861 - "description": "", ~/~/ Описание задания
862 - "mileageCondition": "", ~/~/ Условие по пробегу
863 - "lastMileage": "", ~/~/ Пробег (в метрах)
864 - "motohoursCondition": "", ~/~/ Условие по моточасам
865 - "lastMotohours": "", ~/~/ Моточасы
866 - "periodicCondition": "", ~/~/ Условие периодичности по времени
867 - "kind": "", ~/~/ Вид периодичности по времени 
868 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1459 +(((
1460 +(((
1461 +(((
1462 +{
1463 + "vehicleId": 0,  ~/~/ ID ТС
1464 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1465 + "name": "string", ~/~/ Имя объекта
1466 + "imei": "string", ~/~/ IMEI
1467 + "deviceTypeId": 0, ~/~/ ID типа устройства
1468 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1469 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1470 + "sim1": "string", ~/~/ SIM1
1471 + "sim2": "string", ~/~/ SIM2
1472 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1473 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1474 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1475 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1476 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1477 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1478 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1479 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1480 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1481 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1482 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1483 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1484 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1485 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1486 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1487 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1488 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1489 + "counters": {  ~/~/ Dto для состояний счётчиков
1490 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1491 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1492 + "mileage": 0, ~/~/ Пробег
1493 + "motohours": 0 ~/~/ Моточасы
1494 + },
1495 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1496 + "id": "string", ~/~/ CMSV6 Идентификатор
1497 + "enabled": true, ~/~/ Признак включения
1498 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1499 + "login": "string", ~/~/ CMSV6 имя учетной записи
1500 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1501 + },
1502 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1503 + {
1504 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1505 + "enabled": true, ~/~/ Признак включения
1506 + "name": "string", ~/~/ Имя задания
1507 + "description": "string", ~/~/ Описание задания
1508 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1509 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1510 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1511 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1512 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1513 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1514 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1515 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
869 869   }
1517 + ],
1518 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1519 + {
1520 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1521 + "inputNumber": 0, ~/~/ № входа.
1522 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1523 + "comment": "string", ~/~/ Комментарий
1524 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1525 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1526 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1527 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1528 + }
1529 + ],
1530 + "commandTemplates": [  ~/~/ Список шаблонов команд
1531 + {
1532 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1533 + "name": "string", ~/~/ Название шаблона команд
1534 + "command": "string", ~/~/ Команда на выполнение
1535 + "retries": 0 ~/~/ Лимит попыток отправки
1536 + }
1537 + ],
1538 + "sensors": [ ~/~/ Список датчиков
1539 + {
1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1541 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1542 + "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
1543 + "name": "string",  ~/~/ Имя датчика
1544 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1545 + "inputNumber": 0, ~/~/ Номер входа
1546 + "pseudonym": "string", ~/~/ Псевдоним
1547 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1548 + "isInverted": true, ~/~/  Признак инверсии
1549 + "disabled": true, ~/~/ Датчик не участвует в обработке
1550 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1551 + "gradesTables": [ ~/~/ Тарировка
1552 + {
1553 + "grades": [ ~/~/ Таблицы тарировки
1554 + {
1555 + "input": 0, ~/~/ Вход
1556 + "output": 0 ~/~/ Выход
1557 + }
1558 + ],
1559 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1560 + }
1561 + ],
1562 + "showInTooltip": true, ~/~/ Отображение в подсказке
1563 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1564 + "color": "string", ~/~/ код цвета датчиков
1565 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1566 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1567 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1568 + "expr": "string", ~/~/ Выражение
1569 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1570 + "string"
1571 + ],
1572 + "customParams": {
1573 + "additionalProp1": "string",
1574 + "additionalProp2": "string",
1575 + "additionalProp3": "string"
1576 + },
1577 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1578 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1579 + {
1580 + "from": 0, ~/~/ С какого значения
1581 + "color": "string", ~/~/ Каким цветом
1582 +)))
870 870  
871 -(% style="text-align:left" %)
872 -(% style="color:#000000" %)}
1584 +(((
1585 + "text": "string" ~/~/ Текст подписи к этому интервалу
1586 + }
1587 + ]
1588 + }
1589 + ],
1590 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1591 + "customFields": [ ~/~/ Список произвольных полей
1592 + {
1593 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1594 + "name": "string", ~/~/ Наименование произвольного поля
1595 + "value": "string", ~/~/ Значение произвольного поля
1596 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1597 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1598 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1599 + }
1600 + ],
1601 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1602 +}
1603 +)))
1604 +)))
1605 +)))
873 873  
1607 +
874 874  **Валидация:**
875 875  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
876 876  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
877 877  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
878 878  
879 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
880 880  
1614 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1615 +
881 881  (% class="box infomessage" %)
882 882  (((
883 883  (% lang="en-US" %)**POST /api/v3/vehicles/find**
884 884  )))
885 885  
886 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1621 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
887 887  
888 888  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
889 889  
... ... @@ -917,9 +917,12 @@
917 917   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
918 918   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
919 919   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
920 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
921 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
922 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1655 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1656 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1657 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1658 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1659 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1660 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
923 923  }
924 924  
925 925  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -926,8 +926,14 @@
926 926  
927 927  (% style="color:#000000" %)Ответ:
928 928  
929 -(% style="color:#000000" %){
1667 +(% style="color:#000000" %)[
1668 +{
930 930  
1670 +(((
1671 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1672 +)))
1673 +
1674 +(((
931 931  (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
932 932   "name": "" ~/~/ наименование объекта
933 933   "imei": "" ~/~/ IMEI объекта
... ... @@ -953,9 +953,21 @@
953 953   "forClient": true, ~/~/ право на отображение у клиента
954 954   "forTooltip": false, ~/~/ право на отображение в подсказке
955 955   "forReport": false ~/~/ право на отображение в отчетах
956 - }(%%)
957 -(% style="color:#000000" %)}
1700 +)))
958 958  
1702 +(((
1703 + }
1704 + ],
1705 + "vehicleGroups": [  ~/~/ Группы ТС
1706 + {
1707 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1708 + "name": "string" ~/~/ Наименование группы ТС
1709 + }
1710 + ]
1711 + }
1712 +]
1713 +)))
1714 +
959 959  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
960 960  
961 961  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -987,13 +987,11 @@
987 987   "data": "", ~/~/ Данные
988 988   "overwrite": false, ~/~/ Флаг перезаписи
989 989   "stage": "", ~/~/ Состояние, может быть null
990 -
991 991  (% style="color:#000000" %)}
992 992  
993 993  (% style="color:#000000" %)Ответ:
994 994  
995 -(% style="color:#000000" %){
996 -
1750 +(% style="color:#000000" %){(%%)
997 997   "status": "", ~/~/ значение статуса
998 998   "date": "", ~/~/ Дата смены статуса 
999 999   "description": "", ~/~/ Описание
... ... @@ -1000,10 +1000,9 @@
1000 1000   "data": "", ~/~/ Данные
1001 1001   "overwrite": false, ~/~/ Флаг перезаписи
1002 1002   "stage": "", ~/~/ Состояние
1003 -
1004 -(% style="text-align:left" %)
1005 1005  (% style="color:#000000" %) }
1006 1006  
1759 +
1007 1007  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1008 1008  
1009 1009  (% class="box warningmessage" %)
... ... @@ -1011,7 +1011,7 @@
1011 1011  (% lang="en-US" %)**PUT /api/v3/vehicles**
1012 1012  )))
1013 1013  
1014 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе.
1767 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1015 1015  
1016 1016  (% style="color:#000000" %)Метод запроса: **PUT**
1017 1017  
... ... @@ -1021,18 +1021,16 @@
1021 1021  
1022 1022  (% style="color:#000000" %)Параметры в теле запроса (JSON):
1023 1023  
1024 -(% style="color:#000000" %){    
1025 -
1026 -(((
1027 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1028 - "parentId": "", ~/~/ ID клиента
1029 - "name": "", ~/~/ имя ТС
1030 - "imei": "", ~/~/ IMEI
1031 - "deviceTypeId": "", ~/~/ ID типа устройства
1032 - "modelId": "", ~/~/ , ID модели    
1033 - "unitId": "", ~/~/ подразделения
1034 - "sim1": "", ~/~/ SIM 1
1035 - "sim2": "", ~/~/ SIM2     (%%)
1777 +(% style="color:#000000" %){
1778 + "vehicleId": , ~/~/ ID объекта
1779 + "parentId": "" , ~/~/ ID клиента
1780 + "name": "" , ~/~/ имя ТС
1781 + "imei": "" , ~/~/ IMEI
1782 + "deviceTypeId": "" , ~/~/ ID типа устройства
1783 + "modelId": "" , ~/~/ ID модели
1784 + "unitId": "" , ~/~/ ID подразделения
1785 + "sim1": "" , ~/~/ Номер SIM 1
1786 + "sim2": "" , ~/~/ Номер SIM2
1036 1036   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1037 1037   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1038 1038   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -1045,89 +1045,326 @@
1045 1045   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1046 1046   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1047 1047   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1048 -(% style="color:#000000" %) "counters": 
1049 - {
1050 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1051 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1052 - "mileage": "", ~/~/ пробег, в метрах 
1053 - "motohours": "" ~/~/ моточасы, в секундах
1054 - }
1055 - "cmsv6Parameters": ~/~/ параметры CMSv6
1056 - {       
1057 - "id": "", ~/~/ идентификатор
1058 - "enabled": true, ~/~/ флаг включения
1059 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1060 - "login": "", ~/~/ имя учетной записи
1061 - "password": "", ~/~/ пароль учетной записи
1062 - }
1063 - "inspectionTasks": ~/~/ задания на ТО
1064 - {
1065 - "id": "", ~/~/ ID задания
1066 - "enabled": false, ~/~/ Признак включения
1067 - "name": "", ~/~/ Имя задания
1068 - "description": "", ~/~/ Описание задания
1069 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1070 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1071 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1072 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1073 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1074 - "kind": "", ~/~/ Вид периодичности по времени
1075 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1076 - } 
1799 +
1800 + "mileageCalcMethod": 0,
1801 + "mileageCoeff": 0,
1802 + "locationByCellId": true,
1803 + "dottedLineTrackWhenNoCoords": true,
1804 + "counters": ~/~/ счетчики
1805 + {
1806 + "mileage": "" , ~/~/ пробег
1807 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1808 + "motohours": "" , ~/~/ моточасы
1809 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1810 + },
1811 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1812 + "enabled": true, ~/~/ флаг включения
1813 + "id": "" , ~/~/ идентификатор
1814 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1815 + "login": "" , ~/~/ имя учетной записи
1816 + "password": "" ~/~/ пароль учетной записи
1817 + },
1818 + "inspectionTasks": ~/~/ задания на ТО
1819 + {
1820 + "enabled": "" , ~/~/ Признак включения
1821 + "name": "" , ~/~/ Имя задания
1822 + "description": "" , ~/~/ Описание задания
1823 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1824 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1825 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1826 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1827 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1828 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1829 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1830 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1831 + }
1832 +
1833 +"drivers": [ ~/~/ Водители
1834 + {
1835 +
1836 +(((
1837 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1838 + "inputNumber": 0, ~/~/ № входа.
1839 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1840 + "comment": "string", ~/~/ Комментарий.
1841 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1842 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1843 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1844 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1077 1077  )))
1078 1078  
1079 -(% style="color:#000000" %)}
1847 + } 
1848 + ],
1849 + "commandTemplates": [ ~/~/ Шаблон команды
1850 + {
1851 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1852 + "name": "string",
1853 + "command": "string",
1854 + "retries": 0
1855 + }
1856 + ],
1857 +"sensors": [ ~/~/ Датчики
1858 + {
1859 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1860 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1861 + "type": 0, ~/~/ Тип датчика
1862 + "name": "string", ~/~/ Имя датчика
1863 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1864 + "inputNumber": 0, ~/~/ Номер входа
1865 + "pseudonym": "string", ~/~/ Псевдоним
1866 + "medianDegree": 0, ~/~/ Медианная фильтрация
1867 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1868 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1869 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1870 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1871 + {
1872 + "grades": [ ~/~/ Таблица тарировки 1
1873 + {
1874 + "input": 0, ~/~/ Входящее значение
1875 + "output": 0 ~/~/ Выходящее значение
1876 + }
1877 + ],
1878 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1879 + }
1880 + ],
1881 + "showInTooltip": true, ~/~/ Отображать в подсказке
1882 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1080 1080  
1884 +(((
1885 + "color": "string",** ~/~/ **Цвет датчика
1886 +)))
1887 +
1888 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1889 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1890 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1891 + "expr": "string", ~/~/ Формула
1892 + "children": [ ~/~/ массив дочерних датчиков
1893 + "string"
1894 + ],
1895 + "customParams": { ~/~/ прочие произвольные параметры
1896 + "additionalProp1": "string",
1897 + "additionalProp2": "string",
1898 + "additionalProp3": "string"
1899 + },
1900 +~/~/ Характерные для произвольного:
1901 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1902 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1903 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1904 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1905 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1906 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1907 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1908 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1909 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1910 +~/~/ "ValueOn": "Вкл.",
1911 +~/~/ "ValueOff": "Выкл."
1912 + "summaryMaxValue": 0 ~/~/ Макс. значение
1913 +
1914 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1915 + {
1916 + "from": 0, ~/~/ С какого значения
1917 + "color": "string", ~/~/ Каким цветом
1918 + "text": "string" ~/~/ Текст подписи к этому интервалу
1919 + }
1920 + ]
1921 + }
1922 + ],
1923 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1924 +
1925 + "customFields": [ ~/~/ Произвольные поля
1926 + {     
1927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1928 + "name": "string", ~/~/ Наименование произвольного поля
1929 + "value": "string", ~/~/ Значение произвольного поля
1930 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1931 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1932 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1933 + }
1934 +
1935 +(((
1936 + ],
1937 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1938 +)))
1939 +
1940 +}
1941 +
1942 +
1081 1081  (% style="color:#000000" %)Ответ:
1082 1082  
1083 -(% lang="en-US" style="text-align:left" %)
1084 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1945 +(((
1946 +{
1947 + "vehicleId": 0, ~/~/ ID ТС
1948 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1949 + "name": "string", ~/~/ Имя объекта
1950 + "imei": "string", ~/~/ IMEI
1951 + "deviceTypeId": 0, ~/~/ ID типа устройства
1952 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1953 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1954 + "sim1": "string", ~/~/ SIM1
1955 + "sim2": "string", ~/~/ SIM2
1956 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1957 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1958 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1959 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1960 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1961 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1962 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1963 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1964 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1965 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1966 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1967 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1968 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1969 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1970 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1971 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1972 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1973 + "counters": { ~/~/ состояний счётчиков
1974 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1975 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1976 + "mileage": 0, ~/~/ Пробег
1977 + "motohours": 0 ~/~/ Моточасы 
1978 + },
1979 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1980 + "id": "string", ~/~/ CMSV6 Идентификатор
1981 + "enabled": true, ~/~/ Признак включения
1982 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1983 +)))
1085 1085  
1086 -(% lang="en-US" style="text-align:left" %)
1087 - "vehicleId": "", ~/~/ ID ТС
1088 - "parentId": "", ~/~/ ID клиента
1089 - "name": "", ~/~/ имя ТС
1090 - "imei": "", ~/~/ IMEI
1091 - "deviceTypeId": "", ~/~/ типа устройства
1092 - "modelId": "", ~/~/ ID модели
1093 - "unitId": "", ~/~/ ID подразделения
1094 - "sim1": "", ~/~/ SIM 1
1095 - "sim2": "", ~/~/ SIM2
1096 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1097 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1098 - "counters": 
1099 - {
1100 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1101 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1102 - "mileage": "", ~/~/ пробег
1103 - "motohours": "", ~/~/ моточасы
1104 - }
1105 - "cmsv6Parameters": ~/~/ параметры CMSv6
1985 +
1986 +(((
1987 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1988 + "login": "string", ~/~/ CMSV6 имя учетной записи
1989 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1990 + },
1991 + "inspectionTasks": [ ~/~/ Задания на ТО
1992 + {
1993 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1994 + "enabled": true, ~/~/ Признак включения
1995 + "name": "string", ~/~/ Имя задания
1996 + "description": "string", ~/~/ Описание задания
1997 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1998 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1999 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2000 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2001 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
2002 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2003 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2004 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2005 + }
2006 + ],
2007 + "drivers": [  ~/~/ Список водителей
2008 + {
2009 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2010 + "inputNumber": 0, ~/~/ № входа.
2011 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2012 + "comment": "string", ~/~/ Комментарий.
2013 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2014 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2015 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2016 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2017 + }
2018 + ],
2019 + "commandTemplates": [ ~/~/ Список шаблонов команд
2020 + {
2021 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2022 + "name": "string", ~/~/ Название шаблона команд
2023 + "command": "string", ~/~/ Команда на выполнение
2024 + "retries": 0 ~/~/ Лимит попыток отправки
2025 + }
2026 + ],
2027 + "sensors": [  ~/~/ Список датчиков 
2028 + {
2029 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2030 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2031 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2032 +)))
2033 +
2034 +(((
2035 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2036 +)))
2037 +
2038 +(((
2039 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2040 +)))
2041 +
2042 +(((
2043 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2044 +)))
2045 +
2046 +(((
2047 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2048 +)))
2049 +
2050 +(((
2051 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2052 + "name": "string", ~/~/ Имя датчика
2053 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2054 +)))
2055 +
2056 +(((
2057 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2058 + "inputNumber": 0, ~/~/ Номер входа
2059 + "pseudonym": "string", ~/~/ Псевдоним
2060 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
2061 + "isInverted": true, ~/~/ Признак инверсии
2062 + "disabled": true, ~/~/ Датчик не участвует в обработке
2063 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2064 + "gradesTables": [ ~/~/ Тарировка
1106 1106   {
1107 - "id": ~/~/ идентификатор
1108 - "enabled": true, ~/~/ флаг включения
1109 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1110 - "login": "", ~/~/ имя учетной записи
1111 - "password": "", ~/~/ пароль учетной записи
1112 - }
1113 - "inspectionTasks": ~/~/ задания на ТО
1114 - {
1115 - "id": "", ~/~/ ID задания
1116 - "enabled": false, ~/~/ Признак включения
1117 - "name": "", ~/~/ Имя задания
1118 - "description": "", ~/~/ Описание задания
1119 - "mileageCondition": "", ~/~/ Условие по пробегу
1120 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1121 - "motohoursCondition": "", ~/~/ Условие по моточасам
1122 - "lastMotohours": "", ~/~/ Моточасы
1123 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1124 - "kind": "", ~/~/ Вид периодичности по времени
1125 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2066 + "grades": [ ~/~/ Таблицы тарировки
2067 + {
2068 + "input": 0, ~/~/ Вход
2069 + "output": 0 ~/~/ Выход
2070 + }
2071 + ],
2072 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
1126 1126   }
2074 + ],
2075 + "showInTooltip": true, ~/~/ Отображение в подсказке
2076 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1127 1127  
1128 -(% lang="en-US" style="text-align:left" %)
1129 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
2078 +(((
2079 + "color": "string", ~/~/ цвет уведомлений
2080 +)))
1130 1130  
2082 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2083 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2084 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2085 + "expr": "string", ~/~/ Выражение
2086 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2087 + "string" 
2088 + ],
2089 + "customParams": { ~/~/ Дополнительные настройки
2090 + "additionalProp1": "string",
2091 + "additionalProp2": "string",
2092 + "additionalProp3": "string"
2093 + },
2094 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2095 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2096 + {
2097 + "from": 0, ~/~/ С какого значения
2098 + "color": "string", ~/~/ Каким цветом
2099 + "text": "string" ~/~/ Текст подписи к этому интервалу
2100 + }
2101 + ]
2102 + }
2103 + ],
2104 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2105 + "customFields": [ ~/~/ Список произвольных полей
2106 + {
2107 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2108 + "name": "string", ~/~/ Наименование произвольного поля
2109 + "value": "string", ~/~/ Значение произвольного поля
2110 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2111 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2112 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2113 + }
2114 + ],
2115 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2116 +}
2117 +)))
2118 +
1131 1131  **Валидация:**
1132 1132  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1133 1133  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
... ... @@ -1140,7 +1140,7 @@
1140 1140  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1141 1141  )))
1142 1142  
1143 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса.
2131 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1144 1144  
1145 1145  (% style="color:#000000" %)Метод запроса: **DELETE**
1146 1146  
... ... @@ -1166,18 +1166,15 @@
1166 1166  
1167 1167  (% style="color:#000000" %)Метод запроса: **GET**
1168 1168  
1169 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
2157 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1170 1170  
1171 1171  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1172 1172  
1173 1173  (% style="color:#000000" %)Ответ:
1174 1174  
1175 -(% style="color:#000000" %){
1176 -
2163 +(% style="color:#000000" %){(%%)
1177 1177   "deviceTypeId" : "", ~/~/ ID типа устройства
1178 1178   "deviceTypeName" : "" ~/~/ Название типа устройства
1179 -
1180 -(% style="text-align:left" %)
1181 1181  (% style="color:#000000" %)}
1182 1182  
1183 1183  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1199,13 +1199,10 @@
1199 1199  
1200 1200  (% style="color:#000000" %)Ответ:
1201 1201  
1202 -(% style="color:#000000" %){
1203 -
2187 +(% style="color:#000000" %){(%%)
1204 1204   "id": "", ~/~/ ID типа датчика 
1205 1205   "name": "", ~/~/ Название
1206 1206   "description": "", ~/~/ Описание
1207 -
1208 -(% style="text-align:left" %)
1209 1209  (% style="color:#000000" %)}
1210 1210  
1211 1211  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1249,6 +1249,56 @@
1249 1249   }
1250 1250  ]
1251 1251  
2234 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2235 +
2236 +(% class="box infomessage" style="text-align: left;" %)
2237 +(((
2238 +**POST /api/v3/terminalMessages/mapping**
2239 +)))
2240 +
2241 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2242 +
2243 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2244 +
2245 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2246 +
2247 +{
2248 + "protocolType": 0,
2249 + "params": ["string"]
2250 +}
2251 +
2252 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2253 +|protocolType|ID типа протокола
2254 +|params|(((
2255 +Массив наименований параметров в сообщении
2256 +)))
2257 +
2258 +Ответ:
2259 +
2260 +{
2261 + "protocolType": 0,
2262 + "mapping": {
2263 + "additionalProp1": {
2264 + "inputType": 0,
2265 + "inputNumber": 0
2266 + },
2267 + "additionalProp2": {
2268 + "inputType": 0,
2269 + "inputNumber": 0
2270 + }
2271 + }
2272 +}
2273 +
2274 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2275 +|protocolType|Тип протокола
2276 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2277 +|inputNumber|(((
2278 +Номер входа
2279 +)))
2280 +
2281 +(% class="wikigeneratedid" %)
2282 +Перечень 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/]]
2283 +
1252 1252  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1253 1253  
1254 1254  (% class="box infomessage" %)
... ... @@ -1273,6 +1273,11 @@
1273 1273   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1274 1274  }
1275 1275  
2308 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2309 +|vehicleId|ID объекта
2310 +|from|Дата и время начала периода запроса
2311 +|to|Дата и время окончания периода запроса
2312 +
1276 1276  Ответ:
1277 1277  
1278 1278  [
... ... @@ -1279,30 +1279,475 @@
1279 1279   {
1280 1280   "messages": [
1281 1281   {
1282 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1283 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1284 - "speed": 0, ~/~/ Скорость, км/ч
1285 - "altitude": 0, ~/~/ Высота, м
1286 - "latitude": 0, ~/~/ Широта [-90°;90°]
1287 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1288 - "satellites": 0, ~/~/ Кол-во спутников
1289 - "voltage": 0, ~/~/ Напряжение
1290 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
2319 + "deviceTime": "2023-11-29T07:40:44.052Z",
2320 + "serverTime": "2023-11-29T07:40:44.052Z",
2321 + "speed": 0,
2322 + "altitude": 0,
2323 + "latitude": 0,
2324 + "longitude": 0,
2325 + "satellites": 0,
2326 + "course": 0,
2327 + "voltage": 0,
2328 + "parameters": {
1291 1291   "additionalProp1": "string",
1292 1292   "additionalProp2": "string",
1293 1293   "additionalProp3": "string"
1294 1294   },
1295 - "photoCount": 0 ~/~/ Кол-во фото
2333 + "photoCount": 0,
2334 + "lbsCorrectedCoords": true,
2335 + "protocolType": 0
1296 1296   }
1297 1297   ]
1298 1298   }
1299 1299  ]
1300 1300  
2341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2342 +|deviceTime|Время сообщения терминала
2343 +|serverTime|Время когда сообщение поступило на сервер
2344 +|speed|Скорость
2345 +|altitude|Высота над уровнем моря
2346 +|latitude|Широта
2347 +|longitude|Долгота
2348 +|satellites|Кол-во спутников
2349 +|course|Курс
2350 +|voltage|Бортовое напряжение
2351 +|parameters|Список параметров и их значений
2352 +|photoCount|Количество фото
2353 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2354 +|protocolType|ID типа протокола
2355 +
2356 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2357 +
2358 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2359 +
2360 +(% class="box infomessage" %)
2361 +(((
2362 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2363 +)))
2364 +
2365 +(% style="color:#000000" %)Метод запроса: **POST**
2366 +
2367 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2368 +
2369 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2370 +
2371 +(% style="text-align:left" %)
2372 +Тело запроса:
2373 +
2374 +{
2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2376 + "vehicleIds": [0], ~/~/ Список ID объектов
2377 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2378 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2379 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2380 +}
2381 +
2382 +Ответ:
2383 +
2384 +[
2385 + {
2386 + "vehicleId": 0, ~/~/ ID объекта
2387 + "name": "string", ~/~/ Имя ТС
2388 + "periods": [ ~/~/ Периоды
2389 + {
2390 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2391 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2392 + "mileage": 0, ~/~/ Пробег за период, километры
2393 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2394 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2395 + "motohours": 0, ~/~/ Моточасы за период, секунды
2396 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2397 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2398 + "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2399 +
2400 + }
2401 + ]
2402 + }
2403 +]
2404 +
2405 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2406 +
2407 +(% class="box infomessage" %)
2408 +(((
2409 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2410 +)))
2411 +
2412 +(% style="color:#000000" %)Метод запроса: **POST**
2413 +
2414 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2415 +
2416 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2417 +
2418 +(% style="text-align:left" %)
2419 +Тело запроса:
2420 +
2421 +{
2422 + "sampling": 86400, ~/~/ Частота дискретизации, секунд, минимум - 60 (если передано, то весь период бъётся на подпериоды с указанной частотой)
2423 + "vehicleIds": [0], ~/~/ Список ID объектов
2424 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2425 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2426 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2427 +}
2428 +
2429 +Ответ:
2430 +
2431 +[
2432 + {
2433 + "vehicleId": 0, ~/~/ ID объекта
2434 + "name": "string", ~/~/ Имя ТС
2435 + "periods": [ ~/~/ Периоды
2436 + {
2437 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2438 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2439 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2440 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2441 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2442 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2443 + "fuelConsumption": 0, ~/~/ Расход топлива
2444 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2445 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2446 +
2447 + }
2448 + ]
2449 + }
2450 +]
2451 +
2452 +(% class="box warningmessage" %)
2453 +(((
2454 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2455 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2456 +)))
2457 +
2458 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2459 +
2460 +(% class="box infomessage" %)
2461 +(((
2462 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2463 +)))
2464 +
2465 +(% style="color:#000000" %)Метод запроса: **POST**
2466 +
2467 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2468 +
2469 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2470 +
2471 +(% style="text-align:left" %)
2472 +Тело запроса:
2473 +
2474 +{
2475 + "vehicleIds": [0], ~/~/ Список ID объектов
2476 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2477 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2478 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2479 +}
2480 +
2481 +Ответ:
2482 +
2483 +[
2484 + {
2485 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2486 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2487 + "vehicleId": 0, ~/~/ ID объекта
2488 + "name": "string", ~/~/ Имя объекта
2489 + "model": "string", ~/~/ Модель объекта
2490 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2491 + {
2492 + "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
2493 +
2494 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2495 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2496 + "valueFuel": 0, ~/~/ Количество
2497 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2498 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2499 + }
2500 + ]
2501 + }
2502 +]
2503 +
2504 +
2505 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2506 +
2507 +(% class="box infomessage" %)
2508 +(((
2509 +**POST /api/v3/vehicles/moveStop**
2510 +)))
2511 +
2512 +Метод запроса: **POST**
2513 +
2514 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2515 +
2516 +В заголовках запроса: X-Auth: Токен авторизации
2517 +
2518 +
2519 +Тело запроса:
2520 +
2521 +{
2522 + "vehicleIds": [ ], ~/~/ Список ID объектов
2523 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2524 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2525 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2526 +}
2527 +
2528 +Ответ:
2529 +
2530 +[ 
2531 + {
2532 + "vehicleId": 0, ~/~/ ID объекта
2533 + "vehicleName": "string", ~/~/ Имя объекта
2534 + "moves": [ ~/~/ Событие движения
2535 + {
2536 + "mileage": 0, ~/~/ Пробег, км
2537 + "eventId": 0, ~/~/ Идентификатор события
2538 + "eventName": "string", ~/~/ Название события
2539 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2540 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2541 + "duration": 0 ~/~/ Продолжительность события, секунд
2542 + }
2543 + ],
2544 + "stops": [ ~/~/ События стоянок
2545 + {
2546 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2547 + "eventId": 0, ~/~/ Идентификатор события
2548 + "eventName": "string", ~/~/ Название события
2549 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2550 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2551 + "duration": 0 ~/~/ Продолжительность события, секунд
2552 + }
2553 + ]
2554 + }
2555 +]
2556 +
2557 +
2558 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2559 +
2560 +(% class="box infomessage" %)
2561 +(((
2562 +**POST /api/v3/vehicles/getlastdata**
2563 +)))
2564 +
2565 +Метод запроса: **POST**
2566 +
2567 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2568 +
2569 +В заголовках запроса: X-Auth: Токен авторизации
2570 +
2571 +
2572 +В массиве указываем id объектов через запятую
2573 +
2574 +Ответ:
2575 +
2576 +[
2577 + {
2578 + "vehicleId": 55728, ~/~/ Идентификатор объекта 
2579 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2580 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2581 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2582 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2583 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2584 + "speed": 31, ~/~/ Скорость объекта 
2585 + "course": 116, ~/~/ Курс движения [0;360]
2586 + "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2587 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2588 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2589 + "geozones": [ ~/~/ Сведения по геозонам. 
2590 + {
2591 + "id": 10225647, ~/~/ ID Геозоны 
2592 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2593 + },
2594 + {
2595 + "id": 10282875, ~/~/ ID Геозоны 
2596 + "name": "Ё2" ~/~/ Наименование геозоны 
2597 + },
2598 + {
2599 + "id": 10226240, ~/~/ ID Геозоны 
2600 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2601 + },
2602 + {
2603 + "id": 9747869, ~/~/ ID Геозоны 
2604 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2605 + },
2606 + {
2607 + "id": 10221123, ~/~/ ID Геозоны 
2608 + "name": "53r" ~/~/ Наименование геозоны 
2609 + },
2610 + {
2611 + "id": 10197638, ~/~/ ID Геозоны 
2612 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2613 + }
2614 + ]
2615 + }
2616 +
2617 +
2618 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2619 +
2620 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2621 +
2622 +(% class="box infomessage" %)
2623 +(((
2624 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2625 +)))
2626 +
2627 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2628 +
2629 +(% style="color:#000000" %)Метод запроса: **POST**
2630 +
2631 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2632 +
2633 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2634 +
2635 +(% style="text-align:left" %)
2636 +Тело запроса:
2637 +
2638 +(% style="text-align:left" %)
2639 +{
2640 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента, для которого надо получить данные
2641 +}
2642 +
2643 +(% style="text-align:left" %)
2644 +Ответ:
2645 +
2646 +[
2647 + {
2648 + "id": 0, ~/~/ Идентификатор объекта геозоны
2649 + "name": "string", ~/~/ Название объекта геозоны
2650 + "type": 0, ~/~/ Тип объекта геозоны
2651 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
2652 + "fname": "string", ~/~/ Имя файла
2653 + "parentId": "string", ~/~/ Идентификатор клиента
2654 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2655 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2656 + "description": "string", ~/~/ Описание
2657 + "area": 0, ~/~/ Площадь, м^^2^^
2658 + "perimetr": 0, ~/~/ Периметр, м
2659 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2660 + }
2661 +]
2662 +
2663 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2664 +
2665 +(% class="box infomessage" %)
2666 +(((
2667 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2668 +)))
2669 +
2670 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2671 +
2672 +(% style="color:#000000" %)Метод запроса: **POST**
2673 +
2674 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2675 +
2676 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2677 +
2678 +(% style="text-align:left" %)
2679 +Тело запроса:
2680 +
2681 +{
2682 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2683 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2684 + "ids": [ ], ~/~/ Массив id объектов
2685 + "byTime": 0, ~/~/ Объединение событий по времени 
2686 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2687 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2688 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2689 +}
2690 +
2691 +Ответ:
2692 +[
2693 + {
2694 + "geozoneId": 0, ~/~/ ID геообъекта
2695 + "geozoneName": "string", ~/~/ Название геообъекта
2696 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2697 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2698 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2699 + "vehicleId": 0, ~/~/ ID объекта
2700 + "vehicleName": "string" ~/~/ Имя объекта
2701 + }
2702 +]
2703 +
2704 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2705 +
2706 +(% class="box infomessage" %)
2707 +(((
2708 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2709 +)))
2710 +
2711 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2712 +
2713 +(% style="color:#000000" %)Метод запроса: **POST**
2714 +
2715 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2716 +
2717 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2718 +
2719 +(% style="text-align:left" %)
2720 +Тело запроса:
2721 +
2722 +{
2723 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2724 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2725 + "ids": [ ], ~/~/ Массив id геообъектов
2726 + "byTime": 0, ~/~/ Объединение событий по времени 
2727 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2728 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2729 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2730 +}
2731 +
2732 +Ответ:
2733 +
2734 +[
2735 + {
2736 + "geozoneId": 0, ~/~/ ID геообъекта
2737 + "geozoneName": "string", ~/~/ Название геообъекта
2738 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2739 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2740 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2741 + "vehicleId": 0, ~/~/ ID объекта
2742 + "vehicleName": "string" ~/~/ Имя объекта
2743 + }
2744 +]
2745 +
2746 +
2747 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2748 +
2749 +(% class="box successmessage" %)
2750 +(((
2751 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2752 +)))
2753 +
2754 +(% style="color:#000000" %)Метод запроса: **PUT**
2755 +
2756 +Пример запроса:
2757 +
2758 +(((
2759 +{
2760 + "id": 0,  ~/~/ Идентификатор объекта геозоны
2761 + "name": "string",  ~/~/ Наименование объекта геозоны
2762 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2763 + "description": "string", ~/~/ Описание объекта геозоны
2764 + "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2765 + "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2766 + "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2767 + "type": 0, ~/~/ Тип геозоны - линия,полигон
2768 + "radius": 0, ~/~/ Радиус геозоны
2769 + "shape": "string", ~/~/ Координаты геозоны
2770 + "shape_format": "string" ~/~/ Формат xml,json
2771 +
2772 +}
2773 +)))
2774 +
2775 +
2776 +Пример ответа:
2777 +
2778 +200 ~/~/ Success
2779 +
1301 1301  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1302 1302  
1303 1303  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
1304 1304  
1305 -POST /api/v3/notifications/find
2784 +(% class="box infomessage" %)
2785 +(((
2786 +**POST /api/v3/notifications/find**
2787 +)))
1306 1306  
1307 1307  Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
1308 1308  
... ... @@ -1323,19 +1323,171 @@
1323 1323  
1324 1324  [
1325 1325   {
1326 - "id": 0,
1327 - "name": "string",
1328 - "active": true,
1329 - "type": 0,
1330 - "userId": "",
1331 - "parentId": "",
1332 - "parentName": "string"
2808 + "id": 0, ~/~/ ID уведомления
2809 + "name": "string", ~/~/ Название уведомления
2810 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
2811 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2812 + "userId": "", ~/~/ Пользователь, создавший уведомление
2813 + "parentId": "", ~/~/ Идентификатор клиента
2814 + "parentName": "string" ~/~/ Имя клиента
1333 1333   }
1334 1334  ]
1335 1335  
2818 +
2819 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2820 +
2821 +(% class="box infomessage" %)
2822 +(((
2823 +**POST /api/v3/notifications**
2824 +)))
2825 +
2826 +Метод запроса **POST**
2827 +
2828 +(% style="text-align: left;" %)
2829 +(% style="color:#000000" %)Пример запроса
2830 +
2831 +(((
2832 +{
2833 + "id": 0, ~/~/ ID правила
2834 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2835 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2836 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2837 + "name": "string", ~/~/ Имя правила
2838 + "active": true, ~/~/ Активность правила
2839 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2840 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2841 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2842 + ],
2843 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2844 + 0
2845 + ],
2846 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2847 + 0
2848 + ],
2849 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2850 + 0
2851 + ],
2852 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2853 + "additionalProp1": "string",  
2854 + "additionalProp2": "string",
2855 + "additionalProp3": "string"
2856 + },
2857 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2858 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2859 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2860 + ],
2861 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2862 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2863 + "string"
2864 + ],
2865 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2866 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2867 + {
2868 + "id": 0, ~/~/ Идентификатор участника чата.
2869 + "info": "string" ~/~/ Дополнительные сведения.
2870 + }
2871 + ],
2872 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2873 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2874 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2875 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2876 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2877 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2878 + "timezone": 0, ~/~/ часовой пояс 
2879 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2880 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2881 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2882 + {
2883 + "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 - Срок действия правила истек
2884 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2885 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2886 + "additionalProp1": "string",
2887 + "additionalProp2": "string",
2888 + "additionalProp3": "string"
2889 + }
2890 + }
2891 + ]
2892 +}
2893 +)))
2894 +
2895 +(((
2896 +
2897 +)))
2898 +
2899 +(((
2900 +
2901 +)))
2902 +
2903 +Ответ:
2904 +
2905 +{
2906 + "id": 0, ~/~/ ID правила
2907 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2908 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2909 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2910 + "name": "string", ~/~/ Имя правила
2911 + "active": true, ~/~/ Активность правила
2912 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2913 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2914 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2915 + ],
2916 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2917 + 0
2918 + ],
2919 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2920 + 0
2921 + ],
2922 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2923 + 0
2924 + ],
2925 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2926 + "additionalProp1": "string",  
2927 + "additionalProp2": "string",
2928 + "additionalProp3": "string"
2929 + },
2930 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2931 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2932 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2933 + ],
2934 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2935 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2936 + "string"
2937 + ],
2938 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2939 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2940 + {
2941 + "id": 0, ~/~/ Идентификатор участника чата.
2942 + "info": "string" ~/~/ Дополнительные сведения.
2943 + }
2944 + ],
2945 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2946 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2947 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2948 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2949 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2950 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2951 + "timezone": 0, ~/~/ часовой пояс 
2952 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2953 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2954 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2955 + {
2956 + "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 - Срок действия правила истек
2957 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2958 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2959 + "additionalProp1": "string",
2960 + "additionalProp2": "string",
2961 + "additionalProp3": "string"
2962 + }
2963 + }
2964 + ]
2965 +}
2966 +
1336 1336  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
1337 1337  
1338 -GET /api/v3/notifications/{id}
2969 +(% class="box infomessage" %)
2970 +(((
2971 +**GET /api/v3/notifications/{id}**
2972 +)))
1339 1339  
1340 1340  Метод возвращает данные правил формирования выбранного уведомления.
1341 1341  
... ... @@ -1343,7 +1343,7 @@
1343 1343  Метод запроса **GET**
1344 1344  
1345 1345  (% style="text-align: left;" %)
1346 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]
2980 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1347 1347  
1348 1348  (% style="text-align: left;" %)
1349 1349  (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
... ... @@ -1356,54 +1356,3715 @@
1356 1356  
1357 1357  (% style="text-align: left;" %)
1358 1358  (% style="color:#000000" %){
1359 - "id": 0,
1360 - "type": 0,
1361 - "userId": "",
1362 - "parentId": "",
1363 - "parentName": "string",
1364 - "name": "string",
1365 - "active": true,
1366 - "vehicleIds": [
2993 + "id": 0, ~/~/ (%%)id уведомления
2994 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2995 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2996 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2997 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2998 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2999 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
3000 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
3001 +(% style="color:#000000" %) 0
3002 + ],
3003 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
3004 +(% style="color:#000000" %) 0
3005 + ],
3006 + "fieldids": [ ~/~/ (%%)Список id полей для анализа
3007 +(% style="color:#000000" %) 0
3008 + ],
3009 + "settings": { ~/~/ Список параметров уведомления
3010 + "additionalProp1": "string",
3011 + "additionalProp2": "string",
3012 + "additionalProp3": "string"
3013 + },
3014 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3015 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3016 +(% style="color:#000000" %) ""
3017 + ],
3018 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3019 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
3020 +(% style="color:#000000" %) "string"
3021 + ],
3022 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
3023 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
3024 +(% style="color:#000000" %) {
3025 + "id": 0, ~/~/ (%%)Идентификатор участника чата
3026 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
3027 +(% style="color:#000000" %) }
3028 + ],
3029 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
3030 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
3031 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3032 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
3033 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3034 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
3035 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
3036 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
3037 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
3038 +(% style="color:#000000" %)}
3039 +
3040 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
3041 +
3042 +(% class="box warningmessage" %)
3043 +(((
3044 +**PUT /api/v3/notifications/**
3045 +)))
3046 +
3047 +Метод позволяет отредактировать уведомление.
3048 +
3049 +Метод запроса **PUT**
3050 +
3051 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
3052 +
3053 +В заголовках запроса: X-Auth: Токен авторизации
3054 +
3055 +Тело запроса:
3056 +{
3057 + "id": 0, ~/~/ id уведомления
3058 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
3059 + "userId": "", ~/~/ Пользователь, создавший уведомление
3060 + "parentId": "", ~/~/ Идентификатор клиента
3061 + "parentName": "string", ~/~/ Имя клиента
3062 + "name": "string", ~/~/ Название уведомления
3063 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
3064 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1367 1367   0
1368 1368   ],
1369 - "geoids": [
3067 + "geoids": [ ~/~/ Список id геообъектов для анализа
1370 1370   0
1371 1371   ],
1372 - "fieldids": [
3070 + "fieldids": [ ~/~/ Список id полей для анализа
1373 1373   0
1374 1374   ],
1375 - "settings": {
3073 + "settings": { ~/~/ Список параметров уведомления
1376 1376   "additionalProp1": "string",
1377 1377   "additionalProp2": "string",
1378 1378   "additionalProp3": "string"
1379 1379   },
1380 - "toEmail": true,
1381 - "recipientIds": [
3078 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3079 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1382 1382   ""
1383 1383   ],
1384 - "enableSideEmails": true,
1385 - "sideEmails": [
3082 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3083 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1386 1386   "string"
1387 1387   ],
1388 - "toTelegram": true,
1389 - "telegrams": [
3086 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
3087 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1390 1390   {
1391 - "id": 0,
1392 - "info": "string"
3089 + "id": 0, ~/~/ Идентификатор участника чата
3090 + "info": "string" ~/~/ Дополнительные сведения
1393 1393   }
1394 1394   ],
1395 - "toMobile": true,
1396 - "toClient": true,
1397 - "stored": true,
1398 - "kind": 0,
1399 - "activationMode": 0,
1400 - "activationTime": "2023-03-29T09:57:48.932Z",
1401 - "timezone": 0,
1402 - "validity": 0,
1403 - "autoProlongation": true
3093 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
3094 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
3095 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3096 + "kind": 0, ~/~/ Определяет вид уведомления
3097 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3098 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
3099 + "timezone": 0, ~/~/ Сдвиг часового пояса
3100 + "validity": 0, ~/~/ Срок действия в днях (1-90)
3101 + "autoProlongation": true ~/~/ Автопродление срока действия
1404 1404  }
1405 1405  
3104 +Ответ:
1406 1406  
3106 +Success
3107 +
3108 +
3109 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
3110 +
3111 +(% class="box warningmessage" %)
3112 +(((
3113 +**PUT** /api/v3/notifications/prolongation
3114 +)))
3115 +
3116 +Метод позволяет продлить уведомления.
3117 +
3118 +Метод запроса **PUT**
3119 +
3120 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
3121 +
3122 +В заголовках запроса: X-Auth: Токен авторизации.
3123 +
3124 +Тело запроса:
3125 +
3126 +[
3127 +
3128 +0
3129 +
3130 +]
3131 +
3132 +где 0 идентификатор ids.
3133 +
3134 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
3135 +
3136 +(% class="box errormessage" %)
3137 +(((
3138 +**DELETE /api/v3/notifications/{id}**
3139 +)))
3140 +
3141 +Метод позволяет удалить выбранное уведомление.
3142 +
3143 +Метод запроса **DELETE**
3144 +
3145 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3146 +
3147 +Передаваемый параметр: {id} - id уведомления
3148 +
3149 +В заголовках запроса: X-Auth: Токен авторизации
3150 +
3151 +Ответ:
3152 +
3153 +Success
3154 +
3155 +
3156 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3157 +
3158 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3159 +
3160 +(% class="box infomessage" %)
3161 +(((
3162 +**POST /api/v3/Drivers/find**
3163 +)))
3164 +
3165 +Передается параметр: parentId - ID клиента-родителя
3166 +
3167 +Ответ:
3168 +
3169 +[
3170 + {
3171 + "name": "string", ~/~/ Определяет наименование
3172 + "description": "string", ~/~/ Определяет описание
3173 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3174 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3175 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
3176 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3177 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3178 + "deleted": true ~/~/ Признак удаления
3179 + }
3180 +]
3181 +
3182 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3183 +
3184 +(% class="box infomessage" %)
3185 +(((
3186 +**GET /api/v3/Drivers/{driverGuid}**
3187 +)))
3188 +
3189 +Передается параметр: ID водителя
3190 +
3191 +Ответ:
3192 +
3193 +{
3194 + "name": "string", ~/~/ Определяет наименование
3195 + "description": "string", ~/~/ Определяет описание
3196 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3197 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3198 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
3199 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3200 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3201 + "deleted": true ~/~/ Признак удаления
3202 +}
3203 +
3204 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3205 +
3206 +(% class="box successmessage" %)
3207 +(((
3208 +**POST /api/v3/Drivers**
3209 +)))
3210 +
3211 +Запрос:
3212 +
3213 +{
3214 + "name": "string",
3215 + "description": "string",
3216 + "hiredate": "2023-06-30T12:50:54.020Z",
3217 + "chopdate": "2023-06-30T12:50:54.020Z",
3218 + "exclusive": true,
3219 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3220 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3221 + "deleted": true
3222 +}
3223 +
3224 +Ответ:
3225 +
3226 +{
3227 + "name": "string",
3228 + "description": "string",
3229 + "hiredate": "2023-06-30T12:50:54.051Z",
3230 + "chopdate": "2023-06-30T12:50:54.051Z",
3231 + "exclusive": true,
3232 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3233 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3234 + "deleted": true
3235 +}
3236 +
3237 +
3238 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3239 +
3240 +(% class="box warningmessage" %)
3241 +(((
3242 +**PUT /api/v3/Drivers**
3243 +)))
3244 +
3245 +Запрос:
3246 +
3247 +{
3248 + "name": "string",
3249 + "description": "string",
3250 + "hiredate": "2023-06-30T12:50:27.910Z",
3251 + "chopdate": "2023-06-30T12:50:27.910Z",
3252 + "exclusive": true,
3253 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3254 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3255 + "deleted": true
3256 +}
3257 +
3258 +Ответ:
3259 +
3260 +{
3261 + "name": "string",
3262 + "description": "string",
3263 + "hiredate": "2023-06-30T12:50:27.929Z",
3264 + "chopdate": "2023-06-30T12:50:27.929Z",
3265 + "exclusive": true,
3266 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3267 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3268 + "deleted": true
3269 +}
3270 +
3271 +
3272 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3273 +
3274 +(% class="box errormessage" %)
3275 +(((
3276 +**DELETE /api/v3/Drivers/{driverGuid}**
3277 +)))
3278 +
3279 +Передается параметр: ID водителя
3280 +
3281 +Ответ:
3282 +
3283 +Success
3284 +
3285 +
3286 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3287 +
3288 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3289 +
3290 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3291 +
3292 +(% class="box infomessage" %)
3293 +(((
3294 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3295 +)))
3296 +
3297 +Запрос:
3298 +
3299 +{
3300 + "Ids": [
3301 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3302 + ],
3303 + "BeginTime": "2023-06-30T12:49:04.365Z",
3304 + "EndTime": "2023-06-30T12:49:04.365Z"
3305 +}
3306 +
3307 +Ответ:
3308 +
3309 +[
3310 + {
3311 + "VehicleId": 0,
3312 + "CreateTime": "2023-06-30T09:52:31.240Z",
3313 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3314 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3315 + "BeginTime": "2023-06-30T09:52:31.240Z",
3316 + "EndTime": "2023-06-30T09:52:31.240Z"
3317 + }
3318 +]
3319 +
3320 +
3321 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3322 +
3323 +(% class="box infomessage" %)
3324 +(((
3325 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3326 +)))
3327 +
3328 +Запрос:
3329 +
3330 +{
3331 + "Ids": [
3332 + 0
3333 + ],
3334 + "BeginTime": "2023-06-30T12:48:39.419Z",
3335 + "EndTime": "2023-06-30T12:48:39.419Z"
3336 +}
3337 +
3338 +Ответ:
3339 +
3340 +[
3341 + {
3342 + "VehicleId": 0,
3343 + "CreateTime": "2023-06-30T09:54:01.631Z",
3344 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3345 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3346 + "BeginTime": "2023-06-30T09:54:01.631Z",
3347 + "EndTime": "2023-06-30T09:54:01.631Z"
3348 + }
3349 +]
3350 +
3351 +
3352 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3353 +
3354 +(% class="box successmessage" %)
3355 +(((
3356 +**POST /api/v3/DriversVehiclesAssignments**
3357 +)))
3358 +
3359 +Передается массив назначений
3360 +
3361 +Запрос:
3362 +
3363 +[
3364 + {
3365 + "VehicleId": 0, ~/~/ Идентификатор объекта
3366 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3367 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3368 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3369 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3370 + }
3371 +]
3372 +
3373 +Ответ:
3374 +
3375 +[
3376 + {
3377 + "VehicleId": 0,
3378 + "CreateTime": "2023-06-30T11:04:46.903Z",
3379 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3380 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3381 + "BeginTime": "2023-06-30T11:04:46.903Z",
3382 + "EndTime": "2023-06-30T11:04:46.903Z"
3383 + }
3384 +]
3385 +
3386 +
3387 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3388 +
3389 +(% class="box warningmessage" %)
3390 +(((
3391 +**PUT /api/v3/DriversVehiclesAssignments**
3392 +)))
3393 +
3394 +Запрос:
3395 +
3396 +[
3397 + {
3398 + "VehicleId": 0,
3399 + "CreateTime": "2023-06-30T11:14:08.117Z",
3400 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3401 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3402 + "BeginTime": "2023-06-30T11:14:08.117Z",
3403 + "EndTime": "2023-06-30T11:14:08.117Z"
3404 + }
3405 +]
3406 +
3407 +Ответ:
3408 +
3409 +[
3410 + {
3411 + "VehicleId": 0,
3412 + "CreateTime": "2023-06-30T11:14:53.349Z",
3413 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3414 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3415 + "BeginTime": "2023-06-30T11:14:53.349Z",
3416 + "EndTime": "2023-06-30T11:14:53.349Z"
3417 + }
3418 +]
3419 +
3420 +
3421 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3422 +
3423 +(% class="box errormessage" %)
3424 +(((
3425 +**DELETE /api/v3/DriversVehiclesAssignments**
3426 +)))
3427 +
3428 +Запрос:
3429 +
3430 +[
3431 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3432 +]
3433 +
3434 +Ответ:
3435 +
3436 +Success
3437 +
3438 +
3439 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3440 +
3441 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3442 +
3443 +(% class="box infomessage" %)
3444 +(((
3445 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3446 +)))
3447 +
3448 +Запрос:
3449 +
3450 +{
3451 + "Ids": [
3452 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3453 + ],
3454 + "BeginTime": "2023-06-30T12:47:12.162Z",
3455 + "EndTime": "2023-06-30T12:47:12.162Z"
3456 +}
3457 +
3458 +Ответ:
3459 +
3460 +[
3461 + {
3462 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3463 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3464 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3465 + "BeginTime": "2023-06-30T11:19:40.703Z",
3466 + "EndTime": "2023-06-30T11:19:40.703Z"
3467 + }
3468 +]
3469 +
3470 +
3471 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3472 +
3473 +(% class="box infomessage" %)
3474 +(((
3475 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
3476 +)))
3477 +
3478 +Запрос:
3479 +
3480 +{
3481 + "Ids": [
3482 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3483 + ],
3484 + "BeginTime": "2023-06-30T12:47:12.162Z",
3485 + "EndTime": "2023-06-30T12:47:12.162Z"
3486 +}
3487 +
3488 +Ответ:
3489 +
3490 +[
3491 + {
3492 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3493 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3494 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3495 + "BeginTime": "2023-06-30T11:19:40.703Z",
3496 + "EndTime": "2023-06-30T11:19:40.703Z"
3497 + }
3498 +]
3499 +
3500 +
3501 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3502 +
3503 +(% class="box successmessage" %)
3504 +(((
3505 +**POST /api/v3/DriversRfidsAssignments**
3506 +)))
3507 +
3508 +Запрос:
3509 +
3510 +[
3511 + {
3512 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3513 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3514 + "BeginTime": "2023-06-30T11:27:08.635Z",
3515 + "EndTime": "2023-06-30T11:27:08.635Z"
3516 + }
3517 +]
3518 +
3519 +Ответ:
3520 +
3521 +[
3522 + {
3523 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3524 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3525 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3526 + "BeginTime": "2023-06-30T11:27:08.677Z",
3527 + "EndTime": "2023-06-30T11:27:08.677Z"
3528 + }
3529 +]
3530 +
3531 +
3532 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3533 +
3534 +(% class="box warningmessage" %)
3535 +(((
3536 +**PUT /api/v3/DriversRfidsAssignments**
3537 +)))
3538 +
3539 +Запрос:
3540 +
3541 +[
3542 + {
3543 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3544 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3545 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3546 + "BeginTime": "2023-06-30T11:28:43.330Z",
3547 + "EndTime": "2023-06-30T11:28:43.330Z"
3548 + }
3549 +]
3550 +
3551 +Ответ:
3552 +
3553 +[
3554 + {
3555 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3556 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3557 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3558 + "BeginTime": "2023-06-30T11:28:43.331Z",
3559 + "EndTime": "2023-06-30T11:28:43.331Z"
3560 + }
3561 +]
3562 +
3563 +
3564 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3565 +
3566 +(% class="box errormessage" %)
3567 +(((
3568 +**DELETE /api/v3/DriversRfidsAssignments**
3569 +)))
3570 +
3571 +Запрос:
3572 +
3573 +[
3574 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3575 +]
3576 +
3577 +Ответ:
3578 +
3579 +Success
3580 +
3581 +
3582 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3583 +
3584 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3585 +
3586 +(% class="box infomessage" %)
3587 +(((
3588 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3589 +)))
3590 +
3591 +Запрос:
3592 +
3593 +{
3594 + "Ids": [
3595 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3596 + ],
3597 + "BeginTime": "2023-06-30T12:45:10.852Z",
3598 + "EndTime": "2023-06-30T12:45:10.852Z"
3599 +}
3600 +
3601 +Ответ:
3602 +
3603 +[
3604 + {
3605 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3606 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3607 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3608 + "BeginTime": "2023-06-30T11:58:04.695Z",
3609 + "EndTime": "2023-06-30T11:58:04.695Z"
3610 + }
3611 +]
3612 +
3613 +
3614 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3615 +
3616 +(% class="box infomessage" %)
3617 +(((
3618 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3619 +)))
3620 +
3621 +Запрос:
3622 +
3623 +{
3624 + "Ids": [
3625 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3626 + ],
3627 + "BeginTime": "2023-06-30T12:45:10.852Z",
3628 + "EndTime": "2023-06-30T12:45:10.852Z"
3629 +}
3630 +
3631 +Ответ:
3632 +
3633 +[
3634 + {
3635 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3636 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3637 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3638 + "BeginTime": "2023-06-30T11:58:04.695Z",
3639 + "EndTime": "2023-06-30T11:58:04.695Z"
3640 + }
3641 +]
3642 +
3643 +
3644 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3645 +
3646 +(% class="box successmessage" %)
3647 +(((
3648 +**POST /api/v3/DriversFuelCardsAssignments**
3649 +)))
3650 +
3651 +Запрос:
3652 +
3653 +[
3654 + {
3655 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3656 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3657 + "BeginTime": "2023-06-30T12:09:53.175Z",
3658 + "EndTime": "2023-06-30T12:09:53.175Z"
3659 + }
3660 +]
3661 +
3662 +Ответ:
3663 +
3664 +[
3665 + {
3666 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3667 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3668 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3669 + "BeginTime": "2023-06-30T12:09:53.201Z",
3670 + "EndTime": "2023-06-30T12:09:53.201Z"
3671 + }
3672 +]
3673 +
3674 +
3675 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3676 +
3677 +(% class="box warningmessage" %)
3678 +(((
3679 +**PUT /api/v3/DriversFuelCardsAssignments**
3680 +)))
3681 +
3682 +Запрос:
3683 +
3684 +[
3685 + {
3686 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3687 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3688 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3689 + "BeginTime": "2023-06-30T12:09:53.201Z",
3690 + "EndTime": "2023-06-30T12:09:53.201Z"
3691 + }
3692 +]
3693 +
3694 +Ответ:
3695 +
3696 +[
3697 + {
3698 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3699 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3700 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3701 + "BeginTime": "2023-06-30T12:09:53.201Z",
3702 + "EndTime": "2023-06-30T12:09:53.201Z"
3703 + }
3704 +]
3705 +
3706 +
3707 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3708 +
3709 +(% class="box errormessage" %)
3710 +(((
3711 +**DELETE /api/v3/DriversFuelCardsAssignments**
3712 +)))
3713 +
3714 +Запрос:
3715 +
3716 +[
3717 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3718 +]
3719 +
3720 +Ответ:
3721 +
3722 +Success
3723 +
3724 +
3725 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3726 +
3727 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3728 +
3729 +(% class="box infomessage" %)
3730 +(((
3731 +**POST /api/v3/Trailers**
3732 +)))
3733 +
3734 +Пример запроса:
3735 +
3736 +{
3737 + "startDate": "2023-11-14T10:48:03.671Z",
3738 + "endDate": "2023-11-14T10:48:03.671Z",
3739 + "ids": [ 0 ],
3740 + "timezone": 0
3741 +}
3742 +
3743 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3744 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3745 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3746 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3747 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3748 +
3749 +Пример ответа:
3750 +
3751 +[
3752 + {
3753 + "SD": "2023-11-14T10:48:03.717Z",
3754 + "ED": "2023-11-14T10:48:03.717Z", 
3755 + "id": 0,
3756 + "SLat": 0,
3757 + "SLon": 0,
3758 + "ELat": 0,
3759 + "ELon": 0,
3760 + "mileage": 0
3761 + "Duration": 0
3762 + "Address": "string",
3763 + "Address2": "string",
3764 + "name": "string",
3765 + "rid": "string",
3766 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3767 + "trailer": {
3768 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3769 + "Number": "string",
3770 + "Description": "string",
3771 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3772 + "ExternalID": "string",
3773 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3774 + "CreateTime": "2023-11-14T10:48:03.717Z",
3775 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3776 + "IsDeleted": true
3777 + },
3778 + "filesCount": 0,
3779 + }
3780 +]
3781 +
3782 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3783 +|SD|Дата и время начала события
3784 +|ED|Дата и время окончания события
3785 +|id|ID объекта
3786 +|SLat|Широта начальной координаты
3787 +|SLon|Долгота начальной координаты
3788 +|ELat|Широта конечной координаты
3789 +|ELon|Долгота конечной координаты
3790 +|mileage|Пробег
3791 +|Duration|Продолжительность
3792 +|Address|Адрес начального местоположения
3793 +|Address2|Адрес конечного местоположения
3794 +|name|Имя радиометки
3795 +|rid|Номер радиометки
3796 +|rguid|ID радиометки
3797 +|trailer|Информация об агрегате
3798 +|ModelGuid|ID агрегата
3799 +|Number|Название/номер агрегата
3800 +|Description|Текст примечания агрегата
3801 +
3802 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3803 +
3804 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3805 +
3806 +(% class="box infomessage" %)
3807 +(((
3808 +**POST /api/v3/Rfids/find**
3809 +)))
3810 +
3811 +Запрос:
3812 +
3813 +{
3814 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3815 +}
3816 +
3817 +Ответ:
3818 +
3819 +[
3820 + {
3821 + "name": "string",
3822 + "number": 0,
3823 + "period": 0,
3824 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3825 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3826 + }
3827 +]
3828 +
3829 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3830 +|parentId|ID клиента
3831 +|name|Название карты-метки
3832 +|number|Номер
3833 +|period|Период запросов в секундах (работает только для агрегатов)
3834 +|id|ID карты-метки
3835 +
3836 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3837 +
3838 +(% class="box infomessage" %)
3839 +(((
3840 +**GET /api/v3/Rfids/{rfidGuid}**
3841 +)))
3842 +
3843 +Передаем параметр rfidGuid - идентификатор карты-метки
3844 +
3845 +Ответ:
3846 +
3847 +[
3848 + {
3849 + "name": "string",
3850 + "number": 0,
3851 + "period": 0,
3852 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3853 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3854 + }
3855 +]
3856 +
3857 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3858 +|name|Название карты-метки
3859 +|number|Номер
3860 +|period|Период запросов в секундах (работает только для агрегатов)
3861 +|id|ID карты-метки
3862 +|parentId|ID клиента
3863 +
3864 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3865 +
3866 +(% class="box successmessage" %)
3867 +(((
3868 +**POST /api/v3/Rfids**
3869 +)))
3870 +
3871 +Запрос:
3872 +
3873 +{
3874 + "name": "string",
3875 + "number": 0,
3876 + "period": 0,
3877 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3878 +}
3879 +
3880 +Ответ:
3881 +
3882 +{
3883 + "name": "string",
3884 + "number": 0,
3885 + "period": 0,
3886 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3887 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3888 +}
3889 +
3890 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3891 +|name|Название карты-метки
3892 +|number|Номер
3893 +|period|Период запросов в секундах (работает только для агрегатов)
3894 +|id|ID карты-метки
3895 +|parentId|ID клиента
3896 +
3897 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3898 +
3899 +(% class="box warningmessage" %)
3900 +(((
3901 +**PUT /api/v3/Rfids**
3902 +)))
3903 +
3904 +Запрос:
3905 +
3906 +{
3907 + "name": "string",
3908 + "number": 0,
3909 + "period": 0,
3910 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3911 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3912 +}
3913 +
3914 +Ответ:
3915 +
3916 +{
3917 + "name": "string",
3918 + "number": 0,
3919 + "period": 0,
3920 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3921 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3922 +}
3923 +
3924 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3925 +|name|Название карты-метки
3926 +|number|Номер
3927 +|period|Период запросов в секундах (работает только для агрегатов)
3928 +|id|ID карты-метки
3929 +|parentId|ID клиента
3930 +
3931 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3932 +
3933 +(% class="box errormessage" %)
3934 +(((
3935 +**DELETE /api/v3/Rfids/{rfidGuid}**
3936 +)))
3937 +
3938 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3939 +
3940 +Ответ:
3941 +
3942 +Success
3943 +
3944 +
3945 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3946 +
3947 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3948 +
3949 +(% class="box infomessage" %)
3950 +(((
3951 +**GET /api/v3/Billing/client/balance/{clientId}**
3952 +)))
3953 +
3954 +Параметр запроса: **clientId **- идентификатор клиента.
3955 +
3956 +Ответ:
3957 +
3958 +{
3959 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3960 + "Balance": 0
3961 +}
3962 +
3963 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3964 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3965 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3966 +
3967 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3968 +
3969 +(% class="box infomessage" %)
3970 +(((
3971 +**GET /api/v3/Billing/client/constraint/{clientId}**
3972 +)))
3973 +
3974 +Параметр запроса: **clientId **- идентификатор клиента.
3975 +
3976 +Ответ:
3977 +
3978 +{
3979 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3980 + "CalculationType": 0,
3981 + "PermissibleBalance": 0,
3982 + "DefermentDays": 0,
3983 + "SendUiNotifications": true,
3984 + "SendEmailNotifications": true,
3985 + "IsPrivate": true,
3986 +}
3987 +
3988 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3989 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3990 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3991 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3992 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3993 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3994 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3995 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3996 +
3997 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3998 +
3999 +(% class="box infomessage" %)
4000 +(((
4001 +**GET /api/v3/Billing/client/plan/{clientId}**
4002 +)))
4003 +
4004 +Параметры запроса:
4005 +
4006 +**clientId **- идентификатор клиента.
4007 +
4008 +**planId **- идентификатор тарифного плана.
4009 +
4010 +Ответ:
4011 +
4012 +{
4013 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4014 + "Plan": { **~/~/ Описание тарифного плана**
4015 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4016 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4017 + "Name": "string",
4018 + "IsArchived": true,
4019 + "Constraint": {
4020 + "CalculationType": 0,
4021 + "PermissibleBalance": 0,
4022 + "DefermentDays": 0
4023 + },
4024 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
4025 + {
4026 + "Feature": "string",
4027 + "IsFactual": true,
4028 + "Limit": 0,
4029 + "Price": 0,
4030 + "PeriodValue": 0,
4031 + "PeriodType": 0
4032 + }
4033 + ]
4034 + },
4035 + "DebitDate": "2023-10-18T12:46:24.213Z",
4036 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
4037 + {
4038 + "Feature": "string",
4039 + "IsEnabled": true,
4040 + "IsPrivate": true,
4041 + "IsFactual": true,
4042 + "Limit": 0,
4043 + "Price": 0,
4044 + "DebitDate": "2023-10-18T12:46:24.213Z",
4045 + "PeriodValue": 0,
4046 + "PeriodType": 0
4047 + }
4048 + ]
4049 +}
4050 +
4051 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4052 +|ClientId|Идентификатор клиента
4053 +|Id|Идентификатор тарифного плана
4054 +|OwnerId|Идентификатор клиента-владельца
4055 +|Name|Наименование тарифного плана
4056 +|IsArchived|Признак, определяющий архивный тарифный план
4057 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4058 +|PermissibleBalance|Допустимый баланс
4059 +|DefermentDays|Отсрочка, количество дней
4060 +|Feature|Код услуги
4061 +|IsEnabled|Признак, определяющий активирована ли услуга
4062 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4063 +|IsFactual|Признак, определяющий расчёт по факту
4064 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4065 +|Price|Цена за единицу.
4066 +|DebitDate|Следующий момент времени списания с баланса за услугу.
4067 +|PeriodValue|Значение периода.
4068 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4069 +
4070 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
4071 +
4072 +(% class="box infomessage" %)
4073 +(((
4074 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4075 +)))
4076 +
4077 +Параметр запроса: **clientId **- идентификатор клиента.
4078 +
4079 +Ответ:
4080 +
4081 +[
4082 + {
4083 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4084 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4085 + "Name": "string",
4086 + "IsArchived": true,
4087 + "Constraint": {
4088 + "CalculationType": 0,
4089 + "PermissibleBalance": 0,
4090 + "DefermentDays": 0
4091 + },
4092 + "Features": [
4093 + {
4094 + "Feature": "string",
4095 + "IsFactual": true,
4096 + "Limit": 0,
4097 + "Price": 0,
4098 + "PeriodValue": 0,
4099 + "PeriodType": 0
4100 + }
4101 + ]
4102 + }
4103 +]
4104 +
4105 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4106 +|ClientId|Идентификатор клиента
4107 +|Id|Идентификатор тарифного плана
4108 +|OwnerId|Идентификатор клиента-владельца
4109 +|Name|Наименование тарифного плана
4110 +|IsArchived|Признак, определяющий архивный тарифный план
4111 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4112 +|PermissibleBalance|Допустимый баланс
4113 +|DefermentDays|Отсрочка, количество дней
4114 +|Feature|Код услуги
4115 +|IsFactual|Признак, определяющий расчёт по факту
4116 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4117 +|Price|Цена за единицу.
4118 +|PeriodValue|Значение периода.
4119 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4120 +
4121 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
4122 +
4123 +(% class="box infomessage" %)
4124 +(((
4125 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4126 +)))
4127 +
4128 +Параметр запроса: **clientId **- идентификатор клиента.
4129 +
4130 +Ответ:
4131 +
4132 +[
4133 + {
4134 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4135 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4136 + "Name": "string",
4137 + "IsArchived": true,
4138 + "Constraint": {
4139 + "CalculationType": 0,
4140 + "PermissibleBalance": 0,
4141 + "DefermentDays": 0
4142 + },
4143 + "Features": [
4144 + {
4145 + "Feature": "string",
4146 + "IsFactual": true,
4147 + "Limit": 0,
4148 + "Price": 0,
4149 + "PeriodValue": 0,
4150 + "PeriodType": 0
4151 + }
4152 + ]
4153 + }
4154 +]
4155 +
4156 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4157 +|ClientId|Идентификатор клиента
4158 +|Id|Идентификатор тарифного плана
4159 +|OwnerId|Идентификатор клиента-владельца
4160 +|Name|Наименование тарифного плана
4161 +|IsArchived|Признак, определяющий архивный тарифный план
4162 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4163 +|PermissibleBalance|Допустимый баланс
4164 +|DefermentDays|Отсрочка, количество дней
4165 +|Feature|Код услуги
4166 +|IsFactual|Признак, определяющий расчёт по факту
4167 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4168 +|Price|Цена за единицу.
4169 +|PeriodValue|Значение периода.
4170 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4171 +
4172 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4173 +
4174 +(% class="box warningmessage" %)
4175 +(((
4176 +**PUT /api/v3/Billing/client/balance**
4177 +)))
4178 +
4179 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4180 +
4181 +Тело запроса:
4182 +
4183 +{
4184 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4185 + "Balance": 0 ~/~/ Значение баланса.
4186 +}
4187 +
4188 +Ответ: Success
4189 +
4190 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4191 +
4192 +(% class="box warningmessage" %)
4193 +(((
4194 +**PUT /api/v3/billing/client/balance/deposit**
4195 +)))
4196 +
4197 +Создает операцию **Пополнение **с указанной суммой
4198 +
4199 +Тело запроса:
4200 +
4201 +(((
4202 +{
4203 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4204 + "amount": 0 ~/~/ Сумма пополнения баланса 
4205 +}
4206 +)))
4207 +
4208 +(((
4209 +
4210 +)))
4211 +
4212 +Ответ: Success
4213 +
4214 +(((
4215 +{
4216 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4217 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4218 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4219 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4220 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4221 + "Description": "string" ~/~/ Описание корректировки.
4222 +}
4223 +)))
4224 +
4225 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4226 +
4227 +Создает операцию **Списание **с указанной суммой
4228 +
4229 +(% class="box warningmessage" %)
4230 +(((
4231 +**PUT /api/v3/billing/client/balance/withdraw**
4232 +)))
4233 +
4234 +Тело запроса:
4235 +
4236 +(((
4237 +{
4238 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4239 + "amount": 0 ~/~/ Сумма списания с баланса
4240 +}
4241 +)))
4242 +
4243 +Ответ: Success
4244 +
4245 +(((
4246 +{
4247 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4248 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4249 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4250 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4251 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4252 + "Description": "string" ~/~/ Описание корректировки
4253 +}
4254 +)))
4255 +
4256 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4257 +
4258 +(% class="box warningmessage" %)
4259 +(((
4260 +**PUT /api/v3/Billing/client/constraint**
4261 +)))
4262 +
4263 +Тело запроса:
4264 +
4265 +(((
4266 +{
4267 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4268 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4269 + "PermissibleBalance": 0, ~/~/ Допустимый баланс
4270 + "DefermentDays": 0, ~/~/ Отсрочка (дни).
4271 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4272 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4273 +}
4274 +)))
4275 +
4276 +(((
4277 +
4278 +)))
4279 +
4280 +Ответ: Success
4281 +
4282 +(((
4283 +{
4284 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4285 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4286 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4287 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4288 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4289 + "DefermentDays": 0, ~/~/ Отсрочка (дни)
4290 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4291 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4292 +}
4293 +)))
4294 +
4295 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4296 +
4297 +(% class="box warningmessage" %)
4298 +(((
4299 +**PUT /api/v3/Billing/client/plan**
4300 +)))
4301 +
4302 +Тело запроса:
4303 +
4304 +{
4305 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4306 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4307 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4308 + {
4309 + "Feature": "string", ~/~/ Код услуги.
4310 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4311 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4312 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4313 + "Price": 0, ~/~/ Цена за единицу.
4314 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4315 + "PeriodValue": 0, ~/~/ Значение периода.
4316 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4317 + }
4318 + ]
4319 +}
4320 +
4321 +
4322 +Ответ: Success
4323 +
4324 +(((
4325 +{
4326 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4327 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4328 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4329 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4330 + "Name": "string", ~/~/ Наименование.
4331 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4332 + "Constraint": { ~/~/ Ограничения по тарифу 
4333 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4334 + "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4335 + "DefermentDays": 0 ~/~/ Отсрочка (дни)
4336 + },
4337 + "Features": [ ~/~/ Набор услуг по тарифному плану.
4338 + {
4339 + "Feature": "string", ~/~/Код услуги.
4340 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4341 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4342 + "Price": 0, ~/~/ Цена за единицу.
4343 + "PeriodValue": 0, ~/~/ Значение периода.
4344 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4345 + }
4346 + ],
4347 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4348 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4349 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4350 + },
4351 + "Features": [ ~/~/ Набор услуг по тарифу клиента.
4352 + {
4353 + "Feature": "string", ~/~/ Код услуги.
4354 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4355 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4356 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4357 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4358 + "Price": 0, ~/~/ Цена за единицу.
4359 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4360 + "PeriodValue": 0, ~/~/ Значение периода.
4361 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4362 + "Quantity": 0 ~/~/ Количество использования услуги.
4363 + }
4364 + ]
4365 +}
4366 +)))
4367 +
4368 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4369 +
4370 +(% class="box warningmessage" %)
4371 +(((
4372 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4373 +)))
4374 +
4375 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4376 +
4377 +(% class="box infomessage" %)
4378 +(((
4379 +**POST /api/v3/vehicles/import/{agentId}**
4380 +)))
4381 +
4382 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4383 +
4384 +В пути указывается **agentId** - id клиента.
4385 +
4386 +**Заголовок**
4387 +
4388 +**X-Auth: [токен авторизации]**
4389 +
4390 +**Параметры**
4391 +
4392 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4393 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4394 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4395 +
4396 +В теле использовать тип **form-data,** тип значения** file**
4397 +
4398 +**Ключи**
4399 +
4400 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4401 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
4402 +|csv|В значении передаем файл датчиков, формат **csv**
4403 +
4404 +Ответ:
4405 +
4406 +{
4407 + "vehicleId": 0,
4408 + "name": "string",
4409 + "errors": ["string"]
4410 +}
4411 +
4412 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4413 +|vehicleId|ID созданного объекта
4414 +|name|Имя созданного объекта
4415 +|errors|Ошибки и их описание
4416 +
4417 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4418 +
4419 +(% class="box infomessage" %)
4420 +(((
4421 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4422 +)))
4423 +
4424 +(% class="wikigeneratedid" %)
4425 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4426 +
4427 +(% class="wikigeneratedid" %)
4428 +В пути указывается **vehicleId **- id объекта.
4429 +
4430 +**Заголовок**
4431 +
4432 +**X-Auth: [токен авторизации]**
4433 +
4434 +В теле использовать тип **form-data.**
4435 +
4436 +Ключи:
4437 +
4438 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4439 +|**history**|В значении передавать файл с историей
4440 +
4441 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4442 +
4443 +Ответ:
4444 +
4445 +{
4446 + "results": [
4447 + {
4448 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4449 + "vehicleId": 0,
4450 + "errors": [
4451 + "string"
4452 + ],
4453 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
4454 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
4455 + "producedCount": 0,
4456 + "msgCount": 0
4457 + }
4458 + ]
4459 +}
4460 +
4461 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4462 +|results|Результаты импорта в разрезе ТС
4463 +|vehicleGuid|Guid ТС
4464 +|vehicleId|ID ТС
4465 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4466 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
4467 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4468 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
4469 +|msgCount|Кол-во обработанных сообщений всего
4470 +
4471 +== **Импортировать историю ТС (Асинхронный запрос)** ==
4472 +
4473 +(% class="box successmessage" %)
4474 +(((
4475 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4476 +)))
4477 +
4478 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4479 +
4480 +Метод запроса: **POST**
4481 +
4482 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4483 +
4484 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4485 +
4486 +
4487 +Ответ:
4488 +
4489 +{
4490 +
4491 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4492 +
4493 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4494 +
4495 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4496 +
4497 + "Message": "string", ~/~/ Информация о выполнении запроса
4498 +
4499 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4500 +
4501 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4502 +
4503 + "Data": "string" ~/~/ Данные
4504 +
4505 +}
4506 +
4507 +
4508 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4509 +
4510 +(% class="box infomessage" %)
4511 +(((
4512 +**GET /api/v3/vehicles/import/history/status**
4513 +)))
4514 +
4515 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4516 +
4517 +Ответ:
4518 +
4519 +{
4520 + "activity": true,
4521 + "progress": 0,
4522 + "message": "string"
4523 +}
4524 +
4525 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4526 +**Параметр**
4527 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4528 +**Описание**
4529 +)))
4530 +|(((
4531 +activity
4532 +)))|(((
4533 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4534 +)))
4535 +|(((
4536 +progress
4537 +)))|(((
4538 +Guid ТС
4539 +)))
4540 +
4541 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4542 +
4543 +(% class="box infomessage" %)
4544 +(((
4545 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4546 +)))
4547 +
4548 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4549 +
4550 +Метод запроса: **GET**
4551 +
4552 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4553 +
4554 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4555 +
4556 +
4557 +Ответ:
4558 +
4559 +{
4560 +
4561 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4562 +
4563 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4564 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4565 +
4566 + "Message": "string", ~/~/ Информация о выполнении запроса
4567 +
4568 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4569 +
4570 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4571 +
4572 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4573 +
4574 + "Data": "string" ~/~/ Данные
4575 +
4576 +}
4577 +
4578 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4579 +
4580 +(% class="box infomessage" %)
4581 +(((
4582 +**POST /api/v3/vehicles/export**
4583 +)))
4584 +
4585 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4586 +
4587 +Тело запроса:
4588 +
4589 +[
4590 + id
4591 +]
4592 +
4593 +Ответ: Success 200, получаете файлы с настройками.
4594 +
4595 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4596 +
4597 +(% class="box infomessage" %)
4598 +(((
4599 +**POST /api/v3/vehicles/export/history**
4600 +)))
4601 +
4602 +Метод возвращает список сообщений терминала объекта за выбранный период.
4603 +
4604 +Тело запроса:
4605 +
4606 +{
4607 + "vehicleId": 0,
4608 + "asArchive": true,
4609 + "from": "2023-09-27T12:17:45.973Z",
4610 + "to": "2023-09-27T12:17:45.973Z"
4611 +}
4612 +
4613 +Ответ:
4614 +
4615 +Получаете файл. Сообщение: Code 200/Success
4616 +
4617 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4618 +|vehicleId|ID объекта
4619 +|asArchive|true - Архивировать файл, False - не архивировать
4620 +|from|Дата и время начала запроса
4621 +|to|Дата и время окончания запроса
4622 +
4623 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4624 +
4625 +(% class="box infomessage" %)
4626 +(((
4627 +**GET /api/v3/vehicles/export/history/status**
4628 +)))
4629 +
4630 +Метод возвращает список сообщений терминала объекта за выбранный период.
4631 +
4632 +Ответ:
4633 +
4634 +{
4635 + "activity": true,
4636 + "progress": 0,
4637 + "message": "string"
4638 +}
4639 +
4640 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4641 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4642 +|progress|Прогресс экспорта, от 0 до 100%
4643 +|message|Текст описывающий статус
4644 +
4645 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4646 +
4647 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4648 +
4649 +(% class="box infomessage" %)
4650 +(((
4651 +**POST /api/v3/EcoDriving/rating**
4652 +)))
4653 +
4654 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4655 +
4656 +Тело запроса:
4657 +
4658 +{
4659 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4660 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4661 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4662 +}
4663 +
4664 +Ответ:
4665 +
4666 +{
4667 + "items": [  ~/~/ Список в разрезе ТС
4668 + {
4669 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4670 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4671 + "vehicleId": 0, ~/~/ ID ТС
4672 + "vehicleName": "string", ~/~/ Название ТС
4673 + "vehicleModel": "string", ~/~/ Модель ТС
4674 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4675 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4676 + "totalViolations": 0, ~/~/ Нарушений всего
4677 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4678 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4679 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4680 + "brakingViolations": 0, ~/~/ Нарушений торможения
4681 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4682 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4683 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4684 + },
4685 +
4686 +(((
4687 +
4688 +)))
4689 +
4690 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4691 + "mileage": 0, ~/~/ Пробег, м
4692 + "tripsCount": 0, ~/~/ Кол-во рейсов
4693 + "trips": [  ~/~/ Информация по рейсу
4694 + {
4695 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4696 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4697 + "violationsCount": 0, ~/~/ Всего нарушений
4698 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4699 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4700 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4701 + "brakingViolations": 0, ~/~/ Нарушений торможения
4702 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4703 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4704 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4705 + },
4706 +
4707 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4708 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4709 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4710 + "mileage": 0, ~/~/ Пробег, м
4711 + "motohours": 0, ~/~/ Моточасы, секунды
4712 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4713 + "startAddress": "string", ~/~/ Адрес начала рейса
4714 + "endAddress": "string", ~/~/ Адрес конца рейса
4715 + "drivers": [  ~/~/ Список водителей
4716 + {
4717 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4718 + "driverName": "string", ~/~/ФИО водителя
4719 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4720 + }
4721 + ]
4722 + }
4723 + ]
4724 + }
4725 + ]
4726 +}
4727 +
4728 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4729 +
4730 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4731 +
4732 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4733 +
4734 +(% class="box infomessage" %)
4735 +(((
4736 +**POST /api/v3/fuelcards/transactions**
4737 +)))
4738 +
4739 +Метод запроса: POST
4740 +
4741 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4742 +\\В заголовках запроса: X-Auth: Токен авторизации
4743 +
4744 +Параметры в теле запроса (JSON):
4745 +
4746 +{
4747 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4748 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4749 + "ids": [ 
4750 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4751 + ],
4752 + "timezone": 0 ~/~/ Часовой пояс
4753 +}
4754 +
4755 +
4756 +Ответ:
4757 + {
4758 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4759 + "driver": "string", ~/~/ Водители, привязанные к ТК
4760 + "object": "string", ~/~/ Наименование ТС
4761 + "amount": 0, ~/~/ Количество топлива
4762 + "amountDut": 0, ~/~/ Количество по ДУТ
4763 + "amountDiff": 0, ~/~/ Разница, л
4764 + "amountDiffPerc": 0, ~/~/ Разница, %
4765 + "summa": 0, ~/~/ Стоимость, руб
4766 + "serviceName": "string", ~/~/ Тип топлива
4767 + "price": 0, ~/~/ Цена за литр, руб
4768 + "cardName": "string", ~/~/ Наименование ТК
4769 + "cardNum": "string", ~/~/ Номер ТК
4770 + "operator": "string", ~/~/ Оператор ТК
4771 + "address": "string" ~/~/ Адрес АЗС
4772 + }
4773 +
4774 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4775 +
4776 +(% class="box infomessage" %)
4777 +(((
4778 +**GET /api/v3/fuelcards**
4779 +)))
4780 +
4781 +Метод запроса: GET
4782 +
4783 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4784 +
4785 +Ответ:
4786 +
4787 +[
4788 + {
4789 + "Name": "string", ~/~/ Определяет наименование карты.
4790 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4791 + "Number": "string", ~/~/ Определяет № карты.
4792 + "Enabled": true, ~/~/ Определяет признак активности карты.
4793 + "Description": "string", ~/~/ Определяет описание карты.
4794 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4795 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4796 + "deleted": true ~/~/ Признак удаления
4797 + }
4798 +]
4799 +
4800 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4801 +
4802 +
4803 +== **Получение полных данных о ретрансляторе** ==
4804 +
4805 +(% class="box infomessage" %)
4806 +(((
4807 +**GET ** **/api/v3/retranslations/{id}**
4808 +)))
4809 +
4810 +id - Идентификатор ретранслятора
4811 +
4812 +
4813 +Пример ответа:
4814 +
4815 +{  
4816 +"description": "", ~/~/ Поле описания ретранслятора
4817 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4818 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4819 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4820 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4821 +"objects": [ ~/~/ Объекты для ретрансляции
4822 +{      
4823 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4824 +"name": "", ~/~/ Наименование объекта ретрансляции
4825 +"imei": "", ~/~/ IMEI объекта  ретрансляции
4826 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4827 +}
4828 + ],  
4829 +"id": "", ~/~/ Идентификатор ретранслятора 
4830 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4831 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4832 +}
4833 +
4834 +
4835 +== **Удаление данных ретранслятора** ==
4836 +
4837 +(% class="box infomessage" %)
4838 +(((
4839 +**DELETE** **/api/v3/retranslations/{id}**
4840 +)))
4841 +
4842 +id - Идентификатор ретранслятора
4843 +
4844 +
4845 +== **Создание ретранслятора** ==
4846 +
4847 +(% class="box infomessage" %)
4848 +(((
4849 +**POST ** **/api/v3/retranslations/{id}**
4850 +)))
4851 +
4852 +Запрос:
4853 +
4854 +{  
4855 +"description": "", ~/~/ Поле описания ретранслятора
4856 +"subscriberId": "", ~/~/ Идентификатор подписчика
4857 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4858 +"address": "", ~/~/ Адрес и порт принимающего сервера
4859 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4860 +"objects": [ ~/~/Объекты для ретрансляции
4861 +{      
4862 +"id": "", ~/~/ Идентификатор ретранслятора 
4863 +"imei": "", ~/~/ IMEI объекта ретрансляции
4864 +"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4865 +}
4866 + ]
4867 +}
4868 +
4869 +
4870 +Ответ:
4871 +
4872 +{  
4873 +"description": "", ~/~/ Поле описания ретранслятора
4874 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4875 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4876 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4877 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4878 +"objects": [ ~/~/ Объекты для ретрансляции
4879 +{      
4880 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4881 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4882 +"imei": "", ~/~/ IMEI объекта ретрансляции
4883 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4884 +}
4885 + ],
4886 +"id": "", ~/~/ Идентификатор ретранслятора   
4887 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4888 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4889 +}
4890 +
4891 +
4892 +== **Редактирование ретранслятора** ==
4893 +
4894 +(% class="box infomessage" %)
4895 +(((
4896 +**PUT** **/api/v3/retranslations**
4897 +)))
4898 +
4899 +Пример запроса:
4900 +
4901 +{  
4902 +"id": "", ~/~/ Идентификатор ретранслятора   
4903 +"description": "string", ~/~/ Поле описания ретранслятора
4904 +"subscriberId": "", ~/~/ Идентификатор подписчика
4905 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4906 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4907 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4908 +"objects": ~/~/ Объекты для ретрансляции
4909 +[    
4910 +{      
4911 +"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4912 +"imei": "", ~/~/ IMEI объекта ретрансляции
4913 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4914 +}
4915 + ]
4916 +}
4917 +
4918 +
4919 +Пример ответа:
4920 +
4921 +{  
4922 +"description": "", ~/~/ Поле описания ретранслятора
4923 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4924 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4925 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4926 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4927 +"objects": [ ~/~/ Объекты для ретрансляции
4928 +{      
4929 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4930 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4931 +"imei": "", ~/~/ IMEI объекта ретрансляции
4932 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4933 +}
4934 + ],
4935 +"id": "", ~/~/ Идентификатор ретранслятора   
4936 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4937 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4938 +}
4939 +
4940 +
4941 +== **Получение списка ретранслятора клиента** ==
4942 +
4943 +(% class="box infomessage" %)
4944 +(((
4945 +**POST /api/v3/retranslations/find**
4946 +)))
4947 +
4948 +Пример запроса:
4949 +
4950 +{  
4951 +"id": "", ~/~/ Идентификатор ретранслятора   
4952 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4953 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4954 +}
4955 +
4956 +Ответ:
4957 +
4958 +[ 
4959 +{    
4960 +"description": "", ~/~/ Поле описания ретранслятора
4961 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4962 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4963 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4964 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4965 +"id": "", ~/~/ Идентификатор ретранслятора   
4966 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4967 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4968 +}
4969 +]
4970 +
4971 +
4972 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4973 +
4974 +== **API для отчета по выгрузке комбайнов** ==
4975 +
4976 +(% class="box infomessage" %)
4977 +(((
4978 +**POST /api/v3/Reports/harvesterUnloading**
4979 +)))
4980 +
4981 +Пример запроса:
4982 +
4983 +{
4984 + "byTime": 0, ~/~/ Объединение событий по времени
4985 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4986 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4987 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4988 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4989 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4990 + 0
4991 + ],
4992 + "from": "", ~/~/ Дата и время начало запроса
4993 + "to": "", ~/~/ Дата и время окончания запроса
4994 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4995 +}
4996 +
4997 +Пример ответа:
4998 +
4999 +[ 
5000 + {
5001 + "harvesterName": "", ~/~/Комбайн, номер
5002 + "harvesterId": 0, ~/~/Комбайн, id
5003 +"harvesterModel": "", ~/~/ Модель комбайна
5004 +"hopperCapacity": 0, ~/~/ Объем бункера м3
5005 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
5006 + "events": [ ~/~/Список событий в разрезе комбайна
5007 + {
5008 + "driverId": "", ~/~/Идентификатор водителя
5009 + "driverName": "", ~/~/Водитель комбайна, ФИО
5010 + "RFID": "", ~/~/ идентификатор карты-метки
5011 + "rfidName": "", ~/~/Водитель комбайна, имя метки
5012 + "vehicleId": 0, ~/~/идентификатор объекта
5013 + "vehicleName": "string", ~/~/ Имя объекта
5014 + "modelName": "string", ~/~/ Имя модели объекта
5015 + "nearestVehicles": [ ~/~/Объекты рядом
5016 + {
5017 + "vehicleId": 0, ~/~/идентификатор объекта
5018 + "vehicleName": "string" ~/~/ Имя объекта
5019 + }
5020 + ],
5021 + "fields": [ ~/~/Поля, где происходила выгрузка
5022 + {
5023 + "id": 0, ~/~/ идентификатор пользователя 
5024 + "name": "string" ~/~/ имя пользователя 
5025 + }
5026 + ],
5027 + "event": "string", ~/~/Событие
5028 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
5029 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
5030 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
5031 + "cultureName": "string", ~/~/ название культуры
5032 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
5033 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
5034 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
5035 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
5036 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
5037 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
5038 + "issued": 0, ~/~/Выдано, бункеров
5039 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
5040 + "latitude": 0, ~/~/Широта
5041 + "longitude": 0, ~/~/ Долгота
5042 + "litresAway": 0, ~/~/Отдано, л
5043 + "m3Away": 0 ~/~/Отдано, м3
5044 + }
5045 + ]
5046 + }
5047 +]
5048 +
5049 +
5050 +== **Отчет трек-датчики** ==
5051 +
5052 +(% class="box infomessage" %)
5053 +(((
5054 +**POST /api/v3/Reports/sensorsWorks**
5055 +)))
5056 +
5057 +**Пример запроса:**
5058 +
5059 +{
5060 + "vehicleIds": [ ~/~/ Список ID объектов
5061 + 0
5062 + ],
5063 + "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
5064 + "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
5065 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5066 +}
5067 +
5068 +**Пример ответа:**
5069 +
5070 +(((
5071 +{
5072 + "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
5073 + {
5074 + "vehicleId": 0, ~/~/ Идентификатор ТС
5075 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
5076 + {
5077 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
5078 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
5079 + "duration": 0, ~/~/  Продолжительность интервала в секундах.
5080 + "name": "string", ~/~/ Наименование оборудования.
5081 + "mileage": 0, ~/~/ Пробег за время работы оборудования.
5082 + "totalMileage": 0, ~/~/ Общий пробег.
5083 + "avgSpeed": 0 ~/~/ Средняя скорость.
5084 + }
5085 + ]
5086 + }
5087 + ]
5088 +}
5089 +
5090 +
5091 +== **Превышение скорости** ==
5092 +
5093 +(% class="box infomessage" %)
5094 +(((
5095 +**POST /api/v3/Reports/overSpeedDuration**
5096 +)))
5097 +
5098 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
5099 +
5100 +Пример запроса:
5101 +
5102 +(((
5103 +{
5104 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
5105 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
5106 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
5107 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5108 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
5109 +}
5110 +)))
5111 +
5112 +(((
5113 +
5114 +)))
5115 +
5116 +(((
5117 +Пример ответа:
5118 +)))
5119 +
5120 +(((
5121 +(((
5122 +[
5123 + {
5124 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
5125 + "duration": 0, ~/~/ Продолжительность события в секундах 
5126 + "maxSpeed": 0, ~/~/ Максимальная скорость 
5127 + "speedLimit": 0 ~/~/ Ограничение скорости 
5128 + }
5129 +]
5130 +)))
5131 +)))
5132 +)))
5133 +
5134 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
5135 +
5136 +
5137 +== **Запрос списка полей** ==
5138 +
5139 +(% class="box successmessage" %)
5140 +(((
5141 +**POST /api/v3/agroLands/find**
5142 +)))
5143 +
5144 +Пример запроса:
5145 +
5146 +(((
5147 +(((
5148 +(((
5149 +{
5150 + "year": 0, ~/~/ Фильтр по году
5151 + "name": "string", ~/~/ Фильтр по названию
5152 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
5153 +}
5154 +)))
5155 +)))
5156 +
5157 +
5158 +)))
5159 +
5160 +Пример ответа:
5161 +
5162 +(((
5163 +[
5164 + {
5165 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5166 + "year": 0, ~/~/ Год поля
5167 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
5168 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
5169 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5170 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5171 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5172 + "counts": { ~/~/ Счётчики с/х поля 
5173 + "fieldOperations": 0, ~/~/ Количество операций на поле
5174 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5175 + "facts": 0 ~/~/ Счётчик факта
5176 + },
5177 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5178 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5179 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5180 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5181 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5182 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5183 + "planComment": "string", ~/~/ Комментарий к полю
5184 + "productivity": 0, ~/~/ Урожайность.
5185 + "id": 0, ~/~/ Идентификатор объекта геозоны
5186 + "name": "string", ~/~/ Название объекта геозоны
5187 + "type": 0, ~/~/ Тип объекта геозоны
5188 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5189 + "fname": "string", ~/~/ Имя файла
5190 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5191 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
5192 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
5193 + "description": "string", ~/~/ Описание объекта геозоны
5194 + "area": 0, ~/~/ Площадь, м2
5195 + "perimetr": 0, ~/~/ Периметр, м
5196 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
5197 + }
5198 +]
5199 +
5200 +
5201 +== **Создание нового поля ** ==
5202 +
5203 +(% class="box successmessage" %)
5204 +(((
5205 +**POST /api/v3/agroLands**
5206 +)))
5207 +
5208 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5209 +X-agent  - ID клиента
5210 +
5211 +Пример запроса:
5212 +
5213 +(((
5214 +{
5215 + "extId": "string", 
5216 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5217 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5218 + "display": "string", ~/~/ Настройки отображения
5219 + "year": 0, ~/~/ Год поля
5220 + "name": "string", ~/~/ Наименование
5221 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5222 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5223 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5224 + "planComment": "string", ~/~/ Комментарий к полю
5225 + "cropRotations": [ ~/~/ Данные по севообороту
5226 + {
5227 + "landId": 0, ~/~/ ID поля
5228 + "landName": "string", ~/~/ Название поля
5229 + "year": 0, ~/~/ Год урожая
5230 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5231 + "cultureName": "string", ~/~/ Название культуры
5232 + "productivity": 0, ~/~/ Урожайность
5233 + "area": 0, ~/~/ Площадь поля, Га
5234 + "total": 0, ~/~/ Валовый сбор
5235 + "productivityFact": 0, ~/~/ Фактическая урожайность
5236 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5237 + "totalFact": 0, ~/~/ Фактический валовый сбор
5238 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5239 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5240 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5241 + "isyearplan": true, ~/~/ Годовой план 
5242 + "comment": "string" ~/~/ Комментарий
5243 + }
5244 + ]
5245 +}
5246 +)))
5247 +
5248 +(((
5249 +
5250 +)))
5251 +
5252 +Пример ответа:
5253 +
5254 +(((
5255 +(((
5256 +{
5257 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5258 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5259 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5260 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5261 + "cropRotations": [ ~/~/ Данные по севообороту
5262 + {
5263 + "landId": 0, ~/~/ ID поля
5264 + "landName": "string", ~/~/ Название поля
5265 + "year": 0, ~/~/ Год урожая 
5266 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5267 + "cultureName": "string", ~/~/ Название культуры
5268 + "productivity": 0, ~/~/ Урожайность
5269 + "area": 0, ~/~/ Площадь поля, Га.
5270 + "total": 0, ~/~/ Валовый сбор
5271 + "productivityFact": 0, ~/~/ Фактическая урожайность
5272 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5273 + "totalFact": 0, ~/~/ Фактический валовый сбор
5274 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5275 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5276 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5277 + "isyearplan": true, ~/~/ годовой план 
5278 + "comment": "string" ~/~/ Комментарий
5279 + }
5280 + ],
5281 + "cropVegetation": [ ~/~/ История вегетации поля
5282 + {
5283 + "values": [  ~/~/ Данные вегетации и состояния посева
5284 + {
5285 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5286 + "ndvi": 0 ~/~/ Индекс вегетации
5287 + }
5288 + ],
5289 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5290 + {
5291 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5292 + "type": "string", ~/~/ Тип
5293 + "pictureid": "string" ~/~/ Идентификатор ресурса
5294 + }
5295 + ],
5296 + "states": [ ~/~/ Ключевые даты развития поля
5297 + {
5298 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5299 + "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5300 + }
5301 + ]
5302 + }
5303 + ],
5304 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5305 + "counts": {
5306 + "fieldOperations": 0, ~/~/ Количество операций на поле
5307 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5308 + "facts": 0 ~/~/ Счётчик факта
5309 + },
5310 + "planComment": "string", ~/~/ Комментарий к полю
5311 +)))
5312 +
5313 +(((
5314 + "productivity": 0, ~/~/ Урожайность.
5315 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5316 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5317 + "year": 0, ~/~/ Год поля
5318 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5319 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5320 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5321 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5322 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5323 + "id": 0, ~/~/ Идентификатор объекта геозоны
5324 + "name": "string", ~/~/ Название объекта геозоны
5325 + "type": 0, ~/~/ Тип объекта геозоны
5326 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5327 + "fname": "string", ~/~/ Имя файла
5328 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5329 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5330 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5331 + "description": "string", ~/~/ Описание объекта геозоны
5332 + "area": 0, ~/~/ Площадь, м2
5333 + "perimetr": 0, ~/~/ Периметр, м
5334 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5335 +}
5336 +
5337 +
5338 +)))
5339 +)))
5340 +)))
5341 +
5342 +== **Получение поля по id** ==
5343 +
5344 +(% class="box infomessage" %)
5345 +(((
5346 +**GET /api/v3/agroLands/{id}**
5347 +)))
5348 +
5349 +Пример запроса:
5350 +id  ~/~/ Идентификатор поля
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-20T07:45:52.611Z", ~/~/ Дата начала работ
5374 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5375 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5376 + "isyearplan": true, ~/~/ План года 
5377 + "comment": "string" ~/~/ Комментарий
5378 + }
5379 + ],
5380 + "cropVegetation": [ ~/~/ История вегетации поля
5381 + {
5382 + "values": [ ~/~/ Данные вегетации и состояния посева
5383 + {
5384 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5385 + "ndvi": 0 ~/~/ Индекс вегетации
5386 + }
5387 + ],
5388 + "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5389 + {
5390 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5391 + "type": "string", ~/~/ Тип 
5392 + "pictureid": "string" ~/~/ Идентификатор ресурса
5393 + }
5394 + ],
5395 + "states": [ ~/~/ Ключевые даты развития поля
5396 + {
5397 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5398 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5399 + }
5400 + ]
5401 + }
5402 + ],
5403 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5404 + "counts": {
5405 + "fieldOperations": 0, ~/~/ Количество операций на поле
5406 + "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5407 + "facts": 0 ~/~/ Счётчик факта
5408 + },
5409 + "planComment": "string", ~/~/ Комментарий к полю
5410 + "productivity": 0, ~/~/ Урожайность.
5411 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5412 +)))
5413 +
5414 +(((
5415 +(((
5416 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5417 + "year": 0, ~/~/ Год поля
5418 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5419 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5420 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5421 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5422 + "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5423 + "id": 0, ~/~/ Идентификатор объекта геозоны
5424 + "name": "string", ~/~/ Название объекта геозоны
5425 + "type": 0, ~/~/ Тип объекта геозоны 
5426 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5427 + "fname": "string", ~/~/ Имя файла
5428 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5429 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5430 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5431 + "description": "string", ~/~/ Описание объекта геозоны
5432 + "area": 0, ~/~/ Площадь, м2
5433 + "perimetr": 0, ~/~/ Периметр, м
5434 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5435 +}
5436 +)))
5437 +
5438 +
5439 +(((
5440 +(((
5441 +(((
5442 +== **Изменение поля** ==
5443 +
5444 +(% class="box infomessage" %)
5445 +(((
5446 +**PUT /api/v3/agroLands**
5447 +)))
5448 +
5449 +Пример запроса:
5450 +
5451 +(((
5452 +(((
5453 +{
5454 + "id": 0, ~/~/ Идентификатор поля
5455 + "extId": "string", ~/~/ ExtId
5456 + "shape": "string", ~/~/ Форма поля
5457 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5458 + "display": "string", ~/~/ Настройки отображения
5459 + "year": 0, ~/~/ Год поля
5460 + "name": "string", ~/~/ Наименование
5461 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5462 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5463 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5464 + "planComment": "string", ~/~/Комментарий к полю
5465 + "cropRotations": [  ~/~/ Данные по севообороту
5466 + {
5467 + "landId": 0, ~/~/ ID поля
5468 + "landName": "string", ~/~/ Название поля
5469 + "year": 0, ~/~/ Год урожая
5470 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5471 + "cultureName": "string", ~/~/ Название культуры
5472 + "productivity": 0, ~/~/ Урожайность
5473 + "area": 0, ~/~/ Площадь поля, Га.
5474 + "total": 0, ~/~/ Валовый сбор
5475 + "productivityFact": 0, ~/~/ Фактическая урожайность
5476 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5477 + "totalFact": 0, ~/~/ Фактический валовый сбор
5478 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5479 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5480 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5481 + "isyearplan": true, 
5482 + "comment": "string" ~/~/ Комментарий
5483 + }
5484 + ],
5485 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5486 +}
5487 +)))
5488 +)))
5489 +
5490 +(((
5491 +
5492 +)))
5493 +
5494 +Пример ответа:
5495 +
5496 +(((
5497 +(((
5498 +(((
5499 +{
5500 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5501 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5502 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5503 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5504 + "cropRotations": [ ~/~/ Данные по севообороту
5505 + {
5506 + "landId": 0, ~/~/ ID поля
5507 + "landName": "string", ~/~/ Название поля
5508 + "year": 0, ~/~/  Год урожая
5509 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5510 + "cultureName": "string", ~/~/ Название культуры
5511 + "productivity": 0, ~/~/ Урожайность
5512 + "area": 0, ~/~/ Площадь поля, Га
5513 + "total": 0, ~/~/ Валовый сбор
5514 + "productivityFact": 0, ~/~/ Фактическая урожайность
5515 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5516 + "totalFact": 0, ~/~/ Фактический валовый сбор
5517 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5518 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5519 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5520 + "isyearplan": true, ~/~/ 
5521 + "comment": "string" ~/~/ Комментарий
5522 + }
5523 + ],
5524 + "cropVegetation": [ ~/~/ История вегетации поля
5525 + {
5526 + "values": [ ~/~/ Данные вегетации и состояния посева
5527 + {
5528 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5529 + "ndvi": 0 ~/~/ Индекс вегетации
5530 + }
5531 + ],
5532 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5533 + {
5534 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5535 + "type": "string", ~/~/ Тип
5536 + "pictureid": "string" ~/~/ Идентификатор ресурса
5537 + }
5538 + ],
5539 + "states": [ ~/~/ Ключевые даты развития поля 
5540 + {
5541 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5542 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5543 + }
5544 + ]
5545 + }
5546 + ],
5547 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5548 + "counts": { 
5549 + "fieldOperations": 0, ~/~/ Количество операций на поле
5550 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5551 + "facts": 0 ~/~/ Счётчик факта
5552 + },
5553 + "planComment": "string", ~/~/ Комментарий к полю
5554 + "productivity": 0, ~/~/ Урожайность.
5555 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5556 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5557 + "year": 0, ~/~/ Год поля
5558 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5559 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5560 + "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5561 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5562 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5563 + "id": 0, ~/~/ Идентификатор объекта геозоны
5564 + "name": "string", ~/~/ Название объекта геозоны
5565 + "type": 0, ~/~/ Тип объекта геозоны
5566 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5567 + "fname": "string", ~/~/ Имя файла
5568 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5569 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5570 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5571 + "description": "string", ~/~/ Описание объекта геозоны
5572 + "area": 0, ~/~/ Площадь, м2
5573 + "perimetr": 0, ~/~/ Периметр, м
5574 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5575 +}
5576 +)))
5577 +)))
5578 +)))
5579 +)))
5580 +)))
5581 +
5582 +
5583 +== **Редактирование года урожая ** ==
5584 +
5585 +(% class="box successmessage" %)
5586 +(((
5587 +**POST /api/v3/agroLands/updateOpenCloseYear**
5588 +)))
5589 +
5590 +Пример запроса:
5591 +
5592 +(((
5593 +(((
5594 +{
5595 + "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5596 + 0
5597 + ],
5598 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5599 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5600 +}
5601 +)))
5602 +
5603 +
5604 +)))
5605 +
5606 +Пример ответа:
5607 +
5608 +(((
5609 +(((
5610 +{
5611 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5612 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5613 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5614 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5615 + "cropRotations": [ ~/~/ Данные по севообороту
5616 + {
5617 + "landId": 0, ~/~/ ID поля
5618 + "landName": "string", ~/~/ Название поля
5619 + "year": 0, ~/~/ Год урожая
5620 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5621 + "cultureName": "string", ~/~/ Название культуры
5622 + "productivity": 0, ~/~/ Урожайность
5623 + "area": 0, ~/~/ Площадь поля, Га.
5624 + "total": 0, ~/~/ Валовый сбор
5625 + "productivityFact": 0, ~/~/ Фактическая урожайность
5626 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5627 + "totalFact": 0, ~/~/ Фактический валовый сбор
5628 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5629 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5630 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5631 + "isyearplan": true, ~/~/ 
5632 + "comment": "string" ~/~/ Комментарий
5633 + }
5634 + ],
5635 + "cropVegetation": [ ~/~/ История вегетации поля
5636 + {
5637 + "values": [ ~/~/ Данные вегетации и состояния посева
5638 + {
5639 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5640 + "ndvi": 0 ~/~/ Индекс вегетации
5641 + }
5642 + ],
5643 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5644 + {
5645 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5646 + "type": "string", ~/~/ Тип
5647 + "pictureid": "string" ~/~/ Идентификатор ресурса
5648 + }
5649 + ],
5650 + "states": [ ~/~/ Ключевые даты развития поля
5651 + {
5652 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5653 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5654 + }
5655 + ]
5656 + }
5657 + ],
5658 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5659 + "counts": { 
5660 + "fieldOperations": 0, ~/~/ Количество операций на поле
5661 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5662 + "facts": 0 ~/~/ Счётчик факта
5663 + },
5664 + "planComment": "string", ~/~/ Комментарий к полю
5665 + "productivity": 0, ~/~/ Урожайность.
5666 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5667 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5668 + "year": 0, ~/~/ Год поля
5669 + "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5670 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5671 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5672 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5673 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5674 + "id": 0, ~/~/ Идентификатор объекта геозоны
5675 + "name": "string", ~/~/ Название объекта геозоны
5676 + "type": 0, ~/~/ Тип объекта геозоны
5677 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5678 + "fname": "string", ~/~/ Имя файла
5679 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5680 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5681 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5682 + "description": "string", ~/~/ Описание объекта геозоны
5683 + "area": 0, ~/~/ Площадь, м2
5684 + "perimetr": 0, ~/~/ ериметр, м
5685 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5686 +}
5687 +
5688 +
5689 +== **Какие поля посещал объект** ==
5690 +
5691 +(% class="box successmessage" %)
5692 +(((
5693 +**POST /api/v3/agroLands/visitingByVehicle**
5694 +)))
5695 +
5696 +Пример запроса:
5697 +
5698 +{
5699 + "vehicleId": 0, ~/~/ id объекта 
5700 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5701 + "byTime": 0, ~/~/ Объединение событий по времени
5702 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5703 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5704 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5705 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5706 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5707 +}
5708 +
5709 +Пример ответа:
5710 +
5711 +[
5712 + {
5713 + "fieldId": 0, ~/~/ id объекта 
5714 + "vehicleName": "string", ~/~/ Наименование объекта 
5715 + "fieldName": "string", ~/~/ Наименование поля 
5716 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5717 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5718 + "vehicleId": 0, ~/~/ Идентификатор ТС
5719 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5720 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5721 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5722 + "mileage": 0 ~/~/ Пробег 
5723 + }
5724 +]
5725 +)))
5726 +
5727 +
5728 +== **Посещение поля объектами ** ==
5729 +
5730 +(% class="box successmessage" %)
5731 +(((
5732 +**POST /api/v3/agroLands/visitingByField**
5733 +)))
5734 +
5735 +Пример запроса:
5736 +{
5737 + "fieldId": 0, ~/~/ ID поля
5738 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5739 + "byTime": 0, ~/~/ Объединение событий по времени
5740 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5741 + "byDist": 0, ~/~/ Объединение событий по расстоянию
5742 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5743 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5744 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5745 +}
5746 +
5747 +Пример ответа:
5748 +
5749 +[
5750 + {
5751 + "fieldId": 0, ~/~/ ID поля
5752 + "vehicleName": "string", ~/~/ Наименование объекта 
5753 + "fieldName": "string", ~/~/ Имя поля
5754 + "fuelUsage": 0, ~/~/ Расход топлива, л/га
5755 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5756 + "vehicleId": 0, ~/~/ Идентификатор ТС
5757 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5758 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5759 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5760 + "mileage": 0 ~/~/ Пробег
5761 + }
5762 +]
5763 +
5764 +
5765 +== **Удаление существующего поля** ==
5766 +
5767 +(% class="box errormessage" %)
5768 +(((
5769 +**DELETE /api/v3/agroLands/{id}**
5770 +)))
5771 +
5772 +Пример запроса:
5773 +id  ~/~/ Идентификатор поля
5774 +
5775 +Пример ответа:
5776 +
5777 +(((
5778 +200 ~/~/ Успех
5779 +
5780 +
5781 +)))
5782 +
5783 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5784 +)))
5785 +)))
5786 +)))
5787 +
5788 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5789 +
5790 +
5791 +(% class="box infomessage" %)
5792 +(((
5793 +**GET api/v3/Vehicles/recyclebin/all**
5794 +)))
5795 +
5796 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5797 +
5798 +Параметр запроса: {parentId} - идентификатор агента
5799 +
5800 +В заголовках запроса: X-Auth: Токен авторизации
5801 +
5802 +Ответ:
5803 +
5804 +[ 
5805 + {
5806 + "recordTime": "", ~/~/Время записи
5807 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5808 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5809 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5810 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5811 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5812 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5813 + "items": [ ~/~/ 
5814 +nullable: true ~/~/Детали
5815 + {
5816 + "name": "string", ~/~/наименование столбца
5817 + "value": "string" ~/~/содержание столбца
5818 + }
5819 + ]
5820 + },
5821 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5822 + "string"
5823 + ]
5824 + }
5825 +]
5826 +
5827 +
5828 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5829 +
5830 +(% class="box infomessage" %)
5831 +(((
5832 +**POST api/v3/Vehicles/recyclebin/erase**
5833 +)))
5834 +
5835 +В заголовках запроса: X-Auth: Токен авторизации
5836 +
5837 +Пример запроса:
5838 +
5839 +[
5840 +0
5841 +]
5842 +
5843 +
5844 +Пример ответа:
5845 +
5846 +[ 
5847 +{
5848 + "recordTime": "", ~/~/Время записи
5849 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5850 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5851 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
5852 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5853 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5854 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5855 + "items": [ ~/~/Детали
5856 + {
5857 + "name": "", ~/~/Имя свойства
5858 + "value": "" ~/~/Значение свойства
5859 + }
5860 + ]
5861 + },
5862 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5863 + ""
5864 + ]
5865 + }
5866 +]
5867 +
5868 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5869 +
5870 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5871 +
5872 +(% class="box infomessage" %)
5873 +(((
5874 +**POST api/v3/Vehicles/recyclebin/restore**
5875 +)))
5876 +
5877 +В заголовках запроса: X-Auth: Токен авторизации
5878 +
5879 +Параметры в теле запроса (JSON):
5880 +
5881 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5882 +
5883 +В заголовках запроса: X-Auth: Токен авторизации
5884 +
5885 +
5886 +Пример запроса:
5887 +
5888 +(((
5889 +[
5890 +)))
5891 +
5892 +(((
5893 + 0
5894 +)))
5895 +
5896 +(((
5897 +]
5898 +)))
5899 +
5900 +
5901 +Пример ответа:
5902 +
5903 +[
5904 +{
5905 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5906 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5907 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5908 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5909 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5910 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5911 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5912 + "items": [ ~/~/Детали
5913 + {
5914 + "name": "string", ~/~/Имя свойства
5915 + "value": "string" ~/~/Значение свойства
5916 + }
5917 + ]
5918 + },
5919 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5920 + "string"
5921 + ]
5922 + }
5923 +]
5924 +
5925 +
5926 += **Раздел: Журнал заданий ** =
5927 +
5928 +
5929 +== **Создание задания в Журнале заданий** ==
5930 +
5931 +(% class="box infomessage" %)
5932 +(((
5933 +**POST /api/v3/vehicletasks**
5934 +)))
5935 +
5936 +Пример запроса:
5937 +
5938 +(((
5939 +{
5940 + "vehicleId": 0, ~/~/ Идентификатор ТС
5941 + "description": "string", ~/~/ Описание
5942 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5943 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5944 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5945 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5946 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5947 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5948 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5949 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5950 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5951 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5952 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5953 + "cost": { 
5954 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5955 + "Name": "string", ~/~/ Наименование
5956 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5957 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5958 + "Norm": 0 ~/~/ Норма внесения
5959 + },
5960 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5961 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5962 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5963 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5964 + "deleted": true, ~/~/ Признак удаления
5965 + "extId": "string", 
5966 + "GeoIds": [ ~/~/ Cвязанные поля
5967 + 0
5968 + ]
5969 +}
5970 +)))
5971 +
5972 +
5973 +Пример ответа:
5974 +
5975 +{
5976 + "vehicleId": 0, ~/~/ Идентификатор ТС
5977 + "description": "string", ~/~/ Описание
5978 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5979 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5980 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5981 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5982 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5983 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5984 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5985 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5986 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5987 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5988 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5989 + "cost": { 
5990 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5991 + "Name": "string", ~/~/ Наименование
5992 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5993 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5994 + "Norm": 0 ~/~/ Норма внесения
5995 + },
5996 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5997 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5998 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5999 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6000 + "deleted": true, ~/~/ Признак удаления
6001 + "extId": "string", ~/~/ ExtId
6002 + "GeoIds": [ ~/~/ Связанные поля
6003 + 0
6004 + ]
6005 +}
6006 +
6007 +
6008 +== **Редактирование задания в Журнале заданий** ==
6009 +
6010 +(% class="box successmessage" %)
6011 +(((
6012 +**PUT /api/v3/vehicletasks**
6013 +)))
6014 +
6015 +Пример запроса:
6016 +
6017 +(((
6018 +{
6019 + "vehicleId": 0, ~/~/ Идентификатор ТС
6020 + "description": "string", ~/~/ Описание
6021 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6022 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6023 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
6024 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
6025 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6026 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6027 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6028 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6029 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6030 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6031 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6032 + "cost": { 
6033 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6034 + "Name": "string", ~/~/ Наименование
6035 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6036 + "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6037 + "Norm": 0 ~/~/ Норма внесения
6038 + },
6039 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6040 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6041 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
6042 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
6043 + "deleted": true, ~/~/ Признак удаления
6044 + "extId": "string", ~/~/ ExtId
6045 + "GeoIds": [ ~/~/ Связанные поля
6046 + 0
6047 + ]
6048 +}
6049 +)))
6050 +
6051 +
6052 +Пример ответа:
6053 +
6054 +{
6055 + "vehicleId": 0, ~/~/ Идентификатор ТС
6056 + "description": "string", ~/~/ Описание
6057 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6058 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6059 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6060 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6061 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6062 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6063 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6064 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6065 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6066 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6067 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6068 + "cost": { 
6069 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6070 + "Name": "string", ~/~/ Наименование
6071 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6072 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6073 + "Norm": 0 ~/~/ Норма внесения
6074 + },
6075 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6076 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6077 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6078 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6079 + "deleted": true, ~/~/ Признак удаления
6080 + "extId": "string", ~/~/ ExtId
6081 + "GeoIds": [ ~/~/ Связанные поля
6082 + 0
6083 + ]
6084 +}
6085 +
6086 +
6087 +== **Удаление задания в Журнале заданий** ==
6088 +
6089 +(% class="box warningmessage" %)
6090 +(((
6091 +**DELETE /api/v3/vehicletasks**
6092 +)))
6093 +
6094 +Пример запроса:
6095 +
6096 +(((
6097 +[
6098 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
6099 +]
6100 +)))
6101 +
6102 +(((
6103 +
6104 +)))
6105 +
6106 +Пример ответа:
6107 +
6108 +{
6109 + "vehicleId": 0, ~/~/ Идентификатор ТС
6110 + "description": "string", ~/~/ Описание
6111 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6112 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6113 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6114 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6115 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6116 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6117 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6118 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6119 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6120 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6121 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6122 + "cost": { 
6123 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6124 + "Name": "string", ~/~/ Наименование
6125 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6126 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6127 + "Norm": 0 ~/~/ Норма внесения
6128 + },
6129 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6130 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6131 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6132 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6133 + "deleted": true, ~/~/ Признак удаления
6134 + "extId": "string", ~/~/ ExtId
6135 + "GeoIds": [ ~/~/ Связанные поля
6136 + 0
6137 + ]
6138 +}
6139 +
6140 +
6141 +== **Получение списка Журнала заданий** ==
6142 +
6143 +(% class="box infomessage" %)
6144 +(((
6145 +**POST /api/v3/vehicletasks/getbyperiod**
6146 +)))
6147 +
6148 +Пример запроса:
6149 +
6150 +(((
6151 +{
6152 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
6153 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
6154 + "TimeZone": 0, ~/~/ Часовой пояс.
6155 + "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
6156 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
6157 + ],
6158 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
6159 + 0
6160 + ],
6161 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
6162 + 0
6163 + ],
6164 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
6165 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
6166 +}
6167 +)))
6168 +
6169 +
6170 +Пример ответа:
6171 +
6172 +(((
6173 +{
6174 + "total": 0,  ~/~/ Общее количество записей
6175 + "pages": 0,  ~/~/ Общее количество страниц
6176 + "currentPage": 0, ~/~/ Текущая страница
6177 + "items": [  ~/~/ Записи 
6178 + {
6179 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6180 + "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
6181 + "name": "string", ~/~/ Название задания.
6182 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
6183 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
6184 + "workKind": "string", ~/~/ Вид работ
6185 + "techOp": "string", ~/~/ Тех. операция
6186 + "trailerModel": "string", ~/~/ Модель агрегата
6187 + "width": "string", ~/~/ Ширина, м
6188 + "speed": "string", ~/~/ Тех. скорость
6189 + "fields": "string", ~/~/ Поля
6190 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
6191 + "vehicles": "string", ~/~/ Объект-модель
6192 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
6193 + "drivers": "string", ~/~/ Водители
6194 + "tmc": "string", ~/~/ ТМЦ
6195 + "client": "string", ~/~/  Клиент
6196 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6197 + "dep": "string", ~/~/ Подразделение
6198 + "geoIds": [ ~/~/  Связанные поля
6199 + 0
6200 + ]
6201 + }
6202 + ]
6203 +}
6204 +)))
6205 +
6206 +
6207 += **Раздел: Роли** =
6208 +
6209 +== **Получение списка клиентских и системных ролей пользователя ** ==
6210 +
6211 +(% class="box successmessage" %)
6212 +(((
6213 +**POST /api/v3/groups/find**
6214 +)))
6215 +
6216 +Пример запроса:
6217 +
6218 +(((
6219 +{
6220 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6221 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6222 +}
6223 +)))
6224 +
6225 +(((
6226 +
6227 +)))
6228 +
6229 +(((
6230 +Пример ответа:
6231 +)))
6232 +
6233 +(((
6234 +(((
6235 +{
6236 + "groups": [  ~/~/ Системные роли пользователя
6237 + {
6238 + "code": "string", ~/~/ Код роли.
6239 + "name": "string", ~/~/ Имя  
6240 + "shortName": "string" ~/~/ Короткое имя 
6241 + }
6242 + ],
6243 + "customGroups": [ ~/~/ Системные роли пользователя
6244 + {
6245 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6246 + "name": "string", ~/~/ Наименование 
6247 + "shortName": "string", ~/~/ Короткое наименование 
6248 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6249 + }
6250 + ]
6251 +}
6252 +)))
6253 +)))
6254 +
6255 +(((
6256 +
6257 +)))
6258 +
6259 +(((
6260 +
6261 +)))
6262 +
6263 += **Раздел: Локатор ** =
6264 +
6265 +
6266 +== **Получение данных по локатору** ==
6267 +
6268 +(% class="box infomessage" %)
6269 +(((
6270 +**GET /api/v3/locators/{locatorId}**
6271 +)))
6272 +
6273 +В запросе указывается locatorid - идентификатор локатора
6274 +
6275 +
6276 +Пример ответа:
6277 +
6278 +(((
6279 +(((
6280 +{
6281 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6282 + 0
6283 + ],
6284 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6285 + 0
6286 + ],
6287 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6288 + 0
6289 + ],
6290 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6291 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6292 + "agentName": "string", ~/~/ Наименование агента.
6293 + "isEnabled": true, ~/~/ Активность 
6294 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6295 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6296 + "name": "string", ~/~/ Наименование.
6297 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6298 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6299 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6300 + "validity": 0, ~/~/ Значение срока действия
6301 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6302 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6303 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6304 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6305 + "url": "string", ~/~/ Ссылка
6306 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6307 +
6308 + "showVehicleName": true, ~/~/ Наименование объекта
6309 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6310 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6311 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6312 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6313 + "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ГИС)
6314 +
6315 + 1
6316 +
6317 + ]
6318 +}
6319 +)))
6320 +)))
6321 +
6322 +
6323 +(((
6324 +(((
6325 +
6326 +)))
6327 +)))
6328 +
6329 +
6330 +== **Создание локатора** ==
6331 +
6332 +(% class="box successmessage" %)
6333 +(((
6334 +**POST /api/v3/locators**
6335 +)))
6336 +
6337 +Пример запроса:
6338 +
6339 +(((
6340 +{
6341 + "isEnabled": true, ~/~/ Активность
6342 + "name": "string", ~/~/ Наименование локатора
6343 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
6344 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
6345 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6346 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6347 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6348 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6349 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6350 + 0
6351 + ],
6352 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6353 + 0
6354 + ],
6355 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6356 + 0
6357 + ],
6358 +
6359 + "showVehicleName": true, ~/~/ Наименование объекта
6360 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6361 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6362 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6363 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6364 + "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ГИС)
6365 +
6366 + 1
6367 +
6368 + ]
6369 +}
6370 +)))
6371 +
6372 +
6373 +Пример ответа:
6374 +
6375 +(((
6376 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
6377 +)))
6378 +
6379 +
6380 +== **Выводит список локаторов ** ==
6381 +
6382 +(% class="box successmessage" %)
6383 +(((
6384 +**POST /api/v3/locators/find**
6385 +)))
6386 +
6387 +Пример запроса:
6388 +
6389 +(((
6390 +{
6391 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6392 +}
6393 +)))
6394 +
6395 +(((
6396 +
6397 +)))
6398 +
6399 +(((
6400 +
6401 +)))
6402 +
6403 +
6404 +Пример ответа:
6405 +
6406 +(((
6407 +[
6408 + {
6409 + "vehiclesCount": 0, ~/~/ Количество объектов.
6410 + "geozonesCount": 0, ~/~/ Количество геозон.
6411 + "fieldsCount": 0, ~/~/ Количество полей.
6412 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6413 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6414 + "agentName": "string", ~/~/ Наименование агента.
6415 + "isEnabled": true, ~/~/ Активность локатора
6416 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6417 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6418 + "name": "string", ~/~/ Наименование локатора 
6419 + "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6420 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6421 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6422 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6423 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6424 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6425 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6426 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6427 + "url": "string", ~/~/ ссылка на локатор 
6428 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6429 + "showVehicleName": true, ~/~/ Наименование объекта
6430 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6431 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6432 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6433 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6434 + "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ГИС)
6435 +
6436 + 0
6437 + ]
6438 + }
6439 +]
6440 +)))
6441 +
6442 +
6443 +== **Изменение локатора** ==
6444 +
6445 +(% class="box infomessage" %)
6446 +(((
6447 +**PUT /api/v3/locators**
6448 +)))
6449 +
6450 +Пример запроса:
6451 +
6452 +(((
6453 +{
6454 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6455 + "isEnabled": true, ~/~/ Активность 
6456 + "name": "string", ~/~/ Наименование
6457 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6458 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6459 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6460 + "autoProlongation": true, ~/~/ Автопродление срока действия
6461 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6462 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6463 + 0
6464 + ],
6465 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6466 + 0
6467 + ],
6468 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6469 + 0
6470 + ],
6471 + "showVehicleName": true, ~/~/ Наименование объекта
6472 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6473 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6474 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6475 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6476 + "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ГИС)
6477 +
6478 + 0
6479 +
6480 + ]
6481 +}
6482 +
6483 +
6484 +)))
6485 +
6486 +Пример ответа:
6487 +
6488 +200 ~/~/ Success
6489 +
6490 +
6491 +== **Удалить локатор** ==
6492 +
6493 +(% class="box warningmessage" %)
6494 +(((
6495 +**DELETE /api/v3/locators**
6496 +)))
6497 +
6498 +Пример запроса:
6499 +
6500 +(((
6501 +[
6502 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6503 +]
6504 +)))
6505 +
6506 +
6507 += **Раздел: Яндекс Маршруты** =
6508 +
6509 +
6510 +== **Возвращение списка маршрутов** ==
6511 +
6512 +(% class="box infomessage" %)
6513 +(((
6514 +**GET /api/v3/TransportRoutes**
6515 +)))
6516 +
6517 +Пример запроса:
6518 +Id  ~/~/ Идентификатор поля
6519 +
6520 +Пример ответа:
6521 +
6522 +(((
6523 +[
6524 + {
6525 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6526 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6527 + "name": "string", ~/~/ Наименование маршрута.
6528 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6529 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6530 + 0
6531 + ]
6532 + }
6533 +]
6534 +)))
6535 +
6536 +
6537 +== **Добавить маршрут** ==
6538 +
6539 +(% class="box infomessage" %)
6540 +(((
6541 +**POST /api/v3/TransportRoutes**
6542 +)))
6543 +
6544 +Пример запроса: 
6545 +{
6546 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6547 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6548 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6549 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6550 + 0
6551 + ]
6552 +}
6553 +
6554 +
6555 +Пример ответа:
6556 +
6557 +(((
6558 +{
6559 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6560 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6561 + "name": "string", ~/~/ Определяет наименование маршрута 
6562 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6563 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6564 + 0
6565 + ]
6566 +}
6567 +)))
6568 +
6569 +
6570 +== **Обновление маршрута** ==
6571 +
6572 +(% class="box successmessage" %)
6573 +(((
6574 +**PUT /api/v3/TransportRoutes**
6575 +)))
6576 +
6577 +Пример запроса:
6578 +
6579 +(((
6580 +{
6581 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6582 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6583 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6584 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6585 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6586 + 0
6587 + ]
6588 +}
6589 +)))
6590 +
6591 +Пример ответа:
6592 +
6593 +(((
6594 +{
6595 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6596 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6597 + "name": "string", ~/~/ Определяет наименование маршрута 
6598 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6599 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6600 + 0
6601 + ]
6602 +}
6603 +)))
6604 +
6605 +
6606 +== **Получить связки маршрутов ТС** ==
6607 +
6608 +(% class="box infomessage" %)
6609 +(((
6610 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6611 +)))
6612 +
6613 +Пример запроса:
6614 +
6615 +(((
6616 +[
6617 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6618 +]
6619 +)))
6620 +
6621 +Пример ответа:
6622 +
6623 +(((
6624 +[
6625 + {
6626 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6627 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6628 + }
6629 +]
6630 +)))
6631 +
6632 +
6633 +== **Удалить маршрут** ==
6634 +
6635 +(% class="box warningmessage" %)
6636 +(((
6637 +**DELETE /api/v3/TransportRoutes/{id}**
6638 +)))
6639 +
6640 +Пример запроса:
6641 +Id  ~/~/ Идентификатор поля
6642 +
6643 +
6644 += **Раздел: Управление доступа к машинам** =
6645 +
6646 +
6647 +== Получение списка транспортных средств видимых пользователю ==
6648 +
6649 +(% class="box infomessage" %)
6650 +(((
6651 +**GET /api/v3/UserVisibleVehicles/{userId}**
6652 +)))
6653 +
6654 +Пример ответа:
6655 +
6656 +(((
6657 +{
6658 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6659 + 0
6660 + ]
6661 +}
6662 +)))
6663 +
6664 +
6665 +== Задает видимость транспортных средств пользователю ==
6666 +
6667 +(% class="box infomessage" %)
6668 +(((
6669 +**POST /api/v3/UserVisibleVehicles**
6670 +)))
6671 +
6672 +Пример запроса:
6673 +
6674 +(((
6675 +(((
6676 +{
6677 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6678 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6679 + 0
6680 + ]
6681 +}
6682 +)))
6683 +
6684 +(((
6685 +
6686 +)))
6687 +
6688 +(((
6689 +Пример ответа :
6690 +)))
6691 +
6692 +(((
6693 +
6694 +)))
6695 +
6696 +(((
6697 +200 ~/~/ Success
6698 +)))
6699 +)))
6700 +
6701 +
1407 1407  (% class="box" lang="en-US" style="text-align: center;" %)
1408 1408  (((
1409 1409  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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