Last modified by Андрей Калиновский on 2025/04/21 14:13
<
From version < 88.1 >
edited by Михаил Жучков
on 2023/05/17 14:40
To version < 213.1 >
edited by Андрей Калиновский
on 2025/03/19 13:51
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.SupportZhuchkov
1 +XWiki.Gadmin
Content
... ... @@ -1,5 +1,24 @@
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 +При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
20 +
21 +
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" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
36 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
38 +
39 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
40 +
41 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
42 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
45 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
46 +(((
47 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
48 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
49 +)))
22 22  
23 -(% class="box infomessage" %)
51 +(% 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**__».
62 +(% 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" %)
75 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
76 + "User": "testuser" , ~/~/ имя пользователя(%%)
54 54  }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
81 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
82 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
83 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
84 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
85 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
86 +
87 +(% class="wikigeneratedid" %)
88 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
89 +
58 58  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
... ... @@ -93,30 +93,51 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 -А
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" ~/~/ Корр. счет
129 + "agentId": "",  (%%)
130 + "parentId": "",
131 + "parentName": "string",
132 + "name": "string",
133 + "fullName": "string",
134 + "agentInfoType": 0,
135 + "isForeign": true/false,
136 + "district": "string", 
137 + "region": "string",
138 + "city": "string",
139 + "inn": "string",
140 + "kpp": "string",
141 + "address": "string",
142 + "addressFact": "string",
143 + "email": "string",
144 + "director": "string",
145 + "bankName": "string",
146 + "bankBIK": "string",
147 + "bankRS": "string",
148 + "bankKS": "string"
118 118   }
119 119  
151 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
152 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
153 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
154 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
155 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
156 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
157 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
158 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
159 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
160 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
161 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
162 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
163 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
164 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
165 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
166 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
167 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
168 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
169 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
170 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
171 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
172 +
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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
186 +(% 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 - Отказ)
201 + "agentId": "",(% style="color:#000000" %)   (%%)
202 + "parentId": "",
203 + "name": "string",
204 + "fullName": "string",
205 + "agentInfoType": 0,
206 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
209 +
210 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
211 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
212 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
213 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
214 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
215 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
216 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
217 +
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", ~/~/ идентификатор клиента-родителя 
236 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 178   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -192,7 +192,6 @@
192 192   "bankKS": "string" ~/~/ корр. счёт
193 193  }
194 194  
195 -
196 196  Ответ:
197 197  
198 198  {
... ... @@ -217,6 +217,28 @@
217 217   "bankKS": "string" ~/~/ корр. счёт
218 218  }
219 219  
280 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
281 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
282 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
283 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
284 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
285 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
286 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
287 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
288 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
289 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
290 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
291 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
292 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
293 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
294 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
295 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
296 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
297 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
298 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
299 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
300 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
301 +
220 220  == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
221 221  
222 222  (% class="box warningmessage" %)
... ... @@ -232,7 +232,6 @@
232 232  
233 233  В заголовках запроса: X-Auth: Токен авторизации
234 234  
235 -
236 236  Параметры в теле запроса (JSON):
237 237  
238 238  {
... ... @@ -257,7 +257,6 @@
257 257   "bankKS": "string" ~/~/ корр. счёт
258 258  }
259 259  
260 -
261 261  Ответ:
262 262  
263 263  {
... ... @@ -300,6 +300,21 @@
300 300  
301 301  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
302 302  
383 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
384 +
385 +(% class="box warningmessage" %)
386 +(((
387 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
388 +)))
389 +
390 +Метод позволяет изменить статус клиента, указанного в запросе.
391 +
392 +В пути указывается GUID клиента и статус клиента.
393 +
394 +**status **- значение 0 - заблокирован, 1 - активен.
395 +
396 +Ответ: Code 204
397 +
303 303  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
304 304  
305 305  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -351,7 +351,6 @@
351 351   ],
352 352   "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
353 353  }
354 -
355 355  {
356 356   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
357 357   "lastName": "string",
... ... @@ -363,15 +363,10 @@
363 363   "password": "string",
364 364   "email": "string",
365 365  
366 -
367 367  (% style="text-align:left" %)
368 368  (% style="color:#000000; font-weight:normal" %)Ответ:
369 -
370 -(% style="text-align:left" %)
371 -(% style="color:#000000; font-weight:normal" %){    
372 -
373 -(% style="text-align:left" %)
374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
462 +{     
463 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя
480 +}
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 -
502 +(% style="color:#000000" %){(%%)
416 416   "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
417 417   "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
418 418   "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
419 419   "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
420 -
421 421  (% style="color:#000000" %)}
422 422  
423 423  (% style="color:#000000" %)Ответ:
424 424  
425 425  (% style="color:#000000" %){         (%%)
426 -
427 427   "id": "" , ~/~/ идентификатор пользователя
428 428   "lastName": "" , ~/~/ фамилия
429 429   "firstName": "" , ~/~/ имя
... ... @@ -437,7 +437,6 @@
437 437   "sessionDuration":"", ~/~/ длительность сессии в минутах
438 438   "status": "1",  ~/~/ статус пользователя
439 439   "lastLogged": "", ~/~/ дата/время последней авторизации
440 -
441 441  (% style="color:#000000" %)}
442 442  
443 443  == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
... ... @@ -511,10 +511,8 @@
511 511  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
512 512  
513 513  (% lang="en-US" style="text-align:left" %)
514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
515 -
516 -(% lang="en-US" style="text-align:left" %)
517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
598 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
599 + "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" %)
621 + "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": "" , ~/~/ идентификатор пользователя
628 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
629 + "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» названия группы пользователя
650 +}
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 -
671 +(% 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",
696 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
623 623   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
624 624   ]
625 625  
... ... @@ -682,8 +682,251 @@
682 682  (% style="text-align:left" %)
683 683  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
684 684  
685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) =
759 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
686 686  
761 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
762 +
763 +(% class="box infomessage" %)
764 +(((
765 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
766 +)))
767 +
768 +Метод возвращает полную информацию о модели объекта.
769 +
770 +(% style="color:#000000" %)Метод запроса: **GET**
771 +
772 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
773 +
774 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
775 +
776 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
777 +
778 +(% style="color:#000000" %)Ответ:
779 +
780 +(% style="color:#000000" %){
781 + "parentName": "string",
782 + "name": "string",
783 + "picture": "string",
784 + "minspeed": 0,
785 + "maxspeed": 0,
786 + "width": 0,
787 + "imbeddedtrailer": true,
788 + "hoppercapacity": 0,
789 + "hopperdischargespeed": 0,
790 + "modelType": 0,
791 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
792 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
793 + "deleted": true
794 +}
795 +
796 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
797 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
798 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
799 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
800 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
801 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
802 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
803 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
804 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
805 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
806 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
807 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
808 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
809 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
810 +
811 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
812 +
813 +(% class="box successmessage" %)
814 +(((
815 +(% lang="en-US" %)**POST /api/v3/models/find**
816 +)))
817 +
818 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
819 +
820 +(% style="color:#000000" %)Метод запроса: **POST**
821 +
822 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
823 +
824 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
825 +
826 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
827 +
828 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
829 +}
830 +
831 +(% style="color:#000000" %)Ответ:
832 +
833 +(% style="color:#000000" %)[
834 + {
835 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
836 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
837 + "parentName": "string",
838 + "name": "string",
839 + "modelType": 0
840 + }
841 +]
842 +
843 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
844 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
845 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
846 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
847 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
848 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
849 +
850 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
851 +
852 +(% class="box successmessage" %)
853 +(((
854 +(% lang="en-US" %)**POST /api/v3/models**
855 +)))
856 +
857 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
858 +
859 +(% style="color:#000000" %)Метод запроса: **POST**
860 +
861 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
862 +
863 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
864 +
865 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
866 +
867 +{
868 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
869 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
870 + "deleted": true,
871 + "extId": "string",
872 + "name": "string",
873 + "picture": "string",
874 + "minspeed": 0,
875 + "maxspeed": 0,
876 + "width": 0,
877 + "imbeddedtrailer": true,
878 + "fueloutlay": 0,
879 + "hoppercapacity": 0,
880 + "hopperdischargespeed": 0,
881 + "modelType": 0
882 +}
883 +
884 +Ответ:
885 +
886 +{
887 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
888 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
889 + "deleted": true,
890 + "extId": "string",
891 + "name": "string",
892 + "picture": "string",
893 + "minspeed": 0,
894 + "maxspeed": 0,
895 + "width": 0,
896 + "imbeddedtrailer": true,
897 + "hoppercapacity": 0,
898 + "hopperdischargespeed": 0,
899 + "modelType": 0
900 +}
901 +
902 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
903 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
904 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
905 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
906 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
907 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
908 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
909 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
910 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
911 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
912 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
913 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
914 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
915 +
916 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
917 +
918 +(% class="box warningmessage" %)
919 +(((
920 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
921 +)))
922 +
923 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
924 +
925 +(% style="color:#000000" %)Метод запроса: **PUT**
926 +
927 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
928 +
929 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
930 +
931 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
932 +
933 +{
934 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
935 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
936 + "deleted": true,
937 + "extId": "string",
938 + "name": "string",
939 + "picture": "string",
940 + "minspeed": 0,
941 + "maxspeed": 0,
942 + "width": 0,
943 + "imbeddedtrailer": true,
944 + "fueloutlay": 0,
945 + "hoppercapacity": 0,
946 + "hopperdischargespeed": 0,
947 + "modelType": 0
948 +}
949 +
950 +Ответ:
951 +
952 +{
953 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
954 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
955 + "deleted": true,
956 + "extId": "string",
957 + "name": "string",
958 + "picture": "string",
959 + "minspeed": 0,
960 + "maxspeed": 0,
961 + "width": 0,
962 + "imbeddedtrailer": true,
963 + "fueloutlay": 0,
964 + "hoppercapacity": 0,
965 + "hopperdischargespeed": 0,
966 + "modelType": 0
967 +}
968 +
969 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
970 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
971 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
972 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
973 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
974 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
975 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
976 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
977 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
978 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
979 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
980 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
981 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
982 +
983 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
984 +
985 +(% class="box errormessage" %)
986 +(((
987 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
988 +)))
989 +
990 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
991 +
992 +(% style="color:#000000" %)Метод запроса: **DELETE**
993 +
994 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
995 +
996 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
997 +
998 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
999 +
1000 +Ответ: В случае успеха **Success 200**
1001 +
1002 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
1003 +
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
688 688  
689 689  (% class="box infomessage" %)
... ... @@ -711,6 +711,17 @@
711 711  
712 712  (((
713 713  {
1031 +
1032 +(((
1033 + "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1034 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1035 +)))
1036 +
1037 +(((
1038 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1039 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1040 +)))
1041 +
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" ~/~/ временная метка редактирования/обновления счетчика моточасов
1048 + "sim2": "", ~/~/ Номер SIM2
1049 + "parentId": "", ~/~/ ID клиента-родителя
1050 + "parentName": "", ~/~/ Наименование клиента-родителя
1051 + "modelId": "", ~/~/ ID модели объекта
1052 + "modelName": "", ~/~/ Имя модели объекта
1053 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1054 + "unitName": "string", ~/~/ Наименование подразделения
1055 + "status": 0, ~/~/ Статус объекта
1056 + "createdAt": "", ~/~/ Дата создания объекта
733 733   },
1058 +"customFields": [ ~/~/ Произвольные поля
1059 + {
1060 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1061 + "name": "string", ~/~/ Имя поля
1062 + "value": "string", ~/~/ Значение поля
1063 + "forClient": true, ~/~/ Не используемая функция
1064 + "forTooltip": true, ~/~/ Отображать в подсказке
1065 + "forReport": true ~/~/ Отображать в отчете
1066 + }
1067 +
1068 +], ~/~/ Данные с вкладки нормы
1069 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1070 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1071 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1072 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1073 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1074 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1075 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1076 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1077 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1078 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1079 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1080 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1081 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1082 + "mileageCoeff": 0, ~/~/ коэффициент пробега
1083 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1084 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1085 + "counters": { ~/~/ Счетчики
1086 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1087 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1088 + "mileage": 0, ~/~/ Текущий пробег
1089 + "motohours": 0, ~/~/ Текущие моточасы
1090 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1091 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1092 + },
1093 +
1094 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1095 + "id": "string", ~/~/ ID объекта
1096 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
1097 + "host": "string", ~/~/ CMSV6 Web Host
1098 + "login": "string", ~/~/ CMSV6 Account
1099 + "password": "string" ~/~/ CMSV6 Password
1100 + },
1101 +
1102 +"commandTemplates": [ ~/~/ Шаблоны команд
1103 + {
1104 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1105 + "name": "string", ~/~/ Наименование команды
1106 + "command": "string", ~/~/ Текст команды
1107 + "retries": 0 ~/~/ Количество попыток
1108 + }
1109 + ],
1110 + "sensors": [ ~/~/ Датчики
1111 + {
1112 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1113 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1114 + "type": 0, ~/~/ Тип датчика
1115 + "name": "string", ~/~/ Имя датчика
1116 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1117 + "inputNumber": 0, ~/~/ Номер входа
1118 + "pseudonym": "string", ~/~/ Псевдоним
1119 + "medianDegree": 0, ~/~/ Медианная фильтрация
1120 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1121 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1122 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1123 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1124 + {
1125 + "grades": [ ~/~/ Таблица тарировки 1
1126 + {
1127 + "input": 0, ~/~/ Входящее значение
1128 + "output": 0 ~/~/ Выходящее значение
1129 + }
1130 + ],
1131 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1132 + }
1133 + ],
1134 + "showInTooltip": true, ~/~/ Отображать в подсказке
1135 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1136 + "color": "string", ~/~/ Код цвета датчиков
1137 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1138 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1139 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1140 + "expr": "string", ~/~/ Формула
1141 + "children": [ ~/~/ массив дочерних датчиков
1142 + "string"
1143 + ],
1144 + "customParams": { ~/~/ прочие произвольные параметры
1145 + "additionalProp1": "string",
1146 + "additionalProp2": "string",
1147 + "additionalProp3": "string"
1148 + },
1149 +
1150 +~/~/ Характерные для произвольного:
1151 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1152 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1153 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1154 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1155 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1156 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1157 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1158 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1159 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1160 +~/~/ "ValueOn": "Вкл.",
1161 +~/~/ "ValueOff": "Выкл."
1162 + "summaryMaxValue": 0 ~/~/ Макс. значение
1163 + }
1164 + "drivers": [ ~/~/ Водители
1165 + {
1166 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1167 + "name": "string", ~/~/ Наименование
1168 + "description": "string",
1169 + "isDefault": true ~/~/ По умолчанию
1170 + }
1171 + ],
734 734   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
735 735   {
736 736   "id": "", ~/~/ ID  задания
... ... @@ -746,10 +746,28 @@
746 746   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
747 747   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
748 748   }
749 - ]
1187 + ],
1188 +"statusHistory": [ ~/~/ История статусов
1189 + {
1190 + "status": 0,
1191 + "date": "2023-05-22T09:57:39.562Z",
1192 + "description": "string",
1193 + "additionalInfo": "string"
1194 +
1195 +(((
750 750  }
1197 + ],
1198 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1199 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
751 751  )))
752 752  
1202 +(((
1203 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1204 +}
1205 +
1206 +)))
1207 +)))
1208 +
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  
1215 +
1216 +== **Отправить команду на терминал** ==
1217 +
1218 +(% class="box successmessage" %)
1219 +(((
1220 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1221 +)))
1222 +
1223 +Команда для отправки на тс.
1224 +
1225 +{  
1226 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1227 +"command": "", ~/~/ Текст отправляемой команды
1228 +"retries": "", ~/~/ Количество попыток отправки на терминал
1229 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1230 +}
1231 +
1232 +В ответ получаем cmdid
1233 +
1234 +
1235 +== **Получить ответ на отправленную на ТС команду** ==
1236 +
1237 +(% class="box infomessage" %)
1238 +(((
1239 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1240 +)))
1241 +
1242 +Идентификатор команды: cmdId
1243 +
1244 +Запрос от терминала на ответ команды
1245 +
1246 +Пример ответ от терминала:
1247 +
1248 +ID= "" ~/~/ идентификатор объекта
1249 +Soft="" ~/~/ версия софта
1250 +GPS=4 ~/~/ тип трекера
1251 +Time=11:05:43 28.06.24 ~/~/ время запроса
1252 +Lat=45.056221 ~/~/ широта
1253 +Lon=39.035938 ~/~/ долгота
1254 +Speed=0.0 ~/~/ скорость
1255 +Course=181.4 ~/~/направление
1256 +
1257 +(((
1258 +== **Список отправленных объекту команд с ответами** ==
1259 +
1260 +(% class="box infomessage" %)
1261 +(((
1262 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1263 +)))
1264 +
1265 +Идентификатор ТС: vehicleId
1266 +
1267 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1268 +
1269 +Пример ответа терминала
1270 +
1271 +[ 
1272 +{    
1273 +"id": "", ~/~/ идентификатор пользователя
1274 +"commandText": "", ~/~/Текст команды.
1275 +"templateId": "", ~/~/Идентификатор шаблона
1276 +"updated": "", ~/~/ Время отправки  
1277 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1278 +"answer": "", ~/~/ Ответ терминала.
1279 +"status": "" ~/~/ Статус отправки
1280 +}
1281 +]
1282 +)))
1283 +
759 759  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
760 760  
761 761  (% class="box successmessage" %)
... ... @@ -775,6 +775,11 @@
775 775  
776 776  (% style="color:#000000" %){
777 777  
1303 +
1304 +(((
1305 + "vehicleId": 0, ~/~/ ID ТС
1306 +)))
1307 +
778 778   "parentId": "" , ~/~/ ID клиента
779 779   "name": "" , ~/~/ имя ТС
780 780   "imei": "" , ~/~/ IMEI
... ... @@ -795,6 +795,10 @@
795 795   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
796 796   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
797 797   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1328 + "mileageCalcMethod": 0,
1329 + "mileageCoeff": 0,
1330 + "locationByCellId": true,
1331 + "dottedLineTrackWhenNoCoords": true,
798 798   "counters": ~/~/ счетчики
799 799   {
800 800   "mileage": "" , ~/~/ пробег
... ... @@ -823,67 +823,346 @@
823 823   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
824 824   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
825 825   }
1360 +"drivers": [ ~/~/ Водители
1361 + {
1362 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1363 + "isDefault": true
1364 + }
1365 + ],
1366 + "commandTemplates": [ ~/~/ Шаблон команды
1367 + {
1368 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1369 + "name": "string",
1370 + "command": "string",
1371 + "retries": 0
1372 + }
1373 + ],
1374 +"sensors": [ ~/~/ Датчики
1375 + {
1376 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1377 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1378 + "type": 0, ~/~/ Тип датчика
1379 + "name": "string", ~/~/ Имя датчика
1380 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1381 + "inputNumber": 0, ~/~/ Номер входа
1382 + "pseudonym": "string", ~/~/ Псевдоним
1383 + "medianDegree": 0, ~/~/ Медианная фильтрация
1384 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1385 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1386 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1387 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1388 + {
1389 + "grades": [ ~/~/ Таблица тарировки 1
1390 + {
1391 + "input": 0, ~/~/ Входящее значение
1392 + "output": 0 ~/~/ Выходящее значение
1393 + }
1394 + ],
1395 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1396 + }
1397 + ],
1398 + "showInTooltip": true, ~/~/ Отображать в подсказке
1399 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1400 + "color": "string", ~/~/ код цвета датчиков
1401 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1402 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1403 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1404 + "expr": "string", ~/~/ Формула
1405 + "children": [ ~/~/ массив дочерних датчиков
1406 + "string"
1407 + ],
1408 + "customParams": { ~/~/ прочие произвольные параметры
1409 + "additionalProp1": "string",
1410 + "additionalProp2": "string",
1411 + "additionalProp3": "string"
1412 + },
1413 +~/~/ Характерные для произвольного:
1414 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1415 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1416 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1417 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1418 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1419 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1420 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1421 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1422 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1423 +~/~/ "ValueOn": "Вкл.",
1424 +~/~/ "ValueOff": "Выкл."
1425 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
826 826  
827 -(% style="color:#000000" %) }
1427 +(((
1428 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1429 + {
1430 + "from": 0, ~/~/ С какого значения
1431 + "color": "string", ~/~/ Каким цветом
1432 + "text": "string" ~/~/ Текст подписи к этому интервалу
1433 + }
1434 + ]
1435 + }
1436 + ],
1437 +)))
828 828  
1439 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1440 +
1441 +
1442 + "customFields": [ ~/~/ Произвольные поля
1443 + {
1444 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1445 + "name": "string", ~/~/ Наименование произвольного поля
1446 + "value": "string", ~/~/ Значение произвольного поля
1447 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1448 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1449 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1450 +
1451 +(((
1452 + }
1453 + ],
1454 + "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1455 +)))
1456 +
1457 +(((
1458 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1459 +}
1460 +)))
1461 +
1462 +
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 - однократно)
1466 +(((
1467 +(((
1468 +(((
1469 +{
1470 + "vehicleId": 0,  ~/~/ ID ТС
1471 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1472 + "name": "string", ~/~/ Имя объекта
1473 + "imei": "string", ~/~/ IMEI
1474 + "deviceTypeId": 0, ~/~/ ID типа устройства
1475 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1476 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1477 + "sim1": "string", ~/~/ SIM1
1478 + "sim2": "string", ~/~/ SIM2
1479 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1480 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1481 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1482 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1483 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1484 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1485 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1486 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1487 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1488 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1489 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1490 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1491 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1492 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1493 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1494 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1495 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1496 + "counters": {  ~/~/ Dto для состояний счётчиков
1497 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1498 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1499 + "mileage": 0, ~/~/ Пробег
1500 + "motohours": 0 ~/~/ Моточасы
1501 + },
1502 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1503 + "id": "string", ~/~/ CMSV6 Идентификатор
1504 + "enabled": true, ~/~/ Признак включения
1505 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1506 + "login": "string", ~/~/ CMSV6 имя учетной записи
1507 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1508 + },
1509 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1510 + {
1511 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1512 + "enabled": true, ~/~/ Признак включения
1513 + "name": "string", ~/~/ Имя задания
1514 + "description": "string", ~/~/ Описание задания
1515 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1516 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1517 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1518 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1519 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1520 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1521 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1522 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
869 869   }
1524 + ],
1525 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1526 + {
1527 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1528 + "inputNumber": 0, ~/~/ № входа.
1529 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1530 + "comment": "string", ~/~/ Комментарий
1531 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1532 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1533 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1534 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1535 + }
1536 + ],
1537 + "commandTemplates": [  ~/~/ Список шаблонов команд
1538 + {
1539 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1540 + "name": "string", ~/~/ Название шаблона команд
1541 + "command": "string", ~/~/ Команда на выполнение
1542 + "retries": 0 ~/~/ Лимит попыток отправки
1543 + }
1544 + ],
1545 + "sensors": [ ~/~/ Список датчиков
1546 + {
1547 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1548 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1549 + "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
1550 + "name": "string",  ~/~/ Имя датчика
1551 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1552 + "inputNumber": 0, ~/~/ Номер входа
1553 + "pseudonym": "string", ~/~/ Псевдоним
1554 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1555 + "isInverted": true, ~/~/  Признак инверсии
1556 + "disabled": true, ~/~/ Датчик не участвует в обработке
1557 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1558 + "gradesTables": [ ~/~/ Тарировка
1559 + {
1560 + "grades": [ ~/~/ Таблицы тарировки
1561 + {
1562 + "input": 0, ~/~/ Вход
1563 + "output": 0 ~/~/ Выход
1564 + }
1565 + ],
1566 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1567 + }
1568 + ],
1569 + "showInTooltip": true, ~/~/ Отображение в подсказке
1570 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1571 + "color": "string", ~/~/ код цвета датчиков
1572 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1573 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1574 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1575 + "expr": "string", ~/~/ Выражение
1576 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1577 + "string"
1578 + ],
1579 + "customParams": {
1580 + "additionalProp1": "string",
1581 + "additionalProp2": "string",
1582 + "additionalProp3": "string"
1583 + },
1584 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1585 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1586 + {
1587 + "from": 0, ~/~/ С какого значения
1588 + "color": "string", ~/~/ Каким цветом
1589 +)))
870 870  
871 -(% style="text-align:left" %)
872 -(% style="color:#000000" %)}
1591 +(((
1592 + "text": "string" ~/~/ Текст подписи к этому интервалу
1593 + }
1594 + ]
1595 + }
1596 + ],
1597 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1598 + "customFields": [ ~/~/ Список произвольных полей
1599 + {
1600 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1601 + "name": "string", ~/~/ Наименование произвольного поля
1602 + "value": "string", ~/~/ Значение произвольного поля
1603 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1604 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1605 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1606 + }
1607 + ],
1608 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1609 +}
1610 +)))
1611 +)))
1612 +)))
873 873  
1614 +
874 874  **Валидация:**
875 875  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
876 876  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
877 877  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
878 878  
879 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
880 880  
1621 +== **Импортировать историю ТС (Асинхронный запрос)** ==
1622 +
1623 +(% class="box successmessage" %)
1624 +(((
1625 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1626 +)))
1627 +
1628 +Метод запроса: **POST**
1629 +
1630 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1631 +
1632 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1633 +
1634 +
1635 +Ответ:
1636 +
1637 +{
1638 +
1639 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1640 +
1641 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1642 +
1643 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1644 +
1645 + "Message": "string", ~/~/ Информация о выполнении запроса
1646 +
1647 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1648 +
1649 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1650 +
1651 + "Data": "string" ~/~/ Данные
1652 +
1653 +}
1654 +
1655 +
1656 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1657 +
881 881  (% class="box infomessage" %)
882 882  (((
1660 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1661 +)))
1662 +
1663 +Метод запроса: **GET**
1664 +
1665 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1666 +
1667 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1668 +
1669 +
1670 +Ответ:
1671 +
1672 +{
1673 +
1674 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1675 +
1676 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
1677 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1678 +
1679 + "Message": "string", ~/~/ Информация о выполнении запроса
1680 +
1681 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1682 +
1683 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1684 +
1685 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1686 +
1687 + "Data": "string" ~/~/ Данные
1688 +
1689 +}
1690 +
1691 +
1692 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1693 +
1694 +(% class="box infomessage" %)
1695 +(((
883 883  (% lang="en-US" %)**POST /api/v3/vehicles/find**
884 884  )))
885 885  
886 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1699 +(% 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 ~/~/ значение любого из произвольных полей ТС
1733 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1734 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1735 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1736 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1737 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1738 + "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" %){
1745 +(% style="color:#000000" %)[
1746 +{
930 930  
1748 +(((
1749 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1750 +)))
1751 +
1752 +(((
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" %)}
1778 +)))
958 958  
1780 +(((
1781 + }
1782 + ],
1783 + "vehicleGroups": [  ~/~/ Группы ТС
1784 + {
1785 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1786 + "name": "string" ~/~/ Наименование группы ТС
1787 + }
1788 + ]
1789 + }
1790 +]
1791 +)))
1792 +
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 -
1828 +(% style="color:#000000" %){(%%)
997 997   "status": "", ~/~/ значение статуса
998 998   "date": "", ~/~/ Дата смены статуса 
999 999   "description": "", ~/~/ Описание
... ... @@ -1000,10 +1000,10 @@
1000 1000   "data": "", ~/~/ Данные
1001 1001   "overwrite": false, ~/~/ Флаг перезаписи
1002 1002   "stage": "", ~/~/ Состояние
1003 -
1004 -(% style="text-align:left" %)
1005 1005  (% style="color:#000000" %) }
1006 1006  
1837 +== ==
1838 +
1007 1007  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1008 1008  
1009 1009  (% class="box warningmessage" %)
... ... @@ -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     (%%)
1856 +(% style="color:#000000" %){
1857 + "vehicleId": , ~/~/ ID объекта
1858 + "parentId": "" , ~/~/ ID клиента
1859 + "name": "" , ~/~/ имя ТС
1860 + "imei": "" , ~/~/ IMEI
1861 + "deviceTypeId": "" , ~/~/ ID типа устройства
1862 + "modelId": "" , ~/~/ ID модели
1863 + "unitId": "" , ~/~/ ID подразделения
1864 + "sim1": "" , ~/~/ Номер SIM 1
1865 + "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 - } 
1878 +
1879 + "mileageCalcMethod": 0,
1880 + "mileageCoeff": 0,
1881 + "locationByCellId": true,
1882 + "dottedLineTrackWhenNoCoords": true,
1883 + "counters": ~/~/ счетчики
1884 + {
1885 + "mileage": "" , ~/~/ пробег
1886 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1887 + "motohours": "" , ~/~/ моточасы
1888 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1889 + },
1890 + "cmsv6Parameters": { ~/~/ параметры CMSv6
1891 + "enabled": true, ~/~/ флаг включения
1892 + "id": "" , ~/~/ идентификатор
1893 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1894 + "login": "" , ~/~/ имя учетной записи
1895 + "password": "" ~/~/ пароль учетной записи
1896 + },
1897 + "inspectionTasks": ~/~/ задания на ТО
1898 + {
1899 + "enabled": "" , ~/~/ Признак включения
1900 + "name": "" , ~/~/ Имя задания
1901 + "description": "" , ~/~/ Описание задания
1902 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1903 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1904 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1905 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1906 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1907 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1908 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1909 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1910 + }
1911 +
1912 +"drivers": [ ~/~/ Водители
1913 + {
1914 +
1915 +(((
1916 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1917 + "inputNumber": 0, ~/~/ № входа.
1918 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1919 + "comment": "string", ~/~/ Комментарий.
1920 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1921 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1922 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1923 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1077 1077  )))
1078 1078  
1079 -(% style="color:#000000" %)}
1926 + } 
1927 + ],
1928 + "commandTemplates": [ ~/~/ Шаблон команды
1929 + {
1930 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1931 + "name": "string",
1932 + "command": "string",
1933 + "retries": 0
1934 + }
1935 + ],
1936 +"sensors": [ ~/~/ Датчики
1937 + {
1938 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1939 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1940 + "type": 0, ~/~/ Тип датчика
1941 + "name": "string", ~/~/ Имя датчика
1942 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1943 + "inputNumber": 0, ~/~/ Номер входа
1944 + "pseudonym": "string", ~/~/ Псевдоним
1945 + "medianDegree": 0, ~/~/ Медианная фильтрация
1946 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1947 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1948 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1949 + "gradesTables": [ ~/~/ Массив таблиц тарировки
1950 + {
1951 + "grades": [ ~/~/ Таблица тарировки 1
1952 + {
1953 + "input": 0, ~/~/ Входящее значение
1954 + "output": 0 ~/~/ Выходящее значение
1955 + }
1956 + ],
1957 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1958 + }
1959 + ],
1960 + "showInTooltip": true, ~/~/ Отображать в подсказке
1961 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1080 1080  
1963 +(((
1964 + "color": "string",** ~/~/ **Цвет датчика
1965 +)))
1966 +
1967 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1968 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1969 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1970 + "expr": "string", ~/~/ Формула
1971 + "children": [ ~/~/ массив дочерних датчиков
1972 + "string"
1973 + ],
1974 + "customParams": { ~/~/ прочие произвольные параметры
1975 + "additionalProp1": "string",
1976 + "additionalProp2": "string",
1977 + "additionalProp3": "string"
1978 + },
1979 +~/~/ Характерные для произвольного:
1980 +~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1981 +~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1982 +~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1983 +~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1984 +~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1985 +~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1986 +~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1987 +~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1988 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1989 +~/~/ "ValueOn": "Вкл.",
1990 +~/~/ "ValueOff": "Выкл."
1991 + "summaryMaxValue": 0 ~/~/ Макс. значение
1992 +
1993 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1994 + {
1995 + "from": 0, ~/~/ С какого значения
1996 + "color": "string", ~/~/ Каким цветом
1997 + "text": "string" ~/~/ Текст подписи к этому интервалу
1998 + }
1999 + ]
2000 + }
2001 + ],
2002 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2003 +
2004 + "customFields": [ ~/~/ Произвольные поля
2005 + {     
2006 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
2007 + "name": "string", ~/~/ Наименование произвольного поля
2008 + "value": "string", ~/~/ Значение произвольного поля
2009 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2010 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2011 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2012 + }
2013 +
2014 +(((
2015 + ],
2016 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
2017 +)))
2018 +
2019 +}
2020 +
2021 +
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" %){    
2024 +(((
2025 +{
2026 + "vehicleId": 0, ~/~/ ID ТС
2027 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
2028 + "name": "string", ~/~/ Имя объекта
2029 + "imei": "string", ~/~/ IMEI
2030 + "deviceTypeId": 0, ~/~/ ID типа устройства
2031 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
2032 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
2033 + "sim1": "string", ~/~/ SIM1
2034 + "sim2": "string", ~/~/ SIM2
2035 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
2036 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
2037 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
2038 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
2039 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
2040 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
2041 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
2042 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
2043 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
2044 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
2045 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
2046 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
2047 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
2048 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
2049 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
2050 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
2051 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
2052 + "counters": { ~/~/ состояний счётчиков
2053 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
2054 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
2055 + "mileage": 0, ~/~/ Пробег
2056 + "motohours": 0 ~/~/ Моточасы 
2057 + },
2058 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
2059 + "id": "string", ~/~/ CMSV6 Идентификатор
2060 + "enabled": true, ~/~/ Признак включения
2061 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2062 +)))
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
2064 +
2065 +(((
2066 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2067 + "login": "string", ~/~/ CMSV6 имя учетной записи
2068 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
2069 + },
2070 + "inspectionTasks": [ ~/~/ Задания на ТО
2071 + {
2072 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2073 + "enabled": true, ~/~/ Признак включения
2074 + "name": "string", ~/~/ Имя задания
2075 + "description": "string", ~/~/ Описание задания
2076 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2077 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2078 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2079 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2080 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
2081 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2082 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2083 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2084 + }
2085 + ],
2086 + "drivers": [  ~/~/ Список водителей
2087 + {
2088 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2089 + "inputNumber": 0, ~/~/ № входа.
2090 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2091 + "comment": "string", ~/~/ Комментарий.
2092 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2093 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2094 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2095 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2096 + }
2097 + ],
2098 + "commandTemplates": [ ~/~/ Список шаблонов команд
2099 + {
2100 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2101 + "name": "string", ~/~/ Название шаблона команд
2102 + "command": "string", ~/~/ Команда на выполнение
2103 + "retries": 0 ~/~/ Лимит попыток отправки
2104 + }
2105 + ],
2106 + "sensors": [  ~/~/ Список датчиков 
2107 + {
2108 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2109 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2110 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2111 +)))
2112 +
2113 +(((
2114 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2115 +)))
2116 +
2117 +(((
2118 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2119 +)))
2120 +
2121 +(((
2122 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2123 +)))
2124 +
2125 +(((
2126 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2127 +)))
2128 +
2129 +(((
2130 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2131 + "name": "string", ~/~/ Имя датчика
2132 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2133 +)))
2134 +
2135 +(((
2136 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2137 + "inputNumber": 0, ~/~/ Номер входа
2138 + "pseudonym": "string", ~/~/ Псевдоним
2139 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
2140 + "isInverted": true, ~/~/ Признак инверсии
2141 + "disabled": true, ~/~/ Датчик не участвует в обработке
2142 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2143 + "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": "", ~/~/ Сколько раз выполнить задание
2145 + "grades": [ ~/~/ Таблицы тарировки
2146 + {
2147 + "input": 0, ~/~/ Вход
2148 + "output": 0 ~/~/ Выход
2149 + }
2150 + ],
2151 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
1126 1126   }
2153 + ],
2154 + "showInTooltip": true, ~/~/ Отображение в подсказке
2155 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1127 1127  
1128 -(% lang="en-US" style="text-align:left" %)
1129 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
2157 +(((
2158 + "color": "string", ~/~/ цвет уведомлений
2159 +)))
1130 1130  
2161 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2162 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2163 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2164 + "expr": "string", ~/~/ Выражение
2165 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2166 + "string" 
2167 + ],
2168 + "customParams": { ~/~/ Дополнительные настройки
2169 + "additionalProp1": "string",
2170 + "additionalProp2": "string",
2171 + "additionalProp3": "string"
2172 + },
2173 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2174 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2175 + {
2176 + "from": 0, ~/~/ С какого значения
2177 + "color": "string", ~/~/ Каким цветом
2178 + "text": "string" ~/~/ Текст подписи к этому интервалу
2179 + }
2180 + ]
2181 + }
2182 + ],
2183 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2184 + "customFields": [ ~/~/ Список произвольных полей
2185 + {
2186 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2187 + "name": "string", ~/~/ Наименование произвольного поля
2188 + "value": "string", ~/~/ Значение произвольного поля
2189 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2190 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2191 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2192 + }
2193 + ],
2194 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2195 +}
2196 +)))
2197 +
1131 1131  **Валидация:**
1132 1132  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1133 1133  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
... ... @@ -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]]
2236 +(% 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 -
2242 +(% 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 -
2266 +(% 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  
2313 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2314 +
2315 +(% class="box infomessage" style="text-align: left;" %)
2316 +(((
2317 +**POST /api/v3/terminalMessages/mapping**
2318 +)))
2319 +
2320 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2321 +
2322 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2323 +
2324 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2325 +
2326 +{
2327 + "protocolType": 0,
2328 + "params": ["string"]
2329 +}
2330 +
2331 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2332 +|protocolType|ID типа протокола
2333 +|params|(((
2334 +Массив наименований параметров в сообщении
2335 +)))
2336 +
2337 +Ответ:
2338 +
2339 +{
2340 + "protocolType": 0,
2341 + "mapping": {
2342 + "additionalProp1": {
2343 + "inputType": 0,
2344 + "inputNumber": 0
2345 + },
2346 + "additionalProp2": {
2347 + "inputType": 0,
2348 + "inputNumber": 0
2349 + }
2350 + }
2351 +}
2352 +
2353 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2354 +|protocolType|Тип протокола
2355 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2356 +|inputNumber|(((
2357 +Номер входа
2358 +)))
2359 +
2360 +(% class="wikigeneratedid" %)
2361 +Перечень 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/]]
2362 +
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  
2387 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2388 +|vehicleId|ID объекта
2389 +|from|Дата и время начала периода запроса
2390 +|to|Дата и время окончания периода запроса
2391 +
1276 1276  Ответ:
1277 1277  
1278 1278  [
... ... @@ -1279,25 +1279,404 @@
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": { ~/~/ список параметров датчиков передаваемых терминалом
2398 + "deviceTime": "2023-11-29T07:40:44.052Z",
2399 + "serverTime": "2023-11-29T07:40:44.052Z",
2400 + "speed": 0,
2401 + "altitude": 0,
2402 + "latitude": 0,
2403 + "longitude": 0,
2404 + "satellites": 0,
2405 + "course": 0,
2406 + "voltage": 0,
2407 + "parameters": {
1291 1291   "additionalProp1": "string",
1292 1292   "additionalProp2": "string",
1293 1293   "additionalProp3": "string"
1294 1294   },
1295 - "photoCount": 0 ~/~/ Кол-во фото
2412 + "photoCount": 0,
2413 + "lbsCorrectedCoords": true,
2414 + "protocolType": 0
1296 1296   }
1297 1297   ]
1298 1298   }
1299 1299  ]
1300 1300  
2420 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2421 +|deviceTime|Время сообщения терминала
2422 +|serverTime|Время когда сообщение поступило на сервер
2423 +|speed|Скорость
2424 +|altitude|Высота над уровнем моря
2425 +|latitude|Широта
2426 +|longitude|Долгота
2427 +|satellites|Кол-во спутников
2428 +|course|Курс
2429 +|voltage|Бортовое напряжение
2430 +|parameters|Список параметров и их значений
2431 +|photoCount|Количество фото
2432 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2433 +|protocolType|ID типа протокола
2434 +
2435 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2436 +
2437 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2438 +
2439 +(% class="box infomessage" %)
2440 +(((
2441 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2442 +)))
2443 +
2444 +(% style="color:#000000" %)Метод запроса: **POST**
2445 +
2446 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2447 +
2448 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2449 +
2450 +(% style="text-align:left" %)
2451 +Тело запроса:
2452 +
2453 +{
2454 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2455 + "vehicleIds": [0], ~/~/ Список ID объектов
2456 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2457 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2458 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2459 +}
2460 +
2461 +Ответ:
2462 +
2463 +[
2464 + {
2465 + "vehicleId": 0, ~/~/ ID объекта
2466 + "name": "string", ~/~/ Имя ТС
2467 + "periods": [ ~/~/ Периоды
2468 + {
2469 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2470 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2471 + "mileage": 0, ~/~/ Пробег за период, километры
2472 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2473 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2474 + "motohours": 0, ~/~/ Моточасы за период, секунды
2475 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2476 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2477 + "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2478 +
2479 + }
2480 + ]
2481 + }
2482 +]
2483 +
2484 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2485 +
2486 +(% class="box infomessage" %)
2487 +(((
2488 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2489 +)))
2490 +
2491 +(% style="color:#000000" %)Метод запроса: **POST**
2492 +
2493 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2494 +
2495 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2496 +
2497 +(% style="text-align:left" %)
2498 +Тело запроса:
2499 +
2500 +{
2501 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2502 + "vehicleIds": [0], ~/~/ Список ID объектов
2503 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2504 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2505 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2506 +}
2507 +
2508 +Ответ:
2509 +
2510 +[
2511 + {
2512 + "vehicleId": 0, ~/~/ ID объекта
2513 + "name": "string", ~/~/ Имя ТС
2514 + "periods": [ ~/~/ Периоды
2515 + {
2516 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2517 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2518 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2519 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2520 + "fuelConsumption": 0, ~/~/ Расход топлива
2521 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2522 + }
2523 + ]
2524 + }
2525 +]
2526 +
2527 +(% class="box warningmessage" %)
2528 +(((
2529 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2530 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2531 +)))
2532 +
2533 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2534 +
2535 +(% class="box infomessage" %)
2536 +(((
2537 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2538 +)))
2539 +
2540 +(% style="color:#000000" %)Метод запроса: **POST**
2541 +
2542 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2543 +
2544 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2545 +
2546 +(% style="text-align:left" %)
2547 +Тело запроса:
2548 +
2549 +{
2550 + "vehicleIds": [0], ~/~/ Список ID объектов
2551 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2552 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2553 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2554 +}
2555 +
2556 +Ответ:
2557 +
2558 +[
2559 + {
2560 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2561 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2562 + "vehicleId": 0, ~/~/ ID объекта
2563 + "name": "string", ~/~/ Имя объекта
2564 + "model": "string", ~/~/ Модель объекта
2565 + "fuels": [ ~/~/ Массив данным по заправкам и сливам
2566 + {
2567 + "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2568 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2569 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2570 + "valueFuel": 0, ~/~/ Количество
2571 + "fuelStart": 0, ~/~/ Уровень топлива на начало события
2572 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2573 + }
2574 + ]
2575 + }
2576 +]
2577 +
2578 +
2579 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2580 +
2581 +(% class="box infomessage" %)
2582 +(((
2583 +**POST /api/v3/vehicles/moveStop**
2584 +)))
2585 +
2586 +Метод запроса: **POST**
2587 +
2588 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2589 +
2590 +В заголовках запроса: X-Auth: Токен авторизации
2591 +
2592 +
2593 +Тело запроса:
2594 +
2595 +{
2596 + "vehicleIds": [ ], ~/~/ Список ID объектов
2597 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2598 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2599 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2600 +}
2601 +
2602 +Ответ:
2603 +
2604 +[ 
2605 + {
2606 + "vehicleId": 0, ~/~/ ID объекта
2607 + "vehicleName": "string", ~/~/ Имя объекта
2608 + "moves": [ ~/~/ Событие движения
2609 + {
2610 + "mileage": 0, ~/~/ Пробег, км
2611 + "eventId": 0, ~/~/ Идентификатор события
2612 + "eventName": "string", ~/~/ Название события
2613 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2614 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2615 + "duration": 0 ~/~/ Продолжительность события, секунд
2616 + }
2617 + ],
2618 + "stops": [ ~/~/ События стоянок
2619 + {
2620 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2621 + "eventId": 0, ~/~/ Идентификатор события
2622 + "eventName": "string", ~/~/ Название события
2623 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2624 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2625 + "duration": 0 ~/~/ Продолжительность события, секунд
2626 + }
2627 + ]
2628 + }
2629 +]
2630 +
2631 +
2632 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2633 +
2634 +(% class="box infomessage" %)
2635 +(((
2636 +**POST /api/v3/vehicles/getlastdata**
2637 +)))
2638 +
2639 +Метод запроса: **POST**
2640 +
2641 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2642 +
2643 +В заголовках запроса: X-Auth: Токен авторизации
2644 +
2645 +
2646 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2647 +
2648 +Ответ:
2649 + {
2650 + "vehicleId": 0, ~/~/Идентификатор объекта.
2651 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2652 + "vehicleNumber": "string",~/~/Номер объекта.
2653 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2654 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2655 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2656 + "speed": 0,~/~/Скорость объекта.
2657 + "course": 0,~/~/Курс движения [0;360]
2658 + "latitude": 0,~/~/Широта [-90°;90°].
2659 + "longitude": 0,~/~/Долгота [-180°;180°].
2660 + "address": "string",~/~/Адрес.
2661 + "geozones": [ ~/~/Сведения по геозонам.
2662 + {
2663 + "id": 0,
2664 + "name": "string"
2665 + }
2666 +
2667 +
2668 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2669 +
2670 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2671 +
2672 +(% class="box infomessage" %)
2673 +(((
2674 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2675 +)))
2676 +
2677 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2678 +
2679 +(% style="color:#000000" %)Метод запроса: **POST**
2680 +
2681 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2682 +
2683 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2684 +
2685 +(% style="text-align:left" %)
2686 +Тело запроса:
2687 +
2688 +(% style="text-align:left" %)
2689 +{
2690 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2691 +}
2692 +
2693 +(% style="text-align:left" %)
2694 +Ответ:
2695 +
2696 +[
2697 + {
2698 + "id": 0, ~/~/ Идентификатор объекта геозоны
2699 + "name": "string", ~/~/ Название объекта геозоны
2700 + "type": 0, ~/~/ Тип объекта геозоны
2701 + "fname": "string", ~/~/ Имя файла
2702 + "parentId": "string", ~/~/ Идентификатор клиента
2703 + "radius": 0, ~/~/ Радиус геообъекта
2704 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2705 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2706 + "description": "string", ~/~/ Описание
2707 + "area": 0, ~/~/ Площадь, м^^2^^
2708 + "perimetr": 0, ~/~/ Периметр, м
2709 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2710 + }
2711 +]
2712 +
2713 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2714 +
2715 +(% class="box infomessage" %)
2716 +(((
2717 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2718 +)))
2719 +
2720 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2721 +
2722 +(% style="color:#000000" %)Метод запроса: **POST**
2723 +
2724 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2725 +
2726 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2727 +
2728 +(% style="text-align:left" %)
2729 +Тело запроса:
2730 +
2731 +{
2732 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2733 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2734 + "ids": [ ], ~/~/ Массив id объектов
2735 + "byTime": 0, ~/~/ Объединение событий по времени 
2736 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2737 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2738 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2739 +}
2740 +
2741 +Ответ:
2742 +[
2743 + {
2744 + "geozoneId": 0, ~/~/ ID геообъекта
2745 + "geozoneName": "string", ~/~/ Название геообъекта
2746 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2747 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2748 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2749 + "vehicleId": 0, ~/~/ ID объекта
2750 + "vehicleName": "string" ~/~/ Имя объекта
2751 + }
2752 +]
2753 +
2754 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2755 +
2756 +(% class="box infomessage" %)
2757 +(((
2758 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2759 +)))
2760 +
2761 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2762 +
2763 +(% style="color:#000000" %)Метод запроса: **POST**
2764 +
2765 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2766 +
2767 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2768 +
2769 +(% style="text-align:left" %)
2770 +Тело запроса:
2771 +
2772 +{
2773 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2774 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2775 + "ids": [ ], ~/~/ Массив id геообъектов
2776 + "byTime": 0, ~/~/ Объединение событий по времени 
2777 + "byDist": 0, ~/~/ Объединение событий по расстоянию
2778 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2779 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2780 +}
2781 +
2782 +Ответ:
2783 +
2784 +[
2785 + {
2786 + "geozoneId": 0, ~/~/ ID геообъекта
2787 + "geozoneName": "string", ~/~/ Название геообъекта
2788 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2789 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2790 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2791 + "vehicleId": 0, ~/~/ ID объекта
2792 + "vehicleName": "string" ~/~/ Имя объекта
2793 + }
2794 +]
2795 +
1301 1301  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1302 1302  
1303 1303  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -1477,6 +1477,32 @@
1477 1477  
1478 1478  Success
1479 1479  
2975 +
2976 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2977 +
2978 +(% class="box warningmessage" %)
2979 +(((
2980 +**PUT** /api/v3/notifications/prolongation
2981 +)))
2982 +
2983 +Метод позволяет продлить уведомления.
2984 +
2985 +Метод запроса **PUT**
2986 +
2987 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2988 +
2989 +В заголовках запроса: X-Auth: Токен авторизации.
2990 +
2991 +Тело запроса:
2992 +
2993 +[
2994 +
2995 +0
2996 +
2997 +]
2998 +
2999 +где 0 идентификатор ids.
3000 +
1480 1480  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1481 1481  
1482 1482  (% class="box errormessage" %)
... ... @@ -1498,6 +1498,2924 @@
1498 1498  
1499 1499  Success
1500 1500  
3022 +
3023 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3024 +
3025 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3026 +
3027 +(% class="box infomessage" %)
3028 +(((
3029 +**POST /api/v3/Drivers/find**
3030 +)))
3031 +
3032 +Передается параметр: parentId - ID клиента-родителя
3033 +
3034 +Ответ:
3035 +
3036 +[
3037 + {
3038 + "name": "string", ~/~/ Определяет наименование
3039 + "description": "string", ~/~/ Определяет описание
3040 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3041 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3042 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
3043 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3044 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3045 + "deleted": true ~/~/ Признак удаления
3046 + }
3047 +]
3048 +
3049 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3050 +
3051 +(% class="box infomessage" %)
3052 +(((
3053 +**GET /api/v3/Drivers/{driverGuid}**
3054 +)))
3055 +
3056 +Передается параметр: ID водителя
3057 +
3058 +Ответ:
3059 +
3060 +{
3061 + "name": "string", ~/~/ Определяет наименование
3062 + "description": "string", ~/~/ Определяет описание
3063 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3064 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3065 + "exclusive": true, ~/~/ Определяет признак "Исключительный"
3066 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3067 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3068 + "deleted": true ~/~/ Признак удаления
3069 +}
3070 +
3071 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3072 +
3073 +(% class="box successmessage" %)
3074 +(((
3075 +**POST /api/v3/Drivers**
3076 +)))
3077 +
3078 +Запрос:
3079 +
3080 +{
3081 + "name": "string",
3082 + "description": "string",
3083 + "hiredate": "2023-06-30T12:50:54.020Z",
3084 + "chopdate": "2023-06-30T12:50:54.020Z",
3085 + "exclusive": true,
3086 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3087 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3088 + "deleted": true
3089 +}
3090 +
3091 +Ответ:
3092 +
3093 +{
3094 + "name": "string",
3095 + "description": "string",
3096 + "hiredate": "2023-06-30T12:50:54.051Z",
3097 + "chopdate": "2023-06-30T12:50:54.051Z",
3098 + "exclusive": true,
3099 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3100 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3101 + "deleted": true
3102 +}
3103 +
3104 +
3105 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3106 +
3107 +(% class="box warningmessage" %)
3108 +(((
3109 +**PUT /api/v3/Drivers**
3110 +)))
3111 +
3112 +Запрос:
3113 +
3114 +{
3115 + "name": "string",
3116 + "description": "string",
3117 + "hiredate": "2023-06-30T12:50:27.910Z",
3118 + "chopdate": "2023-06-30T12:50:27.910Z",
3119 + "exclusive": true,
3120 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3121 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3122 + "deleted": true
3123 +}
3124 +
3125 +Ответ:
3126 +
3127 +{
3128 + "name": "string",
3129 + "description": "string",
3130 + "hiredate": "2023-06-30T12:50:27.929Z",
3131 + "chopdate": "2023-06-30T12:50:27.929Z",
3132 + "exclusive": true,
3133 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3134 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3135 + "deleted": true
3136 +}
3137 +
3138 +
3139 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3140 +
3141 +(% class="box errormessage" %)
3142 +(((
3143 +**DELETE /api/v3/Drivers/{driverGuid}**
3144 +)))
3145 +
3146 +Передается параметр: ID водителя
3147 +
3148 +Ответ:
3149 +
3150 +Success
3151 +
3152 +
3153 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3154 +
3155 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3156 +
3157 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3158 +
3159 +(% class="box infomessage" %)
3160 +(((
3161 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3162 +)))
3163 +
3164 +Запрос:
3165 +
3166 +{
3167 + "Ids": [
3168 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3169 + ],
3170 + "BeginTime": "2023-06-30T12:49:04.365Z",
3171 + "EndTime": "2023-06-30T12:49:04.365Z"
3172 +}
3173 +
3174 +Ответ:
3175 +
3176 +[
3177 + {
3178 + "VehicleId": 0,
3179 + "CreateTime": "2023-06-30T09:52:31.240Z",
3180 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3181 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3182 + "BeginTime": "2023-06-30T09:52:31.240Z",
3183 + "EndTime": "2023-06-30T09:52:31.240Z"
3184 + }
3185 +]
3186 +
3187 +
3188 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3189 +
3190 +(% class="box infomessage" %)
3191 +(((
3192 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3193 +)))
3194 +
3195 +Запрос:
3196 +
3197 +{
3198 + "Ids": [
3199 + 0
3200 + ],
3201 + "BeginTime": "2023-06-30T12:48:39.419Z",
3202 + "EndTime": "2023-06-30T12:48:39.419Z"
3203 +}
3204 +
3205 +Ответ:
3206 +
3207 +[
3208 + {
3209 + "VehicleId": 0,
3210 + "CreateTime": "2023-06-30T09:54:01.631Z",
3211 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3212 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3213 + "BeginTime": "2023-06-30T09:54:01.631Z",
3214 + "EndTime": "2023-06-30T09:54:01.631Z"
3215 + }
3216 +]
3217 +
3218 +
3219 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3220 +
3221 +(% class="box successmessage" %)
3222 +(((
3223 +**POST /api/v3/DriversVehiclesAssignments**
3224 +)))
3225 +
3226 +Передается массив назначений
3227 +
3228 +Запрос:
3229 +
3230 +[
3231 + {
3232 + "VehicleId": 0, ~/~/ Идентификатор объекта
3233 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3234 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3235 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3236 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3237 + }
3238 +]
3239 +
3240 +Ответ:
3241 +
3242 +[
3243 + {
3244 + "VehicleId": 0,
3245 + "CreateTime": "2023-06-30T11:04:46.903Z",
3246 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3247 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3248 + "BeginTime": "2023-06-30T11:04:46.903Z",
3249 + "EndTime": "2023-06-30T11:04:46.903Z"
3250 + }
3251 +]
3252 +
3253 +
3254 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3255 +
3256 +(% class="box warningmessage" %)
3257 +(((
3258 +**PUT /api/v3/DriversVehiclesAssignments**
3259 +)))
3260 +
3261 +Запрос:
3262 +
3263 +[
3264 + {
3265 + "VehicleId": 0,
3266 + "CreateTime": "2023-06-30T11:14:08.117Z",
3267 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3268 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3269 + "BeginTime": "2023-06-30T11:14:08.117Z",
3270 + "EndTime": "2023-06-30T11:14:08.117Z"
3271 + }
3272 +]
3273 +
3274 +Ответ:
3275 +
3276 +[
3277 + {
3278 + "VehicleId": 0,
3279 + "CreateTime": "2023-06-30T11:14:53.349Z",
3280 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3281 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3282 + "BeginTime": "2023-06-30T11:14:53.349Z",
3283 + "EndTime": "2023-06-30T11:14:53.349Z"
3284 + }
3285 +]
3286 +
3287 +
3288 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3289 +
3290 +(% class="box errormessage" %)
3291 +(((
3292 +**DELETE /api/v3/DriversVehiclesAssignments**
3293 +)))
3294 +
3295 +Запрос:
3296 +
3297 +[
3298 + "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3299 +]
3300 +
3301 +Ответ:
3302 +
3303 +Success
3304 +
3305 +
3306 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3307 +
3308 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3309 +
3310 +(% class="box infomessage" %)
3311 +(((
3312 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3313 +)))
3314 +
3315 +Запрос:
3316 +
3317 +{
3318 + "Ids": [
3319 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3320 + ],
3321 + "BeginTime": "2023-06-30T12:47:12.162Z",
3322 + "EndTime": "2023-06-30T12:47:12.162Z"
3323 +}
3324 +
3325 +Ответ:
3326 +
3327 +[
3328 + {
3329 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3330 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3331 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3332 + "BeginTime": "2023-06-30T11:19:40.703Z",
3333 + "EndTime": "2023-06-30T11:19:40.703Z"
3334 + }
3335 +]
3336 +
3337 +
3338 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3339 +
3340 +(% class="box infomessage" %)
3341 +(((
3342 +**POST /api/v3/DriversRfidsAssignments/GetByRfids**
3343 +)))
3344 +
3345 +Запрос:
3346 +
3347 +{
3348 + "Ids": [
3349 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3350 + ],
3351 + "BeginTime": "2023-06-30T12:47:12.162Z",
3352 + "EndTime": "2023-06-30T12:47:12.162Z"
3353 +}
3354 +
3355 +Ответ:
3356 +
3357 +[
3358 + {
3359 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3360 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3361 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3362 + "BeginTime": "2023-06-30T11:19:40.703Z",
3363 + "EndTime": "2023-06-30T11:19:40.703Z"
3364 + }
3365 +]
3366 +
3367 +
3368 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3369 +
3370 +(% class="box successmessage" %)
3371 +(((
3372 +**POST /api/v3/DriversRfidsAssignments**
3373 +)))
3374 +
3375 +Запрос:
3376 +
3377 +[
3378 + {
3379 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3380 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3381 + "BeginTime": "2023-06-30T11:27:08.635Z",
3382 + "EndTime": "2023-06-30T11:27:08.635Z"
3383 + }
3384 +]
3385 +
3386 +Ответ:
3387 +
3388 +[
3389 + {
3390 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3391 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3392 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3393 + "BeginTime": "2023-06-30T11:27:08.677Z",
3394 + "EndTime": "2023-06-30T11:27:08.677Z"
3395 + }
3396 +]
3397 +
3398 +
3399 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3400 +
3401 +(% class="box warningmessage" %)
3402 +(((
3403 +**PUT /api/v3/DriversRfidsAssignments**
3404 +)))
3405 +
3406 +Запрос:
3407 +
3408 +[
3409 + {
3410 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3411 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3412 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3413 + "BeginTime": "2023-06-30T11:28:43.330Z",
3414 + "EndTime": "2023-06-30T11:28:43.330Z"
3415 + }
3416 +]
3417 +
3418 +Ответ:
3419 +
3420 +[
3421 + {
3422 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3423 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3424 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3425 + "BeginTime": "2023-06-30T11:28:43.331Z",
3426 + "EndTime": "2023-06-30T11:28:43.331Z"
3427 + }
3428 +]
3429 +
3430 +
3431 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3432 +
3433 +(% class="box errormessage" %)
3434 +(((
3435 +**DELETE /api/v3/DriversRfidsAssignments**
3436 +)))
3437 +
3438 +Запрос:
3439 +
3440 +[
3441 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3442 +]
3443 +
3444 +Ответ:
3445 +
3446 +Success
3447 +
3448 +
3449 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3450 +
3451 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3452 +
3453 +(% class="box infomessage" %)
3454 +(((
3455 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3456 +)))
3457 +
3458 +Запрос:
3459 +
3460 +{
3461 + "Ids": [
3462 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3463 + ],
3464 + "BeginTime": "2023-06-30T12:45:10.852Z",
3465 + "EndTime": "2023-06-30T12:45:10.852Z"
3466 +}
3467 +
3468 +Ответ:
3469 +
3470 +[
3471 + {
3472 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3473 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3474 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3475 + "BeginTime": "2023-06-30T11:58:04.695Z",
3476 + "EndTime": "2023-06-30T11:58:04.695Z"
3477 + }
3478 +]
3479 +
3480 +
3481 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3482 +
3483 +(% class="box infomessage" %)
3484 +(((
3485 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3486 +)))
3487 +
3488 +Запрос:
3489 +
3490 +{
3491 + "Ids": [
3492 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3493 + ],
3494 + "BeginTime": "2023-06-30T12:45:10.852Z",
3495 + "EndTime": "2023-06-30T12:45:10.852Z"
3496 +}
3497 +
3498 +Ответ:
3499 +
3500 +[
3501 + {
3502 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3503 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3504 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3505 + "BeginTime": "2023-06-30T11:58:04.695Z",
3506 + "EndTime": "2023-06-30T11:58:04.695Z"
3507 + }
3508 +]
3509 +
3510 +
3511 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3512 +
3513 +(% class="box successmessage" %)
3514 +(((
3515 +**POST /api/v3/DriversFuelCardsAssignments**
3516 +)))
3517 +
3518 +Запрос:
3519 +
3520 +[
3521 + {
3522 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3523 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3524 + "BeginTime": "2023-06-30T12:09:53.175Z",
3525 + "EndTime": "2023-06-30T12:09:53.175Z"
3526 + }
3527 +]
3528 +
3529 +Ответ:
3530 +
3531 +[
3532 + {
3533 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3534 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3535 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3536 + "BeginTime": "2023-06-30T12:09:53.201Z",
3537 + "EndTime": "2023-06-30T12:09:53.201Z"
3538 + }
3539 +]
3540 +
3541 +
3542 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3543 +
3544 +(% class="box warningmessage" %)
3545 +(((
3546 +**PUT /api/v3/DriversFuelCardsAssignments**
3547 +)))
3548 +
3549 +Запрос:
3550 +
3551 +[
3552 + {
3553 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3554 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3555 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3556 + "BeginTime": "2023-06-30T12:09:53.201Z",
3557 + "EndTime": "2023-06-30T12:09:53.201Z"
3558 + }
3559 +]
3560 +
3561 +Ответ:
3562 +
3563 +[
3564 + {
3565 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3566 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3567 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3568 + "BeginTime": "2023-06-30T12:09:53.201Z",
3569 + "EndTime": "2023-06-30T12:09:53.201Z"
3570 + }
3571 +]
3572 +
3573 +
3574 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3575 +
3576 +(% class="box errormessage" %)
3577 +(((
3578 +**DELETE /api/v3/DriversFuelCardsAssignments**
3579 +)))
3580 +
3581 +Запрос:
3582 +
3583 +[
3584 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3585 +]
3586 +
3587 +Ответ:
3588 +
3589 +Success
3590 +
3591 +
3592 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3593 +
3594 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3595 +
3596 +(% class="box infomessage" %)
3597 +(((
3598 +**POST /api/v3/Trailers**
3599 +)))
3600 +
3601 +Пример запроса:
3602 +
3603 +{
3604 + "startDate": "2023-11-14T10:48:03.671Z",
3605 + "endDate": "2023-11-14T10:48:03.671Z",
3606 + "ids": [ 0 ],
3607 + "timezone": 0
3608 +}
3609 +
3610 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3611 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3612 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3613 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3614 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3615 +
3616 +Пример ответа:
3617 +
3618 +[
3619 + {
3620 + "SD": "2023-11-14T10:48:03.717Z",
3621 + "ED": "2023-11-14T10:48:03.717Z", 
3622 + "id": 0,
3623 + "SLat": 0,
3624 + "SLon": 0,
3625 + "ELat": 0,
3626 + "ELon": 0,
3627 + "mileage": 0
3628 + "Duration": 0
3629 + "Address": "string",
3630 + "Address2": "string",
3631 + "name": "string",
3632 + "rid": "string",
3633 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3634 + "trailer": {
3635 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3636 + "Number": "string",
3637 + "Description": "string",
3638 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3639 + "ExternalID": "string",
3640 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3641 + "CreateTime": "2023-11-14T10:48:03.717Z",
3642 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3643 + "IsDeleted": true
3644 + },
3645 + "filesCount": 0,
3646 + }
3647 +]
3648 +
3649 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3650 +|SD|Дата и время начала события
3651 +|ED|Дата и время окончания события
3652 +|id|ID объекта
3653 +|SLat|Широта начальной координаты
3654 +|SLon|Долгота начальной координаты
3655 +|ELat|Широта конечной координаты
3656 +|ELon|Долгота конечной координаты
3657 +|mileage|Пробег
3658 +|Duration|Продолжительность
3659 +|Address|Адрес начального местоположения
3660 +|Address2|Адрес конечного местоположения
3661 +|name|Имя радиометки
3662 +|rid|Номер радиометки
3663 +|rguid|ID радиометки
3664 +|trailer|Информация об агрегате
3665 +|ModelGuid|ID агрегата
3666 +|Number|Название/номер агрегата
3667 +|Description|Текст примечания агрегата
3668 +
3669 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3670 +
3671 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3672 +
3673 +(% class="box infomessage" %)
3674 +(((
3675 +**POST /api/v3/Rfids/find**
3676 +)))
3677 +
3678 +Запрос:
3679 +
3680 +{
3681 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3682 +}
3683 +
3684 +Ответ:
3685 +
3686 +[
3687 + {
3688 + "name": "string",
3689 + "number": 0,
3690 + "period": 0,
3691 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3692 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3693 + }
3694 +]
3695 +
3696 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3697 +|parentId|ID клиента
3698 +|name|Название карты-метки
3699 +|number|Номер
3700 +|period|Период запросов в секундах (работает только для агрегатов)
3701 +|id|ID карты-метки
3702 +
3703 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3704 +
3705 +(% class="box infomessage" %)
3706 +(((
3707 +**GET /api/v3/Rfids/{rfidGuid}**
3708 +)))
3709 +
3710 +Передаем параметр rfidGuid - идентификатор карты-метки
3711 +
3712 +Ответ:
3713 +
3714 +[
3715 + {
3716 + "name": "string",
3717 + "number": 0,
3718 + "period": 0,
3719 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3720 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3721 + }
3722 +]
3723 +
3724 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3725 +|name|Название карты-метки
3726 +|number|Номер
3727 +|period|Период запросов в секундах (работает только для агрегатов)
3728 +|id|ID карты-метки
3729 +|parentId|ID клиента
3730 +
3731 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3732 +
3733 +(% class="box successmessage" %)
3734 +(((
3735 +**POST /api/v3/Rfids**
3736 +)))
3737 +
3738 +Запрос:
3739 +
3740 +{
3741 + "name": "string",
3742 + "number": 0,
3743 + "period": 0,
3744 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3745 +}
3746 +
3747 +Ответ:
3748 +
3749 +{
3750 + "name": "string",
3751 + "number": 0,
3752 + "period": 0,
3753 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3754 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3755 +}
3756 +
3757 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3758 +|name|Название карты-метки
3759 +|number|Номер
3760 +|period|Период запросов в секундах (работает только для агрегатов)
3761 +|id|ID карты-метки
3762 +|parentId|ID клиента
3763 +
3764 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3765 +
3766 +(% class="box warningmessage" %)
3767 +(((
3768 +**PUT /api/v3/Rfids**
3769 +)))
3770 +
3771 +Запрос:
3772 +
3773 +{
3774 + "name": "string",
3775 + "number": 0,
3776 + "period": 0,
3777 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3778 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3779 +}
3780 +
3781 +Ответ:
3782 +
3783 +{
3784 + "name": "string",
3785 + "number": 0,
3786 + "period": 0,
3787 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3788 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3789 +}
3790 +
3791 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3792 +|name|Название карты-метки
3793 +|number|Номер
3794 +|period|Период запросов в секундах (работает только для агрегатов)
3795 +|id|ID карты-метки
3796 +|parentId|ID клиента
3797 +
3798 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3799 +
3800 +(% class="box errormessage" %)
3801 +(((
3802 +**DELETE /api/v3/Rfids/{rfidGuid}**
3803 +)))
3804 +
3805 +Передаем параметр **rfidGuid** - идентификатор карты-метки
3806 +
3807 +Ответ:
3808 +
3809 +Success
3810 +
3811 +
3812 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3813 +
3814 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3815 +
3816 +(% class="box infomessage" %)
3817 +(((
3818 +**GET /api/v3/Billing/client/balance/{clientId}**
3819 +)))
3820 +
3821 +Параметр запроса: **clientId **- идентификатор клиента.
3822 +
3823 +Ответ:
3824 +
3825 +{
3826 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3827 + "Balance": 0
3828 +}
3829 +
3830 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3831 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3832 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3833 +
3834 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3835 +
3836 +(% class="box infomessage" %)
3837 +(((
3838 +**GET /api/v3/Billing/client/constraint/{clientId}**
3839 +)))
3840 +
3841 +Параметр запроса: **clientId **- идентификатор клиента.
3842 +
3843 +Ответ:
3844 +
3845 +{
3846 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3847 + "CalculationType": 0,
3848 + "PermissibleBalance": 0,
3849 + "DefermentDays": 0,
3850 + "SendUiNotifications": true,
3851 + "SendEmailNotifications": true,
3852 + "IsPrivate": true,
3853 +}
3854 +
3855 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3856 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3857 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3858 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3859 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3860 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3861 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3862 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3863 +
3864 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3865 +
3866 +(% class="box infomessage" %)
3867 +(((
3868 +**GET /api/v3/Billing/client/plan/{clientId}**
3869 +)))
3870 +
3871 +Параметры запроса:
3872 +
3873 +**clientId **- идентификатор клиента.
3874 +
3875 +**planId **- идентификатор тарифного плана.
3876 +
3877 +Ответ:
3878 +
3879 +{
3880 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3881 + "Plan": { **~/~/ Описание тарифного плана**
3882 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3883 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3884 + "Name": "string",
3885 + "IsArchived": true,
3886 + "Constraint": {
3887 + "CalculationType": 0,
3888 + "PermissibleBalance": 0,
3889 + "DefermentDays": 0
3890 + },
3891 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3892 + {
3893 + "Feature": "string",
3894 + "IsFactual": true,
3895 + "Limit": 0,
3896 + "Price": 0,
3897 + "PeriodValue": 0,
3898 + "PeriodType": 0
3899 + }
3900 + ]
3901 + },
3902 + "DebitDate": "2023-10-18T12:46:24.213Z",
3903 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3904 + {
3905 + "Feature": "string",
3906 + "IsEnabled": true,
3907 + "IsPrivate": true,
3908 + "IsFactual": true,
3909 + "Limit": 0,
3910 + "Price": 0,
3911 + "DebitDate": "2023-10-18T12:46:24.213Z",
3912 + "PeriodValue": 0,
3913 + "PeriodType": 0
3914 + }
3915 + ]
3916 +}
3917 +
3918 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3919 +|ClientId|Идентификатор клиента
3920 +|Id|Идентификатор тарифного плана
3921 +|OwnerId|Идентификатор клиента-владельца
3922 +|Name|Наименование тарифного плана
3923 +|IsArchived|Признак, определяющий архивный тарифный план
3924 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3925 +|PermissibleBalance|Допустимый баланс
3926 +|DefermentDays|Отсрочка, количество дней
3927 +|Feature|Код услуги
3928 +|IsEnabled|Признак, определяющий активирована ли услуга
3929 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3930 +|IsFactual|Признак, определяющий расчёт по факту
3931 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3932 +|Price|Цена за единицу.
3933 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3934 +|PeriodValue|Значение периода.
3935 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3936 +
3937 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3938 +
3939 +(% class="box infomessage" %)
3940 +(((
3941 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3942 +)))
3943 +
3944 +Параметр запроса: **clientId **- идентификатор клиента.
3945 +
3946 +Ответ:
3947 +
3948 +[
3949 + {
3950 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3951 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3952 + "Name": "string",
3953 + "IsArchived": true,
3954 + "Constraint": {
3955 + "CalculationType": 0,
3956 + "PermissibleBalance": 0,
3957 + "DefermentDays": 0
3958 + },
3959 + "Features": [
3960 + {
3961 + "Feature": "string",
3962 + "IsFactual": true,
3963 + "Limit": 0,
3964 + "Price": 0,
3965 + "PeriodValue": 0,
3966 + "PeriodType": 0
3967 + }
3968 + ]
3969 + }
3970 +]
3971 +
3972 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3973 +|ClientId|Идентификатор клиента
3974 +|Id|Идентификатор тарифного плана
3975 +|OwnerId|Идентификатор клиента-владельца
3976 +|Name|Наименование тарифного плана
3977 +|IsArchived|Признак, определяющий архивный тарифный план
3978 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3979 +|PermissibleBalance|Допустимый баланс
3980 +|DefermentDays|Отсрочка, количество дней
3981 +|Feature|Код услуги
3982 +|IsFactual|Признак, определяющий расчёт по факту
3983 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3984 +|Price|Цена за единицу.
3985 +|PeriodValue|Значение периода.
3986 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3987 +
3988 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3989 +
3990 +(% class="box infomessage" %)
3991 +(((
3992 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3993 +)))
3994 +
3995 +Параметр запроса: **clientId **- идентификатор клиента.
3996 +
3997 +Ответ:
3998 +
3999 +[
4000 + {
4001 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4002 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4003 + "Name": "string",
4004 + "IsArchived": true,
4005 + "Constraint": {
4006 + "CalculationType": 0,
4007 + "PermissibleBalance": 0,
4008 + "DefermentDays": 0
4009 + },
4010 + "Features": [
4011 + {
4012 + "Feature": "string",
4013 + "IsFactual": true,
4014 + "Limit": 0,
4015 + "Price": 0,
4016 + "PeriodValue": 0,
4017 + "PeriodType": 0
4018 + }
4019 + ]
4020 + }
4021 +]
4022 +
4023 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4024 +|ClientId|Идентификатор клиента
4025 +|Id|Идентификатор тарифного плана
4026 +|OwnerId|Идентификатор клиента-владельца
4027 +|Name|Наименование тарифного плана
4028 +|IsArchived|Признак, определяющий архивный тарифный план
4029 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4030 +|PermissibleBalance|Допустимый баланс
4031 +|DefermentDays|Отсрочка, количество дней
4032 +|Feature|Код услуги
4033 +|IsFactual|Признак, определяющий расчёт по факту
4034 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4035 +|Price|Цена за единицу.
4036 +|PeriodValue|Значение периода.
4037 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4038 +
4039 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4040 +
4041 +(% class="box warningmessage" %)
4042 +(((
4043 +**PUT /api/v3/Billing/client/balance**
4044 +)))
4045 +
4046 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4047 +
4048 +Тело запроса:
4049 +
4050 +{
4051 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4052 + "Balance": 0
4053 +}
4054 +
4055 +Ответ: Success
4056 +
4057 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4058 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4059 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4060 +
4061 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4062 +
4063 +(% class="box warningmessage" %)
4064 +(((
4065 +**PUT /api/v3/billing/client/balance/deposit**
4066 +)))
4067 +
4068 +Создает операцию **Пополнение **с указанной суммой
4069 +
4070 +Тело запроса:
4071 +
4072 +{
4073 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4074 + "Balance": 0
4075 +}
4076 +
4077 +Ответ: Success
4078 +
4079 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4080 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4081 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4082 +
4083 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4084 +
4085 +Создает операцию **Списание **с указанной суммой
4086 +
4087 +(% class="box warningmessage" %)
4088 +(((
4089 +**PUT /api/v3/billing/client/balance/withdraw**
4090 +)))
4091 +
4092 +Тело запроса:
4093 +
4094 +{
4095 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4096 + "Balance": 0
4097 +}
4098 +
4099 +Ответ: Success
4100 +
4101 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4102 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4103 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4104 +
4105 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4106 +
4107 +(% class="box warningmessage" %)
4108 +(((
4109 +**PUT /api/v3/Billing/client/constraint**
4110 +)))
4111 +
4112 +Тело запроса:
4113 +
4114 +{
4115 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4116 + "CalculationType": 0,
4117 + "PermissibleBalance": 0,
4118 + "DefermentDays": 0,
4119 + "SendUiNotifications": true,
4120 + "SendEmailNotifications": true,
4121 + "IsPrivate": true,
4122 +}
4123 +
4124 +Ответ: Success
4125 +
4126 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4127 +|ClientId|Идентификатор клиента
4128 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4129 +|PermissibleBalance|Допустимый баланс
4130 +|DefermentDays|(((
4131 +Отсрочка, количество дней
4132 +)))
4133 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4134 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4135 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4136 +
4137 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4138 +
4139 +(% class="box warningmessage" %)
4140 +(((
4141 +**PUT /api/v3/Billing/client/plan**
4142 +)))
4143 +
4144 +Тело запроса:
4145 +
4146 +{
4147 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4148 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4149 + "Features": [
4150 + {
4151 + "Feature": "string",
4152 + "IsEnabled": true,
4153 + "IsFactual": true,
4154 + "Limit": 0,
4155 + "Price": 0,
4156 + "DebitDate": "2023-10-18T13:26:58.987Z",
4157 + "PeriodValue": 0,
4158 + "PeriodType": 0
4159 + }
4160 + ]
4161 +}
4162 +
4163 +Ответ: Success
4164 +
4165 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4166 +|ClientId|Идентификатор клиента
4167 +|PlanId|Идентификатор тарифного плана
4168 +|Feature|Код услуги
4169 +|IsEnabled|Признак, определяющий активирована ли услуга
4170 +|IsFactual|Признак, определяющий расчёт по факту
4171 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4172 +|Price|Цена за единицу.
4173 +|DebitDate|Следующий момент времени списания с баланса за услугу.
4174 +|PeriodValue|Значение периода.
4175 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4176 +
4177 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4178 +
4179 +(% class="box warningmessage" %)
4180 +(((
4181 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4182 +)))
4183 +
4184 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4185 +
4186 +(% class="box infomessage" %)
4187 +(((
4188 +**POST /api/v3/vehicles/import/{agentId}**
4189 +)))
4190 +
4191 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4192 +
4193 +В пути указывается **agentId** - id клиента.
4194 +
4195 +**Заголовок**
4196 +
4197 +**X-Auth: [токен авторизации]**
4198 +
4199 +**Параметры**
4200 +
4201 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4202 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4203 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4204 +
4205 +В теле использовать тип **form-data,** тип значения** file**
4206 +
4207 +**Ключи**
4208 +
4209 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4210 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
4211 +|csv|В значении передаем файл датчиков, формат **csv**
4212 +
4213 +Ответ:
4214 +
4215 +{
4216 + "vehicleId": 0,
4217 + "name": "string",
4218 + "errors": ["string"]
4219 +}
4220 +
4221 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4222 +|vehicleId|ID созданного объекта
4223 +|name|Имя созданного объекта
4224 +|errors|Ошибки и их описание
4225 +
4226 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4227 +
4228 +(% class="box infomessage" %)
4229 +(((
4230 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4231 +)))
4232 +
4233 +(% class="wikigeneratedid" %)
4234 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4235 +
4236 +(% class="wikigeneratedid" %)
4237 +В пути указывается **vehicleId **- id объекта.
4238 +
4239 +**Заголовок**
4240 +
4241 +**X-Auth: [токен авторизации]**
4242 +
4243 +В теле использовать тип **form-data.**
4244 +
4245 +Ключи:
4246 +
4247 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4248 +|**history**|В значении передавать файл с историей
4249 +
4250 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4251 +
4252 +Ответ:
4253 +
4254 +{
4255 + "results": [
4256 + {
4257 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4258 + "vehicleId": 0,
4259 + "errors": [
4260 + "string"
4261 + ],
4262 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
4263 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
4264 + "producedCount": 0,
4265 + "msgCount": 0
4266 + }
4267 + ]
4268 +}
4269 +
4270 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4271 +|results|Результаты импорта в разрезе ТС
4272 +|vehicleGuid|Guid ТС
4273 +|vehicleId|ID ТС
4274 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4275 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
4276 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4277 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
4278 +|msgCount|Кол-во обработанных сообщений всего
4279 +
4280 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4281 +
4282 +(% class="box infomessage" %)
4283 +(((
4284 +**GET /api/v3/vehicles/import/history/status**
4285 +)))
4286 +
4287 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4288 +
4289 +Ответ:
4290 +
4291 +{
4292 + "activity": true,
4293 + "progress": 0,
4294 + "message": "string"
4295 +}
4296 +
4297 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4298 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4299 +|progress|Guid ТС
4300 +
4301 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4302 +
4303 +(% class="box infomessage" %)
4304 +(((
4305 +**POST /api/v3/vehicles/export**
4306 +)))
4307 +
4308 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4309 +
4310 +Тело запроса:
4311 +
4312 +[
4313 + id
4314 +]
4315 +
4316 +Ответ: Success 200, получаете файлы с настройками.
4317 +
4318 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4319 +
4320 +(% class="box infomessage" %)
4321 +(((
4322 +**POST /api/v3/vehicles/export/history**
4323 +)))
4324 +
4325 +Метод возвращает список сообщений терминала объекта за выбранный период.
4326 +
4327 +Тело запроса:
4328 +
4329 +{
4330 + "vehicleId": 0,
4331 + "asArchive": true,
4332 + "from": "2023-09-27T12:17:45.973Z",
4333 + "to": "2023-09-27T12:17:45.973Z"
4334 +}
4335 +
4336 +Ответ:
4337 +
4338 +Получаете файл. Сообщение: Code 200/Success
4339 +
4340 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4341 +|vehicleId|ID объекта
4342 +|asArchive|true - Архивировать файл, False - не архивировать
4343 +|from|Дата и время начала запроса
4344 +|to|Дата и время окончания запроса
4345 +
4346 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4347 +
4348 +(% class="box infomessage" %)
4349 +(((
4350 +**GET /api/v3/vehicles/export/history/status**
4351 +)))
4352 +
4353 +Метод возвращает список сообщений терминала объекта за выбранный период.
4354 +
4355 +Ответ:
4356 +
4357 +{
4358 + "activity": true,
4359 + "progress": 0,
4360 + "message": "string"
4361 +}
4362 +
4363 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4364 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4365 +|progress|Прогресс экспорта, от 0 до 100%
4366 +|message|Текст описывающий статус
4367 +
4368 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4369 +
4370 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4371 +
4372 +(% class="box infomessage" %)
4373 +(((
4374 +**POST /api/v3/EcoDriving/rating**
4375 +)))
4376 +
4377 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4378 +
4379 +Тело запроса:
4380 +
4381 +{
4382 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4383 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4384 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4385 +}
4386 +
4387 +Ответ:
4388 +
4389 +{
4390 + "items": [  ~/~/ Список в разрезе ТС
4391 + {
4392 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4393 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4394 + "vehicleId": 0, ~/~/ ID ТС
4395 + "vehicleName": "string", ~/~/ Название ТС
4396 + "vehicleModel": "string", ~/~/ Модель ТС
4397 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4398 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4399 + "totalViolations": 0, ~/~/ Нарушений всего
4400 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4401 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4402 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4403 + "brakingViolations": 0, ~/~/ Нарушений торможения
4404 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4405 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4406 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4407 + },
4408 +
4409 +(((
4410 +
4411 +)))
4412 +
4413 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4414 + "mileage": 0, ~/~/ Пробег, м
4415 + "tripsCount": 0, ~/~/ Кол-во рейсов
4416 + "trips": [  ~/~/ Информация по рейсу
4417 + {
4418 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4419 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4420 + "violationsCount": 0, ~/~/ Всего нарушений
4421 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4422 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4423 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4424 + "brakingViolations": 0, ~/~/ Нарушений торможения
4425 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4426 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4427 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4428 + },
4429 +
4430 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4431 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4432 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4433 + "mileage": 0, ~/~/ Пробег, м
4434 + "motohours": 0, ~/~/ Моточасы, секунды
4435 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4436 + "startAddress": "string", ~/~/ Адрес начала рейса
4437 + "endAddress": "string", ~/~/ Адрес конца рейса
4438 + "drivers": [  ~/~/ Список водителей
4439 + {
4440 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4441 + "driverName": "string", ~/~/ФИО водителя
4442 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4443 + }
4444 + ]
4445 + }
4446 + ]
4447 + }
4448 + ]
4449 +}
4450 +
4451 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4452 +
4453 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4454 +
4455 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4456 +
4457 +(% class="box infomessage" %)
4458 +(((
4459 +**POST /api/v3/fuelcards/transactions**
4460 +)))
4461 +
4462 +Метод запроса: POST
4463 +
4464 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4465 +\\В заголовках запроса: X-Auth: Токен авторизации
4466 +
4467 +Параметры в теле запроса (JSON):
4468 +
4469 +{
4470 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4471 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4472 + "ids": [ 
4473 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4474 + ],
4475 + "timezone": 0 ~/~/ Часовой пояс
4476 +}
4477 +
4478 +
4479 +Ответ:
4480 + {
4481 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4482 + "driver": "string", ~/~/ Водители, привязанные к ТК
4483 + "object": "string", ~/~/ Наименование ТС
4484 + "amount": 0, ~/~/ Количество топлива
4485 + "amountDut": 0, ~/~/ Количество по ДУТ
4486 + "amountDiff": 0, ~/~/ Разница, л
4487 + "amountDiffPerc": 0, ~/~/ Разница, %
4488 + "summa": 0, ~/~/ Стоимость, руб
4489 + "serviceName": "string", ~/~/ Тип топлива
4490 + "price": 0, ~/~/ Цена за литр, руб
4491 + "cardName": "string", ~/~/ Наименование ТК
4492 + "cardNum": "string", ~/~/ Номер ТК
4493 + "operator": "string", ~/~/ Оператор ТК
4494 + "address": "string" ~/~/ Адрес АЗС
4495 + }
4496 +
4497 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4498 +
4499 +(% class="box infomessage" %)
4500 +(((
4501 +**GET /api/v3/fuelcards**
4502 +)))
4503 +
4504 +Метод запроса: GET
4505 +
4506 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4507 +
4508 +Ответ:
4509 +
4510 +[
4511 + {
4512 + "Name": "string", ~/~/ Определяет наименование карты.
4513 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4514 + "Number": "string", ~/~/ Определяет № карты.
4515 + "Enabled": true, ~/~/ Определяет признак активности карты.
4516 + "Description": "string", ~/~/ Определяет описание карты.
4517 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4518 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4519 + "deleted": true ~/~/ Признак удаления
4520 + }
4521 +]
4522 +
4523 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4524 +
4525 +
4526 +== **Получение полных данных о ретрансляторе** ==
4527 +
4528 +(% class="box infomessage" %)
4529 +(((
4530 +**GET ** **/api/v3/retranslations/{id}**
4531 +)))
4532 +
4533 +id - Идентификатор ретранслятора
4534 +
4535 +
4536 +Пример ответа:
4537 +
4538 +{  
4539 +"description": "", ~/~/ Поле описания ретранслятора
4540 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4541 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4542 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4543 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4544 +"objects": [ ~/~/ Объекты для ретрансляции
4545 +{      
4546 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4547 +"name": "", ~/~/ Наименование объекта ретрансляции
4548 +"imei": "", ~/~/ IMEI объекта  ретрансляции
4549 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4550 +}
4551 + ],  
4552 +"id": "", ~/~/ Идентификатор ретранслятора 
4553 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4554 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4555 +}
4556 +
4557 +
4558 +== **Удаление данных ретранслятора** ==
4559 +
4560 +(% class="box infomessage" %)
4561 +(((
4562 +**DELETE** **/api/v3/retranslations/{id}**
4563 +)))
4564 +
4565 +id - Идентификатор ретранслятора
4566 +
4567 +
4568 +== **Создание ретранслятора** ==
4569 +
4570 +(% class="box infomessage" %)
4571 +(((
4572 +**POST ** **/api/v3/retranslations/{id}**
4573 +)))
4574 +
4575 +Запрос:
4576 +
4577 +{  
4578 +"description": "", ~/~/ Поле описания ретранслятора
4579 +"subscriberId": "", ~/~/ Идентификатор подписчика
4580 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4581 +"address": "", ~/~/ Адрес и порт принимающего сервера
4582 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4583 +"objects": [ ~/~/Объекты для ретрансляции
4584 +{      
4585 +"id": "", ~/~/ Идентификатор ретранслятора 
4586 +"imei": "", ~/~/ IMEI объекта ретрансляции
4587 +"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4588 +}
4589 + ]
4590 +}
4591 +
4592 +
4593 +Ответ:
4594 +
4595 +{  
4596 +"description": "", ~/~/ Поле описания ретранслятора
4597 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4598 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4599 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4600 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4601 +"objects": [ ~/~/ Объекты для ретрансляции
4602 +{      
4603 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4604 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4605 +"imei": "", ~/~/ IMEI объекта ретрансляции
4606 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4607 +}
4608 + ],
4609 +"id": "", ~/~/ Идентификатор ретранслятора   
4610 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4611 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4612 +}
4613 +
4614 +
4615 +== **Редактирование ретранслятора** ==
4616 +
4617 +(% class="box infomessage" %)
4618 +(((
4619 +**PUT** **/api/v3/retranslations**
4620 +)))
4621 +
4622 +Пример запроса:
4623 +
4624 +{  
4625 +"id": "", ~/~/ Идентификатор ретранслятора   
4626 +"description": "string", ~/~/ Поле описания ретранслятора
4627 +"subscriberId": "", ~/~/ Идентификатор подписчика
4628 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4629 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4630 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4631 +"objects": ~/~/ Объекты для ретрансляции
4632 +[    
4633 +{      
4634 +"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4635 +"imei": "", ~/~/ IMEI объекта ретрансляции
4636 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4637 +}
4638 + ]
4639 +}
4640 +
4641 +
4642 +Пример ответа:
4643 +
4644 +{  
4645 +"description": "", ~/~/ Поле описания ретранслятора
4646 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4647 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4648 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4649 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4650 +"objects": [ ~/~/ Объекты для ретрансляции
4651 +{      
4652 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4653 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4654 +"imei": "", ~/~/ IMEI объекта ретрансляции
4655 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4656 +}
4657 + ],
4658 +"id": "", ~/~/ Идентификатор ретранслятора   
4659 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4660 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4661 +}
4662 +
4663 +
4664 +== **Получение списка ретранслятора клиента** ==
4665 +
4666 +(% class="box infomessage" %)
4667 +(((
4668 +**POST /api/v3/retranslations/find**
4669 +)))
4670 +
4671 +Пример запроса:
4672 +
4673 +{  
4674 +"id": "", ~/~/ Идентификатор ретранслятора   
4675 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4676 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4677 +}
4678 +
4679 +Ответ:
4680 +
4681 +[ 
4682 +{    
4683 +"description": "", ~/~/ Поле описания ретранслятора
4684 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4685 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4686 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4687 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4688 +"id": "", ~/~/ Идентификатор ретранслятора   
4689 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4690 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4691 +}
4692 +]
4693 +
4694 +
4695 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4696 +
4697 +== **API для отчета по выгрузке комбайнов** ==
4698 +
4699 +(% class="box infomessage" %)
4700 +(((
4701 +**POST /api/v3/Reports/harvesterUnloading**
4702 +)))
4703 +
4704 +Пример запроса:
4705 +
4706 +{
4707 + "byTime": 0, ~/~/ Объединение событий по времени
4708 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4709 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4710 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4711 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4712 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4713 + 0
4714 + ],
4715 + "from": "", ~/~/ Дата и время начало запроса
4716 + "to": "", ~/~/ Дата и время окончания запроса
4717 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4718 +}
4719 +
4720 +Пример ответа:
4721 +
4722 +[ 
4723 + {
4724 + "harvesterName": "", ~/~/Комбайн, номер
4725 + "harvesterId": 0, ~/~/Комбайн, id
4726 +"harvesterModel": "", ~/~/ Модель комбайна
4727 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4728 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4729 + "events": [ ~/~/Список событий в разрезе комбайна
4730 + {
4731 + "driverId": "", ~/~/Идентификатор водителя
4732 + "driverName": "", ~/~/Водитель комбайна, ФИО
4733 + "RFID": "", ~/~/ идентификатор карты-метки
4734 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4735 + "vehicleId": 0, ~/~/идентификатор объекта
4736 + "vehicleName": "string", ~/~/ Имя объекта
4737 + "modelName": "string", ~/~/ Имя модели объекта
4738 + "nearestVehicles": [ ~/~/Объекты рядом
4739 + {
4740 + "vehicleId": 0, ~/~/идентификатор объекта
4741 + "vehicleName": "string" ~/~/ Имя объекта
4742 + }
4743 + ],
4744 + "fields": [ ~/~/Поля, где происходила выгрузка
4745 + {
4746 + "id": 0, ~/~/ идентификатор пользователя 
4747 + "name": "string" ~/~/ имя пользователя 
4748 + }
4749 + ],
4750 + "event": "string", ~/~/Событие
4751 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4752 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4753 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4754 + "cultureName": "string", ~/~/ название культуры
4755 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4756 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4757 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4758 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4759 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4760 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4761 + "issued": 0, ~/~/Выдано, бункеров
4762 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4763 + "latitude": 0, ~/~/Широта
4764 + "longitude": 0, ~/~/ Долгота
4765 + "litresAway": 0, ~/~/Отдано, л
4766 + "m3Away": 0 ~/~/Отдано, м3
4767 + }
4768 + ]
4769 + }
4770 +]
4771 +
4772 +
4773 +== **Отчет трек-датчики** ==
4774 +
4775 +(% class="box infomessage" %)
4776 +(((
4777 +**POST /api/v3/Reports/sensorsWorks**
4778 +)))
4779 +
4780 +**Пример запроса:**
4781 +
4782 +{
4783 + "vehicleIds": [ ~/~/ Список ID объектов
4784 + 0
4785 + ],
4786 + "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4787 + "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4788 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4789 +}
4790 +
4791 +**Пример ответа:**
4792 +
4793 +(((
4794 +{
4795 + "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4796 + {
4797 + "vehicleId": 0, ~/~/ Идентификатор ТС
4798 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4799 + {
4800 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4801 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4802 + "duration": 0, ~/~/  Продолжительность интервала в секундах.
4803 + "name": "string", ~/~/ Наименование оборудования.
4804 + "mileage": 0, ~/~/ Пробег за время работы оборудования.
4805 + "totalMileage": 0, ~/~/ Общий пробег.
4806 + "avgSpeed": 0 ~/~/ Средняя скорость.
4807 + }
4808 + ]
4809 + }
4810 + ]
4811 +}
4812 +)))
4813 +
4814 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4815 +
4816 +
4817 +== **Запрос списка полей** ==
4818 +
4819 +(% class="box successmessage" %)
4820 +(((
4821 +**POST /api/v3/agroLands/find**
4822 +)))
4823 +
4824 +Пример запроса:
4825 +
4826 +(((
4827 +(((
4828 +(((
4829 +{
4830 + "year": 0, ~/~/ Фильтр по году
4831 + "name": "string", ~/~/ Фильтр по названию
4832 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4833 +}
4834 +)))
4835 +)))
4836 +
4837 +
4838 +)))
4839 +
4840 +Пример ответа:
4841 +
4842 +(((
4843 +[
4844 + {
4845 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4846 + "year": 0, ~/~/ Год поля
4847 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4848 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4849 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4850 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4851 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4852 + "counts": { ~/~/ Счётчики с/х поля 
4853 + "fieldOperations": 0, ~/~/ Количество операций на поле
4854 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4855 + "facts": 0 ~/~/ Счётчик факта
4856 + },
4857 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4858 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4859 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4860 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4861 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4862 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4863 + "planComment": "string", ~/~/ Комментарий к полю
4864 + "productivity": 0, ~/~/ Урожайность.
4865 + "id": 0, ~/~/ Идентификатор объекта геозоны
4866 + "name": "string", ~/~/ Название объекта геозоны
4867 + "type": 0, ~/~/ Тип объекта геозоны
4868 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4869 + "fname": "string", ~/~/ Имя файла
4870 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4871 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4872 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4873 + "description": "string", ~/~/ Описание объекта геозоны
4874 + "area": 0, ~/~/ Площадь, м2
4875 + "perimetr": 0, ~/~/ Периметр, м
4876 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4877 + }
4878 +]
4879 +
4880 +
4881 +== **Создание нового поля ** ==
4882 +
4883 +(% class="box successmessage" %)
4884 +(((
4885 +**POST /api/v3/agroLands**
4886 +)))
4887 +
4888 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
4889 +X-agent  - ID клиента
4890 +
4891 +Пример запроса:
4892 +
4893 +(((
4894 +{
4895 + "extId": "string", 
4896 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
4897 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
4898 + "display": "string", ~/~/ Настройки отображения
4899 + "year": 0, ~/~/ Год поля
4900 + "name": "string", ~/~/ Наименование
4901 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4902 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4903 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4904 + "planComment": "string", ~/~/ Комментарий к полю
4905 + "cropRotations": [ ~/~/ Данные по севообороту
4906 + {
4907 + "landId": 0, ~/~/ ID поля
4908 + "landName": "string", ~/~/ Название поля
4909 + "year": 0, ~/~/ Год урожая
4910 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4911 + "cultureName": "string", ~/~/ Название культуры
4912 + "productivity": 0, ~/~/ Урожайность
4913 + "area": 0, ~/~/ Площадь поля, Га
4914 + "total": 0, ~/~/ Валовый сбор
4915 + "productivityFact": 0, ~/~/ Фактическая урожайность
4916 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4917 + "totalFact": 0, ~/~/ Фактический валовый сбор
4918 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
4919 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
4920 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
4921 + "isyearplan": true, ~/~/ Годовой план 
4922 + "comment": "string" ~/~/ Комментарий
4923 + }
4924 + ]
4925 +}
4926 +)))
4927 +
4928 +(((
4929 +
4930 +)))
4931 +
4932 +Пример ответа:
4933 +
4934 +(((
4935 +(((
4936 +{
4937 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4938 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4939 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4940 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4941 + "cropRotations": [ ~/~/ Данные по севообороту
4942 + {
4943 + "landId": 0, ~/~/ ID поля
4944 + "landName": "string", ~/~/ Название поля
4945 + "year": 0, ~/~/ Год урожая 
4946 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4947 + "cultureName": "string", ~/~/ Название культуры
4948 + "productivity": 0, ~/~/ Урожайность
4949 + "area": 0, ~/~/ Площадь поля, Га.
4950 + "total": 0, ~/~/ Валовый сбор
4951 + "productivityFact": 0, ~/~/ Фактическая урожайность
4952 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4953 + "totalFact": 0, ~/~/ Фактический валовый сбор
4954 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
4955 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
4956 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
4957 + "isyearplan": true, ~/~/ годовой план 
4958 + "comment": "string" ~/~/ Комментарий
4959 + }
4960 + ],
4961 + "cropVegetation": [ ~/~/ История вегетации поля
4962 + {
4963 + "values": [  ~/~/ Данные вегетации и состояния посева
4964 + {
4965 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4966 + "ndvi": 0 ~/~/ Индекс вегетации
4967 + }
4968 + ],
4969 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
4970 + {
4971 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4972 + "type": "string", ~/~/ Тип
4973 + "pictureid": "string" ~/~/ Идентификатор ресурса
4974 + }
4975 + ],
4976 + "states": [ ~/~/ Ключевые даты развития поля
4977 + {
4978 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4979 + "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
4980 + }
4981 + ]
4982 + }
4983 + ],
4984 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
4985 + "counts": {
4986 + "fieldOperations": 0, ~/~/ Количество операций на поле
4987 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4988 + "facts": 0 ~/~/ Счётчик факта
4989 + },
4990 + "planComment": "string", ~/~/ Комментарий к полю
4991 +)))
4992 +
4993 +(((
4994 + "productivity": 0, ~/~/ Урожайность.
4995 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4996 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
4997 + "year": 0, ~/~/ Год поля
4998 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4999 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5000 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5001 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5002 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5003 + "id": 0, ~/~/ Идентификатор объекта геозоны
5004 + "name": "string", ~/~/ Название объекта геозоны
5005 + "type": 0, ~/~/ Тип объекта геозоны
5006 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5007 + "fname": "string", ~/~/ Имя файла
5008 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5009 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5010 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5011 + "description": "string", ~/~/ Описание объекта геозоны
5012 + "area": 0, ~/~/ Площадь, м2
5013 + "perimetr": 0, ~/~/ Периметр, м
5014 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5015 +}
5016 +
5017 +
5018 +)))
5019 +)))
5020 +)))
5021 +
5022 +== **Получение поля по id** ==
5023 +
5024 +(% class="box infomessage" %)
5025 +(((
5026 +**GET /api/v3/agroLands/{id}**
5027 +)))
5028 +
5029 +Пример запроса:
5030 +id  ~/~/ Идентификатор поля
5031 +
5032 +Пример ответа:
5033 +
5034 +(((
5035 +{
5036 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5037 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5038 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5039 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5040 + "cropRotations": [ ~/~/ Данные по севообороту
5041 + {
5042 + "landId": 0, ~/~/ ID поля
5043 + "landName": "string", ~/~/ Название поля
5044 + "year": 0, ~/~/ Год урожая
5045 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5046 + "cultureName": "string", ~/~/ Название культуры
5047 + "productivity": 0, ~/~/ Урожайность
5048 + "area": 0, ~/~/ Площадь поля, Га
5049 + "total": 0, ~/~/ Валовый сбор
5050 + "productivityFact": 0, ~/~/ Фактическая урожайность
5051 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5052 + "totalFact": 0, ~/~/ Фактический валовый сбор
5053 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5054 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5055 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5056 + "isyearplan": true, ~/~/ План года 
5057 + "comment": "string" ~/~/ Комментарий
5058 + }
5059 + ],
5060 + "cropVegetation": [ ~/~/ История вегетации поля
5061 + {
5062 + "values": [ ~/~/ Данные вегетации и состояния посева
5063 + {
5064 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5065 + "ndvi": 0 ~/~/ Индекс вегетации
5066 + }
5067 + ],
5068 + "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5069 + {
5070 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5071 + "type": "string", ~/~/ Тип 
5072 + "pictureid": "string" ~/~/ Идентификатор ресурса
5073 + }
5074 + ],
5075 + "states": [ ~/~/ Ключевые даты развития поля
5076 + {
5077 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5078 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5079 + }
5080 + ]
5081 + }
5082 + ],
5083 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5084 + "counts": {
5085 + "fieldOperations": 0, ~/~/ Количество операций на поле
5086 + "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5087 + "facts": 0 ~/~/ Счётчик факта
5088 + },
5089 + "planComment": "string", ~/~/ Комментарий к полю
5090 + "productivity": 0, ~/~/ Урожайность.
5091 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5092 +)))
5093 +
5094 +(((
5095 +(((
5096 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5097 + "year": 0, ~/~/ Год поля
5098 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5099 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5100 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5101 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5102 + "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5103 + "id": 0, ~/~/ Идентификатор объекта геозоны
5104 + "name": "string", ~/~/ Название объекта геозоны
5105 + "type": 0, ~/~/ Тип объекта геозоны 
5106 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5107 + "fname": "string", ~/~/ Имя файла
5108 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5109 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5110 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5111 + "description": "string", ~/~/ Описание объекта геозоны
5112 + "area": 0, ~/~/ Площадь, м2
5113 + "perimetr": 0, ~/~/ Периметр, м
5114 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5115 +}
5116 +)))
5117 +
5118 +
5119 +== **Удаление существующего поля** ==
5120 +
5121 +(% class="box errormessage" %)
5122 +(((
5123 +**DELETE /api/v3/agroLands/{id}**
5124 +)))
5125 +
5126 +Пример запроса:
5127 +id  ~/~/ Идентификатор поля
5128 +
5129 +Пример ответа:
5130 +
5131 +(((
5132 +200 ~/~/ Успех
5133 +)))
5134 +
5135 +(((
5136 +
5137 +)))
5138 +
5139 +(((
5140 +(((
5141 +(((
5142 +
5143 +)))
5144 +
5145 +(((
5146 +== **Изменение поля** ==
5147 +
5148 +(% class="box infomessage" %)
5149 +(((
5150 +**PUT /api/v3/agroLands**
5151 +)))
5152 +
5153 +Пример запроса:
5154 +
5155 +(((
5156 +(((
5157 +{
5158 + "id": 0, ~/~/ Идентификатор поля
5159 + "extId": "string", ~/~/ ExtId
5160 + "shape": "string", ~/~/ Форма поля
5161 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5162 + "display": "string", ~/~/ Настройки отображения
5163 + "year": 0, ~/~/ Год поля
5164 + "name": "string", ~/~/ Наименование
5165 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5166 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5167 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5168 + "planComment": "string", ~/~/Комментарий к полю
5169 + "cropRotations": [  ~/~/ Данные по севообороту
5170 + {
5171 + "landId": 0, ~/~/ ID поля
5172 + "landName": "string", ~/~/ Название поля
5173 + "year": 0, ~/~/ Год урожая
5174 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5175 + "cultureName": "string", ~/~/ Название культуры
5176 + "productivity": 0, ~/~/ Урожайность
5177 + "area": 0, ~/~/ Площадь поля, Га.
5178 + "total": 0, ~/~/ Валовый сбор
5179 + "productivityFact": 0, ~/~/ Фактическая урожайность
5180 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5181 + "totalFact": 0, ~/~/ Фактический валовый сбор
5182 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5183 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5184 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5185 + "isyearplan": true, 
5186 + "comment": "string" ~/~/ Комментарий
5187 + }
5188 + ],
5189 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5190 +}
5191 +)))
5192 +)))
5193 +
5194 +(((
5195 +
5196 +)))
5197 +
5198 +Пример ответа:
5199 +
5200 +(((
5201 +(((
5202 +(((
5203 +{
5204 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5205 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5206 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5207 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5208 + "cropRotations": [ ~/~/ Данные по севообороту
5209 + {
5210 + "landId": 0, ~/~/ ID поля
5211 + "landName": "string", ~/~/ Название поля
5212 + "year": 0, ~/~/  Год урожая
5213 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5214 + "cultureName": "string", ~/~/ Название культуры
5215 + "productivity": 0, ~/~/ Урожайность
5216 + "area": 0, ~/~/ Площадь поля, Га
5217 + "total": 0, ~/~/ Валовый сбор
5218 + "productivityFact": 0, ~/~/ Фактическая урожайность
5219 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5220 + "totalFact": 0, ~/~/ Фактический валовый сбор
5221 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5222 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5223 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5224 + "isyearplan": true, ~/~/ 
5225 + "comment": "string" ~/~/ Комментарий
5226 + }
5227 + ],
5228 + "cropVegetation": [ ~/~/ История вегетации поля
5229 + {
5230 + "values": [ ~/~/ Данные вегетации и состояния посева
5231 + {
5232 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5233 + "ndvi": 0 ~/~/ Индекс вегетации
5234 + }
5235 + ],
5236 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5237 + {
5238 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5239 + "type": "string", ~/~/ Тип
5240 + "pictureid": "string" ~/~/ Идентификатор ресурса
5241 + }
5242 + ],
5243 + "states": [ ~/~/ Ключевые даты развития поля 
5244 + {
5245 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5246 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5247 + }
5248 + ]
5249 + }
5250 + ],
5251 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5252 + "counts": { 
5253 + "fieldOperations": 0, ~/~/ Количество операций на поле
5254 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5255 + "facts": 0 ~/~/ Счётчик факта
5256 + },
5257 + "planComment": "string", ~/~/ Комментарий к полю
5258 + "productivity": 0, ~/~/ Урожайность.
5259 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5260 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5261 + "year": 0, ~/~/ Год поля
5262 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5263 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5264 + "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5265 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5266 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5267 + "id": 0, ~/~/ Идентификатор объекта геозоны
5268 + "name": "string", ~/~/ Название объекта геозоны
5269 + "type": 0, ~/~/ Тип объекта геозоны
5270 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5271 + "fname": "string", ~/~/ Имя файла
5272 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5273 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5274 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5275 + "description": "string", ~/~/ Описание объекта геозоны
5276 + "area": 0, ~/~/ Площадь, м2
5277 + "perimetr": 0, ~/~/ Периметр, м
5278 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5279 +}
5280 +)))
5281 +)))
5282 +)))
5283 +)))
5284 +)))
5285 +
5286 +
5287 +== **Редактирование года урожая ** ==
5288 +
5289 +(% class="box successmessage" %)
5290 +(((
5291 +**POST /api/v3/agroLands/updateOpenCloseYear**
5292 +)))
5293 +
5294 +Пример запроса:
5295 +
5296 +(((
5297 +(((
5298 +{
5299 + "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5300 + 0
5301 + ],
5302 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5303 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5304 +}
5305 +)))
5306 +
5307 +
5308 +)))
5309 +
5310 +Пример ответа:
5311 +
5312 +(((
5313 +(((
5314 +{
5315 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5316 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5317 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5318 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5319 + "cropRotations": [ ~/~/ Данные по севообороту
5320 + {
5321 + "landId": 0, ~/~/ ID поля
5322 + "landName": "string", ~/~/ Название поля
5323 + "year": 0, ~/~/ Год урожая
5324 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5325 + "cultureName": "string", ~/~/ Название культуры
5326 + "productivity": 0, ~/~/ Урожайность
5327 + "area": 0, ~/~/ Площадь поля, Га.
5328 + "total": 0, ~/~/ Валовый сбор
5329 + "productivityFact": 0, ~/~/ Фактическая урожайность
5330 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5331 + "totalFact": 0, ~/~/ Фактический валовый сбор
5332 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5333 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5334 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5335 + "isyearplan": true, ~/~/ 
5336 + "comment": "string" ~/~/ Комментарий
5337 + }
5338 + ],
5339 + "cropVegetation": [ ~/~/ История вегетации поля
5340 + {
5341 + "values": [ ~/~/ Данные вегетации и состояния посева
5342 + {
5343 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5344 + "ndvi": 0 ~/~/ Индекс вегетации
5345 + }
5346 + ],
5347 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5348 + {
5349 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5350 + "type": "string", ~/~/ Тип
5351 + "pictureid": "string" ~/~/ Идентификатор ресурса
5352 + }
5353 + ],
5354 + "states": [ ~/~/ Ключевые даты развития поля
5355 + {
5356 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5357 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5358 + }
5359 + ]
5360 + }
5361 + ],
5362 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5363 + "counts": { 
5364 + "fieldOperations": 0, ~/~/ Количество операций на поле
5365 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5366 + "facts": 0 ~/~/ Счётчик факта
5367 + },
5368 + "planComment": "string", ~/~/ Комментарий к полю
5369 + "productivity": 0, ~/~/ Урожайность.
5370 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5371 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5372 + "year": 0, ~/~/ Год поля
5373 + "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5374 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5375 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5376 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5377 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5378 + "id": 0, ~/~/ Идентификатор объекта геозоны
5379 + "name": "string", ~/~/ Название объекта геозоны
5380 + "type": 0, ~/~/ Тип объекта геозоны
5381 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5382 + "fname": "string", ~/~/ Имя файла
5383 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5384 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5385 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5386 + "description": "string", ~/~/ Описание объекта геозоны
5387 + "area": 0, ~/~/ Площадь, м2
5388 + "perimetr": 0, ~/~/ ериметр, м
5389 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5390 +}
5391 +)))
5392 +
5393 +
5394 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5395 +)))
5396 +)))
5397 +)))
5398 +
5399 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5400 +
5401 +
5402 +(% class="box infomessage" %)
5403 +(((
5404 +**GET api/v3/Vehicles/recyclebin/all**
5405 +)))
5406 +
5407 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5408 +
5409 +Параметр запроса: {parentId} - идентификатор агента
5410 +
5411 +В заголовках запроса: X-Auth: Токен авторизации
5412 +
5413 +Ответ:
5414 +
5415 +[ 
5416 + {
5417 + "recordTime": "", ~/~/Время записи
5418 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5419 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5420 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5421 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5422 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5423 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5424 + "items": [ ~/~/ 
5425 +nullable: true ~/~/Детали
5426 + {
5427 + "name": "string", ~/~/наименование столбца
5428 + "value": "string" ~/~/содержание столбца
5429 + }
5430 + ]
5431 + },
5432 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5433 + "string"
5434 + ]
5435 + }
5436 +]
5437 +
5438 +
5439 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5440 +
5441 +(% class="box infomessage" %)
5442 +(((
5443 +**POST api/v3/Vehicles/recyclebin/erase**
5444 +)))
5445 +
5446 +В заголовках запроса: X-Auth: Токен авторизации
5447 +
5448 +Пример запроса:
5449 +
5450 +[
5451 +0
5452 +]
5453 +
5454 +
5455 +Пример ответа:
5456 +
5457 +[ 
5458 +{
5459 + "recordTime": "", ~/~/Время записи
5460 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5461 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5462 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
5463 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5464 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5465 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5466 + "items": [ ~/~/Детали
5467 + {
5468 + "name": "", ~/~/Имя свойства
5469 + "value": "" ~/~/Значение свойства
5470 + }
5471 + ]
5472 + },
5473 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5474 + ""
5475 + ]
5476 + }
5477 +]
5478 +
5479 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5480 +
5481 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5482 +
5483 +(% class="box infomessage" %)
5484 +(((
5485 +**POST api/v3/Vehicles/recyclebin/restore**
5486 +)))
5487 +
5488 +В заголовках запроса: X-Auth: Токен авторизации
5489 +
5490 +Параметры в теле запроса (JSON):
5491 +
5492 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5493 +
5494 +В заголовках запроса: X-Auth: Токен авторизации
5495 +
5496 +
5497 +Пример запроса:
5498 +
5499 +(((
5500 +[
5501 +)))
5502 +
5503 +(((
5504 + 0
5505 +)))
5506 +
5507 +(((
5508 +]
5509 +)))
5510 +
5511 +
5512 +Пример ответа:
5513 +
5514 +[
5515 +{
5516 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5517 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5518 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5519 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5520 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5521 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5522 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5523 + "items": [ ~/~/Детали
5524 + {
5525 + "name": "string", ~/~/Имя свойства
5526 + "value": "string" ~/~/Значение свойства
5527 + }
5528 + ]
5529 + },
5530 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5531 + "string"
5532 + ]
5533 + }
5534 +]
5535 +
5536 +
5537 += **Раздел: Журнал заданий ** =
5538 +
5539 +
5540 +== **Создание задания в Журнале заданий** ==
5541 +
5542 +(% class="box infomessage" %)
5543 +(((
5544 +**POST /api/v3/vehicletasks**
5545 +)))
5546 +
5547 +Пример запроса:
5548 +
5549 +(((
5550 +{
5551 + "vehicleId": 0, ~/~/ Идентификатор ТС
5552 + "description": "string", ~/~/ Описание
5553 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5554 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5555 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5556 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5557 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5558 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5559 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5560 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5561 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5562 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5563 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5564 + "cost": { 
5565 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5566 + "Name": "string", ~/~/ Наименование
5567 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5568 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5569 + "Norm": 0 ~/~/ Норма внесения
5570 + },
5571 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5572 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5573 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5574 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5575 + "deleted": true, ~/~/ Признак удаления
5576 + "extId": "string", 
5577 + "GeoIds": [ ~/~/ Cвязанные поля
5578 + 0
5579 + ]
5580 +}
5581 +)))
5582 +
5583 +
5584 +Пример ответа:
5585 +
5586 +{
5587 + "vehicleId": 0, ~/~/ Идентификатор ТС
5588 + "description": "string", ~/~/ Описание
5589 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5590 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5591 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5592 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5593 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5594 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5595 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5596 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5597 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5598 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5599 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5600 + "cost": { 
5601 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5602 + "Name": "string", ~/~/ Наименование
5603 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5604 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5605 + "Norm": 0 ~/~/ Норма внесения
5606 + },
5607 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5608 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5609 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5610 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5611 + "deleted": true, ~/~/ Признак удаления
5612 + "extId": "string", ~/~/ ExtId
5613 + "GeoIds": [ ~/~/ Связанные поля
5614 + 0
5615 + ]
5616 +}
5617 +
5618 +
5619 +== **Редактирование задания в Журнале заданий** ==
5620 +
5621 +(% class="box successmessage" %)
5622 +(((
5623 +**PUT /api/v3/vehicletasks**
5624 +)))
5625 +
5626 +Пример запроса:
5627 +
5628 +(((
5629 +{
5630 + "vehicleId": 0, ~/~/ Идентификатор ТС
5631 + "description": "string", ~/~/ Описание
5632 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5633 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5634 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5635 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5636 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5637 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5638 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5639 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5640 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5641 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5642 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5643 + "cost": { 
5644 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5645 + "Name": "string", ~/~/ Наименование
5646 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5647 + "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5648 + "Norm": 0 ~/~/ Норма внесения
5649 + },
5650 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5651 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5652 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5653 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5654 + "deleted": true, ~/~/ Признак удаления
5655 + "extId": "string", ~/~/ ExtId
5656 + "GeoIds": [ ~/~/ Связанные поля
5657 + 0
5658 + ]
5659 +}
5660 +)))
5661 +
5662 +
5663 +Пример ответа:
5664 +
5665 +{
5666 + "vehicleId": 0, ~/~/ Идентификатор ТС
5667 + "description": "string", ~/~/ Описание
5668 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5669 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5670 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5671 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5672 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5673 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5674 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5675 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5676 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5677 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5678 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5679 + "cost": { 
5680 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5681 + "Name": "string", ~/~/ Наименование
5682 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5683 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5684 + "Norm": 0 ~/~/ Норма внесения
5685 + },
5686 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5687 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5688 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5689 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5690 + "deleted": true, ~/~/ Признак удаления
5691 + "extId": "string", ~/~/ ExtId
5692 + "GeoIds": [ ~/~/ Связанные поля
5693 + 0
5694 + ]
5695 +}
5696 +
5697 +
5698 +== **Удаление задания в Журнале заданий** ==
5699 +
5700 +(% class="box warningmessage" %)
5701 +(((
5702 +**DELETE /api/v3/vehicletasks**
5703 +)))
5704 +
5705 +Пример запроса:
5706 +
5707 +(((
5708 +[
5709 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5710 +]
5711 +)))
5712 +
5713 +(((
5714 +
5715 +)))
5716 +
5717 +Пример ответа:
5718 +
5719 +{
5720 + "vehicleId": 0, ~/~/ Идентификатор ТС
5721 + "description": "string", ~/~/ Описание
5722 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5723 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5724 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5725 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5726 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5727 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5728 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5729 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5730 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5731 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5732 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5733 + "cost": { 
5734 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5735 + "Name": "string", ~/~/ Наименование
5736 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5737 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5738 + "Norm": 0 ~/~/ Норма внесения
5739 + },
5740 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5741 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5742 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5743 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5744 + "deleted": true, ~/~/ Признак удаления
5745 + "extId": "string", ~/~/ ExtId
5746 + "GeoIds": [ ~/~/ Связанные поля
5747 + 0
5748 + ]
5749 +}
5750 +
5751 +
5752 +== **Получение списка Журнала заданий** ==
5753 +
5754 +(% class="box infomessage" %)
5755 +(((
5756 +**POST /api/v3/vehicletasks/getbyperiod**
5757 +)))
5758 +
5759 +Пример запроса:
5760 +
5761 +(((
5762 +{
5763 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
5764 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
5765 + "TimeZone": 0, ~/~/ Часовой пояс.
5766 + "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
5767 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
5768 + ],
5769 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
5770 + 0
5771 + ],
5772 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
5773 + 0
5774 + ],
5775 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
5776 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
5777 +}
5778 +)))
5779 +
5780 +
5781 +Пример ответа:
5782 +
5783 +(((
5784 +{
5785 + "total": 0,  ~/~/ Общее количество записей
5786 + "pages": 0,  ~/~/ Общее количество страниц
5787 + "currentPage": 0, ~/~/ Текущая страница
5788 + "items": [  ~/~/ Записи 
5789 + {
5790 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5791 + "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
5792 + "name": "string", ~/~/ Название задания.
5793 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
5794 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
5795 + "workKind": "string", ~/~/ Вид работ
5796 + "techOp": "string", ~/~/ Тех. операция
5797 + "trailerModel": "string", ~/~/ Модель агрегата
5798 + "width": "string", ~/~/ Ширина, м
5799 + "speed": "string", ~/~/ Тех. скорость
5800 + "fields": "string", ~/~/ Поля
5801 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
5802 + "vehicles": "string", ~/~/ Объект-модель
5803 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
5804 + "drivers": "string", ~/~/ Водители
5805 + "tmc": "string", ~/~/ ТМЦ
5806 + "client": "string", ~/~/  Клиент
5807 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5808 + "dep": "string", ~/~/ Подразделение
5809 + "geoIds": [ ~/~/  Связанные поля
5810 + 0
5811 + ]
5812 + }
5813 + ]
5814 +}
5815 +)))
5816 +
5817 +
5818 += **Раздел: Локатор ** =
5819 +
5820 +
5821 +== **Получение списка локаторов, доступных пользователю ** ==
5822 +
5823 +(% class="box infomessage" %)
5824 +(((
5825 +**GET /api/v3/locators**
5826 +)))
5827 +
5828 +В заголовках запроса: X-Auth: Токен авторизации
5829 +
5830 +
5831 +Пример ответа:
5832 +
5833 +(((
5834 +[
5835 + {
5836 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5837 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5838 + "agentName": "string", ~/~/ Наименование агента.
5839 + "isEnabled": true, ~/~/ Активен 
5840 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5841 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5842 + "name": "string", ~/~/ Наименование
5843 + "status": 0, ~/~/ 
5844 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5845 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5846 + "validity": 0, ~/~/ Срок действия в днях (1-90).
5847 + "autoProlongation": true, ~/~/ Автопродление срока действия.
5848 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5849 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5850 + "url": "string", ~/~/ Ссылка
5851 + "language": 0, ~/~/ Язык.
5852 + "vehiclesCount": 0, ~/~/ Количество объектов.
5853 + "geozonesCount": 0, ~/~/ Количество геозон.
5854 + "fieldsCount": 0 ~/~/ Количество полей.
5855 + }
5856 +]
5857 +)))
5858 +
5859 +
5860 +
5861 +== **Создание локатора** ==
5862 +
5863 +(% class="box successmessage" %)
5864 +(((
5865 +**POST /api/v3/locators**
5866 +)))
5867 +
5868 +Пример запроса:
5869 +
5870 +(((
5871 +{
5872 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5873 + "isEnabled": true, ~/~/ Активность
5874 + "name": "string", ~/~/ Наименование локатора
5875 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
5876 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
5877 + "validity": 0, ~/~/ Срок действия в днях (1-90)
5878 + "autoProlongation": true, ~/~/ Автопродление срока действия.
5879 + "url": "string", ~/~/ Ссылка
5880 + "language": 0 ~/~/ Язык
5881 +}
5882 +)))
5883 +
5884 +
5885 +Пример ответа:
5886 +
5887 +(((
5888 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
5889 +)))
5890 +
5891 +
5892 +
5893 +== **Изменение локатора** ==
5894 +
5895 +(% class="box infomessage" %)
5896 +(((
5897 +**PUT /api/v3/locators**
5898 +)))
5899 +
5900 +Пример запроса:
5901 +
5902 +(((
5903 +{
5904 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5905 + "isEnabled": true, ~/~/ Активность 
5906 + "name": "string", ~/~/ Наименование
5907 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
5908 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
5909 + "validity": 0, ~/~/ Срок действия в днях (1-90)
5910 + "autoProlongation": true, ~/~/ Автопродление срока действия
5911 + "url": "string", ~/~/ Ссылка
5912 + "language": 0 ~/~/ Язык
5913 +}
5914 +)))
5915 +
5916 +
5917 +Пример ответа:
5918 +
5919 +200 ~/~/ Success
5920 +
5921 +
5922 +== **Удалить локатор** ==
5923 +
5924 +(% class="box warningmessage" %)
5925 +(((
5926 +**DELETE /api/v3/locators**
5927 +)))
5928 +
5929 +Пример запроса:
5930 +
5931 +(((
5932 +[
5933 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
5934 +]
5935 +)))
5936 +
5937 +
5938 +
5939 +
1501 1501  (% class="box" lang="en-US" style="text-align: center;" %)
1502 1502  (((
1503 1503  (% 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 г.