Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 107.1 >
edited by Илья Крайнов
on 2023/08/30 15:15
To version < 205.1 >
edited by Андрей Калиновский
on 2025/01/14 11:58
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -1,5 +1,17 @@
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 +
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" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
29 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
31 +
32 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
33 +
34 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
35 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
38 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
39 +(((
40 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
41 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
42 +)))
22 22  
23 -(% class="box infomessage" %)
44 +(% 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**__».
55 +(% 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" %)
68 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
69 + "User": "testuser" , ~/~/ имя пользователя(%%)
54 54  }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
74 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
75 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
76 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
77 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
78 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
79 +
80 +(% class="wikigeneratedid" %)
81 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
82 +
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" ~/~/ Корр. счет
122 + "agentId": "",  (%%)
123 + "parentId": "",
124 + "parentName": "string",
125 + "name": "string",
126 + "fullName": "string",
127 + "agentInfoType": 0,
128 + "isForeign": true/false,
129 + "district": "string", 
130 + "region": "string",
131 + "city": "string",
132 + "inn": "string",
133 + "kpp": "string",
134 + "address": "string",
135 + "addressFact": "string",
136 + "email": "string",
137 + "director": "string",
138 + "bankName": "string",
139 + "bankBIK": "string",
140 + "bankRS": "string",
141 + "bankKS": "string"
118 118   }
119 119  
144 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
145 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
146 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
147 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
148 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
149 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
150 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
151 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
152 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
153 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
154 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
155 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
156 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
157 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
158 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
159 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
160 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
161 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
162 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
163 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
164 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
165 +
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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
179 +(% 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 - Отказ)
194 + "agentId": "",(% style="color:#000000" %)   (%%)
195 + "parentId": "",
196 + "name": "string",
197 + "fullName": "string",
198 + "agentInfoType": 0,
199 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
202 +
203 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
204 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
205 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
206 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
207 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
208 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
209 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
210 +
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", ~/~/ идентификатор клиента-родителя 
229 + "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  
273 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
274 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
275 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
276 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
277 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
278 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
279 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
280 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
281 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
282 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
283 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
284 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
285 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
286 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
287 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
288 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
289 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
290 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
291 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
292 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
293 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
294 +
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  
376 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
377 +
378 +(% class="box warningmessage" %)
379 +(((
380 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
381 +)))
382 +
383 +Метод позволяет изменить статус клиента, указанного в запросе.
384 +
385 +В пути указывается GUID клиента и статус клиента.
386 +
387 +**status **- значение 0 - заблокирован, 1 - активен.
388 +
389 +Ответ: Code 204
390 +
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 пользователя
455 +{     
456 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя
473 +}
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 -
495 +(% 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 пользователя 
591 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
592 + "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" %)
614 + "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": "" , ~/~/ идентификатор пользователя
621 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
622 + "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» названия группы пользователя
643 +}
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 -
664 +(% 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",
689 + "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" %)Раздел: **Транспортные средства**(%%) =
752 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
686 686  
754 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
755 +
756 +(% class="box infomessage" %)
757 +(((
758 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
759 +)))
760 +
761 +Метод возвращает полную информацию о модели объекта.
762 +
763 +(% style="color:#000000" %)Метод запроса: **GET**
764 +
765 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
766 +
767 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
768 +
769 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
770 +
771 +(% style="color:#000000" %)Ответ:
772 +
773 +(% style="color:#000000" %){
774 + "parentName": "string",
775 + "name": "string",
776 + "picture": "string",
777 + "minspeed": 0,
778 + "maxspeed": 0,
779 + "width": 0,
780 + "imbeddedtrailer": true,
781 + "hoppercapacity": 0,
782 + "hopperdischargespeed": 0,
783 + "modelType": 0,
784 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
785 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
786 + "deleted": true
787 +}
788 +
789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
790 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
791 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
792 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
793 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
794 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
795 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
796 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
797 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
798 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
799 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
800 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
801 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
802 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
803 +
804 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
805 +
806 +(% class="box successmessage" %)
807 +(((
808 +(% lang="en-US" %)**POST /api/v3/models/find**
809 +)))
810 +
811 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
812 +
813 +(% style="color:#000000" %)Метод запроса: **POST**
814 +
815 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
816 +
817 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
818 +
819 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
820 +
821 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
822 +}
823 +
824 +(% style="color:#000000" %)Ответ:
825 +
826 +(% style="color:#000000" %)[
827 + {
828 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
829 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
830 + "parentName": "string",
831 + "name": "string",
832 + "modelType": 0
833 + }
834 +]
835 +
836 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
837 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
838 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
839 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
840 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
841 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
842 +
843 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
844 +
845 +(% class="box successmessage" %)
846 +(((
847 +(% lang="en-US" %)**POST /api/v3/models**
848 +)))
849 +
850 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
851 +
852 +(% style="color:#000000" %)Метод запроса: **POST**
853 +
854 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
855 +
856 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
857 +
858 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
859 +
860 +{
861 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 + "deleted": true,
864 + "extId": "string",
865 + "name": "string",
866 + "picture": "string",
867 + "minspeed": 0,
868 + "maxspeed": 0,
869 + "width": 0,
870 + "imbeddedtrailer": true,
871 + "fueloutlay": 0,
872 + "hoppercapacity": 0,
873 + "hopperdischargespeed": 0,
874 + "modelType": 0
875 +}
876 +
877 +Ответ:
878 +
879 +{
880 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882 + "deleted": true,
883 + "extId": "string",
884 + "name": "string",
885 + "picture": "string",
886 + "minspeed": 0,
887 + "maxspeed": 0,
888 + "width": 0,
889 + "imbeddedtrailer": true,
890 + "hoppercapacity": 0,
891 + "hopperdischargespeed": 0,
892 + "modelType": 0
893 +}
894 +
895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
896 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
897 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
898 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
899 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
900 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
901 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
902 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
903 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
904 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
905 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
906 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
907 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
908 +
909 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
910 +
911 +(% class="box warningmessage" %)
912 +(((
913 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
914 +)))
915 +
916 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
917 +
918 +(% style="color:#000000" %)Метод запроса: **PUT**
919 +
920 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
921 +
922 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
923 +
924 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
925 +
926 +{
927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
928 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
929 + "deleted": true,
930 + "extId": "string",
931 + "name": "string",
932 + "picture": "string",
933 + "minspeed": 0,
934 + "maxspeed": 0,
935 + "width": 0,
936 + "imbeddedtrailer": true,
937 + "fueloutlay": 0,
938 + "hoppercapacity": 0,
939 + "hopperdischargespeed": 0,
940 + "modelType": 0
941 +}
942 +
943 +Ответ:
944 +
945 +{
946 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
947 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
948 + "deleted": true,
949 + "extId": "string",
950 + "name": "string",
951 + "picture": "string",
952 + "minspeed": 0,
953 + "maxspeed": 0,
954 + "width": 0,
955 + "imbeddedtrailer": true,
956 + "fueloutlay": 0,
957 + "hoppercapacity": 0,
958 + "hopperdischargespeed": 0,
959 + "modelType": 0
960 +}
961 +
962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
963 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
964 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
965 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
966 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
967 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
968 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
969 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
970 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
971 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
972 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
973 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
974 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
975 +
976 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
977 +
978 +(% class="box errormessage" %)
979 +(((
980 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
981 +)))
982 +
983 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
984 +
985 +(% style="color:#000000" %)Метод запроса: **DELETE**
986 +
987 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
988 +
989 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
990 +
991 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
992 +
993 +Ответ: В случае успеха **Success 200**
994 +
995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
996 +
687 687  == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
688 688  
689 689  (% class="box infomessage" %)
... ... @@ -711,6 +711,17 @@
711 711  
712 712  (((
713 713  {
1024 +
1025 +(((
1026 + "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1027 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1028 +)))
1029 +
1030 +(((
1031 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1032 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1033 +)))
1034 +
714 714   "vehicleId": "", ~/~/ ID объекта
715 715   "name": "", ~/~/ Имя объекта
716 716   "imei": "", ~/~/ IMEI объекта
... ... @@ -718,19 +718,15 @@
718 718   "deviceTypeName": "", ~/~/ Название типа устройства
719 719   "sim1": "", ~/~/ Номер SIM1
720 720   "sim2": "", ~/~/ Номер SIM2
721 -
722 722   "parentId": "", ~/~/ ID клиента-родителя
723 723   "parentName": "", ~/~/ Наименование клиента-родителя
724 724   "modelId": "", ~/~/ ID модели объекта
725 725   "modelName": "", ~/~/ Имя модели объекта
726 -
727 727   "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 728   "unitName": "string", ~/~/ Наименование подразделения
729 729   "status": 0, ~/~/ Статус объекта
730 -
731 731   "createdAt": "", ~/~/ Дата создания объекта
732 732   },
733 -
734 734  "customFields": [ ~/~/ Произвольные поля
735 735   {
736 736   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
... ... @@ -753,8 +753,7 @@
753 753   "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 754   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 755   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 -
1073 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
758 758   "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 759   "mileageCoeff": 0, ~/~/ коэффициент пробега
760 760   "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
... ... @@ -784,7 +784,6 @@
784 784   "retries": 0 ~/~/ Количество попыток
785 785   }
786 786   ],
787 -
788 788   "sensors": [ ~/~/ Датчики
789 789   {
790 790   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
... ... @@ -811,6 +811,7 @@
811 811   ],
812 812   "showInTooltip": true, ~/~/ Отображать в подсказке
813 813   "showLastValid": true, ~/~/ Отображать последнее валидное значение
1129 + "color": "string", ~/~/ Код цвета датчиков
814 814   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
815 815   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
816 816   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -825,31 +825,19 @@
825 825   },
826 826  
827 827  ~/~/ Характерные для произвольного:
828 -
829 829  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
830 -
831 831  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
832 -
833 833  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
834 -
835 835  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
836 -
837 837  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
838 -
839 839  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
840 -
841 841  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
842 -
843 843  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
844 -
845 845  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
846 -
847 847  ~/~/ "ValueOn": "Вкл.",
848 -
849 849  ~/~/ "ValueOff": "Выкл."
850 850   "summaryMaxValue": 0 ~/~/ Макс. значение
851 851   }
852 -
853 853   "drivers": [ ~/~/ Водители
854 854   {
855 855   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -858,7 +858,6 @@
858 858   "isDefault": true ~/~/ По умолчанию
859 859   }
860 860   ],
861 -
862 862   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
863 863   {
864 864   "id": "", ~/~/ ID  задания
... ... @@ -875,19 +875,27 @@
875 875   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
876 876   }
877 877   ],
878 -
879 - "statusHistory": [ ~/~/ История статусов
1181 +"statusHistory": [ ~/~/ История статусов
880 880   {
881 881   "status": 0,
882 882   "date": "2023-05-22T09:57:39.562Z",
883 883   "description": "string",
884 884   "additionalInfo": "string"
885 - }
886 - ]
887 887  
1188 +(((
888 888  }
1190 + ],
1191 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1192 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
889 889  )))
890 890  
1195 +(((
1196 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1197 +}
1198 +
1199 +)))
1200 +)))
1201 +
891 891  (% style="text-align:left" %)
892 892  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
893 893  
... ... @@ -894,6 +894,75 @@
894 894  (% style="text-align:left" %)
895 895  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
896 896  
1208 +
1209 +== **Отправить команду на терминал** ==
1210 +
1211 +(% class="box successmessage" %)
1212 +(((
1213 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1214 +)))
1215 +
1216 +Команда для отправки на тс.
1217 +
1218 +{  
1219 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1220 +"command": "", ~/~/ Текст отправляемой команды
1221 +"retries": "", ~/~/ Количество попыток отправки на терминал
1222 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1223 +}
1224 +
1225 +В ответ получаем cmdid
1226 +
1227 +
1228 +== **Получить ответ на отправленную на ТС команду** ==
1229 +
1230 +(% class="box infomessage" %)
1231 +(((
1232 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1233 +)))
1234 +
1235 +Идентификатор команды: cmdId
1236 +
1237 +Запрос от терминала на ответ команды
1238 +
1239 +Пример ответ от терминала:
1240 +
1241 +ID= "" ~/~/ идентификатор объекта
1242 +Soft="" ~/~/ версия софта
1243 +GPS=4 ~/~/ тип трекера
1244 +Time=11:05:43 28.06.24 ~/~/ время запроса
1245 +Lat=45.056221 ~/~/ широта
1246 +Lon=39.035938 ~/~/ долгота
1247 +Speed=0.0 ~/~/ скорость
1248 +Course=181.4 ~/~/направление
1249 +
1250 +(((
1251 +== **Список отправленных объекту команд с ответами** ==
1252 +
1253 +(% class="box infomessage" %)
1254 +(((
1255 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1256 +)))
1257 +
1258 +Идентификатор ТС: vehicleId
1259 +
1260 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1261 +
1262 +Пример ответа терминала
1263 +
1264 +[ 
1265 +{    
1266 +"id": "", ~/~/ идентификатор пользователя
1267 +"commandText": "", ~/~/Текст команды.
1268 +"templateId": "", ~/~/Идентификатор шаблона
1269 +"updated": "", ~/~/ Время отправки  
1270 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1271 +"answer": "", ~/~/ Ответ терминала.
1272 +"status": "" ~/~/ Статус отправки
1273 +}
1274 +]
1275 +)))
1276 +
897 897  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
898 898  
899 899  (% class="box successmessage" %)
... ... @@ -913,6 +913,11 @@
913 913  
914 914  (% style="color:#000000" %){
915 915  
1296 +
1297 +(((
1298 + "vehicleId": 0, ~/~/ ID ТС
1299 +)))
1300 +
916 916   "parentId": "" , ~/~/ ID клиента
917 917   "name": "" , ~/~/ имя ТС
918 918   "imei": "" , ~/~/ IMEI
... ... @@ -933,7 +933,6 @@
933 933   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
934 934   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
935 935   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
936 -
937 937   "mileageCalcMethod": 0,
938 938   "mileageCoeff": 0,
939 939   "locationByCellId": true,
... ... @@ -966,7 +966,6 @@
966 966   "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
967 967   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
968 968   }
969 -
970 970  "drivers": [ ~/~/ Водители
971 971   {
972 972   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -981,8 +981,7 @@
981 981   "retries": 0
982 982   }
983 983   ],
984 -
985 - "sensors": [ ~/~/ Датчики
1367 +"sensors": [ ~/~/ Датчики
986 986   {
987 987   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
988 988   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1008,6 +1008,7 @@
1008 1008   ],
1009 1009   "showInTooltip": true, ~/~/ Отображать в подсказке
1010 1010   "showLastValid": true, ~/~/ Отображать последнее валидное значение
1393 + "color": "string", ~/~/ код цвета датчиков
1011 1011   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1012 1012   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1013 1013   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -1020,103 +1020,293 @@
1020 1020   "additionalProp2": "string",
1021 1021   "additionalProp3": "string"
1022 1022   },
1023 -
1024 1024  ~/~/ Характерные для произвольного:
1025 -
1026 1026  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1027 -
1028 1028  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1029 -
1030 1030  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1031 -
1032 1032  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1033 -
1034 1034  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1035 -
1036 1036  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1037 -
1038 1038  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1039 -
1040 1040  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1041 -
1042 1042  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1043 -
1044 1044  ~/~/ "ValueOn": "Вкл.",
1045 -
1046 1046  ~/~/ "ValueOff": "Выкл."
1047 - "summaryMaxValue": 0 ~/~/ Макс. значение
1418 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1419 +
1420 +(((
1421 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1422 + {
1423 + "from": 0, ~/~/ С какого значения
1424 + "color": "string", ~/~/ Каким цветом
1425 + "text": "string" ~/~/ Текст подписи к этому интервалу
1426 + }
1427 + ]
1048 1048   }
1049 1049   ],
1430 +)))
1431 +
1432 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1433 +
1434 +
1050 1050   "customFields": [ ~/~/ Произвольные поля
1051 1051   {
1052 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1053 - "name": "string",
1054 - "value": "string",
1055 - "forClient": true,
1056 - "forTooltip": true,
1057 - "forReport": true
1058 - }
1059 - ]
1437 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1438 + "name": "string", ~/~/ Наименование произвольного поля
1439 + "value": "string", ~/~/ Значение произвольного поля
1440 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1441 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1442 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1443 +
1444 +(((
1445 + }
1446 + ],
1447 + "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1448 +)))
1449 +
1450 +(((
1451 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1060 1060  }
1453 +)))
1061 1061  
1455 +
1062 1062  (% style="color:#000000" %)Ответ:
1063 1063  
1064 -(% style="color:#000000" %){
1065 1065  
1066 - "vehicleId": "", ~/~/ID ТС 
1067 - "parentId": "", ~/~/Guid владельца ТС
1068 - "name": "", ~/~/Имя объекта
1069 - "imei": "", ~/~/IMEI
1070 - "deviceTypeId": "", ~/~/ID типа устройства
1071 - "modelId": "", ~/~/ID модели
1072 - "unitId": "", ~/~/ID подразделения
1073 - "sim1": "", ~/~/SIM1
1074 - "sim2": "", ~/~/SIM2
1075 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
1076 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
1077 - "counters": { ~/~/Счётчики
1078 - "mileageEnabled": true,
1079 - "motohoursEnabled": true,
1080 - "mileage": "",
1081 - "motohours": 345.0
1082 - },
1083 - "cmsv6Parameters": { ~/~/Параметры CmsV6
1084 - "id": null,
1085 - "enabled": true, ~/~/флаг включения
1086 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1087 - "login": "", ~/~/ имя учетной записи
1088 - "password": "" ~/~/ пароль учетной записи
1089 - },
1090 - "inspectionTasks": { ~/~/ задания на ТО
1091 - "id": "", ~/~/ ID задачи
1092 - "enabled": false, ~/~/ Признак включения
1093 - "name": "", ~/~/ Имя задания
1094 - "description": "", ~/~/ Описание задания
1095 - "mileageCondition": "", ~/~/ Условие по пробегу
1096 - "lastMileage": "", ~/~/ Пробег (в метрах)
1097 - "motohoursCondition": "", ~/~/ Условие по моточасам
1098 - "lastMotohours": "", ~/~/ Моточасы
1099 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1100 - "kind": "", ~/~/ Вид периодичности по времени 
1101 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1459 +(((
1460 +(((
1461 +(((
1462 +{
1463 + "vehicleId": 0,  ~/~/ ID ТС
1464 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1465 + "name": "string", ~/~/ Имя объекта
1466 + "imei": "string", ~/~/ IMEI
1467 + "deviceTypeId": 0, ~/~/ ID типа устройства
1468 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1469 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1470 + "sim1": "string", ~/~/ SIM1
1471 + "sim2": "string", ~/~/ SIM2
1472 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1473 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1474 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1475 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1476 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1477 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1478 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1479 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1480 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1481 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1482 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1483 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1484 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1485 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1486 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1487 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1488 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1489 + "counters": {  ~/~/ Dto для состояний счётчиков
1490 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1491 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1492 + "mileage": 0, ~/~/ Пробег
1493 + "motohours": 0 ~/~/ Моточасы
1494 + },
1495 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1496 + "id": "string", ~/~/ CMSV6 Идентификатор
1497 + "enabled": true, ~/~/ Признак включения
1498 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1499 + "login": "string", ~/~/ CMSV6 имя учетной записи
1500 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1501 + },
1502 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1503 + {
1504 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1505 + "enabled": true, ~/~/ Признак включения
1506 + "name": "string", ~/~/ Имя задания
1507 + "description": "string", ~/~/ Описание задания
1508 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1509 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1510 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1511 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1512 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1513 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1514 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1515 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1102 1102   }
1517 + ],
1518 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1519 + {
1520 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1521 + "inputNumber": 0, ~/~/ № входа.
1522 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1523 + "comment": "string", ~/~/ Комментарий
1524 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1525 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1526 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1527 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1528 + }
1529 + ],
1530 + "commandTemplates": [  ~/~/ Список шаблонов команд
1531 + {
1532 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1533 + "name": "string", ~/~/ Название шаблона команд
1534 + "command": "string", ~/~/ Команда на выполнение
1535 + "retries": 0 ~/~/ Лимит попыток отправки
1536 + }
1537 + ],
1538 + "sensors": [ ~/~/ Список датчиков
1539 + {
1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1541 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1542 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1543 + "name": "string",  ~/~/ Имя датчика
1544 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1545 + "inputNumber": 0, ~/~/ Номер входа
1546 + "pseudonym": "string", ~/~/ Псевдоним
1547 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1548 + "isInverted": true, ~/~/  Признак инверсии
1549 + "disabled": true, ~/~/ Датчик не участвует в обработке
1550 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1551 + "gradesTables": [ ~/~/ Тарировка
1552 + {
1553 + "grades": [ ~/~/ Таблицы тарировки
1554 + {
1555 + "input": 0, ~/~/ Вход
1556 + "output": 0 ~/~/ Выход
1557 + }
1558 + ],
1559 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1560 + }
1561 + ],
1562 + "showInTooltip": true, ~/~/ Отображение в подсказке
1563 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1564 + "color": "string", ~/~/ код цвета датчиков
1565 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1566 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1567 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1568 + "expr": "string", ~/~/ Выражение
1569 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1570 + "string"
1571 + ],
1572 + "customParams": {
1573 + "additionalProp1": "string",
1574 + "additionalProp2": "string",
1575 + "additionalProp3": "string"
1576 + },
1577 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1578 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1579 + {
1580 + "from": 0, ~/~/ С какого значения
1581 + "color": "string", ~/~/ Каким цветом
1582 +)))
1103 1103  
1104 -(% style="text-align:left" %)
1105 -(% style="color:#000000" %)}
1584 +(((
1585 + "text": "string" ~/~/ Текст подписи к этому интервалу
1586 + }
1587 + ]
1588 + }
1589 + ],
1590 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1591 + "customFields": [ ~/~/ Список произвольных полей
1592 + {
1593 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1594 + "name": "string", ~/~/ Наименование произвольного поля
1595 + "value": "string", ~/~/ Значение произвольного поля
1596 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1597 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1598 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1599 + }
1600 + ],
1601 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1602 +}
1603 +)))
1604 +)))
1605 +)))
1106 1106  
1607 +
1107 1107  **Валидация:**
1108 1108  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1109 1109  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1110 1110  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1111 1111  
1112 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1113 1113  
1614 +== **Импортировать историю ТС (Асинхронный запрос)** ==
1615 +
1616 +(% class="box successmessage" %)
1617 +(((
1618 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1619 +)))
1620 +
1621 +Метод запроса: **POST**
1622 +
1623 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1624 +
1625 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1626 +
1627 +
1628 +Ответ:
1629 +
1630 +{
1631 +
1632 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1633 +
1634 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1635 +
1636 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1637 +
1638 + "Message": "string", ~/~/ Информация о выполнении запроса
1639 +
1640 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1641 +
1642 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1643 +
1644 + "Data": "string" ~/~/ Данные
1645 +
1646 +}
1647 +
1648 +
1649 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1650 +
1114 1114  (% class="box infomessage" %)
1115 1115  (((
1653 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1654 +)))
1655 +
1656 +Метод запроса: **GET**
1657 +
1658 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1659 +
1660 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1661 +
1662 +
1663 +Ответ:
1664 +
1665 +{
1666 +
1667 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1668 +
1669 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
1670 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1671 +
1672 + "Message": "string", ~/~/ Информация о выполнении запроса
1673 +
1674 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1675 +
1676 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1677 +
1678 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1679 +
1680 + "Data": "string" ~/~/ Данные
1681 +
1682 +}
1683 +
1684 +
1685 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1686 +
1687 +(% class="box infomessage" %)
1688 +(((
1116 1116  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1117 1117  )))
1118 1118  
1119 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1692 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1120 1120  
1121 1121  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1122 1122  
... ... @@ -1150,9 +1150,12 @@
1150 1150   "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1151 1151   "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1152 1152   "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1153 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
1154 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
1155 - "customFields": null ~/~/ значение любого из произвольных полей ТС
1726 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1727 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1728 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1729 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1730 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1731 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1156 1156  }
1157 1157  
1158 1158  (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
... ... @@ -1159,8 +1159,14 @@
1159 1159  
1160 1160  (% style="color:#000000" %)Ответ:
1161 1161  
1162 -(% style="color:#000000" %){
1738 +(% style="color:#000000" %)[
1739 +{
1163 1163  
1741 +(((
1742 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1743 +)))
1744 +
1745 +(((
1164 1164  (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1165 1165   "name": "" ~/~/ наименование объекта
1166 1166   "imei": "" ~/~/ IMEI объекта
... ... @@ -1186,9 +1186,21 @@
1186 1186   "forClient": true, ~/~/ право на отображение у клиента
1187 1187   "forTooltip": false, ~/~/ право на отображение в подсказке
1188 1188   "forReport": false ~/~/ право на отображение в отчетах
1189 - }(%%)
1190 -(% style="color:#000000" %)}
1771 +)))
1191 1191  
1773 +(((
1774 + }
1775 + ],
1776 + "vehicleGroups": [  ~/~/ Группы ТС
1777 + {
1778 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1779 + "name": "string" ~/~/ Наименование группы ТС
1780 + }
1781 + ]
1782 + }
1783 +]
1784 +)))
1785 +
1192 1192  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1193 1193  
1194 1194  == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
... ... @@ -1220,13 +1220,11 @@
1220 1220   "data": "", ~/~/ Данные
1221 1221   "overwrite": false, ~/~/ Флаг перезаписи
1222 1222   "stage": "", ~/~/ Состояние, может быть null
1223 -
1224 1224  (% style="color:#000000" %)}
1225 1225  
1226 1226  (% style="color:#000000" %)Ответ:
1227 1227  
1228 -(% style="color:#000000" %){
1229 -
1821 +(% style="color:#000000" %){(%%)
1230 1230   "status": "", ~/~/ значение статуса
1231 1231   "date": "", ~/~/ Дата смены статуса 
1232 1232   "description": "", ~/~/ Описание
... ... @@ -1233,10 +1233,10 @@
1233 1233   "data": "", ~/~/ Данные
1234 1234   "overwrite": false, ~/~/ Флаг перезаписи
1235 1235   "stage": "", ~/~/ Состояние
1236 -
1237 -(% style="text-align:left" %)
1238 1238  (% style="color:#000000" %) }
1239 1239  
1830 +== ==
1831 +
1240 1240  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1241 1241  
1242 1242  (% class="box warningmessage" %)
... ... @@ -1312,9 +1312,19 @@
1312 1312  
1313 1313  "drivers": [ ~/~/ Водители
1314 1314   {
1315 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1316 - "isDefault": true
1317 - }
1907 +
1908 +(((
1909 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1910 + "inputNumber": 0, ~/~/ № входа.
1911 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1912 + "comment": "string", ~/~/ Комментарий.
1913 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1914 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1915 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1916 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1917 +)))
1918 +
1919 + } 
1318 1318   ],
1319 1319   "commandTemplates": [ ~/~/ Шаблон команды
1320 1320   {
... ... @@ -1324,8 +1324,7 @@
1324 1324   "retries": 0
1325 1325   }
1326 1326   ],
1327 -
1328 - "sensors": [ ~/~/ Датчики
1929 +"sensors": [ ~/~/ Датчики
1329 1329   {
1330 1330   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1331 1331   "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
... ... @@ -1351,6 +1351,11 @@
1351 1351   ],
1352 1352   "showInTooltip": true, ~/~/ Отображать в подсказке
1353 1353   "showLastValid": true, ~/~/ Отображать последнее валидное значение
1955 +
1956 +(((
1957 + "color": "string",** ~/~/ **Цвет датчика
1958 +)))
1959 +
1354 1354   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1355 1355   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1356 1356   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -1363,95 +1363,225 @@
1363 1363   "additionalProp2": "string",
1364 1364   "additionalProp3": "string"
1365 1365   },
1366 -
1367 1367  ~/~/ Характерные для произвольного:
1368 -
1369 1369  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1370 -
1371 1371  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1372 -
1373 1373  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1374 -
1375 1375  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1376 -
1377 1377  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1378 -
1379 1379  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1380 -
1381 1381  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1382 -
1383 1383  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1384 -
1385 1385  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1386 -
1387 1387  ~/~/ "ValueOn": "Вкл.",
1388 -
1389 1389  ~/~/ "ValueOff": "Выкл."
1390 1390   "summaryMaxValue": 0 ~/~/ Макс. значение
1985 +
1986 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1987 + {
1988 + "from": 0, ~/~/ С какого значения
1989 + "color": "string", ~/~/ Каким цветом
1990 + "text": "string" ~/~/ Текст подписи к этому интервалу
1991 + }
1992 + ]
1391 1391   }
1392 1392   ],
1995 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1996 +
1393 1393   "customFields": [ ~/~/ Произвольные поля
1394 - {
1395 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1396 - "name": "string",
1397 - "value": "string",
1398 - "forClient": true,
1399 - "forTooltip": true,
1400 - "forReport": true
1998 + {     
1999 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
2000 + "name": "string", ~/~/ Наименование произвольного поля
2001 + "value": "string", ~/~/ Значение произвольного поля
2002 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2003 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2004 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1401 1401   }
1402 - ]
2006 +
2007 +(((
2008 + ],
2009 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
2010 +)))
2011 +
1403 1403  }
1404 1404  
2014 +
1405 1405  (% style="color:#000000" %)Ответ:
1406 1406  
1407 -(% lang="en-US" style="text-align:left" %)
1408 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
2017 +(((
2018 +{
2019 + "vehicleId": 0, ~/~/ ID ТС
2020 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
2021 + "name": "string", ~/~/ Имя объекта
2022 + "imei": "string", ~/~/ IMEI
2023 + "deviceTypeId": 0, ~/~/ ID типа устройства
2024 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
2025 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
2026 + "sim1": "string", ~/~/ SIM1
2027 + "sim2": "string", ~/~/ SIM2
2028 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
2029 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
2030 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
2031 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
2032 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
2033 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
2034 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
2035 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
2036 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
2037 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
2038 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
2039 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
2040 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
2041 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
2042 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
2043 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
2044 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
2045 + "counters": { ~/~/ состояний счётчиков
2046 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
2047 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
2048 + "mileage": 0, ~/~/ Пробег
2049 + "motohours": 0 ~/~/ Моточасы 
2050 + },
2051 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
2052 + "id": "string", ~/~/ CMSV6 Идентификатор
2053 + "enabled": true, ~/~/ Признак включения
2054 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2055 +)))
1409 1409  
1410 -(% lang="en-US" style="text-align:left" %)
1411 - "vehicleId": "", ~/~/ ID ТС
1412 - "parentId": "", ~/~/ ID клиента
1413 - "name": "", ~/~/ имя ТС
1414 - "imei": "", ~/~/ IMEI
1415 - "deviceTypeId": "", ~/~/ типа устройства
1416 - "modelId": "", ~/~/ ID модели
1417 - "unitId": "", ~/~/ ID подразделения
1418 - "sim1": "", ~/~/ SIM 1
1419 - "sim2": "", ~/~/ SIM2
1420 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1421 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1422 - "counters": 
1423 - {
1424 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1425 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1426 - "mileage": "", ~/~/ пробег
1427 - "motohours": "", ~/~/ моточасы
1428 - }
1429 - "cmsv6Parameters": ~/~/ параметры CMSv6
2057 +
2058 +(((
2059 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2060 + "login": "string", ~/~/ CMSV6 имя учетной записи
2061 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
2062 + },
2063 + "inspectionTasks": [ ~/~/ Задания на ТО
2064 + {
2065 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2066 + "enabled": true, ~/~/ Признак включения
2067 + "name": "string", ~/~/ Имя задания
2068 + "description": "string", ~/~/ Описание задания
2069 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2070 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2071 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2072 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2073 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
2074 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2075 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2076 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2077 + }
2078 + ],
2079 + "drivers": [  ~/~/ Список водителей
2080 + {
2081 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2082 + "inputNumber": 0, ~/~/ № входа.
2083 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2084 + "comment": "string", ~/~/ Комментарий.
2085 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2086 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2087 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2088 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2089 + }
2090 + ],
2091 + "commandTemplates": [ ~/~/ Список шаблонов команд
2092 + {
2093 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2094 + "name": "string", ~/~/ Название шаблона команд
2095 + "command": "string", ~/~/ Команда на выполнение
2096 + "retries": 0 ~/~/ Лимит попыток отправки
2097 + }
2098 + ],
2099 + "sensors": [  ~/~/ Список датчиков 
2100 + {
2101 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2102 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2103 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2104 +)))
2105 +
2106 +(((
2107 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2108 +)))
2109 +
2110 +(((
2111 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2112 +)))
2113 +
2114 +(((
2115 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2116 +)))
2117 +
2118 +(((
2119 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2120 +)))
2121 +
2122 +(((
2123 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2124 + "name": "string", ~/~/ Имя датчика
2125 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2126 +)))
2127 +
2128 +(((
2129 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2130 + "inputNumber": 0, ~/~/ Номер входа
2131 + "pseudonym": "string", ~/~/ Псевдоним
2132 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
2133 + "isInverted": true, ~/~/ Признак инверсии
2134 + "disabled": true, ~/~/ Датчик не участвует в обработке
2135 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2136 + "gradesTables": [ ~/~/ Тарировка
1430 1430   {
1431 - "id": ~/~/ идентификатор
1432 - "enabled": true, ~/~/ флаг включения
1433 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1434 - "login": "", ~/~/ имя учетной записи
1435 - "password": "", ~/~/ пароль учетной записи
1436 - }
1437 - "inspectionTasks": ~/~/ задания на ТО
1438 - {
1439 - "id": "", ~/~/ ID задания
1440 - "enabled": false, ~/~/ Признак включения
1441 - "name": "", ~/~/ Имя задания
1442 - "description": "", ~/~/ Описание задания
1443 - "mileageCondition": "", ~/~/ Условие по пробегу
1444 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1445 - "motohoursCondition": "", ~/~/ Условие по моточасам
1446 - "lastMotohours": "", ~/~/ Моточасы
1447 - "periodicCondition": "", ~/~/ Условие периодичности по времени
1448 - "kind": "", ~/~/ Вид периодичности по времени
1449 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание
2138 + "grades": [ ~/~/ Таблицы тарировки
2139 + {
2140 + "input": 0, ~/~/ Вход
2141 + "output": 0 ~/~/ Выход
2142 + }
2143 + ],
2144 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
1450 1450   }
2146 + ],
2147 + "showInTooltip": true, ~/~/ Отображение в подсказке
2148 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1451 1451  
1452 -(% lang="en-US" style="text-align:left" %)
1453 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
2150 +(((
2151 + "color": "string", ~/~/ цвет уведомлений
2152 +)))
1454 1454  
2154 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2155 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2156 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2157 + "expr": "string", ~/~/ Выражение
2158 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2159 + "string" 
2160 + ],
2161 + "customParams": { ~/~/ Дополнительные настройки
2162 + "additionalProp1": "string",
2163 + "additionalProp2": "string",
2164 + "additionalProp3": "string"
2165 + },
2166 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2167 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2168 + {
2169 + "from": 0, ~/~/ С какого значения
2170 + "color": "string", ~/~/ Каким цветом
2171 + "text": "string" ~/~/ Текст подписи к этому интервалу
2172 + }
2173 + ]
2174 + }
2175 + ],
2176 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2177 + "customFields": [ ~/~/ Список произвольных полей
2178 + {
2179 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2180 + "name": "string", ~/~/ Наименование произвольного поля
2181 + "value": "string", ~/~/ Значение произвольного поля
2182 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2183 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2184 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2185 + }
2186 + ],
2187 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2188 +}
2189 +)))
2190 +
1455 1455  **Валидация:**
1456 1456  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1457 1457  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
... ... @@ -1490,18 +1490,15 @@
1490 1490  
1491 1491  (% style="color:#000000" %)Метод запроса: **GET**
1492 1492  
1493 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
2229 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
1494 1494  
1495 1495  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1496 1496  
1497 1497  (% style="color:#000000" %)Ответ:
1498 1498  
1499 -(% style="color:#000000" %){
1500 -
2235 +(% style="color:#000000" %){(%%)
1501 1501   "deviceTypeId" : "", ~/~/ ID типа устройства
1502 1502   "deviceTypeName" : "" ~/~/ Название типа устройства
1503 -
1504 -(% style="text-align:left" %)
1505 1505  (% style="color:#000000" %)}
1506 1506  
1507 1507  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
... ... @@ -1523,13 +1523,10 @@
1523 1523  
1524 1524  (% style="color:#000000" %)Ответ:
1525 1525  
1526 -(% style="color:#000000" %){
1527 -
2259 +(% style="color:#000000" %){(%%)
1528 1528   "id": "", ~/~/ ID типа датчика 
1529 1529   "name": "", ~/~/ Название
1530 1530   "description": "", ~/~/ Описание
1531 -
1532 -(% style="text-align:left" %)
1533 1533  (% style="color:#000000" %)}
1534 1534  
1535 1535  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1573,6 +1573,56 @@
1573 1573   }
1574 1574  ]
1575 1575  
2306 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2307 +
2308 +(% class="box infomessage" style="text-align: left;" %)
2309 +(((
2310 +**POST /api/v3/terminalMessages/mapping**
2311 +)))
2312 +
2313 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2314 +
2315 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2316 +
2317 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2318 +
2319 +{
2320 + "protocolType": 0,
2321 + "params": ["string"]
2322 +}
2323 +
2324 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2325 +|protocolType|ID типа протокола
2326 +|params|(((
2327 +Массив наименований параметров в сообщении
2328 +)))
2329 +
2330 +Ответ:
2331 +
2332 +{
2333 + "protocolType": 0,
2334 + "mapping": {
2335 + "additionalProp1": {
2336 + "inputType": 0,
2337 + "inputNumber": 0
2338 + },
2339 + "additionalProp2": {
2340 + "inputType": 0,
2341 + "inputNumber": 0
2342 + }
2343 + }
2344 +}
2345 +
2346 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2347 +|protocolType|Тип протокола
2348 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2349 +|inputNumber|(((
2350 +Номер входа
2351 +)))
2352 +
2353 +(% class="wikigeneratedid" %)
2354 +Перечень 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/]]
2355 +
1576 1576  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1577 1577  
1578 1578  (% class="box infomessage" %)
... ... @@ -1597,6 +1597,11 @@
1597 1597   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1598 1598  }
1599 1599  
2380 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2381 +|vehicleId|ID объекта
2382 +|from|Дата и время начала периода запроса
2383 +|to|Дата и время окончания периода запроса
2384 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,25 +1603,43 @@
1603 1603   {
1604 1604   "messages": [
1605 1605   {
1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1608 - "speed": 0, ~/~/ Скорость, км/ч
1609 - "altitude": 0, ~/~/ Высота, м
1610 - "latitude": 0, ~/~/ Широта [-90°;90°]
1611 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1612 - "satellites": 0, ~/~/ Кол-во спутников
1613 - "voltage": 0, ~/~/ Напряжение
1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
2391 + "deviceTime": "2023-11-29T07:40:44.052Z",
2392 + "serverTime": "2023-11-29T07:40:44.052Z",
2393 + "speed": 0,
2394 + "altitude": 0,
2395 + "latitude": 0,
2396 + "longitude": 0,
2397 + "satellites": 0,
2398 + "course": 0,
2399 + "voltage": 0,
2400 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
2405 + "photoCount": 0,
2406 + "lbsCorrectedCoords": true,
2407 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
2413 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2414 +|deviceTime|Время сообщения терминала
2415 +|serverTime|Время когда сообщение поступило на сервер
2416 +|speed|Скорость
2417 +|altitude|Высота над уровнем моря
2418 +|latitude|Широта
2419 +|longitude|Долгота
2420 +|satellites|Кол-во спутников
2421 +|course|Курс
2422 +|voltage|Бортовое напряжение
2423 +|parameters|Список параметров и их значений
2424 +|photoCount|Количество фото
2425 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2426 +|protocolType|ID типа протокола
2427 +
1625 1625  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1626 1626  
1627 1627  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1658,10 +1658,12 @@
1658 1658   {
1659 1659   "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
1660 1660   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1661 - "mileageBegin": 0, ~/~/ Пробег на начало периода
1662 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
1663 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
1664 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2464 + "mileage": 0, ~/~/ Пробег за период, километры
2465 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2466 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2467 + "motohours": 0, ~/~/ Моточасы за период, секунды
2468 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2469 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
1665 1665   }
1666 1666   ]
1667 1667   }
... ... @@ -1710,6 +1710,12 @@
1710 1710   }
1711 1711  ]
1712 1712  
2518 +(% class="box warningmessage" %)
2519 +(((
2520 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2521 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2522 +)))
2523 +
1713 1713  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
1714 1714  
1715 1715  (% class="box infomessage" %)
... ... @@ -1755,6 +1755,96 @@
1755 1755   }
1756 1756  ]
1757 1757  
2569 +
2570 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2571 +
2572 +(% class="box infomessage" %)
2573 +(((
2574 +**POST /api/v3/vehicles/moveStop**
2575 +)))
2576 +
2577 +Метод запроса: **POST**
2578 +
2579 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2580 +
2581 +В заголовках запроса: X-Auth: Токен авторизации
2582 +
2583 +
2584 +Тело запроса:
2585 +
2586 +{
2587 + "vehicleIds": [ ], ~/~/ Список ID объектов
2588 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2589 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2590 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2591 +}
2592 +
2593 +Ответ:
2594 +
2595 +[ 
2596 + {
2597 + "vehicleId": 0, ~/~/ ID объекта
2598 + "vehicleName": "string", ~/~/ Имя объекта
2599 + "moves": [ ~/~/ Событие движения
2600 + {
2601 + "mileage": 0, ~/~/ Пробег, км
2602 + "eventId": 0, ~/~/ Идентификатор события
2603 + "eventName": "string", ~/~/ Название события
2604 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2605 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2606 + "duration": 0 ~/~/ Продолжительность события, секунд
2607 + }
2608 + ],
2609 + "stops": [ ~/~/ События стоянок
2610 + {
2611 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2612 + "eventId": 0, ~/~/ Идентификатор события
2613 + "eventName": "string", ~/~/ Название события
2614 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2615 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2616 + "duration": 0 ~/~/ Продолжительность события, секунд
2617 + }
2618 + ]
2619 + }
2620 +]
2621 +
2622 +
2623 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2624 +
2625 +(% class="box infomessage" %)
2626 +(((
2627 +**POST /api/v3/vehicles/getlastdata**
2628 +)))
2629 +
2630 +Метод запроса: **POST**
2631 +
2632 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2633 +
2634 +В заголовках запроса: X-Auth: Токен авторизации
2635 +
2636 +
2637 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2638 +
2639 +Ответ:
2640 + {
2641 + "vehicleId": 0, ~/~/Идентификатор объекта.
2642 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2643 + "vehicleNumber": "string",~/~/Номер объекта.
2644 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2645 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2646 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2647 + "speed": 0,~/~/Скорость объекта.
2648 + "course": 0,~/~/Курс движения [0;360]
2649 + "latitude": 0,~/~/Широта [-90°;90°].
2650 + "longitude": 0,~/~/Долгота [-180°;180°].
2651 + "address": "string",~/~/Адрес.
2652 + "geozones": [ ~/~/Сведения по геозонам.
2653 + {
2654 + "id": 0,
2655 + "name": "string"
2656 + }
2657 +
2658 +
1758 1758  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1759 1759  
1760 1760  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -2062,6 +2062,32 @@
2062 2062  
2063 2063  Success
2064 2064  
2966 +
2967 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2968 +
2969 +(% class="box warningmessage" %)
2970 +(((
2971 +**PUT** /api/v3/notifications/prolongation
2972 +)))
2973 +
2974 +Метод позволяет продлить уведомления.
2975 +
2976 +Метод запроса **PUT**
2977 +
2978 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2979 +
2980 +В заголовках запроса: X-Auth: Токен авторизации.
2981 +
2982 +Тело запроса:
2983 +
2984 +[
2985 +
2986 +0
2987 +
2988 +]
2989 +
2990 +где 0 идентификатор ids.
2991 +
2065 2065  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2066 2066  
2067 2067  (% class="box errormessage" %)
... ... @@ -2653,6 +2653,83 @@
2653 2653  Success
2654 2654  
2655 2655  
3583 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3584 +
3585 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3586 +
3587 +(% class="box infomessage" %)
3588 +(((
3589 +**POST /api/v3/Trailers**
3590 +)))
3591 +
3592 +Пример запроса:
3593 +
3594 +{
3595 + "startDate": "2023-11-14T10:48:03.671Z",
3596 + "endDate": "2023-11-14T10:48:03.671Z",
3597 + "ids": [ 0 ],
3598 + "timezone": 0
3599 +}
3600 +
3601 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3602 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3603 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3604 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3605 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3606 +
3607 +Пример ответа:
3608 +
3609 +[
3610 + {
3611 + "SD": "2023-11-14T10:48:03.717Z",
3612 + "ED": "2023-11-14T10:48:03.717Z", 
3613 + "id": 0,
3614 + "SLat": 0,
3615 + "SLon": 0,
3616 + "ELat": 0,
3617 + "ELon": 0,
3618 + "mileage": 0
3619 + "Duration": 0
3620 + "Address": "string",
3621 + "Address2": "string",
3622 + "name": "string",
3623 + "rid": "string",
3624 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3625 + "trailer": {
3626 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3627 + "Number": "string",
3628 + "Description": "string",
3629 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3630 + "ExternalID": "string",
3631 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3632 + "CreateTime": "2023-11-14T10:48:03.717Z",
3633 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3634 + "IsDeleted": true
3635 + },
3636 + "filesCount": 0,
3637 + }
3638 +]
3639 +
3640 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3641 +|SD|Дата и время начала события
3642 +|ED|Дата и время окончания события
3643 +|id|ID объекта
3644 +|SLat|Широта начальной координаты
3645 +|SLon|Долгота начальной координаты
3646 +|ELat|Широта конечной координаты
3647 +|ELon|Долгота конечной координаты
3648 +|mileage|Пробег
3649 +|Duration|Продолжительность
3650 +|Address|Адрес начального местоположения
3651 +|Address2|Адрес конечного местоположения
3652 +|name|Имя радиометки
3653 +|rid|Номер радиометки
3654 +|rguid|ID радиометки
3655 +|trailer|Информация об агрегате
3656 +|ModelGuid|ID агрегата
3657 +|Number|Название/номер агрегата
3658 +|Description|Текст примечания агрегата
3659 +
2656 2656  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2657 2657  
2658 2658  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2674,13 +2674,18 @@
2674 2674   {
2675 2675   "name": "string",
2676 2676   "number": 0,
2677 - "period": 0, ~/~/ Частота трансляции радиометки
3681 + "period": 0,
2678 2678   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2679 2679   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2680 - "deleted": true
2681 2681   }
2682 2682  ]
2683 2683  
3687 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3688 +|parentId|ID клиента
3689 +|name|Название карты-метки
3690 +|number|Номер
3691 +|period|Период запросов в секундах (работает только для агрегатов)
3692 +|id|ID карты-метки
2684 2684  
2685 2685  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2686 2686  
... ... @@ -2697,13 +2697,18 @@
2697 2697   {
2698 2698   "name": "string",
2699 2699   "number": 0,
2700 - "period": 0, ~/~/ Частота трансляции радиометки
3709 + "period": 0,
2701 2701   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2702 2702   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2703 - "deleted": true
2704 2704   }
2705 2705  ]
2706 2706  
3715 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3716 +|name|Название карты-метки
3717 +|number|Номер
3718 +|period|Период запросов в секундах (работает только для агрегатов)
3719 +|id|ID карты-метки
3720 +|parentId|ID клиента
2707 2707  
2708 2708  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2709 2709  
... ... @@ -2719,7 +2719,6 @@
2719 2719   "number": 0,
2720 2720   "period": 0,
2721 2721   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2722 - "deleted": true
2723 2723  }
2724 2724  
2725 2725  Ответ:
... ... @@ -2730,9 +2730,14 @@
2730 2730   "period": 0,
2731 2731   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2732 2732   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2733 - "deleted": true
2734 2734  }
2735 2735  
3748 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3749 +|name|Название карты-метки
3750 +|number|Номер
3751 +|period|Период запросов в секундах (работает только для агрегатов)
3752 +|id|ID карты-метки
3753 +|parentId|ID клиента
2736 2736  
2737 2737  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2738 2738  
... ... @@ -2749,7 +2749,6 @@
2749 2749   "period": 0,
2750 2750   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2751 2751   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2752 - "deleted": true
2753 2753  }
2754 2754  
2755 2755  Ответ:
... ... @@ -2760,9 +2760,14 @@
2760 2760   "period": 0,
2761 2761   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2762 2762   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2763 - "deleted": true
2764 2764  }
2765 2765  
3782 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3783 +|name|Название карты-метки
3784 +|number|Номер
3785 +|period|Период запросов в секундах (работает только для агрегатов)
3786 +|id|ID карты-метки
3787 +|parentId|ID клиента
2766 2766  
2767 2767  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2768 2768  
... ... @@ -2771,7 +2771,7 @@
2771 2771  **DELETE /api/v3/Rfids/{rfidGuid}**
2772 2772  )))
2773 2773  
2774 -Передаем параметр rfidGuid - идентификатор карты-метки
3796 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2775 2775  
2776 2776  Ответ:
2777 2777  
... ... @@ -2778,6 +2778,1663 @@
2778 2778  Success
2779 2779  
2780 2780  
3803 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3804 +
3805 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3806 +
3807 +(% class="box infomessage" %)
3808 +(((
3809 +**GET /api/v3/Billing/client/balance/{clientId}**
3810 +)))
3811 +
3812 +Параметр запроса: **clientId **- идентификатор клиента.
3813 +
3814 +Ответ:
3815 +
3816 +{
3817 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3818 + "Balance": 0
3819 +}
3820 +
3821 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3822 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3823 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3824 +
3825 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3826 +
3827 +(% class="box infomessage" %)
3828 +(((
3829 +**GET /api/v3/Billing/client/constraint/{clientId}**
3830 +)))
3831 +
3832 +Параметр запроса: **clientId **- идентификатор клиента.
3833 +
3834 +Ответ:
3835 +
3836 +{
3837 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3838 + "CalculationType": 0,
3839 + "PermissibleBalance": 0,
3840 + "DefermentDays": 0,
3841 + "SendUiNotifications": true,
3842 + "SendEmailNotifications": true,
3843 + "IsPrivate": true,
3844 +}
3845 +
3846 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3847 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3848 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3849 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3850 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3851 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3852 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3853 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3854 +
3855 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3856 +
3857 +(% class="box infomessage" %)
3858 +(((
3859 +**GET /api/v3/Billing/client/plan/{clientId}**
3860 +)))
3861 +
3862 +Параметры запроса:
3863 +
3864 +**clientId **- идентификатор клиента.
3865 +
3866 +**planId **- идентификатор тарифного плана.
3867 +
3868 +Ответ:
3869 +
3870 +{
3871 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3872 + "Plan": { **~/~/ Описание тарифного плана**
3873 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3874 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3875 + "Name": "string",
3876 + "IsArchived": true,
3877 + "Constraint": {
3878 + "CalculationType": 0,
3879 + "PermissibleBalance": 0,
3880 + "DefermentDays": 0
3881 + },
3882 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3883 + {
3884 + "Feature": "string",
3885 + "IsFactual": true,
3886 + "Limit": 0,
3887 + "Price": 0,
3888 + "PeriodValue": 0,
3889 + "PeriodType": 0
3890 + }
3891 + ]
3892 + },
3893 + "DebitDate": "2023-10-18T12:46:24.213Z",
3894 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3895 + {
3896 + "Feature": "string",
3897 + "IsEnabled": true,
3898 + "IsPrivate": true,
3899 + "IsFactual": true,
3900 + "Limit": 0,
3901 + "Price": 0,
3902 + "DebitDate": "2023-10-18T12:46:24.213Z",
3903 + "PeriodValue": 0,
3904 + "PeriodType": 0
3905 + }
3906 + ]
3907 +}
3908 +
3909 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3910 +|ClientId|Идентификатор клиента
3911 +|Id|Идентификатор тарифного плана
3912 +|OwnerId|Идентификатор клиента-владельца
3913 +|Name|Наименование тарифного плана
3914 +|IsArchived|Признак, определяющий архивный тарифный план
3915 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3916 +|PermissibleBalance|Допустимый баланс
3917 +|DefermentDays|Отсрочка, количество дней
3918 +|Feature|Код услуги
3919 +|IsEnabled|Признак, определяющий активирована ли услуга
3920 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3921 +|IsFactual|Признак, определяющий расчёт по факту
3922 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3923 +|Price|Цена за единицу.
3924 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3925 +|PeriodValue|Значение периода.
3926 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3927 +
3928 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3929 +
3930 +(% class="box infomessage" %)
3931 +(((
3932 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3933 +)))
3934 +
3935 +Параметр запроса: **clientId **- идентификатор клиента.
3936 +
3937 +Ответ:
3938 +
3939 +[
3940 + {
3941 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3942 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3943 + "Name": "string",
3944 + "IsArchived": true,
3945 + "Constraint": {
3946 + "CalculationType": 0,
3947 + "PermissibleBalance": 0,
3948 + "DefermentDays": 0
3949 + },
3950 + "Features": [
3951 + {
3952 + "Feature": "string",
3953 + "IsFactual": true,
3954 + "Limit": 0,
3955 + "Price": 0,
3956 + "PeriodValue": 0,
3957 + "PeriodType": 0
3958 + }
3959 + ]
3960 + }
3961 +]
3962 +
3963 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3964 +|ClientId|Идентификатор клиента
3965 +|Id|Идентификатор тарифного плана
3966 +|OwnerId|Идентификатор клиента-владельца
3967 +|Name|Наименование тарифного плана
3968 +|IsArchived|Признак, определяющий архивный тарифный план
3969 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3970 +|PermissibleBalance|Допустимый баланс
3971 +|DefermentDays|Отсрочка, количество дней
3972 +|Feature|Код услуги
3973 +|IsFactual|Признак, определяющий расчёт по факту
3974 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3975 +|Price|Цена за единицу.
3976 +|PeriodValue|Значение периода.
3977 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3978 +
3979 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3980 +
3981 +(% class="box infomessage" %)
3982 +(((
3983 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3984 +)))
3985 +
3986 +Параметр запроса: **clientId **- идентификатор клиента.
3987 +
3988 +Ответ:
3989 +
3990 +[
3991 + {
3992 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3993 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3994 + "Name": "string",
3995 + "IsArchived": true,
3996 + "Constraint": {
3997 + "CalculationType": 0,
3998 + "PermissibleBalance": 0,
3999 + "DefermentDays": 0
4000 + },
4001 + "Features": [
4002 + {
4003 + "Feature": "string",
4004 + "IsFactual": true,
4005 + "Limit": 0,
4006 + "Price": 0,
4007 + "PeriodValue": 0,
4008 + "PeriodType": 0
4009 + }
4010 + ]
4011 + }
4012 +]
4013 +
4014 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4015 +|ClientId|Идентификатор клиента
4016 +|Id|Идентификатор тарифного плана
4017 +|OwnerId|Идентификатор клиента-владельца
4018 +|Name|Наименование тарифного плана
4019 +|IsArchived|Признак, определяющий архивный тарифный план
4020 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4021 +|PermissibleBalance|Допустимый баланс
4022 +|DefermentDays|Отсрочка, количество дней
4023 +|Feature|Код услуги
4024 +|IsFactual|Признак, определяющий расчёт по факту
4025 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4026 +|Price|Цена за единицу.
4027 +|PeriodValue|Значение периода.
4028 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4029 +
4030 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4031 +
4032 +(% class="box warningmessage" %)
4033 +(((
4034 +**PUT /api/v3/Billing/client/balance**
4035 +)))
4036 +
4037 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4038 +
4039 +Тело запроса:
4040 +
4041 +{
4042 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4043 + "Balance": 0
4044 +}
4045 +
4046 +Ответ: Success
4047 +
4048 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4049 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4050 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4051 +
4052 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4053 +
4054 +(% class="box warningmessage" %)
4055 +(((
4056 +**PUT /api/v3/billing/client/balance/deposit**
4057 +)))
4058 +
4059 +Создает операцию **Пополнение **с указанной суммой
4060 +
4061 +Тело запроса:
4062 +
4063 +{
4064 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4065 + "Balance": 0
4066 +}
4067 +
4068 +Ответ: Success
4069 +
4070 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4071 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4072 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4073 +
4074 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4075 +
4076 +Создает операцию **Списание **с указанной суммой
4077 +
4078 +(% class="box warningmessage" %)
4079 +(((
4080 +**PUT /api/v3/billing/client/balance/withdraw**
4081 +)))
4082 +
4083 +Тело запроса:
4084 +
4085 +{
4086 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4087 + "Balance": 0
4088 +}
4089 +
4090 +Ответ: Success
4091 +
4092 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4093 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4094 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4095 +
4096 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4097 +
4098 +(% class="box warningmessage" %)
4099 +(((
4100 +**PUT /api/v3/Billing/client/constraint**
4101 +)))
4102 +
4103 +Тело запроса:
4104 +
4105 +{
4106 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4107 + "CalculationType": 0,
4108 + "PermissibleBalance": 0,
4109 + "DefermentDays": 0,
4110 + "SendUiNotifications": true,
4111 + "SendEmailNotifications": true,
4112 + "IsPrivate": true,
4113 +}
4114 +
4115 +Ответ: Success
4116 +
4117 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4118 +|ClientId|Идентификатор клиента
4119 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4120 +|PermissibleBalance|Допустимый баланс
4121 +|DefermentDays|(((
4122 +Отсрочка, количество дней
4123 +)))
4124 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4125 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4126 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4127 +
4128 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4129 +
4130 +(% class="box warningmessage" %)
4131 +(((
4132 +**PUT /api/v3/Billing/client/plan**
4133 +)))
4134 +
4135 +Тело запроса:
4136 +
4137 +{
4138 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4139 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4140 + "Features": [
4141 + {
4142 + "Feature": "string",
4143 + "IsEnabled": true,
4144 + "IsFactual": true,
4145 + "Limit": 0,
4146 + "Price": 0,
4147 + "DebitDate": "2023-10-18T13:26:58.987Z",
4148 + "PeriodValue": 0,
4149 + "PeriodType": 0
4150 + }
4151 + ]
4152 +}
4153 +
4154 +Ответ: Success
4155 +
4156 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4157 +|ClientId|Идентификатор клиента
4158 +|PlanId|Идентификатор тарифного плана
4159 +|Feature|Код услуги
4160 +|IsEnabled|Признак, определяющий активирована ли услуга
4161 +|IsFactual|Признак, определяющий расчёт по факту
4162 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4163 +|Price|Цена за единицу.
4164 +|DebitDate|Следующий момент времени списания с баланса за услугу.
4165 +|PeriodValue|Значение периода.
4166 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4167 +
4168 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4169 +
4170 +(% class="box warningmessage" %)
4171 +(((
4172 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4173 +)))
4174 +
4175 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4176 +
4177 +(% class="box infomessage" %)
4178 +(((
4179 +**POST /api/v3/vehicles/import/{agentId}**
4180 +)))
4181 +
4182 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4183 +
4184 +В пути указывается **agentId** - id клиента.
4185 +
4186 +**Заголовок**
4187 +
4188 +**X-Auth: [токен авторизации]**
4189 +
4190 +**Параметры**
4191 +
4192 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4193 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4194 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4195 +
4196 +В теле использовать тип **form-data,** тип значения** file**
4197 +
4198 +**Ключи**
4199 +
4200 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4201 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
4202 +|csv|В значении передаем файл датчиков, формат **csv**
4203 +
4204 +Ответ:
4205 +
4206 +{
4207 + "vehicleId": 0,
4208 + "name": "string",
4209 + "errors": ["string"]
4210 +}
4211 +
4212 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4213 +|vehicleId|ID созданного объекта
4214 +|name|Имя созданного объекта
4215 +|errors|Ошибки и их описание
4216 +
4217 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4218 +
4219 +(% class="box infomessage" %)
4220 +(((
4221 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4222 +)))
4223 +
4224 +(% class="wikigeneratedid" %)
4225 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4226 +
4227 +(% class="wikigeneratedid" %)
4228 +В пути указывается **vehicleId **- id объекта.
4229 +
4230 +**Заголовок**
4231 +
4232 +**X-Auth: [токен авторизации]**
4233 +
4234 +В теле использовать тип **form-data.**
4235 +
4236 +Ключи:
4237 +
4238 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4239 +|**history**|В значении передавать файл с историей
4240 +
4241 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4242 +
4243 +Ответ:
4244 +
4245 +{
4246 + "results": [
4247 + {
4248 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4249 + "vehicleId": 0,
4250 + "errors": [
4251 + "string"
4252 + ],
4253 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
4254 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
4255 + "producedCount": 0,
4256 + "msgCount": 0
4257 + }
4258 + ]
4259 +}
4260 +
4261 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4262 +|results|Результаты импорта в разрезе ТС
4263 +|vehicleGuid|Guid ТС
4264 +|vehicleId|ID ТС
4265 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4266 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
4267 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4268 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
4269 +|msgCount|Кол-во обработанных сообщений всего
4270 +
4271 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4272 +
4273 +(% class="box infomessage" %)
4274 +(((
4275 +**GET /api/v3/vehicles/import/history/status**
4276 +)))
4277 +
4278 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4279 +
4280 +Ответ:
4281 +
4282 +{
4283 + "activity": true,
4284 + "progress": 0,
4285 + "message": "string"
4286 +}
4287 +
4288 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4289 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4290 +|progress|Guid ТС
4291 +
4292 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4293 +
4294 +(% class="box infomessage" %)
4295 +(((
4296 +**POST /api/v3/vehicles/export**
4297 +)))
4298 +
4299 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4300 +
4301 +Тело запроса:
4302 +
4303 +[
4304 + id
4305 +]
4306 +
4307 +Ответ: Success 200, получаете файлы с настройками.
4308 +
4309 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4310 +
4311 +(% class="box infomessage" %)
4312 +(((
4313 +**POST /api/v3/vehicles/export/history**
4314 +)))
4315 +
4316 +Метод возвращает список сообщений терминала объекта за выбранный период.
4317 +
4318 +Тело запроса:
4319 +
4320 +{
4321 + "vehicleId": 0,
4322 + "asArchive": true,
4323 + "from": "2023-09-27T12:17:45.973Z",
4324 + "to": "2023-09-27T12:17:45.973Z"
4325 +}
4326 +
4327 +Ответ:
4328 +
4329 +Получаете файл. Сообщение: Code 200/Success
4330 +
4331 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4332 +|vehicleId|ID объекта
4333 +|asArchive|true - Архивировать файл, False - не архивировать
4334 +|from|Дата и время начала запроса
4335 +|to|Дата и время окончания запроса
4336 +
4337 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4338 +
4339 +(% class="box infomessage" %)
4340 +(((
4341 +**GET /api/v3/vehicles/export/history/status**
4342 +)))
4343 +
4344 +Метод возвращает список сообщений терминала объекта за выбранный период.
4345 +
4346 +Ответ:
4347 +
4348 +{
4349 + "activity": true,
4350 + "progress": 0,
4351 + "message": "string"
4352 +}
4353 +
4354 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4355 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4356 +|progress|Прогресс экспорта, от 0 до 100%
4357 +|message|Текст описывающий статус
4358 +
4359 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4360 +
4361 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4362 +
4363 +(% class="box infomessage" %)
4364 +(((
4365 +**POST /api/v3/EcoDriving/rating**
4366 +)))
4367 +
4368 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4369 +
4370 +Тело запроса:
4371 +
4372 +{
4373 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4374 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4375 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4376 +}
4377 +
4378 +Ответ:
4379 +
4380 +{
4381 + "items": [  ~/~/ Список в разрезе ТС
4382 + {
4383 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4384 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4385 + "vehicleId": 0, ~/~/ ID ТС
4386 + "vehicleName": "string", ~/~/ Название ТС
4387 + "vehicleModel": "string", ~/~/ Модель ТС
4388 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4389 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4390 + "totalViolations": 0, ~/~/ Нарушений всего
4391 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4392 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4393 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4394 + "brakingViolations": 0, ~/~/ Нарушений торможения
4395 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4396 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4397 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4398 + },
4399 +
4400 +(((
4401 +
4402 +)))
4403 +
4404 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4405 + "mileage": 0, ~/~/ Пробег, м
4406 + "tripsCount": 0, ~/~/ Кол-во рейсов
4407 + "trips": [  ~/~/ Информация по рейсу
4408 + {
4409 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4410 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4411 + "violationsCount": 0, ~/~/ Всего нарушений
4412 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4413 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4414 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4415 + "brakingViolations": 0, ~/~/ Нарушений торможения
4416 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4417 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4418 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4419 + },
4420 +
4421 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4422 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4423 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4424 + "mileage": 0, ~/~/ Пробег, м
4425 + "motohours": 0, ~/~/ Моточасы, секунды
4426 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4427 + "startAddress": "string", ~/~/ Адрес начала рейса
4428 + "endAddress": "string", ~/~/ Адрес конца рейса
4429 + "drivers": [  ~/~/ Список водителей
4430 + {
4431 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4432 + "driverName": "string", ~/~/ФИО водителя
4433 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4434 + }
4435 + ]
4436 + }
4437 + ]
4438 + }
4439 + ]
4440 +}
4441 +
4442 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4443 +
4444 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4445 +
4446 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4447 +
4448 +(% class="box infomessage" %)
4449 +(((
4450 +POST /api/v3/fuelcards/transactions
4451 +)))
4452 +
4453 +Метод запроса: POST
4454 +
4455 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4456 +\\В заголовках запроса: X-Auth: Токен авторизации
4457 +
4458 +Параметры в теле запроса (JSON):
4459 +
4460 +{
4461 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4462 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4463 + "ids": [ 
4464 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4465 + ],
4466 + "timezone": 0 ~/~/ Часовой пояс
4467 +}
4468 +
4469 +
4470 +Ответ:
4471 + {
4472 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4473 + "driver": "string", ~/~/ Водители, привязанные к ТК
4474 + "object": "string", ~/~/ Наименование ТС
4475 + "amount": 0, ~/~/ Количество топлива
4476 + "amountDut": 0, ~/~/ Количество по ДУТ
4477 + "amountDiff": 0, ~/~/ Разница, л
4478 + "amountDiffPerc": 0, ~/~/ Разница, %
4479 + "summa": 0, ~/~/ Стоимость, руб
4480 + "serviceName": "string", ~/~/ Тип топлива
4481 + "price": 0, ~/~/ Цена за литр, руб
4482 + "cardName": "string", ~/~/ Наименование ТК
4483 + "cardNum": "string", ~/~/ Номер ТК
4484 + "operator": "string", ~/~/ Оператор ТК
4485 + "address": "string" ~/~/ Адрес АЗС
4486 + }
4487 +
4488 +
4489 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4490 +
4491 +
4492 +== **Получение полных данных о ретрансляторе** ==
4493 +
4494 +(% class="box infomessage" %)
4495 +(((
4496 +**GET ** **/api/v3/retranslations/{id}**
4497 +)))
4498 +
4499 +id - Идентификатор ретранслятора
4500 +
4501 +
4502 +Пример ответа:
4503 +
4504 +{  
4505 +"description": "", ~/~/ Поле описания ретранслятора
4506 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4507 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4508 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4509 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4510 +"objects": [ ~/~/ Объекты для ретрансляции
4511 +{      
4512 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4513 +"name": "", ~/~/ Наименование объекта ретрансляции
4514 +"imei": "", ~/~/ IMEI объекта  ретрансляции
4515 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4516 +}
4517 + ],  
4518 +"id": "", ~/~/ Идентификатор ретранслятора 
4519 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4520 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4521 +}
4522 +
4523 +
4524 +== **Удаление данных ретранслятора** ==
4525 +
4526 +(% class="box infomessage" %)
4527 +(((
4528 +**DELETE** **/api/v3/retranslations/{id}**
4529 +)))
4530 +
4531 +id - Идентификатор ретранслятора
4532 +
4533 +
4534 +== **Создание ретранслятора** ==
4535 +
4536 +(% class="box infomessage" %)
4537 +(((
4538 +**POST ** **/api/v3/retranslations/{id}**
4539 +)))
4540 +
4541 +Запрос:
4542 +
4543 +{  
4544 +"description": "", ~/~/ Поле описания ретранслятора
4545 +"subscriberId": "", ~/~/ Идентификатор подписчика
4546 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4547 +"address": "", ~/~/ Адрес и порт принимающего сервера
4548 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4549 +"objects": [ ~/~/Объекты для ретрансляции
4550 +{      
4551 +"id": "", ~/~/ Идентификатор ретранслятора 
4552 +"imei": "", ~/~/ IMEI объекта ретрансляции
4553 +"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4554 +}
4555 + ]
4556 +}
4557 +
4558 +
4559 +Ответ:
4560 +
4561 +{  
4562 +"description": "", ~/~/ Поле описания ретранслятора
4563 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4564 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4565 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4566 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4567 +"objects": [ ~/~/ Объекты для ретрансляции
4568 +{      
4569 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4570 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4571 +"imei": "", ~/~/ IMEI объекта ретрансляции
4572 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4573 +}
4574 + ],
4575 +"id": "", ~/~/ Идентификатор ретранслятора   
4576 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4577 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4578 +}
4579 +
4580 +
4581 +== **Редактирование ретранслятора** ==
4582 +
4583 +(% class="box infomessage" %)
4584 +(((
4585 +**PUT** **/api/v3/retranslations**
4586 +)))
4587 +
4588 +Пример запроса:
4589 +
4590 +{  
4591 +"id": "", ~/~/ Идентификатор ретранслятора   
4592 +"description": "string", ~/~/ Поле описания ретранслятора
4593 +"subscriberId": "", ~/~/ Идентификатор подписчика
4594 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4595 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4596 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4597 +"objects": ~/~/ Объекты для ретрансляции
4598 +[    
4599 +{      
4600 +"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4601 +"imei": "", ~/~/ IMEI объекта ретрансляции
4602 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4603 +}
4604 + ]
4605 +}
4606 +
4607 +
4608 +Пример ответа:
4609 +
4610 +{  
4611 +"description": "", ~/~/ Поле описания ретранслятора
4612 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4613 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4614 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4615 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4616 +"objects": [ ~/~/ Объекты для ретрансляции
4617 +{      
4618 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4619 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4620 +"imei": "", ~/~/ IMEI объекта ретрансляции
4621 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4622 +}
4623 + ],
4624 +"id": "", ~/~/ Идентификатор ретранслятора   
4625 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4626 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4627 +}
4628 +
4629 +
4630 +== **Получение списка ретранслятора клиента** ==
4631 +
4632 +(% class="box infomessage" %)
4633 +(((
4634 +**POST /api/v3/retranslations/find**
4635 +)))
4636 +
4637 +Пример запроса:
4638 +
4639 +{  
4640 +"id": "", ~/~/ Идентификатор ретранслятора   
4641 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4642 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4643 +}
4644 +
4645 +Ответ:
4646 +
4647 +[ 
4648 +{    
4649 +"description": "", ~/~/ Поле описания ретранслятора
4650 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4651 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4652 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4653 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4654 +"id": "", ~/~/ Идентификатор ретранслятора   
4655 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4656 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4657 +}
4658 +]
4659 +
4660 +
4661 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4662 +
4663 +== **API для отчета по выгрузке комбайнов** ==
4664 +
4665 +(% class="box infomessage" %)
4666 +(((
4667 +**POST /api/v3/Reports/harvesterUnloading**
4668 +)))
4669 +
4670 +Пример запроса:
4671 +
4672 +{
4673 + "byTime": 0, ~/~/ Объединение событий по времени
4674 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4675 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4676 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4677 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4678 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4679 + 0
4680 + ],
4681 + "from": "", ~/~/ Дата и время начало запроса
4682 + "to": "", ~/~/ Дата и время окончания запроса
4683 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4684 +}
4685 +
4686 +Пример ответа:
4687 +
4688 +[ 
4689 + {
4690 + "harvesterName": "", ~/~/Комбайн, номер
4691 + "harvesterId": 0, ~/~/Комбайн, id
4692 +"harvesterModel": "", ~/~/ Модель комбайна
4693 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4694 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4695 + "events": [ ~/~/Список событий в разрезе комбайна
4696 + {
4697 + "driverId": "", ~/~/Идентификатор водителя
4698 + "driverName": "", ~/~/Водитель комбайна, ФИО
4699 + "RFID": "", ~/~/ идентификатор карты-метки
4700 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4701 + "vehicleId": 0, ~/~/идентификатор объекта
4702 + "vehicleName": "string", ~/~/ Имя объекта
4703 + "modelName": "string", ~/~/ Имя модели объекта
4704 + "nearestVehicles": [ ~/~/Объекты рядом
4705 + {
4706 + "vehicleId": 0, ~/~/идентификатор объекта
4707 + "vehicleName": "string" ~/~/ Имя объекта
4708 + }
4709 + ],
4710 + "fields": [ ~/~/Поля, где происходила выгрузка
4711 + {
4712 + "id": 0, ~/~/ идентификатор пользователя 
4713 + "name": "string" ~/~/ имя пользователя 
4714 + }
4715 + ],
4716 + "event": "string", ~/~/Событие
4717 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4718 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4719 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4720 + "cultureName": "string", ~/~/ название культуры
4721 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4722 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4723 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4724 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4725 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4726 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4727 + "issued": 0, ~/~/Выдано, бункеров
4728 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4729 + "latitude": 0, ~/~/Широта
4730 + "longitude": 0, ~/~/ Долгота
4731 + "litresAway": 0, ~/~/Отдано, л
4732 + "m3Away": 0 ~/~/Отдано, м3
4733 + }
4734 + ]
4735 + }
4736 +]
4737 +
4738 +
4739 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4740 +
4741 +
4742 +== **Запрос списка полей** ==
4743 +
4744 +(% class="box successmessage" %)
4745 +(((
4746 +**POST /api/v3/agroLands/find**
4747 +)))
4748 +
4749 +Пример запроса:
4750 +
4751 +(((
4752 +(((
4753 +(((
4754 +{
4755 + "year": 0, ~/~/ Фильтр по году
4756 + "name": "string", ~/~/ Фильтр по названию
4757 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4758 +}
4759 +)))
4760 +)))
4761 +
4762 +
4763 +)))
4764 +
4765 +Пример ответа:
4766 +
4767 +(((
4768 +[
4769 + {
4770 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4771 + "year": 0, ~/~/ Год поля
4772 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4773 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4774 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4775 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4776 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4777 + "counts": { ~/~/ Счётчики с/х поля 
4778 + "fieldOperations": 0, ~/~/ Количество операций на поле
4779 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4780 + "facts": 0 ~/~/ Счётчик факта
4781 + },
4782 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4783 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4784 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4785 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4786 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4787 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4788 + "planComment": "string", ~/~/ Комментарий к полю
4789 + "productivity": 0, ~/~/ Урожайность.
4790 + "id": 0, ~/~/ Идентификатор объекта геозоны
4791 + "name": "string", ~/~/ Название объекта геозоны
4792 + "type": 0, ~/~/ Тип объекта геозоны
4793 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4794 + "fname": "string", ~/~/ Имя файла
4795 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4796 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4797 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4798 + "description": "string", ~/~/ Описание объекта геозоны
4799 + "area": 0, ~/~/ Площадь, м2
4800 + "perimetr": 0, ~/~/ Периметр, м
4801 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4802 + }
4803 +]
4804 +
4805 +
4806 +== **Создание нового поля ** ==
4807 +
4808 +(% class="box successmessage" %)
4809 +(((
4810 +**POST /api/v3/agroLands**
4811 +)))
4812 +
4813 +Пример запроса:
4814 +
4815 +(((
4816 +{
4817 + "extId": "string", 
4818 + "shape": "string", ~/~/ Форма поля
4819 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
4820 + "display": "string", ~/~/ Настройки отображения
4821 + "year": 0, ~/~/ Год поля
4822 + "name": "string", ~/~/ Наименование
4823 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4824 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4825 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4826 + "planComment": "string", ~/~/ Комментарий к полю
4827 + "cropRotations": [ ~/~/ Данные по севообороту
4828 + {
4829 + "landId": 0, ~/~/ ID поля
4830 + "landName": "string", ~/~/ Название поля
4831 + "year": 0, ~/~/ Год урожая
4832 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4833 + "cultureName": "string", ~/~/ Название культуры
4834 + "productivity": 0, ~/~/ Урожайность
4835 + "area": 0, ~/~/ Площадь поля, Га
4836 + "total": 0, ~/~/ Валовый сбор
4837 + "productivityFact": 0, ~/~/ Фактическая урожайность
4838 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4839 + "totalFact": 0, ~/~/ Фактический валовый сбор
4840 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
4841 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
4842 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
4843 + "isyearplan": true, ~/~/ Годовой план 
4844 + "comment": "string" ~/~/ Комментарий
4845 + }
4846 + ]
4847 +}
4848 +)))
4849 +
4850 +(((
4851 +
4852 +)))
4853 +
4854 +Пример ответа:
4855 +
4856 +(((
4857 +(((
4858 +{
4859 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4860 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4861 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4862 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4863 + "cropRotations": [ ~/~/ Данные по севообороту
4864 + {
4865 + "landId": 0, ~/~/ ID поля
4866 + "landName": "string", ~/~/ Название поля
4867 + "year": 0, ~/~/ Год урожая 
4868 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4869 + "cultureName": "string", ~/~/ Название культуры
4870 + "productivity": 0, ~/~/ Урожайность
4871 + "area": 0, ~/~/ Площадь поля, Га.
4872 + "total": 0, ~/~/ Валовый сбор
4873 + "productivityFact": 0, ~/~/ Фактическая урожайность
4874 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4875 + "totalFact": 0, ~/~/ Фактический валовый сбор
4876 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
4877 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
4878 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
4879 + "isyearplan": true, ~/~/ годовой план 
4880 + "comment": "string" ~/~/ Комментарий
4881 + }
4882 + ],
4883 + "cropVegetation": [ ~/~/ История вегетации поля
4884 + {
4885 + "values": [  ~/~/ Данные вегетации и состояния посева
4886 + {
4887 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4888 + "ndvi": 0 ~/~/ Индекс вегетации
4889 + }
4890 + ],
4891 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
4892 + {
4893 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4894 + "type": "string", ~/~/ Тип
4895 + "pictureid": "string" ~/~/ Идентификатор ресурса
4896 + }
4897 + ],
4898 + "states": [ ~/~/ Ключевые даты развития поля
4899 + {
4900 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4901 + "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
4902 + }
4903 + ]
4904 + }
4905 + ],
4906 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
4907 + "counts": {
4908 + "fieldOperations": 0, ~/~/ Количество операций на поле
4909 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4910 + "facts": 0 ~/~/ Счётчик факта
4911 + },
4912 + "planComment": "string", ~/~/ Комментарий к полю
4913 +)))
4914 +
4915 +(((
4916 + "productivity": 0, ~/~/ Урожайность.
4917 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4918 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
4919 + "year": 0, ~/~/ Год поля
4920 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4921 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4922 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4923 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4924 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
4925 + "id": 0, ~/~/ Идентификатор объекта геозоны
4926 + "name": "string", ~/~/ Название объекта геозоны
4927 + "type": 0, ~/~/ Тип объекта геозоны
4928 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4929 + "fname": "string", ~/~/ Имя файла
4930 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4931 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
4932 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
4933 + "description": "string", ~/~/ Описание объекта геозоны
4934 + "area": 0, ~/~/ Площадь, м2
4935 + "perimetr": 0, ~/~/ Периметр, м
4936 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
4937 +}
4938 +
4939 +
4940 +)))
4941 +)))
4942 +)))
4943 +
4944 +== **Получение поля по id** ==
4945 +
4946 +(% class="box infomessage" %)
4947 +(((
4948 +**GET /api/v3/agroLands/{id}**
4949 +)))
4950 +
4951 +Пример запроса:
4952 +id  ~/~/ Идентификатор поля
4953 +
4954 +Пример ответа:
4955 +
4956 +(((
4957 +{
4958 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4959 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4960 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4961 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4962 + "cropRotations": [ ~/~/ Данные по севообороту
4963 + {
4964 + "landId": 0, ~/~/ ID поля
4965 + "landName": "string", ~/~/ Название поля
4966 + "year": 0, ~/~/ Год урожая
4967 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4968 + "cultureName": "string", ~/~/ Название культуры
4969 + "productivity": 0, ~/~/ Урожайность
4970 + "area": 0, ~/~/ Площадь поля, Га
4971 + "total": 0, ~/~/ Валовый сбор
4972 + "productivityFact": 0, ~/~/ Фактическая урожайность
4973 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4974 + "totalFact": 0, ~/~/ Фактический валовый сбор
4975 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
4976 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
4977 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
4978 + "isyearplan": true, ~/~/ План года 
4979 + "comment": "string" ~/~/ Комментарий
4980 + }
4981 + ],
4982 + "cropVegetation": [ ~/~/ История вегетации поля
4983 + {
4984 + "values": [ ~/~/ Данные вегетации и состояния посева
4985 + {
4986 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
4987 + "ndvi": 0 ~/~/ Индекс вегетации
4988 + }
4989 + ],
4990 + "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
4991 + {
4992 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
4993 + "type": "string", ~/~/ Тип 
4994 + "pictureid": "string" ~/~/ Идентификатор ресурса
4995 + }
4996 + ],
4997 + "states": [ ~/~/ Ключевые даты развития поля
4998 + {
4999 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5000 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5001 + }
5002 + ]
5003 + }
5004 + ],
5005 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5006 + "counts": {
5007 + "fieldOperations": 0, ~/~/ Количество операций на поле
5008 + "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5009 + "facts": 0 ~/~/ Счётчик факта
5010 + },
5011 + "planComment": "string", ~/~/ Комментарий к полю
5012 + "productivity": 0, ~/~/ Урожайность.
5013 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5014 +)))
5015 +
5016 +(((
5017 +(((
5018 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5019 + "year": 0, ~/~/ Год поля
5020 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5021 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5022 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5023 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5024 + "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5025 + "id": 0, ~/~/ Идентификатор объекта геозоны
5026 + "name": "string", ~/~/ Название объекта геозоны
5027 + "type": 0, ~/~/ Тип объекта геозоны 
5028 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5029 + "fname": "string", ~/~/ Имя файла
5030 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5031 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5032 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5033 + "description": "string", ~/~/ Описание объекта геозоны
5034 + "area": 0, ~/~/ Площадь, м2
5035 + "perimetr": 0, ~/~/ Периметр, м
5036 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5037 +}
5038 +)))
5039 +
5040 +
5041 +== **Удаление существующего поля** ==
5042 +
5043 +(% class="box errormessage" %)
5044 +(((
5045 +**DELETE /api/v3/agroLands/{id}**
5046 +)))
5047 +
5048 +Пример запроса:
5049 +id  ~/~/ Идентификатор поля
5050 +
5051 +Пример ответа:
5052 +
5053 +(((
5054 +200 ~/~/ Успех
5055 +)))
5056 +
5057 +(((
5058 +
5059 +)))
5060 +
5061 +(((
5062 +(((
5063 +(((
5064 +
5065 +)))
5066 +
5067 +(((
5068 +== **Изменение поля** ==
5069 +
5070 +(% class="box infomessage" %)
5071 +(((
5072 +**PUT /api/v3/agroLands**
5073 +)))
5074 +
5075 +Пример запроса:
5076 +
5077 +(((
5078 +(((
5079 +{
5080 + "id": 0, ~/~/ Идентификатор поля
5081 + "extId": "string", ~/~/ ExtId
5082 + "shape": "string", ~/~/ Форма поля
5083 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5084 + "display": "string", ~/~/ Настройки отображения
5085 + "year": 0, ~/~/ Год поля
5086 + "name": "string", ~/~/ Наименование
5087 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5088 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5089 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5090 + "planComment": "string", ~/~/Комментарий к полю
5091 + "cropRotations": [  ~/~/ Данные по севообороту
5092 + {
5093 + "landId": 0, ~/~/ ID поля
5094 + "landName": "string", ~/~/ Название поля
5095 + "year": 0, ~/~/ Год урожая
5096 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5097 + "cultureName": "string", ~/~/ Название культуры
5098 + "productivity": 0, ~/~/ Урожайность
5099 + "area": 0, ~/~/ Площадь поля, Га.
5100 + "total": 0, ~/~/ Валовый сбор
5101 + "productivityFact": 0, ~/~/ Фактическая урожайность
5102 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5103 + "totalFact": 0, ~/~/ Фактический валовый сбор
5104 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5105 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5106 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5107 + "isyearplan": true, 
5108 + "comment": "string" ~/~/ Комментарий
5109 + }
5110 + ],
5111 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5112 +}
5113 +)))
5114 +)))
5115 +
5116 +(((
5117 +
5118 +)))
5119 +
5120 +Пример ответа:
5121 +
5122 +(((
5123 +(((
5124 +(((
5125 +{
5126 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5127 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5128 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5129 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5130 + "cropRotations": [ ~/~/ Данные по севообороту
5131 + {
5132 + "landId": 0, ~/~/ ID поля
5133 + "landName": "string", ~/~/ Название поля
5134 + "year": 0, ~/~/  Год урожая
5135 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5136 + "cultureName": "string", ~/~/ Название культуры
5137 + "productivity": 0, ~/~/ Урожайность
5138 + "area": 0, ~/~/ Площадь поля, Га
5139 + "total": 0, ~/~/ Валовый сбор
5140 + "productivityFact": 0, ~/~/ Фактическая урожайность
5141 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5142 + "totalFact": 0, ~/~/ Фактический валовый сбор
5143 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5144 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5145 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5146 + "isyearplan": true, ~/~/ 
5147 + "comment": "string" ~/~/ Комментарий
5148 + }
5149 + ],
5150 + "cropVegetation": [ ~/~/ История вегетации поля
5151 + {
5152 + "values": [ ~/~/ Данные вегетации и состояния посева
5153 + {
5154 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5155 + "ndvi": 0 ~/~/ Индекс вегетации
5156 + }
5157 + ],
5158 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5159 + {
5160 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5161 + "type": "string", ~/~/ Тип
5162 + "pictureid": "string" ~/~/ Идентификатор ресурса
5163 + }
5164 + ],
5165 + "states": [ ~/~/ Ключевые даты развития поля 
5166 + {
5167 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5168 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5169 + }
5170 + ]
5171 + }
5172 + ],
5173 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5174 + "counts": { 
5175 + "fieldOperations": 0, ~/~/ Количество операций на поле
5176 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5177 + "facts": 0 ~/~/ Счётчик факта
5178 + },
5179 + "planComment": "string", ~/~/ Комментарий к полю
5180 + "productivity": 0, ~/~/ Урожайность.
5181 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5182 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5183 + "year": 0, ~/~/ Год поля
5184 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5185 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5186 + "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5187 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5188 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5189 + "id": 0, ~/~/ Идентификатор объекта геозоны
5190 + "name": "string", ~/~/ Название объекта геозоны
5191 + "type": 0, ~/~/ Тип объекта геозоны
5192 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5193 + "fname": "string", ~/~/ Имя файла
5194 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5195 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5196 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5197 + "description": "string", ~/~/ Описание объекта геозоны
5198 + "area": 0, ~/~/ Площадь, м2
5199 + "perimetr": 0, ~/~/ Периметр, м
5200 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5201 +}
5202 +)))
5203 +)))
5204 +)))
5205 +)))
5206 +)))
5207 +
5208 +
5209 +== **Редактирование года урожая ** ==
5210 +
5211 +(% class="box successmessage" %)
5212 +(((
5213 +**POST /api/v3/agroLands/updateOpenCloseYear**
5214 +)))
5215 +
5216 +Пример запроса:
5217 +
5218 +(((
5219 +(((
5220 +{
5221 + "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5222 + 0
5223 + ],
5224 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5225 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5226 +}
5227 +)))
5228 +
5229 +
5230 +)))
5231 +
5232 +Пример ответа:
5233 +
5234 +(((
5235 +(((
5236 +{
5237 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5238 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5239 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5240 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5241 + "cropRotations": [ ~/~/ Данные по севообороту
5242 + {
5243 + "landId": 0, ~/~/ ID поля
5244 + "landName": "string", ~/~/ Название поля
5245 + "year": 0, ~/~/ Год урожая
5246 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5247 + "cultureName": "string", ~/~/ Название культуры
5248 + "productivity": 0, ~/~/ Урожайность
5249 + "area": 0, ~/~/ Площадь поля, Га.
5250 + "total": 0, ~/~/ Валовый сбор
5251 + "productivityFact": 0, ~/~/ Фактическая урожайность
5252 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5253 + "totalFact": 0, ~/~/ Фактический валовый сбор
5254 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5255 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5256 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5257 + "isyearplan": true, ~/~/ 
5258 + "comment": "string" ~/~/ Комментарий
5259 + }
5260 + ],
5261 + "cropVegetation": [ ~/~/ История вегетации поля
5262 + {
5263 + "values": [ ~/~/ Данные вегетации и состояния посева
5264 + {
5265 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5266 + "ndvi": 0 ~/~/ Индекс вегетации
5267 + }
5268 + ],
5269 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5270 + {
5271 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5272 + "type": "string", ~/~/ Тип
5273 + "pictureid": "string" ~/~/ Идентификатор ресурса
5274 + }
5275 + ],
5276 + "states": [ ~/~/ Ключевые даты развития поля
5277 + {
5278 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5279 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5280 + }
5281 + ]
5282 + }
5283 + ],
5284 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5285 + "counts": { 
5286 + "fieldOperations": 0, ~/~/ Количество операций на поле
5287 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5288 + "facts": 0 ~/~/ Счётчик факта
5289 + },
5290 + "planComment": "string", ~/~/ Комментарий к полю
5291 + "productivity": 0, ~/~/ Урожайность.
5292 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5293 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5294 + "year": 0, ~/~/ Год поля
5295 + "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5296 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5297 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5298 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5299 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5300 + "id": 0, ~/~/ Идентификатор объекта геозоны
5301 + "name": "string", ~/~/ Название объекта геозоны
5302 + "type": 0, ~/~/ Тип объекта геозоны
5303 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5304 + "fname": "string", ~/~/ Имя файла
5305 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5306 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5307 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5308 + "description": "string", ~/~/ Описание объекта геозоны
5309 + "area": 0, ~/~/ Площадь, м2
5310 + "perimetr": 0, ~/~/ ериметр, м
5311 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5312 +}
5313 +)))
5314 +
5315 +
5316 +== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) ==
5317 +)))
5318 +)))
5319 +)))
5320 +
5321 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5322 +
5323 +
5324 +(% class="box infomessage" %)
5325 +(((
5326 +**GET api/v3/Vehicles/recyclebin/all**
5327 +)))
5328 +
5329 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5330 +
5331 +Параметр запроса: {parentId} - идентификатор агента
5332 +
5333 +В заголовках запроса: X-Auth: Токен авторизации
5334 +
5335 +Ответ:
5336 +
5337 +[ 
5338 + {
5339 + "recordTime": "", ~/~/Время записи
5340 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5341 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5342 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5343 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5344 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5345 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5346 + "items": [ ~/~/ 
5347 +nullable: true ~/~/Детали
5348 + {
5349 + "name": "string", ~/~/наименование столбца
5350 + "value": "string" ~/~/содержание столбца
5351 + }
5352 + ]
5353 + },
5354 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5355 + "string"
5356 + ]
5357 + }
5358 +]
5359 +
5360 +
5361 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
5362 +
5363 +(% class="box infomessage" %)
5364 +(((
5365 +**POST api/v3/Vehicles/recyclebin/erase**
5366 +)))
5367 +
5368 +В заголовках запроса: X-Auth: Токен авторизации
5369 +
5370 +Пример запроса:
5371 +
5372 +[
5373 +0
5374 +]
5375 +
5376 +
5377 +Пример ответа:
5378 +
5379 +[ 
5380 +{
5381 + "recordTime": "", ~/~/Время записи
5382 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5383 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5384 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
5385 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5386 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5387 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5388 + "items": [ ~/~/Детали
5389 + {
5390 + "name": "", ~/~/Имя свойства
5391 + "value": "" ~/~/Значение свойства
5392 + }
5393 + ]
5394 + },
5395 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5396 + ""
5397 + ]
5398 + }
5399 +]
5400 +
5401 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5402 +
5403 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5404 +
5405 +(% class="box infomessage" %)
5406 +(((
5407 +**POST api/v3/Vehicles/recyclebin/restore**
5408 +)))
5409 +
5410 +В заголовках запроса: X-Auth: Токен авторизации
5411 +
5412 +Параметры в теле запроса (JSON):
5413 +
5414 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5415 +
5416 +В заголовках запроса: X-Auth: Токен авторизации
5417 +
5418 +
5419 +Пример запроса:
5420 +
5421 +(((
5422 +[
5423 +)))
5424 +
5425 +(((
5426 + 0
5427 +)))
5428 +
5429 +(((
5430 +]
5431 +)))
5432 +
5433 +
5434 +Пример ответа:
5435 +
5436 +[
5437 +{
5438 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5439 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5440 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5441 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5442 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5443 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5444 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5445 + "items": [ ~/~/Детали
5446 + {
5447 + "name": "string", ~/~/Имя свойства
5448 + "value": "string" ~/~/Значение свойства
5449 + }
5450 + ]
5451 + },
5452 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5453 + "string"
5454 + ]
5455 + }
5456 +]
5457 +
5458 +
5459 +
2781 2781  (% class="box" lang="en-US" style="text-align: center;" %)
2782 2782  (((
2783 2783  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
Icon image-20231020124453-1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.krainovim
Size
... ... @@ -1,0 +1,1 @@
1 +268.0 KB
Content Icon

Меню

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