Last modified by Андрей Калиновский on 2025/05/06 12:41
<
From version < 108.1 >
edited by Илья Крайнов
on 2023/09/27 15:57
To version < 229.1 >
edited by Андрей Калиновский
on 2025/05/06 12:37
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
Content
... ... @@ -1,5 +1,22 @@
1 1  (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 2  (((
3 +(% class="box warningmessage" %)
4 +(((
5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 +просим вас соблюдать несколько простых правил при использовании API-команд:##
7 +)))
8 +
9 +* Формировать не более 3 отчётов одновременно.
10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
11 +
12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13 +
14 +(% class="box infomessage" %)
15 +(((
16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 +)))
19 +
3 3  **Содержание страницы:**
4 4  )))
5 5  
... ... @@ -14,13 +14,22 @@
14 14  
15 15  Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16 16  
17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
34 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
18 18  
36 +
37 +(% style="color:#000000; font-size:16px" %)**Рекомендации**
38 +
39 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
40 +
19 19  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
20 20  
21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) ==
43 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
44 +(((
45 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
46 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
47 +)))
22 22  
23 -(% class="box infomessage" %)
49 +(% class="box successmessage" %)
24 24  (((
25 25  (% lang="en-US" %)**POST /api/v3/auth/login**
26 26  )))
... ... @@ -31,7 +31,7 @@
31 31  
32 32  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33 33  
34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
60 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% style="color:#000000" %)Параметры в теле запроса (JSON):
37 37  
... ... @@ -40,21 +40,25 @@
40 40   "password": "testuser"
41 41  }
42 42  
43 -
44 44  (% style="color:#000000" %)**Ответ:**
45 45  
46 46  (% lang="en-US" %)
47 47  (% style="color:#000000" %){
48 -
49 -(% lang="en-US" %)
50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 - "User": "testuser" , ~/~/ имя пользователя
52 -
53 -(% lang="en-US" %)
73 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
74 + "User": "testuser" , ~/~/ имя пользователя(%%)
54 54  }
55 55  
56 56  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57 57  
79 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
80 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
81 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
82 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
83 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
84 +
85 +(% class="wikigeneratedid" %)
86 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
87 +
58 58  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
59 59  
60 60  (% class="box infomessage" %)
... ... @@ -93,30 +93,63 @@
93 93  Запрос должен содержать данные параметра "**agentId**"
94 94  
95 95  (% style="color:#000000" %)Ответ:
96 -А
126 +
127 +(((
97 97  {
98 - "agentId": "", ~/~/ идентификатор клиента    (%%)
99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
104 - "isForeign": true/false, ~/~/ Иностранный контрагент
105 - "district": "string", ~/~/ округ
106 - "region": "string", ~/~/ регион
107 - "city": "string", ~/~/ город
108 - "inn": "string", ~/~/ ИНН клиента
109 - "kpp": "string", ~/~/ КПП клиента
110 - "address": "string", ~/~/ юридический адрес
111 - "addressFact": "string", ~/~/ фактический адрес
112 - "email": "string", ~/~/ почта
113 - "director": "string", ~/~/ ФИО руководителя
114 - "bankName": "string", ~/~/ Банк
115 - "bankBIK": "string", ~/~/ БИК
116 - "bankRS": "string", ~/~/ Номер счета
117 - "bankKS": "string" ~/~/ Корр. счет
118 - }
129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
131 + "parentName": "string", ~/~/ Наименование агента
132 + "name": "string", ~/~/ Имя клиента
133 + "fullName": "string", ~/~/ ФИО клиента
134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
136 + "district": "string", ~/~/ Район
137 + "region": "string", ~/~/ Область
138 + "city": "string", ~/~/ Город
139 + "email": "string", ~/~/ Email
140 + "director": "string", ~/~/ Руководитель
141 + "RegionalData": [ ~/~/ Определяет региональные сведения.
142 + {
143 + "Country": 0, ~/~/ Страна
144 + "groups": [ ~/~/ Список групп
145 + {
146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 
147 + "fields": [ ~/~/ Список значений полей
148 + {
149 + "name": "string", ~/~/ Имя поля формы
150 + "value": "string" ~/~/ Значение поля формы
151 + }
152 + ]
153 + }
154 + ]
155 + }
156 + ]
157 +}
158 +)))
119 119  
160 +
161 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
162 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
163 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
164 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
165 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
166 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
167 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
168 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
169 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
170 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
171 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
172 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
173 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
174 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
175 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
176 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
177 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
178 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
179 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
180 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
181 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
182 +
120 120  == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
121 121  
122 122  (% class="box infomessage" %)
... ... @@ -130,7 +130,7 @@
130 130  
131 131  (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
132 132  
133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
196 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
134 134  
135 135  (% style="color:#000000" %)Метод запроса: **POST**
136 136  
... ... @@ -145,15 +145,23 @@
145 145  (% style="color:#000000" %)Ответ:
146 146  
147 147  {
148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента    (%%)
149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%)
150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%)
151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента  (%%)
152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%)
153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
211 + "agentId": "",(% style="color:#000000" %)   (%%)
212 + "parentId": "",
213 + "name": "string",
214 + "fullName": "string",
215 + "agentInfoType": 0,
216 +(% style="color:#000000" %) "status": "",
155 155  }
156 156  
219 +
220 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
221 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
222 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
223 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
224 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
225 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
226 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
227 +
157 157  == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
158 158  
159 159  (% class="box successmessage" %)
... ... @@ -172,7 +172,7 @@
172 172  Параметры в теле запроса (JSON):
173 173  
174 174  {
175 - "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
246 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
176 176   "name": "string", ~/~/ имя
177 177   "fullName": "string", ~/~/ полное наименование
178 178   "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
... ... @@ -192,7 +192,6 @@
192 192   "bankKS": "string" ~/~/ корр. счёт
193 193  }
194 194  
195 -
196 196  Ответ:
197 197  
198 198  {
... ... @@ -217,6 +217,28 @@
217 217   "bankKS": "string" ~/~/ корр. счёт
218 218  }
219 219  
290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
291 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
292 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
293 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
294 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
295 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
296 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
297 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
298 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ
299 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион
300 +|(% style="width:215px" %)city|(% style="width:861px" %)Город
301 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
302 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
303 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
304 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
305 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
306 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
307 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
308 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
309 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
310 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
311 +
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  
393 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
394 +
395 +(% class="box warningmessage" %)
396 +(((
397 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
398 +)))
399 +
400 +Метод позволяет изменить статус клиента, указанного в запросе.
401 +
402 +В пути указывается GUID клиента и статус клиента.
403 +
404 +**status **- значение 0 - заблокирован, 1 - активен.
405 +
406 +Ответ: Code 204
407 +
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 пользователя
472 +{     
473 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя
490 +}
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 -
512 +(% 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 пользователя 
608 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
609 + "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" %)
631 + "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": "" , ~/~/ идентификатор пользователя
638 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
639 + "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» названия группы пользователя
660 +}
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 -
681 +(% 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",
706 + "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" %)Раздел: **Транспортные средства**(%%) =
769 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
686 686  
771 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
772 +
773 +(% class="box infomessage" %)
774 +(((
775 +(% lang="en-US" %)**GET /api/v3/models/{Id}**
776 +)))
777 +
778 +Метод возвращает полную информацию о модели объекта.
779 +
780 +(% style="color:#000000" %)Метод запроса: **GET**
781 +
782 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
783 +
784 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
785 +
786 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
787 +
788 +(% style="color:#000000" %)Ответ:
789 +
790 +(% style="color:#000000" %){
791 + "parentName": "string",
792 + "name": "string",
793 + "picture": "string",
794 + "minspeed": 0,
795 + "maxspeed": 0,
796 + "width": 0,
797 + "imbeddedtrailer": true,
798 + "hoppercapacity": 0,
799 + "hopperdischargespeed": 0,
800 + "modelType": 0,
801 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
802 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
803 + "deleted": true
804 +}
805 +
806 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
807 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
808 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
809 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
810 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
811 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
812 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
813 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
814 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
815 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
816 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
817 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
818 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
819 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
820 +
821 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
822 +
823 +(% class="box successmessage" %)
824 +(((
825 +(% lang="en-US" %)**POST /api/v3/models/find**
826 +)))
827 +
828 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
829 +
830 +(% style="color:#000000" %)Метод запроса: **POST**
831 +
832 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
833 +
834 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
835 +
836 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{
837 +
838 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
839 +}
840 +
841 +(% style="color:#000000" %)Ответ:
842 +
843 +(% style="color:#000000" %)[
844 + {
845 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
846 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
847 + "parentName": "string",
848 + "name": "string",
849 + "modelType": 0
850 + }
851 +]
852 +
853 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
854 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
855 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
856 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
857 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
858 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
859 +
860 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
861 +
862 +(% class="box successmessage" %)
863 +(((
864 +(% lang="en-US" %)**POST /api/v3/models**
865 +)))
866 +
867 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
868 +
869 +(% style="color:#000000" %)Метод запроса: **POST**
870 +
871 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
872 +
873 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
874 +
875 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
876 +
877 +{
878 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
879 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
880 + "deleted": true,
881 + "extId": "string",
882 + "name": "string",
883 + "picture": "string",
884 + "minspeed": 0,
885 + "maxspeed": 0,
886 + "width": 0,
887 + "imbeddedtrailer": true,
888 + "fueloutlay": 0,
889 + "hoppercapacity": 0,
890 + "hopperdischargespeed": 0,
891 + "modelType": 0
892 +}
893 +
894 +Ответ:
895 +
896 +{
897 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
898 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
899 + "deleted": true,
900 + "extId": "string",
901 + "name": "string",
902 + "picture": "string",
903 + "minspeed": 0,
904 + "maxspeed": 0,
905 + "width": 0,
906 + "imbeddedtrailer": true,
907 + "hoppercapacity": 0,
908 + "hopperdischargespeed": 0,
909 + "modelType": 0
910 +}
911 +
912 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
913 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
914 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
915 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
916 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
917 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
918 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
919 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
920 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
921 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
922 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
923 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
924 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
925 +
926 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
927 +
928 +(% class="box warningmessage" %)
929 +(((
930 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
931 +)))
932 +
933 +(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
934 +
935 +(% style="color:#000000" %)Метод запроса: **PUT**
936 +
937 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
938 +
939 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
940 +
941 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
942 +
943 +{
944 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
945 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
946 + "deleted": true,
947 + "extId": "string",
948 + "name": "string",
949 + "picture": "string",
950 + "minspeed": 0,
951 + "maxspeed": 0,
952 + "width": 0,
953 + "imbeddedtrailer": true,
954 + "fueloutlay": 0,
955 + "hoppercapacity": 0,
956 + "hopperdischargespeed": 0,
957 + "modelType": 0
958 +}
959 +
960 +Ответ:
961 +
962 +{
963 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
964 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
965 + "deleted": true,
966 + "extId": "string",
967 + "name": "string",
968 + "picture": "string",
969 + "minspeed": 0,
970 + "maxspeed": 0,
971 + "width": 0,
972 + "imbeddedtrailer": true,
973 + "fueloutlay": 0,
974 + "hoppercapacity": 0,
975 + "hopperdischargespeed": 0,
976 + "modelType": 0
977 +}
978 +
979 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
980 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
981 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
982 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
983 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
984 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
985 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
986 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
987 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
988 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
989 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
990 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
991 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
992 +
993 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
994 +
995 +(% class="box errormessage" %)
996 +(((
997 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}**
998 +)))
999 +
1000 +(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
1001 +
1002 +(% style="color:#000000" %)Метод запроса: **DELETE**
1003 +
1004 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
1005 +
1006 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
1007 +
1008 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1009 +
1010 +Ответ: В случае успеха **Success 200**
1011 +
1012 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
1013 +
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  {
1041 +
1042 +(((
1043 + "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1044 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1045 +)))
1046 +
1047 +(((
1048 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1049 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1050 +)))
1051 +
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 -
1090 + "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, ~/~/ Отображать последнее валидное значение
1146 + "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": [ ~/~/ История статусов
1198 +"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  
1205 +(((
888 888  }
1207 + ],
1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
889 889  )))
890 890  
1212 +(((
1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1214 +}
1215 +
1216 +)))
1217 +)))
1218 +
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  
1225 +
1226 +== **Отправить команду на терминал** ==
1227 +
1228 +(% class="box successmessage" %)
1229 +(((
1230 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1231 +)))
1232 +
1233 +Команда для отправки на тс.
1234 +
1235 +{  
1236 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1237 +"command": "", ~/~/ Текст отправляемой команды
1238 +"retries": "", ~/~/ Количество попыток отправки на терминал
1239 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1240 +}
1241 +
1242 +В ответ получаем cmdid
1243 +
1244 +
1245 +== **Получить ответ на отправленную на ТС команду** ==
1246 +
1247 +(% class="box infomessage" %)
1248 +(((
1249 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1250 +)))
1251 +
1252 +Идентификатор команды: cmdId
1253 +
1254 +Запрос от терминала на ответ команды
1255 +
1256 +Пример ответ от терминала:
1257 +
1258 +ID= "" ~/~/ идентификатор объекта
1259 +Soft="" ~/~/ версия софта
1260 +GPS=4 ~/~/ тип трекера
1261 +Time=11:05:43 28.06.24 ~/~/ время запроса
1262 +Lat=45.056221 ~/~/ широта
1263 +Lon=39.035938 ~/~/ долгота
1264 +Speed=0.0 ~/~/ скорость
1265 +Course=181.4 ~/~/направление
1266 +
1267 +(((
1268 +== **Список отправленных объекту команд с ответами** ==
1269 +
1270 +(% class="box infomessage" %)
1271 +(((
1272 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1273 +)))
1274 +
1275 +Идентификатор ТС: vehicleId
1276 +
1277 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1278 +
1279 +Пример ответа терминала
1280 +
1281 +[ 
1282 +{    
1283 +"id": "", ~/~/ идентификатор пользователя
1284 +"commandText": "", ~/~/Текст команды.
1285 +"templateId": "", ~/~/Идентификатор шаблона
1286 +"updated": "", ~/~/ Время отправки  
1287 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1288 +"answer": "", ~/~/ Ответ терминала.
1289 +"status": "" ~/~/ Статус отправки
1290 +}
1291 +]
1292 +)))
1293 +
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  
1313 +
1314 +(((
1315 + "vehicleId": 0, ~/~/ ID ТС
1316 +)))
1317 +
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": [ ~/~/ Датчики
1384 +"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, ~/~/ Отображать последнее валидное значение
1410 + "color": "string", ~/~/ код цвета датчиков
1011 1011   "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1012 1012   "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1013 1013   "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
... ... @@ -1020,103 +1020,222 @@
1020 1020   "additionalProp2": "string",
1021 1021   "additionalProp3": "string"
1022 1022   },
1023 -
1024 1024  ~/~/ Характерные для произвольного:
1025 -
1026 1026  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1027 -
1028 1028  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1029 -
1030 1030  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1031 -
1032 1032  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1033 -
1034 1034  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1035 -
1036 1036  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1037 -
1038 1038  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1039 -
1040 1040  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1041 -
1042 1042  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1043 -
1044 1044  ~/~/ "ValueOn": "Вкл.",
1045 -
1046 1046  ~/~/ "ValueOff": "Выкл."
1047 - "summaryMaxValue": 0 ~/~/ Макс. значение
1435 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1436 +
1437 +(((
1438 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1439 + {
1440 + "from": 0, ~/~/ С какого значения
1441 + "color": "string", ~/~/ Каким цветом
1442 + "text": "string" ~/~/ Текст подписи к этому интервалу
1443 + }
1444 + ]
1048 1048   }
1049 1049   ],
1447 +)))
1448 +
1449 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1450 +
1451 +
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 - ]
1454 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1455 + "name": "string", ~/~/ Наименование произвольного поля
1456 + "value": "string", ~/~/ Значение произвольного поля
1457 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1458 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1459 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1460 +
1461 +(((
1462 + }
1463 + ],
1464 + "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1465 +)))
1466 +
1467 +(((
1468 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1060 1060  }
1470 +)))
1061 1061  
1472 +
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 - однократно)
1476 +(((
1477 +(((
1478 +(((
1479 +{
1480 + "vehicleId": 0,  ~/~/ ID ТС
1481 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1482 + "name": "string", ~/~/ Имя объекта
1483 + "imei": "string", ~/~/ IMEI
1484 + "deviceTypeId": 0, ~/~/ ID типа устройства
1485 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1486 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1487 + "sim1": "string", ~/~/ SIM1
1488 + "sim2": "string", ~/~/ SIM2
1489 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1490 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1491 + "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1492 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1493 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1494 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1495 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1496 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1497 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1498 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1499 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1500 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1501 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1502 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1503 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1504 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1505 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1506 + "counters": {  ~/~/ Dto для состояний счётчиков
1507 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1508 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1509 + "mileage": 0, ~/~/ Пробег
1510 + "motohours": 0 ~/~/ Моточасы
1511 + },
1512 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1513 + "id": "string", ~/~/ CMSV6 Идентификатор
1514 + "enabled": true, ~/~/ Признак включения
1515 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1516 + "login": "string", ~/~/ CMSV6 имя учетной записи
1517 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
1518 + },
1519 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1520 + {
1521 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1522 + "enabled": true, ~/~/ Признак включения
1523 + "name": "string", ~/~/ Имя задания
1524 + "description": "string", ~/~/ Описание задания
1525 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1526 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1527 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1528 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1529 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
1530 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1531 + "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1532 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1102 1102   }
1534 + ],
1535 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1536 + {
1537 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1538 + "inputNumber": 0, ~/~/ № входа.
1539 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1540 + "comment": "string", ~/~/ Комментарий
1541 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1542 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1543 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1544 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1545 + }
1546 + ],
1547 + "commandTemplates": [  ~/~/ Список шаблонов команд
1548 + {
1549 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1550 + "name": "string", ~/~/ Название шаблона команд
1551 + "command": "string", ~/~/ Команда на выполнение
1552 + "retries": 0 ~/~/ Лимит попыток отправки
1553 + }
1554 + ],
1555 + "sensors": [ ~/~/ Список датчиков
1556 + {
1557 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1558 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1559 + "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
1560 + "name": "string",  ~/~/ Имя датчика
1561 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1562 + "inputNumber": 0, ~/~/ Номер входа
1563 + "pseudonym": "string", ~/~/ Псевдоним
1564 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
1565 + "isInverted": true, ~/~/  Признак инверсии
1566 + "disabled": true, ~/~/ Датчик не участвует в обработке
1567 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1568 + "gradesTables": [ ~/~/ Тарировка
1569 + {
1570 + "grades": [ ~/~/ Таблицы тарировки
1571 + {
1572 + "input": 0, ~/~/ Вход
1573 + "output": 0 ~/~/ Выход
1574 + }
1575 + ],
1576 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1577 + }
1578 + ],
1579 + "showInTooltip": true, ~/~/ Отображение в подсказке
1580 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1581 + "color": "string", ~/~/ код цвета датчиков
1582 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1583 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1584 + "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1585 + "expr": "string", ~/~/ Выражение
1586 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1587 + "string"
1588 + ],
1589 + "customParams": {
1590 + "additionalProp1": "string",
1591 + "additionalProp2": "string",
1592 + "additionalProp3": "string"
1593 + },
1594 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1595 + "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1596 + {
1597 + "from": 0, ~/~/ С какого значения
1598 + "color": "string", ~/~/ Каким цветом
1599 +)))
1103 1103  
1104 -(% style="text-align:left" %)
1105 -(% style="color:#000000" %)}
1601 +(((
1602 + "text": "string" ~/~/ Текст подписи к этому интервалу
1603 + }
1604 + ]
1605 + }
1606 + ],
1607 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1608 + "customFields": [ ~/~/ Список произвольных полей
1609 + {
1610 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1611 + "name": "string", ~/~/ Наименование произвольного поля
1612 + "value": "string", ~/~/ Значение произвольного поля
1613 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1614 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1615 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1616 + }
1617 + ],
1618 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1619 +}
1620 +)))
1621 +)))
1622 +)))
1106 1106  
1624 +
1107 1107  **Валидация:**
1108 1108  - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1109 1109  - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1110 1110  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1111 1111  
1112 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) ==
1113 1113  
1631 +(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**
1632 +
1114 1114  (% class="box infomessage" %)
1115 1115  (((
1116 1116  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1117 1117  )))
1118 1118  
1119 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1638 +(% 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 ~/~/ значение любого из произвольных полей ТС
1672 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1673 + "unitName": "string",  ~/~/ Название подразделения (опционально)
1674 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1675 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1676 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1677 + "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" %){
1684 +(% style="color:#000000" %)[
1685 +{
1163 1163  
1687 +(((
1688 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1689 +)))
1690 +
1691 +(((
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" %)}
1717 +)))
1191 1191  
1719 +(((
1720 + }
1721 + ],
1722 + "vehicleGroups": [  ~/~/ Группы ТС
1723 + {
1724 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1725 + "name": "string" ~/~/ Наименование группы ТС
1726 + }
1727 + ]
1728 + }
1729 +]
1730 +)))
1731 +
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 -
1767 +(% 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  
1776 +== ==
1777 +
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 - }
1853 +
1854 +(((
1855 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1856 + "inputNumber": 0, ~/~/ № входа.
1857 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1858 + "comment": "string", ~/~/ Комментарий.
1859 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1860 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1861 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1862 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1863 +)))
1864 +
1865 + } 
1318 1318   ],
1319 1319   "commandTemplates": [ ~/~/ Шаблон команды
1320 1320   {
... ... @@ -1324,8 +1324,7 @@
1324 1324   "retries": 0
1325 1325   }
1326 1326   ],
1327 -
1328 - "sensors": [ ~/~/ Датчики
1875 +"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, ~/~/ Отображать последнее валидное значение
1901 +
1902 +(((
1903 + "color": "string",** ~/~/ **Цвет датчика
1904 +)))
1905 +
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 ~/~/ Макс. значение
1931 +
1932 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1933 + {
1934 + "from": 0, ~/~/ С какого значения
1935 + "color": "string", ~/~/ Каким цветом
1936 + "text": "string" ~/~/ Текст подписи к этому интервалу
1937 + }
1938 + ]
1391 1391   }
1392 1392   ],
1941 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1942 +
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
1944 + {     
1945 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1946 + "name": "string", ~/~/ Наименование произвольного поля
1947 + "value": "string", ~/~/ Значение произвольного поля
1948 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1949 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1950 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
1401 1401   }
1402 - ]
1952 +
1953 +(((
1954 + ],
1955 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1956 +)))
1957 +
1403 1403  }
1404 1404  
1960 +
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" %){    
1963 +(((
1964 +{
1965 + "vehicleId": 0, ~/~/ ID ТС
1966 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1967 + "name": "string", ~/~/ Имя объекта
1968 + "imei": "string", ~/~/ IMEI
1969 + "deviceTypeId": 0, ~/~/ ID типа устройства
1970 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1971 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1972 + "sim1": "string", ~/~/ SIM1
1973 + "sim2": "string", ~/~/ SIM2
1974 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1975 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1976 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1977 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1978 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1979 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1980 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1981 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1982 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1983 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1984 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1985 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1986 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1987 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1988 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1989 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1990 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1991 + "counters": { ~/~/ состояний счётчиков
1992 + "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1993 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1994 + "mileage": 0, ~/~/ Пробег
1995 + "motohours": 0 ~/~/ Моточасы 
1996 + },
1997 + "cmsv6Parameters": { ~/~/ Dto для CMSv6
1998 + "id": "string", ~/~/ CMSV6 Идентификатор
1999 + "enabled": true, ~/~/ Признак включения
2000 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2001 +)))
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
2003 +
2004 +(((
2005 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2006 + "login": "string", ~/~/ CMSV6 имя учетной записи
2007 + "password": "string" ~/~/ CMSV6 — пароль учетной записи
2008 + },
2009 + "inspectionTasks": [ ~/~/ Задания на ТО
2010 + {
2011 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2012 + "enabled": true, ~/~/ Признак включения
2013 + "name": "string", ~/~/ Имя задания
2014 + "description": "string", ~/~/ Описание задания
2015 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2016 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2017 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2018 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2019 + "periodicCondition": 0, ~/~/ Условие периодичности по времени
2020 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2021 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2022 + "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2023 + }
2024 + ],
2025 + "drivers": [  ~/~/ Список водителей
2026 + {
2027 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2028 + "inputNumber": 0, ~/~/ № входа.
2029 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2030 + "comment": "string", ~/~/ Комментарий.
2031 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2032 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2033 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2034 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2035 + }
2036 + ],
2037 + "commandTemplates": [ ~/~/ Список шаблонов команд
2038 + {
2039 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2040 + "name": "string", ~/~/ Название шаблона команд
2041 + "command": "string", ~/~/ Команда на выполнение
2042 + "retries": 0 ~/~/ Лимит попыток отправки
2043 + }
2044 + ],
2045 + "sensors": [  ~/~/ Список датчиков 
2046 + {
2047 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2048 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2049 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2050 +)))
2051 +
2052 +(((
2053 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2054 +)))
2055 +
2056 +(((
2057 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2058 +)))
2059 +
2060 +(((
2061 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2062 +)))
2063 +
2064 +(((
2065 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2066 +)))
2067 +
2068 +(((
2069 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2070 + "name": "string", ~/~/ Имя датчика
2071 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2072 +)))
2073 +
2074 +(((
2075 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2076 + "inputNumber": 0, ~/~/ Номер входа
2077 + "pseudonym": "string", ~/~/ Псевдоним
2078 + "medianDegree": 0, ~/~/ Степень медианной фильтрации
2079 + "isInverted": true, ~/~/ Признак инверсии
2080 + "disabled": true, ~/~/ Датчик не участвует в обработке
2081 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2082 + "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": "", ~/~/ Сколько раз выполнить задание
2084 + "grades": [ ~/~/ Таблицы тарировки
2085 + {
2086 + "input": 0, ~/~/ Вход
2087 + "output": 0 ~/~/ Выход
2088 + }
2089 + ],
2090 + "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
1450 1450   }
2092 + ],
2093 + "showInTooltip": true, ~/~/ Отображение в подсказке
2094 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
1451 1451  
1452 -(% lang="en-US" style="text-align:left" %)
1453 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
2096 +(((
2097 + "color": "string", ~/~/ цвет уведомлений
2098 +)))
1454 1454  
2100 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2101 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2102 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2103 + "expr": "string", ~/~/ Выражение
2104 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2105 + "string" 
2106 + ],
2107 + "customParams": { ~/~/ Дополнительные настройки
2108 + "additionalProp1": "string",
2109 + "additionalProp2": "string",
2110 + "additionalProp3": "string"
2111 + },
2112 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2113 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2114 + {
2115 + "from": 0, ~/~/ С какого значения
2116 + "color": "string", ~/~/ Каким цветом
2117 + "text": "string" ~/~/ Текст подписи к этому интервалу
2118 + }
2119 + ]
2120 + }
2121 + ],
2122 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2123 + "customFields": [ ~/~/ Список произвольных полей
2124 + {
2125 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2126 + "name": "string", ~/~/ Наименование произвольного поля
2127 + "value": "string", ~/~/ Значение произвольного поля
2128 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2129 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2130 + "forReport": true ~/~/ Отобразить произвольное поле в отчете
2131 + }
2132 + ],
2133 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2134 +}
2135 +)))
2136 +
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]]
2175 +(% 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 -
2181 +(% 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 -
2205 +(% 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  
2252 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2253 +
2254 +(% class="box infomessage" style="text-align: left;" %)
2255 +(((
2256 +**POST /api/v3/terminalMessages/mapping**
2257 +)))
2258 +
2259 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2260 +
2261 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2262 +
2263 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2264 +
2265 +{
2266 + "protocolType": 0,
2267 + "params": ["string"]
2268 +}
2269 +
2270 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2271 +|protocolType|ID типа протокола
2272 +|params|(((
2273 +Массив наименований параметров в сообщении
2274 +)))
2275 +
2276 +Ответ:
2277 +
2278 +{
2279 + "protocolType": 0,
2280 + "mapping": {
2281 + "additionalProp1": {
2282 + "inputType": 0,
2283 + "inputNumber": 0
2284 + },
2285 + "additionalProp2": {
2286 + "inputType": 0,
2287 + "inputNumber": 0
2288 + }
2289 + }
2290 +}
2291 +
2292 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2293 +|protocolType|Тип протокола
2294 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2295 +|inputNumber|(((
2296 +Номер входа
2297 +)))
2298 +
2299 +(% class="wikigeneratedid" %)
2300 +Перечень 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/]]
2301 +
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  
2326 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2327 +|vehicleId|ID объекта
2328 +|from|Дата и время начала периода запроса
2329 +|to|Дата и время окончания периода запроса
2330 +
1600 1600  Ответ:
1601 1601  
1602 1602  [
... ... @@ -1603,80 +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": { ~/~/ список параметров датчиков передаваемых терминалом
2337 + "deviceTime": "2023-11-29T07:40:44.052Z",
2338 + "serverTime": "2023-11-29T07:40:44.052Z",
2339 + "speed": 0,
2340 + "altitude": 0,
2341 + "latitude": 0,
2342 + "longitude": 0,
2343 + "satellites": 0,
2344 + "course": 0,
2345 + "voltage": 0,
2346 + "parameters": {
1615 1615   "additionalProp1": "string",
1616 1616   "additionalProp2": "string",
1617 1617   "additionalProp3": "string"
1618 1618   },
1619 - "photoCount": 0 ~/~/ Кол-во фото
2351 + "photoCount": 0,
2352 + "lbsCorrectedCoords": true,
2353 + "protocolType": 0
1620 1620   }
1621 1621   ]
1622 1622   }
1623 1623  ]
1624 1624  
1625 -== (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Экспорт сообщений**(%%) ==
2359 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2360 +|deviceTime|Время сообщения терминала
2361 +|serverTime|Время когда сообщение поступило на сервер
2362 +|speed|Скорость
2363 +|altitude|Высота над уровнем моря
2364 +|latitude|Широта
2365 +|longitude|Долгота
2366 +|satellites|Кол-во спутников
2367 +|course|Курс
2368 +|voltage|Бортовое напряжение
2369 +|parameters|Список параметров и их значений
2370 +|photoCount|Количество фото
2371 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2372 +|protocolType|ID типа протокола
1626 1626  
1627 -(% class="box infomessage" %)
1628 -(((
1629 -**POST /api/v3/vehicles/export/history**
1630 -)))
1631 -
1632 -Метод возвращает список сообщений терминала объекта за выбранный период.
1633 -
1634 -(% style="text-align: left;" %)
1635 -Метод запроса **POST**
1636 -
1637 -(% style="text-align: left;" %)
1638 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1639 -
1640 -(% style="text-align: left;" %)
1641 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1642 -
1643 -{
1644 - "vehicleId": 0, ~/~/ ID объекта
1645 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1646 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1647 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1648 -}
1649 -
1650 -Ответ:
1651 -
1652 -Получаете файл. Сообщение: Code 200/Success
1653 -
1654 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1655 -
1656 -(% class="box infomessage" %)
1657 -(((
1658 -**GET /api/v3/vehicles/export/history/status**
1659 -)))
1660 -
1661 -Метод возвращает список сообщений терминала объекта за выбранный период.
1662 -
1663 -(% style="text-align: left;" %)
1664 -Метод запроса **GET**
1665 -
1666 -(% style="text-align: left;" %)
1667 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1668 -
1669 -(% style="text-align: left;" %)
1670 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1671 -
1672 -Ответ:
1673 -
1674 -{
1675 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1676 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1677 - "message": "string" ~/~/ текст описывающий статус.
1678 -}
1679 -
1680 1680  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1681 1681  
1682 1682  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -1713,10 +1713,14 @@
1713 1713   {
1714 1714   "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
1715 1715   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
1716 - "mileageBegin": 0, ~/~/ Пробег на начало периода
1717 - "mileageEnd": 0, ~/~/ Пробег на окончание периода
1718 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода
1719 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода
2410 + "mileage": 0, ~/~/ Пробег за период, километры
2411 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2412 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2413 + "motohours": 0, ~/~/ Моточасы за период, секунды
2414 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2415 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2416 + "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2417 +
1720 1720   }
1721 1721   ]
1722 1722   }
... ... @@ -1760,11 +1760,19 @@
1760 1760   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
1761 1761   "fuelConsumption": 0, ~/~/ Расход топлива
1762 1762   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2461 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2462 +
1763 1763   }
1764 1764   ]
1765 1765   }
1766 1766  ]
1767 1767  
2468 +(% class="box warningmessage" %)
2469 +(((
2470 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2471 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2472 +)))
2473 +
1768 1768  == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
1769 1769  
1770 1770  (% class="box infomessage" %)
... ... @@ -1799,7 +1799,8 @@
1799 1799   "model": "string", ~/~/ Модель объекта
1800 1800   "fuels": [ ~/~/ Массив данным по заправкам и сливам
1801 1801   {
1802 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2508 + "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
2509 +
1803 1803   "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
1804 1804   "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
1805 1805   "valueFuel": 0, ~/~/ Количество
... ... @@ -1810,6 +1810,96 @@
1810 1810   }
1811 1811  ]
1812 1812  
2520 +
2521 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2522 +
2523 +(% class="box infomessage" %)
2524 +(((
2525 +**POST /api/v3/vehicles/moveStop**
2526 +)))
2527 +
2528 +Метод запроса: **POST**
2529 +
2530 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2531 +
2532 +В заголовках запроса: X-Auth: Токен авторизации
2533 +
2534 +
2535 +Тело запроса:
2536 +
2537 +{
2538 + "vehicleIds": [ ], ~/~/ Список ID объектов
2539 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2540 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2541 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2542 +}
2543 +
2544 +Ответ:
2545 +
2546 +[ 
2547 + {
2548 + "vehicleId": 0, ~/~/ ID объекта
2549 + "vehicleName": "string", ~/~/ Имя объекта
2550 + "moves": [ ~/~/ Событие движения
2551 + {
2552 + "mileage": 0, ~/~/ Пробег, км
2553 + "eventId": 0, ~/~/ Идентификатор события
2554 + "eventName": "string", ~/~/ Название события
2555 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2556 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2557 + "duration": 0 ~/~/ Продолжительность события, секунд
2558 + }
2559 + ],
2560 + "stops": [ ~/~/ События стоянок
2561 + {
2562 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2563 + "eventId": 0, ~/~/ Идентификатор события
2564 + "eventName": "string", ~/~/ Название события
2565 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2566 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2567 + "duration": 0 ~/~/ Продолжительность события, секунд
2568 + }
2569 + ]
2570 + }
2571 +]
2572 +
2573 +
2574 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2575 +
2576 +(% class="box infomessage" %)
2577 +(((
2578 +**POST /api/v3/vehicles/getlastdata**
2579 +)))
2580 +
2581 +Метод запроса: **POST**
2582 +
2583 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2584 +
2585 +В заголовках запроса: X-Auth: Токен авторизации
2586 +
2587 +
2588 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2589 +
2590 +Ответ:
2591 + {
2592 + "vehicleId": 0, ~/~/Идентификатор объекта.
2593 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2594 + "vehicleNumber": "string",~/~/Номер объекта.
2595 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2596 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2597 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2598 + "speed": 0,~/~/Скорость объекта.
2599 + "course": 0,~/~/Курс движения [0;360]
2600 + "latitude": 0,~/~/Широта [-90°;90°].
2601 + "longitude": 0,~/~/Долгота [-180°;180°].
2602 + "address": "string",~/~/Адрес.
2603 + "geozones": [ ~/~/Сведения по геозонам.
2604 + {
2605 + "id": 0,
2606 + "name": "string"
2607 + }
2608 +
2609 +
1813 1813  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
1814 1814  
1815 1815  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -1938,6 +1938,35 @@
1938 1938   }
1939 1939  ]
1940 1940  
2738 +
2739 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2740 +
2741 +(% class="box successmessage" %)
2742 +(((
2743 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2744 +)))
2745 +
2746 +(% style="color:#000000" %)Метод запроса: **PUT**
2747 +
2748 +Пример запроса:
2749 +
2750 +(((
2751 +{
2752 + "id": 0,  ~/~/ Идентификатор объекта геозоны
2753 + "name": "string",  ~/~/ Наименование объекта геозоны
2754 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2755 + "description": "string", ~/~/ Описание объекта геозоны
2756 + "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2757 + "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2758 + "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2759 +}
2760 +)))
2761 +
2762 +
2763 +Пример ответа:
2764 +
2765 +200 ~/~/ Success
2766 +
1941 1941  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
1942 1942  
1943 1943  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2117,6 +2117,32 @@
2117 2117  
2118 2118  Success
2119 2119  
2946 +
2947 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2948 +
2949 +(% class="box warningmessage" %)
2950 +(((
2951 +**PUT** /api/v3/notifications/prolongation
2952 +)))
2953 +
2954 +Метод позволяет продлить уведомления.
2955 +
2956 +Метод запроса **PUT**
2957 +
2958 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2959 +
2960 +В заголовках запроса: X-Auth: Токен авторизации.
2961 +
2962 +Тело запроса:
2963 +
2964 +[
2965 +
2966 +0
2967 +
2968 +]
2969 +
2970 +где 0 идентификатор ids.
2971 +
2120 2120  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2121 2121  
2122 2122  (% class="box errormessage" %)
... ... @@ -2708,6 +2708,83 @@
2708 2708  Success
2709 2709  
2710 2710  
3563 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3564 +
3565 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3566 +
3567 +(% class="box infomessage" %)
3568 +(((
3569 +**POST /api/v3/Trailers**
3570 +)))
3571 +
3572 +Пример запроса:
3573 +
3574 +{
3575 + "startDate": "2023-11-14T10:48:03.671Z",
3576 + "endDate": "2023-11-14T10:48:03.671Z",
3577 + "ids": [ 0 ],
3578 + "timezone": 0
3579 +}
3580 +
3581 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3582 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3583 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3584 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3585 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3586 +
3587 +Пример ответа:
3588 +
3589 +[
3590 + {
3591 + "SD": "2023-11-14T10:48:03.717Z",
3592 + "ED": "2023-11-14T10:48:03.717Z", 
3593 + "id": 0,
3594 + "SLat": 0,
3595 + "SLon": 0,
3596 + "ELat": 0,
3597 + "ELon": 0,
3598 + "mileage": 0
3599 + "Duration": 0
3600 + "Address": "string",
3601 + "Address2": "string",
3602 + "name": "string",
3603 + "rid": "string",
3604 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3605 + "trailer": {
3606 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3607 + "Number": "string",
3608 + "Description": "string",
3609 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3610 + "ExternalID": "string",
3611 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3612 + "CreateTime": "2023-11-14T10:48:03.717Z",
3613 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3614 + "IsDeleted": true
3615 + },
3616 + "filesCount": 0,
3617 + }
3618 +]
3619 +
3620 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3621 +|SD|Дата и время начала события
3622 +|ED|Дата и время окончания события
3623 +|id|ID объекта
3624 +|SLat|Широта начальной координаты
3625 +|SLon|Долгота начальной координаты
3626 +|ELat|Широта конечной координаты
3627 +|ELon|Долгота конечной координаты
3628 +|mileage|Пробег
3629 +|Duration|Продолжительность
3630 +|Address|Адрес начального местоположения
3631 +|Address2|Адрес конечного местоположения
3632 +|name|Имя радиометки
3633 +|rid|Номер радиометки
3634 +|rguid|ID радиометки
3635 +|trailer|Информация об агрегате
3636 +|ModelGuid|ID агрегата
3637 +|Number|Название/номер агрегата
3638 +|Description|Текст примечания агрегата
3639 +
2711 2711  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
2712 2712  
2713 2713  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -2729,13 +2729,18 @@
2729 2729   {
2730 2730   "name": "string",
2731 2731   "number": 0,
2732 - "period": 0, ~/~/ Частота трансляции радиометки
3661 + "period": 0,
2733 2733   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2734 2734   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2735 - "deleted": true
2736 2736   }
2737 2737  ]
2738 2738  
3667 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3668 +|parentId|ID клиента
3669 +|name|Название карты-метки
3670 +|number|Номер
3671 +|period|Период запросов в секундах (работает только для агрегатов)
3672 +|id|ID карты-метки
2739 2739  
2740 2740  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
2741 2741  
... ... @@ -2752,13 +2752,18 @@
2752 2752   {
2753 2753   "name": "string",
2754 2754   "number": 0,
2755 - "period": 0, ~/~/ Частота трансляции радиометки
3689 + "period": 0,
2756 2756   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2757 2757   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2758 - "deleted": true
2759 2759   }
2760 2760  ]
2761 2761  
3695 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3696 +|name|Название карты-метки
3697 +|number|Номер
3698 +|period|Период запросов в секундах (работает только для агрегатов)
3699 +|id|ID карты-метки
3700 +|parentId|ID клиента
2762 2762  
2763 2763  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
2764 2764  
... ... @@ -2774,7 +2774,6 @@
2774 2774   "number": 0,
2775 2775   "period": 0,
2776 2776   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2777 - "deleted": true
2778 2778  }
2779 2779  
2780 2780  Ответ:
... ... @@ -2785,9 +2785,14 @@
2785 2785   "period": 0,
2786 2786   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2787 2787   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2788 - "deleted": true
2789 2789  }
2790 2790  
3728 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3729 +|name|Название карты-метки
3730 +|number|Номер
3731 +|period|Период запросов в секундах (работает только для агрегатов)
3732 +|id|ID карты-метки
3733 +|parentId|ID клиента
2791 2791  
2792 2792  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
2793 2793  
... ... @@ -2804,7 +2804,6 @@
2804 2804   "period": 0,
2805 2805   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2806 2806   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2807 - "deleted": true
2808 2808  }
2809 2809  
2810 2810  Ответ:
... ... @@ -2815,9 +2815,14 @@
2815 2815   "period": 0,
2816 2816   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2817 2817   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
2818 - "deleted": true
2819 2819  }
2820 2820  
3762 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3763 +|name|Название карты-метки
3764 +|number|Номер
3765 +|period|Период запросов в секундах (работает только для агрегатов)
3766 +|id|ID карты-метки
3767 +|parentId|ID клиента
2821 2821  
2822 2822  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
2823 2823  
... ... @@ -2826,7 +2826,7 @@
2826 2826  **DELETE /api/v3/Rfids/{rfidGuid}**
2827 2827  )))
2828 2828  
2829 -Передаем параметр rfidGuid - идентификатор карты-метки
3776 +Передаем параметр **rfidGuid** - идентификатор карты-метки
2830 2830  
2831 2831  Ответ:
2832 2832  
... ... @@ -2833,6 +2833,2474 @@
2833 2833  Success
2834 2834  
2835 2835  
3783 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3784 +
3785 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3786 +
3787 +(% class="box infomessage" %)
3788 +(((
3789 +**GET /api/v3/Billing/client/balance/{clientId}**
3790 +)))
3791 +
3792 +Параметр запроса: **clientId **- идентификатор клиента.
3793 +
3794 +Ответ:
3795 +
3796 +{
3797 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3798 + "Balance": 0
3799 +}
3800 +
3801 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3802 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3803 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3804 +
3805 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3806 +
3807 +(% class="box infomessage" %)
3808 +(((
3809 +**GET /api/v3/Billing/client/constraint/{clientId}**
3810 +)))
3811 +
3812 +Параметр запроса: **clientId **- идентификатор клиента.
3813 +
3814 +Ответ:
3815 +
3816 +{
3817 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3818 + "CalculationType": 0,
3819 + "PermissibleBalance": 0,
3820 + "DefermentDays": 0,
3821 + "SendUiNotifications": true,
3822 + "SendEmailNotifications": true,
3823 + "IsPrivate": true,
3824 +}
3825 +
3826 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3827 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3828 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3829 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3830 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3831 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3832 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3833 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3834 +
3835 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3836 +
3837 +(% class="box infomessage" %)
3838 +(((
3839 +**GET /api/v3/Billing/client/plan/{clientId}**
3840 +)))
3841 +
3842 +Параметры запроса:
3843 +
3844 +**clientId **- идентификатор клиента.
3845 +
3846 +**planId **- идентификатор тарифного плана.
3847 +
3848 +Ответ:
3849 +
3850 +{
3851 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3852 + "Plan": { **~/~/ Описание тарифного плана**
3853 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3854 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3855 + "Name": "string",
3856 + "IsArchived": true,
3857 + "Constraint": {
3858 + "CalculationType": 0,
3859 + "PermissibleBalance": 0,
3860 + "DefermentDays": 0
3861 + },
3862 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3863 + {
3864 + "Feature": "string",
3865 + "IsFactual": true,
3866 + "Limit": 0,
3867 + "Price": 0,
3868 + "PeriodValue": 0,
3869 + "PeriodType": 0
3870 + }
3871 + ]
3872 + },
3873 + "DebitDate": "2023-10-18T12:46:24.213Z",
3874 + "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3875 + {
3876 + "Feature": "string",
3877 + "IsEnabled": true,
3878 + "IsPrivate": true,
3879 + "IsFactual": true,
3880 + "Limit": 0,
3881 + "Price": 0,
3882 + "DebitDate": "2023-10-18T12:46:24.213Z",
3883 + "PeriodValue": 0,
3884 + "PeriodType": 0
3885 + }
3886 + ]
3887 +}
3888 +
3889 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3890 +|ClientId|Идентификатор клиента
3891 +|Id|Идентификатор тарифного плана
3892 +|OwnerId|Идентификатор клиента-владельца
3893 +|Name|Наименование тарифного плана
3894 +|IsArchived|Признак, определяющий архивный тарифный план
3895 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3896 +|PermissibleBalance|Допустимый баланс
3897 +|DefermentDays|Отсрочка, количество дней
3898 +|Feature|Код услуги
3899 +|IsEnabled|Признак, определяющий активирована ли услуга
3900 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3901 +|IsFactual|Признак, определяющий расчёт по факту
3902 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3903 +|Price|Цена за единицу.
3904 +|DebitDate|Следующий момент времени списания с баланса за услугу.
3905 +|PeriodValue|Значение периода.
3906 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3907 +
3908 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3909 +
3910 +(% class="box infomessage" %)
3911 +(((
3912 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3913 +)))
3914 +
3915 +Параметр запроса: **clientId **- идентификатор клиента.
3916 +
3917 +Ответ:
3918 +
3919 +[
3920 + {
3921 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3922 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3923 + "Name": "string",
3924 + "IsArchived": true,
3925 + "Constraint": {
3926 + "CalculationType": 0,
3927 + "PermissibleBalance": 0,
3928 + "DefermentDays": 0
3929 + },
3930 + "Features": [
3931 + {
3932 + "Feature": "string",
3933 + "IsFactual": true,
3934 + "Limit": 0,
3935 + "Price": 0,
3936 + "PeriodValue": 0,
3937 + "PeriodType": 0
3938 + }
3939 + ]
3940 + }
3941 +]
3942 +
3943 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3944 +|ClientId|Идентификатор клиента
3945 +|Id|Идентификатор тарифного плана
3946 +|OwnerId|Идентификатор клиента-владельца
3947 +|Name|Наименование тарифного плана
3948 +|IsArchived|Признак, определяющий архивный тарифный план
3949 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3950 +|PermissibleBalance|Допустимый баланс
3951 +|DefermentDays|Отсрочка, количество дней
3952 +|Feature|Код услуги
3953 +|IsFactual|Признак, определяющий расчёт по факту
3954 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3955 +|Price|Цена за единицу.
3956 +|PeriodValue|Значение периода.
3957 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3958 +
3959 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3960 +
3961 +(% class="box infomessage" %)
3962 +(((
3963 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3964 +)))
3965 +
3966 +Параметр запроса: **clientId **- идентификатор клиента.
3967 +
3968 +Ответ:
3969 +
3970 +[
3971 + {
3972 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3973 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3974 + "Name": "string",
3975 + "IsArchived": true,
3976 + "Constraint": {
3977 + "CalculationType": 0,
3978 + "PermissibleBalance": 0,
3979 + "DefermentDays": 0
3980 + },
3981 + "Features": [
3982 + {
3983 + "Feature": "string",
3984 + "IsFactual": true,
3985 + "Limit": 0,
3986 + "Price": 0,
3987 + "PeriodValue": 0,
3988 + "PeriodType": 0
3989 + }
3990 + ]
3991 + }
3992 +]
3993 +
3994 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3995 +|ClientId|Идентификатор клиента
3996 +|Id|Идентификатор тарифного плана
3997 +|OwnerId|Идентификатор клиента-владельца
3998 +|Name|Наименование тарифного плана
3999 +|IsArchived|Признак, определяющий архивный тарифный план
4000 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4001 +|PermissibleBalance|Допустимый баланс
4002 +|DefermentDays|Отсрочка, количество дней
4003 +|Feature|Код услуги
4004 +|IsFactual|Признак, определяющий расчёт по факту
4005 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4006 +|Price|Цена за единицу.
4007 +|PeriodValue|Значение периода.
4008 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4009 +
4010 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4011 +
4012 +(% class="box warningmessage" %)
4013 +(((
4014 +**PUT /api/v3/Billing/client/balance**
4015 +)))
4016 +
4017 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4018 +
4019 +Тело запроса:
4020 +
4021 +{
4022 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4023 + "Balance": 0
4024 +}
4025 +
4026 +Ответ: Success
4027 +
4028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4029 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4030 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4031 +
4032 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4033 +
4034 +(% class="box warningmessage" %)
4035 +(((
4036 +**PUT /api/v3/billing/client/balance/deposit**
4037 +)))
4038 +
4039 +Создает операцию **Пополнение **с указанной суммой
4040 +
4041 +Тело запроса:
4042 +
4043 +{
4044 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4045 + "Balance": 0
4046 +}
4047 +
4048 +Ответ: Success
4049 +
4050 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4051 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4052 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4053 +
4054 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4055 +
4056 +Создает операцию **Списание **с указанной суммой
4057 +
4058 +(% class="box warningmessage" %)
4059 +(((
4060 +**PUT /api/v3/billing/client/balance/withdraw**
4061 +)))
4062 +
4063 +Тело запроса:
4064 +
4065 +{
4066 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4067 + "Balance": 0
4068 +}
4069 +
4070 +Ответ: Success
4071 +
4072 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4073 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4074 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4075 +
4076 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4077 +
4078 +(% class="box warningmessage" %)
4079 +(((
4080 +**PUT /api/v3/Billing/client/constraint**
4081 +)))
4082 +
4083 +Тело запроса:
4084 +
4085 +{
4086 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4087 + "CalculationType": 0,
4088 + "PermissibleBalance": 0,
4089 + "DefermentDays": 0,
4090 + "SendUiNotifications": true,
4091 + "SendEmailNotifications": true,
4092 + "IsPrivate": true,
4093 +}
4094 +
4095 +Ответ: Success
4096 +
4097 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4098 +|ClientId|Идентификатор клиента
4099 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4100 +|PermissibleBalance|Допустимый баланс
4101 +|DefermentDays|(((
4102 +Отсрочка, количество дней
4103 +)))
4104 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4105 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4106 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4107 +
4108 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4109 +
4110 +(% class="box warningmessage" %)
4111 +(((
4112 +**PUT /api/v3/Billing/client/plan**
4113 +)))
4114 +
4115 +Тело запроса:
4116 +
4117 +{
4118 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4119 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4120 + "Features": [
4121 + {
4122 + "Feature": "string",
4123 + "IsEnabled": true,
4124 + "IsFactual": true,
4125 + "Limit": 0,
4126 + "Price": 0,
4127 + "DebitDate": "2023-10-18T13:26:58.987Z",
4128 + "PeriodValue": 0,
4129 + "PeriodType": 0
4130 + }
4131 + ]
4132 +}
4133 +
4134 +Ответ: Success
4135 +
4136 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4137 +|ClientId|Идентификатор клиента
4138 +|PlanId|Идентификатор тарифного плана
4139 +|Feature|Код услуги
4140 +|IsEnabled|Признак, определяющий активирована ли услуга
4141 +|IsFactual|Признак, определяющий расчёт по факту
4142 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4143 +|Price|Цена за единицу.
4144 +|DebitDate|Следующий момент времени списания с баланса за услугу.
4145 +|PeriodValue|Значение периода.
4146 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4147 +
4148 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4149 +
4150 +(% class="box warningmessage" %)
4151 +(((
4152 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4153 +)))
4154 +
4155 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4156 +
4157 +(% class="box infomessage" %)
4158 +(((
4159 +**POST /api/v3/vehicles/import/{agentId}**
4160 +)))
4161 +
4162 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4163 +
4164 +В пути указывается **agentId** - id клиента.
4165 +
4166 +**Заголовок**
4167 +
4168 +**X-Auth: [токен авторизации]**
4169 +
4170 +**Параметры**
4171 +
4172 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4173 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4174 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4175 +
4176 +В теле использовать тип **form-data,** тип значения** file**
4177 +
4178 +**Ключи**
4179 +
4180 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4181 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
4182 +|csv|В значении передаем файл датчиков, формат **csv**
4183 +
4184 +Ответ:
4185 +
4186 +{
4187 + "vehicleId": 0,
4188 + "name": "string",
4189 + "errors": ["string"]
4190 +}
4191 +
4192 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4193 +|vehicleId|ID созданного объекта
4194 +|name|Имя созданного объекта
4195 +|errors|Ошибки и их описание
4196 +
4197 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4198 +
4199 +(% class="box infomessage" %)
4200 +(((
4201 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
4202 +)))
4203 +
4204 +(% class="wikigeneratedid" %)
4205 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4206 +
4207 +(% class="wikigeneratedid" %)
4208 +В пути указывается **vehicleId **- id объекта.
4209 +
4210 +**Заголовок**
4211 +
4212 +**X-Auth: [токен авторизации]**
4213 +
4214 +В теле использовать тип **form-data.**
4215 +
4216 +Ключи:
4217 +
4218 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4219 +|**history**|В значении передавать файл с историей
4220 +
4221 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4222 +
4223 +Ответ:
4224 +
4225 +{
4226 + "results": [
4227 + {
4228 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4229 + "vehicleId": 0,
4230 + "errors": [
4231 + "string"
4232 + ],
4233 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
4234 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
4235 + "producedCount": 0,
4236 + "msgCount": 0
4237 + }
4238 + ]
4239 +}
4240 +
4241 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4242 +|results|Результаты импорта в разрезе ТС
4243 +|vehicleGuid|Guid ТС
4244 +|vehicleId|ID ТС
4245 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
4246 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
4247 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
4248 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
4249 +|msgCount|Кол-во обработанных сообщений всего
4250 +
4251 +== ==
4252 +
4253 +== **Импортировать историю ТС (Асинхронный запрос)** ==
4254 +
4255 +(% class="box successmessage" %)
4256 +(((
4257 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4258 +)))
4259 +
4260 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4261 +
4262 +Метод запроса: **POST**
4263 +
4264 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4265 +
4266 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4267 +
4268 +
4269 +Ответ:
4270 +
4271 +{
4272 +
4273 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4274 +
4275 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4276 +
4277 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4278 +
4279 + "Message": "string", ~/~/ Информация о выполнении запроса
4280 +
4281 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4282 +
4283 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4284 +
4285 + "Data": "string" ~/~/ Данные
4286 +
4287 +}
4288 +
4289 +
4290 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4291 +
4292 +(% class="box infomessage" %)
4293 +(((
4294 +**GET /api/v3/vehicles/import/history/status**
4295 +)))
4296 +
4297 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4298 +
4299 +Ответ:
4300 +
4301 +{
4302 + "activity": true,
4303 + "progress": 0,
4304 + "message": "string"
4305 +}
4306 +
4307 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4308 +**Параметр**
4309 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4310 +**Описание**
4311 +)))
4312 +|(((
4313 +activity
4314 +)))|(((
4315 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4316 +)))
4317 +|(((
4318 +progress
4319 +)))|(((
4320 +Guid ТС
4321 +)))
4322 +
4323 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4324 +
4325 +(% class="box infomessage" %)
4326 +(((
4327 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4328 +)))
4329 +
4330 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4331 +
4332 +Метод запроса: **GET**
4333 +
4334 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4335 +
4336 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4337 +
4338 +
4339 +Ответ:
4340 +
4341 +{
4342 +
4343 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4344 +
4345 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4346 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4347 +
4348 + "Message": "string", ~/~/ Информация о выполнении запроса
4349 +
4350 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4351 +
4352 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4353 +
4354 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4355 +
4356 + "Data": "string" ~/~/ Данные
4357 +
4358 +}
4359 +
4360 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4361 +
4362 +(% class="box infomessage" %)
4363 +(((
4364 +**POST /api/v3/vehicles/export**
4365 +)))
4366 +
4367 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4368 +
4369 +Тело запроса:
4370 +
4371 +[
4372 + id
4373 +]
4374 +
4375 +Ответ: Success 200, получаете файлы с настройками.
4376 +
4377 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4378 +
4379 +(% class="box infomessage" %)
4380 +(((
4381 +**POST /api/v3/vehicles/export/history**
4382 +)))
4383 +
4384 +Метод возвращает список сообщений терминала объекта за выбранный период.
4385 +
4386 +Тело запроса:
4387 +
4388 +{
4389 + "vehicleId": 0,
4390 + "asArchive": true,
4391 + "from": "2023-09-27T12:17:45.973Z",
4392 + "to": "2023-09-27T12:17:45.973Z"
4393 +}
4394 +
4395 +Ответ:
4396 +
4397 +Получаете файл. Сообщение: Code 200/Success
4398 +
4399 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4400 +|vehicleId|ID объекта
4401 +|asArchive|true - Архивировать файл, False - не архивировать
4402 +|from|Дата и время начала запроса
4403 +|to|Дата и время окончания запроса
4404 +
4405 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4406 +
4407 +(% class="box infomessage" %)
4408 +(((
4409 +**GET /api/v3/vehicles/export/history/status**
4410 +)))
4411 +
4412 +Метод возвращает список сообщений терминала объекта за выбранный период.
4413 +
4414 +Ответ:
4415 +
4416 +{
4417 + "activity": true,
4418 + "progress": 0,
4419 + "message": "string"
4420 +}
4421 +
4422 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4423 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4424 +|progress|Прогресс экспорта, от 0 до 100%
4425 +|message|Текст описывающий статус
4426 +
4427 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4428 +
4429 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4430 +
4431 +(% class="box infomessage" %)
4432 +(((
4433 +**POST /api/v3/EcoDriving/rating**
4434 +)))
4435 +
4436 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4437 +
4438 +Тело запроса:
4439 +
4440 +{
4441 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4442 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4443 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4444 +}
4445 +
4446 +Ответ:
4447 +
4448 +{
4449 + "items": [  ~/~/ Список в разрезе ТС
4450 + {
4451 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4452 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4453 + "vehicleId": 0, ~/~/ ID ТС
4454 + "vehicleName": "string", ~/~/ Название ТС
4455 + "vehicleModel": "string", ~/~/ Модель ТС
4456 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4457 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4458 + "totalViolations": 0, ~/~/ Нарушений всего
4459 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4460 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4461 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4462 + "brakingViolations": 0, ~/~/ Нарушений торможения
4463 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4464 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4465 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4466 + },
4467 +
4468 +(((
4469 +
4470 +)))
4471 +
4472 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4473 + "mileage": 0, ~/~/ Пробег, м
4474 + "tripsCount": 0, ~/~/ Кол-во рейсов
4475 + "trips": [  ~/~/ Информация по рейсу
4476 + {
4477 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4478 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4479 + "violationsCount": 0, ~/~/ Всего нарушений
4480 + "violationsByType": { ~/~/ Информация о нарушениях по типу
4481 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4482 + "accelerationViolations": 0, ~/~/ Нарушений ускорения
4483 + "brakingViolations": 0, ~/~/ Нарушений торможения
4484 + "turningViolations": 0, ~/~/ Нарушений опасного поворота
4485 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4486 + "sensorViolations": 0 ~/~/ Нарушений по датчику
4487 + },
4488 +
4489 + "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4490 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4491 + "moveTime": 0, ~/~/ Продолжительность движения, сек
4492 + "mileage": 0, ~/~/ Пробег, м
4493 + "motohours": 0, ~/~/ Моточасы, секунды
4494 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4495 + "startAddress": "string", ~/~/ Адрес начала рейса
4496 + "endAddress": "string", ~/~/ Адрес конца рейса
4497 + "drivers": [  ~/~/ Список водителей
4498 + {
4499 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4500 + "driverName": "string", ~/~/ФИО водителя
4501 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4502 + }
4503 + ]
4504 + }
4505 + ]
4506 + }
4507 + ]
4508 +}
4509 +
4510 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4511 +
4512 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4513 +
4514 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4515 +
4516 +(% class="box infomessage" %)
4517 +(((
4518 +**POST /api/v3/fuelcards/transactions**
4519 +)))
4520 +
4521 +Метод запроса: POST
4522 +
4523 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4524 +\\В заголовках запроса: X-Auth: Токен авторизации
4525 +
4526 +Параметры в теле запроса (JSON):
4527 +
4528 +{
4529 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4530 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4531 + "ids": [ 
4532 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4533 + ],
4534 + "timezone": 0 ~/~/ Часовой пояс
4535 +}
4536 +
4537 +
4538 +Ответ:
4539 + {
4540 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4541 + "driver": "string", ~/~/ Водители, привязанные к ТК
4542 + "object": "string", ~/~/ Наименование ТС
4543 + "amount": 0, ~/~/ Количество топлива
4544 + "amountDut": 0, ~/~/ Количество по ДУТ
4545 + "amountDiff": 0, ~/~/ Разница, л
4546 + "amountDiffPerc": 0, ~/~/ Разница, %
4547 + "summa": 0, ~/~/ Стоимость, руб
4548 + "serviceName": "string", ~/~/ Тип топлива
4549 + "price": 0, ~/~/ Цена за литр, руб
4550 + "cardName": "string", ~/~/ Наименование ТК
4551 + "cardNum": "string", ~/~/ Номер ТК
4552 + "operator": "string", ~/~/ Оператор ТК
4553 + "address": "string" ~/~/ Адрес АЗС
4554 + }
4555 +
4556 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4557 +
4558 +(% class="box infomessage" %)
4559 +(((
4560 +**GET /api/v3/fuelcards**
4561 +)))
4562 +
4563 +Метод запроса: GET
4564 +
4565 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4566 +
4567 +Ответ:
4568 +
4569 +[
4570 + {
4571 + "Name": "string", ~/~/ Определяет наименование карты.
4572 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4573 + "Number": "string", ~/~/ Определяет № карты.
4574 + "Enabled": true, ~/~/ Определяет признак активности карты.
4575 + "Description": "string", ~/~/ Определяет описание карты.
4576 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4577 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4578 + "deleted": true ~/~/ Признак удаления
4579 + }
4580 +]
4581 +
4582 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4583 +
4584 +
4585 +== **Получение полных данных о ретрансляторе** ==
4586 +
4587 +(% class="box infomessage" %)
4588 +(((
4589 +**GET ** **/api/v3/retranslations/{id}**
4590 +)))
4591 +
4592 +id - Идентификатор ретранслятора
4593 +
4594 +
4595 +Пример ответа:
4596 +
4597 +{  
4598 +"description": "", ~/~/ Поле описания ретранслятора
4599 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4600 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4601 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4602 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4603 +"objects": [ ~/~/ Объекты для ретрансляции
4604 +{      
4605 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4606 +"name": "", ~/~/ Наименование объекта ретрансляции
4607 +"imei": "", ~/~/ IMEI объекта  ретрансляции
4608 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4609 +}
4610 + ],  
4611 +"id": "", ~/~/ Идентификатор ретранслятора 
4612 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4613 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4614 +}
4615 +
4616 +
4617 +== **Удаление данных ретранслятора** ==
4618 +
4619 +(% class="box infomessage" %)
4620 +(((
4621 +**DELETE** **/api/v3/retranslations/{id}**
4622 +)))
4623 +
4624 +id - Идентификатор ретранслятора
4625 +
4626 +
4627 +== **Создание ретранслятора** ==
4628 +
4629 +(% class="box infomessage" %)
4630 +(((
4631 +**POST ** **/api/v3/retranslations/{id}**
4632 +)))
4633 +
4634 +Запрос:
4635 +
4636 +{  
4637 +"description": "", ~/~/ Поле описания ретранслятора
4638 +"subscriberId": "", ~/~/ Идентификатор подписчика
4639 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4640 +"address": "", ~/~/ Адрес и порт принимающего сервера
4641 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4642 +"objects": [ ~/~/Объекты для ретрансляции
4643 +{      
4644 +"id": "", ~/~/ Идентификатор ретранслятора 
4645 +"imei": "", ~/~/ IMEI объекта ретрансляции
4646 +"isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4647 +}
4648 + ]
4649 +}
4650 +
4651 +
4652 +Ответ:
4653 +
4654 +{  
4655 +"description": "", ~/~/ Поле описания ретранслятора
4656 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4657 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4658 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4659 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4660 +"objects": [ ~/~/ Объекты для ретрансляции
4661 +{      
4662 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4663 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4664 +"imei": "", ~/~/ IMEI объекта ретрансляции
4665 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4666 +}
4667 + ],
4668 +"id": "", ~/~/ Идентификатор ретранслятора   
4669 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4670 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4671 +}
4672 +
4673 +
4674 +== **Редактирование ретранслятора** ==
4675 +
4676 +(% class="box infomessage" %)
4677 +(((
4678 +**PUT** **/api/v3/retranslations**
4679 +)))
4680 +
4681 +Пример запроса:
4682 +
4683 +{  
4684 +"id": "", ~/~/ Идентификатор ретранслятора   
4685 +"description": "string", ~/~/ Поле описания ретранслятора
4686 +"subscriberId": "", ~/~/ Идентификатор подписчика
4687 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4688 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4689 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4690 +"objects": ~/~/ Объекты для ретрансляции
4691 +[    
4692 +{      
4693 +"id": "",  ~/~/ Идентификатор объекта ретрансляции 
4694 +"imei": "", ~/~/ IMEI объекта ретрансляции
4695 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4696 +}
4697 + ]
4698 +}
4699 +
4700 +
4701 +Пример ответа:
4702 +
4703 +{  
4704 +"description": "", ~/~/ Поле описания ретранслятора
4705 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4706 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4707 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4708 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4709 +"objects": [ ~/~/ Объекты для ретрансляции
4710 +{      
4711 +"id": "", ~/~/ Идентификатор объекта ретрансляции     
4712 +"name": "string", ~/~/ Наименование объекта ретрансляции    
4713 +"imei": "", ~/~/ IMEI объекта ретрансляции
4714 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4715 +}
4716 + ],
4717 +"id": "", ~/~/ Идентификатор ретранслятора   
4718 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4719 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4720 +}
4721 +
4722 +
4723 +== **Получение списка ретранслятора клиента** ==
4724 +
4725 +(% class="box infomessage" %)
4726 +(((
4727 +**POST /api/v3/retranslations/find**
4728 +)))
4729 +
4730 +Пример запроса:
4731 +
4732 +{  
4733 +"id": "", ~/~/ Идентификатор ретранслятора   
4734 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4735 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4736 +}
4737 +
4738 +Ответ:
4739 +
4740 +[ 
4741 +{    
4742 +"description": "", ~/~/ Поле описания ретранслятора
4743 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4744 +"protocolType": 0, ~/~/ Тип протокола ретрансляции
4745 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4746 +"address": "string", ~/~/ Адрес и порт принимающего сервера
4747 +"id": "", ~/~/ Идентификатор ретранслятора   
4748 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4749 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4750 +}
4751 +]
4752 +
4753 +
4754 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4755 +
4756 +== **API для отчета по выгрузке комбайнов** ==
4757 +
4758 +(% class="box infomessage" %)
4759 +(((
4760 +**POST /api/v3/Reports/harvesterUnloading**
4761 +)))
4762 +
4763 +Пример запроса:
4764 +
4765 +{
4766 + "byTime": 0, ~/~/ Объединение событий по времени
4767 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4768 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4769 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4770 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4771 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4772 + 0
4773 + ],
4774 + "from": "", ~/~/ Дата и время начало запроса
4775 + "to": "", ~/~/ Дата и время окончания запроса
4776 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4777 +}
4778 +
4779 +Пример ответа:
4780 +
4781 +[ 
4782 + {
4783 + "harvesterName": "", ~/~/Комбайн, номер
4784 + "harvesterId": 0, ~/~/Комбайн, id
4785 +"harvesterModel": "", ~/~/ Модель комбайна
4786 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4787 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4788 + "events": [ ~/~/Список событий в разрезе комбайна
4789 + {
4790 + "driverId": "", ~/~/Идентификатор водителя
4791 + "driverName": "", ~/~/Водитель комбайна, ФИО
4792 + "RFID": "", ~/~/ идентификатор карты-метки
4793 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4794 + "vehicleId": 0, ~/~/идентификатор объекта
4795 + "vehicleName": "string", ~/~/ Имя объекта
4796 + "modelName": "string", ~/~/ Имя модели объекта
4797 + "nearestVehicles": [ ~/~/Объекты рядом
4798 + {
4799 + "vehicleId": 0, ~/~/идентификатор объекта
4800 + "vehicleName": "string" ~/~/ Имя объекта
4801 + }
4802 + ],
4803 + "fields": [ ~/~/Поля, где происходила выгрузка
4804 + {
4805 + "id": 0, ~/~/ идентификатор пользователя 
4806 + "name": "string" ~/~/ имя пользователя 
4807 + }
4808 + ],
4809 + "event": "string", ~/~/Событие
4810 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4811 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4812 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4813 + "cultureName": "string", ~/~/ название культуры
4814 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4815 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4816 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4817 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4818 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4819 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4820 + "issued": 0, ~/~/Выдано, бункеров
4821 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4822 + "latitude": 0, ~/~/Широта
4823 + "longitude": 0, ~/~/ Долгота
4824 + "litresAway": 0, ~/~/Отдано, л
4825 + "m3Away": 0 ~/~/Отдано, м3
4826 + }
4827 + ]
4828 + }
4829 +]
4830 +
4831 +
4832 +== **Отчет трек-датчики** ==
4833 +
4834 +(% class="box infomessage" %)
4835 +(((
4836 +**POST /api/v3/Reports/sensorsWorks**
4837 +)))
4838 +
4839 +**Пример запроса:**
4840 +
4841 +{
4842 + "vehicleIds": [ ~/~/ Список ID объектов
4843 + 0
4844 + ],
4845 + "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4846 + "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4847 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4848 +}
4849 +
4850 +**Пример ответа:**
4851 +
4852 +(((
4853 +{
4854 + "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4855 + {
4856 + "vehicleId": 0, ~/~/ Идентификатор ТС
4857 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4858 + {
4859 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4860 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4861 + "duration": 0, ~/~/  Продолжительность интервала в секундах.
4862 + "name": "string", ~/~/ Наименование оборудования.
4863 + "mileage": 0, ~/~/ Пробег за время работы оборудования.
4864 + "totalMileage": 0, ~/~/ Общий пробег.
4865 + "avgSpeed": 0 ~/~/ Средняя скорость.
4866 + }
4867 + ]
4868 + }
4869 + ]
4870 +}
4871 +
4872 +
4873 +== **Превышение скорости** ==
4874 +
4875 +(% class="box infomessage" %)
4876 +(((
4877 +**POST /api/v3/Reports/overSpeedDuration**
4878 +)))
4879 +
4880 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4881 +
4882 +Пример запроса:
4883 +
4884 +(((
4885 +{
4886 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4887 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4888 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4889 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4890 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4891 +}
4892 +)))
4893 +
4894 +(((
4895 +
4896 +)))
4897 +
4898 +(((
4899 +Пример ответа:
4900 +)))
4901 +
4902 +(((
4903 +(((
4904 +[
4905 + {
4906 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4907 + "duration": 0, ~/~/ Продолжительность события в секундах 
4908 + "maxSpeed": 0, ~/~/ Максимальная скорость 
4909 + "speedLimit": 0 ~/~/ Ограничение скорости 
4910 + }
4911 +]
4912 +)))
4913 +)))
4914 +)))
4915 +
4916 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4917 +
4918 +
4919 +== **Запрос списка полей** ==
4920 +
4921 +(% class="box successmessage" %)
4922 +(((
4923 +**POST /api/v3/agroLands/find**
4924 +)))
4925 +
4926 +Пример запроса:
4927 +
4928 +(((
4929 +(((
4930 +(((
4931 +{
4932 + "year": 0, ~/~/ Фильтр по году
4933 + "name": "string", ~/~/ Фильтр по названию
4934 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4935 +}
4936 +)))
4937 +)))
4938 +
4939 +
4940 +)))
4941 +
4942 +Пример ответа:
4943 +
4944 +(((
4945 +[
4946 + {
4947 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4948 + "year": 0, ~/~/ Год поля
4949 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4950 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4951 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4952 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4953 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4954 + "counts": { ~/~/ Счётчики с/х поля 
4955 + "fieldOperations": 0, ~/~/ Количество операций на поле
4956 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4957 + "facts": 0 ~/~/ Счётчик факта
4958 + },
4959 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4960 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4961 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4962 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4963 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4964 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4965 + "planComment": "string", ~/~/ Комментарий к полю
4966 + "productivity": 0, ~/~/ Урожайность.
4967 + "id": 0, ~/~/ Идентификатор объекта геозоны
4968 + "name": "string", ~/~/ Название объекта геозоны
4969 + "type": 0, ~/~/ Тип объекта геозоны
4970 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4971 + "fname": "string", ~/~/ Имя файла
4972 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4973 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4974 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4975 + "description": "string", ~/~/ Описание объекта геозоны
4976 + "area": 0, ~/~/ Площадь, м2
4977 + "perimetr": 0, ~/~/ Периметр, м
4978 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4979 + }
4980 +]
4981 +
4982 +
4983 +== **Создание нового поля ** ==
4984 +
4985 +(% class="box successmessage" %)
4986 +(((
4987 +**POST /api/v3/agroLands**
4988 +)))
4989 +
4990 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
4991 +X-agent  - ID клиента
4992 +
4993 +Пример запроса:
4994 +
4995 +(((
4996 +{
4997 + "extId": "string", 
4998 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
4999 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5000 + "display": "string", ~/~/ Настройки отображения
5001 + "year": 0, ~/~/ Год поля
5002 + "name": "string", ~/~/ Наименование
5003 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5004 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5005 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5006 + "planComment": "string", ~/~/ Комментарий к полю
5007 + "cropRotations": [ ~/~/ Данные по севообороту
5008 + {
5009 + "landId": 0, ~/~/ ID поля
5010 + "landName": "string", ~/~/ Название поля
5011 + "year": 0, ~/~/ Год урожая
5012 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5013 + "cultureName": "string", ~/~/ Название культуры
5014 + "productivity": 0, ~/~/ Урожайность
5015 + "area": 0, ~/~/ Площадь поля, Га
5016 + "total": 0, ~/~/ Валовый сбор
5017 + "productivityFact": 0, ~/~/ Фактическая урожайность
5018 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5019 + "totalFact": 0, ~/~/ Фактический валовый сбор
5020 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5021 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5022 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5023 + "isyearplan": true, ~/~/ Годовой план 
5024 + "comment": "string" ~/~/ Комментарий
5025 + }
5026 + ]
5027 +}
5028 +)))
5029 +
5030 +(((
5031 +
5032 +)))
5033 +
5034 +Пример ответа:
5035 +
5036 +(((
5037 +(((
5038 +{
5039 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5040 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5041 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5042 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5043 + "cropRotations": [ ~/~/ Данные по севообороту
5044 + {
5045 + "landId": 0, ~/~/ ID поля
5046 + "landName": "string", ~/~/ Название поля
5047 + "year": 0, ~/~/ Год урожая 
5048 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5049 + "cultureName": "string", ~/~/ Название культуры
5050 + "productivity": 0, ~/~/ Урожайность
5051 + "area": 0, ~/~/ Площадь поля, Га.
5052 + "total": 0, ~/~/ Валовый сбор
5053 + "productivityFact": 0, ~/~/ Фактическая урожайность
5054 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5055 + "totalFact": 0, ~/~/ Фактический валовый сбор
5056 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5057 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5058 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5059 + "isyearplan": true, ~/~/ годовой план 
5060 + "comment": "string" ~/~/ Комментарий
5061 + }
5062 + ],
5063 + "cropVegetation": [ ~/~/ История вегетации поля
5064 + {
5065 + "values": [  ~/~/ Данные вегетации и состояния посева
5066 + {
5067 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5068 + "ndvi": 0 ~/~/ Индекс вегетации
5069 + }
5070 + ],
5071 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5072 + {
5073 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5074 + "type": "string", ~/~/ Тип
5075 + "pictureid": "string" ~/~/ Идентификатор ресурса
5076 + }
5077 + ],
5078 + "states": [ ~/~/ Ключевые даты развития поля
5079 + {
5080 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5081 + "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5082 + }
5083 + ]
5084 + }
5085 + ],
5086 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5087 + "counts": {
5088 + "fieldOperations": 0, ~/~/ Количество операций на поле
5089 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5090 + "facts": 0 ~/~/ Счётчик факта
5091 + },
5092 + "planComment": "string", ~/~/ Комментарий к полю
5093 +)))
5094 +
5095 +(((
5096 + "productivity": 0, ~/~/ Урожайность.
5097 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5098 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5099 + "year": 0, ~/~/ Год поля
5100 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5101 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5102 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5103 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5104 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5105 + "id": 0, ~/~/ Идентификатор объекта геозоны
5106 + "name": "string", ~/~/ Название объекта геозоны
5107 + "type": 0, ~/~/ Тип объекта геозоны
5108 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5109 + "fname": "string", ~/~/ Имя файла
5110 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5111 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5112 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5113 + "description": "string", ~/~/ Описание объекта геозоны
5114 + "area": 0, ~/~/ Площадь, м2
5115 + "perimetr": 0, ~/~/ Периметр, м
5116 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5117 +}
5118 +
5119 +
5120 +)))
5121 +)))
5122 +)))
5123 +
5124 +== **Получение поля по id** ==
5125 +
5126 +(% class="box infomessage" %)
5127 +(((
5128 +**GET /api/v3/agroLands/{id}**
5129 +)))
5130 +
5131 +Пример запроса:
5132 +id  ~/~/ Идентификатор поля
5133 +
5134 +Пример ответа:
5135 +
5136 +(((
5137 +{
5138 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5139 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5140 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5141 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5142 + "cropRotations": [ ~/~/ Данные по севообороту
5143 + {
5144 + "landId": 0, ~/~/ ID поля
5145 + "landName": "string", ~/~/ Название поля
5146 + "year": 0, ~/~/ Год урожая
5147 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5148 + "cultureName": "string", ~/~/ Название культуры
5149 + "productivity": 0, ~/~/ Урожайность
5150 + "area": 0, ~/~/ Площадь поля, Га
5151 + "total": 0, ~/~/ Валовый сбор
5152 + "productivityFact": 0, ~/~/ Фактическая урожайность
5153 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5154 + "totalFact": 0, ~/~/ Фактический валовый сбор
5155 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5156 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5157 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5158 + "isyearplan": true, ~/~/ План года 
5159 + "comment": "string" ~/~/ Комментарий
5160 + }
5161 + ],
5162 + "cropVegetation": [ ~/~/ История вегетации поля
5163 + {
5164 + "values": [ ~/~/ Данные вегетации и состояния посева
5165 + {
5166 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5167 + "ndvi": 0 ~/~/ Индекс вегетации
5168 + }
5169 + ],
5170 + "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5171 + {
5172 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5173 + "type": "string", ~/~/ Тип 
5174 + "pictureid": "string" ~/~/ Идентификатор ресурса
5175 + }
5176 + ],
5177 + "states": [ ~/~/ Ключевые даты развития поля
5178 + {
5179 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5180 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5181 + }
5182 + ]
5183 + }
5184 + ],
5185 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5186 + "counts": {
5187 + "fieldOperations": 0, ~/~/ Количество операций на поле
5188 + "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5189 + "facts": 0 ~/~/ Счётчик факта
5190 + },
5191 + "planComment": "string", ~/~/ Комментарий к полю
5192 + "productivity": 0, ~/~/ Урожайность.
5193 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5194 +)))
5195 +
5196 +(((
5197 +(((
5198 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5199 + "year": 0, ~/~/ Год поля
5200 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5201 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5202 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5203 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5204 + "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5205 + "id": 0, ~/~/ Идентификатор объекта геозоны
5206 + "name": "string", ~/~/ Название объекта геозоны
5207 + "type": 0, ~/~/ Тип объекта геозоны 
5208 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5209 + "fname": "string", ~/~/ Имя файла
5210 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5211 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5212 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5213 + "description": "string", ~/~/ Описание объекта геозоны
5214 + "area": 0, ~/~/ Площадь, м2
5215 + "perimetr": 0, ~/~/ Периметр, м
5216 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5217 +}
5218 +)))
5219 +
5220 +
5221 +== **Удаление существующего поля** ==
5222 +
5223 +(% class="box errormessage" %)
5224 +(((
5225 +**DELETE /api/v3/agroLands/{id}**
5226 +)))
5227 +
5228 +Пример запроса:
5229 +id  ~/~/ Идентификатор поля
5230 +
5231 +Пример ответа:
5232 +
5233 +(((
5234 +200 ~/~/ Успех
5235 +)))
5236 +
5237 +(((
5238 +
5239 +)))
5240 +
5241 +(((
5242 +(((
5243 +(((
5244 +
5245 +)))
5246 +
5247 +(((
5248 +== **Изменение поля** ==
5249 +
5250 +(% class="box infomessage" %)
5251 +(((
5252 +**PUT /api/v3/agroLands**
5253 +)))
5254 +
5255 +Пример запроса:
5256 +
5257 +(((
5258 +(((
5259 +{
5260 + "id": 0, ~/~/ Идентификатор поля
5261 + "extId": "string", ~/~/ ExtId
5262 + "shape": "string", ~/~/ Форма поля
5263 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5264 + "display": "string", ~/~/ Настройки отображения
5265 + "year": 0, ~/~/ Год поля
5266 + "name": "string", ~/~/ Наименование
5267 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5268 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5269 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5270 + "planComment": "string", ~/~/Комментарий к полю
5271 + "cropRotations": [  ~/~/ Данные по севообороту
5272 + {
5273 + "landId": 0, ~/~/ ID поля
5274 + "landName": "string", ~/~/ Название поля
5275 + "year": 0, ~/~/ Год урожая
5276 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5277 + "cultureName": "string", ~/~/ Название культуры
5278 + "productivity": 0, ~/~/ Урожайность
5279 + "area": 0, ~/~/ Площадь поля, Га.
5280 + "total": 0, ~/~/ Валовый сбор
5281 + "productivityFact": 0, ~/~/ Фактическая урожайность
5282 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5283 + "totalFact": 0, ~/~/ Фактический валовый сбор
5284 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5285 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5286 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5287 + "isyearplan": true, 
5288 + "comment": "string" ~/~/ Комментарий
5289 + }
5290 + ],
5291 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5292 +}
5293 +)))
5294 +)))
5295 +
5296 +(((
5297 +
5298 +)))
5299 +
5300 +Пример ответа:
5301 +
5302 +(((
5303 +(((
5304 +(((
5305 +{
5306 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5307 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5308 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5309 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5310 + "cropRotations": [ ~/~/ Данные по севообороту
5311 + {
5312 + "landId": 0, ~/~/ ID поля
5313 + "landName": "string", ~/~/ Название поля
5314 + "year": 0, ~/~/  Год урожая
5315 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5316 + "cultureName": "string", ~/~/ Название культуры
5317 + "productivity": 0, ~/~/ Урожайность
5318 + "area": 0, ~/~/ Площадь поля, Га
5319 + "total": 0, ~/~/ Валовый сбор
5320 + "productivityFact": 0, ~/~/ Фактическая урожайность
5321 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5322 + "totalFact": 0, ~/~/ Фактический валовый сбор
5323 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5324 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5325 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5326 + "isyearplan": true, ~/~/ 
5327 + "comment": "string" ~/~/ Комментарий
5328 + }
5329 + ],
5330 + "cropVegetation": [ ~/~/ История вегетации поля
5331 + {
5332 + "values": [ ~/~/ Данные вегетации и состояния посева
5333 + {
5334 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5335 + "ndvi": 0 ~/~/ Индекс вегетации
5336 + }
5337 + ],
5338 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5339 + {
5340 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5341 + "type": "string", ~/~/ Тип
5342 + "pictureid": "string" ~/~/ Идентификатор ресурса
5343 + }
5344 + ],
5345 + "states": [ ~/~/ Ключевые даты развития поля 
5346 + {
5347 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5348 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5349 + }
5350 + ]
5351 + }
5352 + ],
5353 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5354 + "counts": { 
5355 + "fieldOperations": 0, ~/~/ Количество операций на поле
5356 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5357 + "facts": 0 ~/~/ Счётчик факта
5358 + },
5359 + "planComment": "string", ~/~/ Комментарий к полю
5360 + "productivity": 0, ~/~/ Урожайность.
5361 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5362 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5363 + "year": 0, ~/~/ Год поля
5364 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5365 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5366 + "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5367 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5368 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5369 + "id": 0, ~/~/ Идентификатор объекта геозоны
5370 + "name": "string", ~/~/ Название объекта геозоны
5371 + "type": 0, ~/~/ Тип объекта геозоны
5372 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5373 + "fname": "string", ~/~/ Имя файла
5374 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5375 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5376 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5377 + "description": "string", ~/~/ Описание объекта геозоны
5378 + "area": 0, ~/~/ Площадь, м2
5379 + "perimetr": 0, ~/~/ Периметр, м
5380 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5381 +}
5382 +)))
5383 +)))
5384 +)))
5385 +)))
5386 +)))
5387 +
5388 +
5389 +== **Редактирование года урожая ** ==
5390 +
5391 +(% class="box successmessage" %)
5392 +(((
5393 +**POST /api/v3/agroLands/updateOpenCloseYear**
5394 +)))
5395 +
5396 +Пример запроса:
5397 +
5398 +(((
5399 +(((
5400 +{
5401 + "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5402 + 0
5403 + ],
5404 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5405 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5406 +}
5407 +)))
5408 +
5409 +
5410 +)))
5411 +
5412 +Пример ответа:
5413 +
5414 +(((
5415 +(((
5416 +{
5417 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5418 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5419 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5420 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5421 + "cropRotations": [ ~/~/ Данные по севообороту
5422 + {
5423 + "landId": 0, ~/~/ ID поля
5424 + "landName": "string", ~/~/ Название поля
5425 + "year": 0, ~/~/ Год урожая
5426 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5427 + "cultureName": "string", ~/~/ Название культуры
5428 + "productivity": 0, ~/~/ Урожайность
5429 + "area": 0, ~/~/ Площадь поля, Га.
5430 + "total": 0, ~/~/ Валовый сбор
5431 + "productivityFact": 0, ~/~/ Фактическая урожайность
5432 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5433 + "totalFact": 0, ~/~/ Фактический валовый сбор
5434 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5435 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5436 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5437 + "isyearplan": true, ~/~/ 
5438 + "comment": "string" ~/~/ Комментарий
5439 + }
5440 + ],
5441 + "cropVegetation": [ ~/~/ История вегетации поля
5442 + {
5443 + "values": [ ~/~/ Данные вегетации и состояния посева
5444 + {
5445 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5446 + "ndvi": 0 ~/~/ Индекс вегетации
5447 + }
5448 + ],
5449 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5450 + {
5451 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5452 + "type": "string", ~/~/ Тип
5453 + "pictureid": "string" ~/~/ Идентификатор ресурса
5454 + }
5455 + ],
5456 + "states": [ ~/~/ Ключевые даты развития поля
5457 + {
5458 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5459 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5460 + }
5461 + ]
5462 + }
5463 + ],
5464 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5465 + "counts": { 
5466 + "fieldOperations": 0, ~/~/ Количество операций на поле
5467 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5468 + "facts": 0 ~/~/ Счётчик факта
5469 + },
5470 + "planComment": "string", ~/~/ Комментарий к полю
5471 + "productivity": 0, ~/~/ Урожайность.
5472 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5473 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5474 + "year": 0, ~/~/ Год поля
5475 + "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5476 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5477 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5478 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5479 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5480 + "id": 0, ~/~/ Идентификатор объекта геозоны
5481 + "name": "string", ~/~/ Название объекта геозоны
5482 + "type": 0, ~/~/ Тип объекта геозоны
5483 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5484 + "fname": "string", ~/~/ Имя файла
5485 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5486 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5487 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5488 + "description": "string", ~/~/ Описание объекта геозоны
5489 + "area": 0, ~/~/ Площадь, м2
5490 + "perimetr": 0, ~/~/ ериметр, м
5491 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5492 +}
5493 +)))
5494 +
5495 +
5496 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5497 +)))
5498 +)))
5499 +)))
5500 +
5501 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5502 +
5503 +
5504 +(% class="box infomessage" %)
5505 +(((
5506 +**GET api/v3/Vehicles/recyclebin/all**
5507 +)))
5508 +
5509 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5510 +
5511 +Параметр запроса: {parentId} - идентификатор агента
5512 +
5513 +В заголовках запроса: X-Auth: Токен авторизации
5514 +
5515 +Ответ:
5516 +
5517 +[ 
5518 + {
5519 + "recordTime": "", ~/~/Время записи
5520 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5521 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5522 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5523 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5524 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5525 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5526 + "items": [ ~/~/ 
5527 +nullable: true ~/~/Детали
5528 + {
5529 + "name": "string", ~/~/наименование столбца
5530 + "value": "string" ~/~/содержание столбца
5531 + }
5532 + ]
5533 + },
5534 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5535 + "string"
5536 + ]
5537 + }
5538 +]
5539 +
5540 +
5541 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5542 +
5543 +(% class="box infomessage" %)
5544 +(((
5545 +**POST api/v3/Vehicles/recyclebin/erase**
5546 +)))
5547 +
5548 +В заголовках запроса: X-Auth: Токен авторизации
5549 +
5550 +Пример запроса:
5551 +
5552 +[
5553 +0
5554 +]
5555 +
5556 +
5557 +Пример ответа:
5558 +
5559 +[ 
5560 +{
5561 + "recordTime": "", ~/~/Время записи
5562 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5563 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5564 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
5565 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5566 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5567 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5568 + "items": [ ~/~/Детали
5569 + {
5570 + "name": "", ~/~/Имя свойства
5571 + "value": "" ~/~/Значение свойства
5572 + }
5573 + ]
5574 + },
5575 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5576 + ""
5577 + ]
5578 + }
5579 +]
5580 +
5581 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5582 +
5583 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5584 +
5585 +(% class="box infomessage" %)
5586 +(((
5587 +**POST api/v3/Vehicles/recyclebin/restore**
5588 +)))
5589 +
5590 +В заголовках запроса: X-Auth: Токен авторизации
5591 +
5592 +Параметры в теле запроса (JSON):
5593 +
5594 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5595 +
5596 +В заголовках запроса: X-Auth: Токен авторизации
5597 +
5598 +
5599 +Пример запроса:
5600 +
5601 +(((
5602 +[
5603 +)))
5604 +
5605 +(((
5606 + 0
5607 +)))
5608 +
5609 +(((
5610 +]
5611 +)))
5612 +
5613 +
5614 +Пример ответа:
5615 +
5616 +[
5617 +{
5618 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5619 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5620 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5621 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
5622 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5623 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5624 + "details": { ~/~/Список деталей объекта, помещённого в корзину
5625 + "items": [ ~/~/Детали
5626 + {
5627 + "name": "string", ~/~/Имя свойства
5628 + "value": "string" ~/~/Значение свойства
5629 + }
5630 + ]
5631 + },
5632 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5633 + "string"
5634 + ]
5635 + }
5636 +]
5637 +
5638 +
5639 += **Раздел: Журнал заданий ** =
5640 +
5641 +
5642 +== **Создание задания в Журнале заданий** ==
5643 +
5644 +(% class="box infomessage" %)
5645 +(((
5646 +**POST /api/v3/vehicletasks**
5647 +)))
5648 +
5649 +Пример запроса:
5650 +
5651 +(((
5652 +{
5653 + "vehicleId": 0, ~/~/ Идентификатор ТС
5654 + "description": "string", ~/~/ Описание
5655 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5656 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5657 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5658 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5659 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5660 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5661 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5662 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5663 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5664 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5665 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5666 + "cost": { 
5667 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5668 + "Name": "string", ~/~/ Наименование
5669 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5670 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5671 + "Norm": 0 ~/~/ Норма внесения
5672 + },
5673 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5674 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5675 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5676 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5677 + "deleted": true, ~/~/ Признак удаления
5678 + "extId": "string", 
5679 + "GeoIds": [ ~/~/ Cвязанные поля
5680 + 0
5681 + ]
5682 +}
5683 +)))
5684 +
5685 +
5686 +Пример ответа:
5687 +
5688 +{
5689 + "vehicleId": 0, ~/~/ Идентификатор ТС
5690 + "description": "string", ~/~/ Описание
5691 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5692 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5693 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5694 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5695 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5696 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5697 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5698 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5699 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5700 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5701 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5702 + "cost": { 
5703 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5704 + "Name": "string", ~/~/ Наименование
5705 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5706 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5707 + "Norm": 0 ~/~/ Норма внесения
5708 + },
5709 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5710 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5711 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5712 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5713 + "deleted": true, ~/~/ Признак удаления
5714 + "extId": "string", ~/~/ ExtId
5715 + "GeoIds": [ ~/~/ Связанные поля
5716 + 0
5717 + ]
5718 +}
5719 +
5720 +
5721 +== **Редактирование задания в Журнале заданий** ==
5722 +
5723 +(% class="box successmessage" %)
5724 +(((
5725 +**PUT /api/v3/vehicletasks**
5726 +)))
5727 +
5728 +Пример запроса:
5729 +
5730 +(((
5731 +{
5732 + "vehicleId": 0, ~/~/ Идентификатор ТС
5733 + "description": "string", ~/~/ Описание
5734 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5735 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5736 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5737 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5738 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5739 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5740 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5741 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5742 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5743 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5744 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5745 + "cost": { 
5746 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5747 + "Name": "string", ~/~/ Наименование
5748 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5749 + "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5750 + "Norm": 0 ~/~/ Норма внесения
5751 + },
5752 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5753 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5754 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5755 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5756 + "deleted": true, ~/~/ Признак удаления
5757 + "extId": "string", ~/~/ ExtId
5758 + "GeoIds": [ ~/~/ Связанные поля
5759 + 0
5760 + ]
5761 +}
5762 +)))
5763 +
5764 +
5765 +Пример ответа:
5766 +
5767 +{
5768 + "vehicleId": 0, ~/~/ Идентификатор ТС
5769 + "description": "string", ~/~/ Описание
5770 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5771 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5772 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5773 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5774 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5775 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5776 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5777 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5778 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5779 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5780 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5781 + "cost": { 
5782 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5783 + "Name": "string", ~/~/ Наименование
5784 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5785 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5786 + "Norm": 0 ~/~/ Норма внесения
5787 + },
5788 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5789 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5790 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5791 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5792 + "deleted": true, ~/~/ Признак удаления
5793 + "extId": "string", ~/~/ ExtId
5794 + "GeoIds": [ ~/~/ Связанные поля
5795 + 0
5796 + ]
5797 +}
5798 +
5799 +
5800 +== **Удаление задания в Журнале заданий** ==
5801 +
5802 +(% class="box warningmessage" %)
5803 +(((
5804 +**DELETE /api/v3/vehicletasks**
5805 +)))
5806 +
5807 +Пример запроса:
5808 +
5809 +(((
5810 +[
5811 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5812 +]
5813 +)))
5814 +
5815 +(((
5816 +
5817 +)))
5818 +
5819 +Пример ответа:
5820 +
5821 +{
5822 + "vehicleId": 0, ~/~/ Идентификатор ТС
5823 + "description": "string", ~/~/ Описание
5824 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5825 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5826 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5827 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5828 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5829 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5830 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5831 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5832 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5833 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5834 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5835 + "cost": { 
5836 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5837 + "Name": "string", ~/~/ Наименование
5838 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5839 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5840 + "Norm": 0 ~/~/ Норма внесения
5841 + },
5842 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5843 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5844 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5845 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5846 + "deleted": true, ~/~/ Признак удаления
5847 + "extId": "string", ~/~/ ExtId
5848 + "GeoIds": [ ~/~/ Связанные поля
5849 + 0
5850 + ]
5851 +}
5852 +
5853 +
5854 +== **Получение списка Журнала заданий** ==
5855 +
5856 +(% class="box infomessage" %)
5857 +(((
5858 +**POST /api/v3/vehicletasks/getbyperiod**
5859 +)))
5860 +
5861 +Пример запроса:
5862 +
5863 +(((
5864 +{
5865 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
5866 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
5867 + "TimeZone": 0, ~/~/ Часовой пояс.
5868 + "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
5869 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
5870 + ],
5871 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
5872 + 0
5873 + ],
5874 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
5875 + 0
5876 + ],
5877 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
5878 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
5879 +}
5880 +)))
5881 +
5882 +
5883 +Пример ответа:
5884 +
5885 +(((
5886 +{
5887 + "total": 0,  ~/~/ Общее количество записей
5888 + "pages": 0,  ~/~/ Общее количество страниц
5889 + "currentPage": 0, ~/~/ Текущая страница
5890 + "items": [  ~/~/ Записи 
5891 + {
5892 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5893 + "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
5894 + "name": "string", ~/~/ Название задания.
5895 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
5896 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
5897 + "workKind": "string", ~/~/ Вид работ
5898 + "techOp": "string", ~/~/ Тех. операция
5899 + "trailerModel": "string", ~/~/ Модель агрегата
5900 + "width": "string", ~/~/ Ширина, м
5901 + "speed": "string", ~/~/ Тех. скорость
5902 + "fields": "string", ~/~/ Поля
5903 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
5904 + "vehicles": "string", ~/~/ Объект-модель
5905 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
5906 + "drivers": "string", ~/~/ Водители
5907 + "tmc": "string", ~/~/ ТМЦ
5908 + "client": "string", ~/~/  Клиент
5909 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5910 + "dep": "string", ~/~/ Подразделение
5911 + "geoIds": [ ~/~/  Связанные поля
5912 + 0
5913 + ]
5914 + }
5915 + ]
5916 +}
5917 +)))
5918 +
5919 +
5920 += **Раздел: Локатор ** =
5921 +
5922 +
5923 +== **Получение списка локаторов, доступных пользователю ** ==
5924 +
5925 +(% class="box infomessage" %)
5926 +(((
5927 +**GET /api/v3/locators**
5928 +)))
5929 +
5930 +В заголовках запроса: X-Auth: Токен авторизации
5931 +
5932 +
5933 +Пример ответа:
5934 +
5935 +(((
5936 +[
5937 + {
5938 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5939 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5940 + "agentName": "string", ~/~/ Наименование агента.
5941 + "isEnabled": true, ~/~/ Активен 
5942 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5943 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5944 + "name": "string", ~/~/ Наименование
5945 + "status": 0, ~/~/ 
5946 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5947 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5948 + "validity": 0, ~/~/ Срок действия в днях (1-90).
5949 + "autoProlongation": true, ~/~/ Автопродление срока действия.
5950 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5951 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5952 + "url": "string", ~/~/ Ссылка
5953 + "language": 0, ~/~/ Язык.
5954 + "vehiclesCount": 0, ~/~/ Количество объектов.
5955 + "geozonesCount": 0, ~/~/ Количество геозон.
5956 + "fieldsCount": 0 ~/~/ Количество полей.
5957 + }
5958 +]
5959 +)))
5960 +
5961 +
5962 +
5963 +== **Создание локатора** ==
5964 +
5965 +(% class="box successmessage" %)
5966 +(((
5967 +**POST /api/v3/locators**
5968 +)))
5969 +
5970 +Пример запроса:
5971 +
5972 +(((
5973 +{
5974 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5975 + "isEnabled": true, ~/~/ Активность
5976 + "name": "string", ~/~/ Наименование локатора
5977 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
5978 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
5979 + "validity": 0, ~/~/ Срок действия в днях (1-90)
5980 + "autoProlongation": true, ~/~/ Автопродление срока действия.
5981 + "url": "string", ~/~/ Ссылка
5982 + "language": 0 ~/~/ Язык
5983 +}
5984 +)))
5985 +
5986 +
5987 +Пример ответа:
5988 +
5989 +(((
5990 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
5991 +)))
5992 +
5993 +
5994 +
5995 +== **Изменение локатора** ==
5996 +
5997 +(% class="box infomessage" %)
5998 +(((
5999 +**PUT /api/v3/locators**
6000 +)))
6001 +
6002 +Пример запроса:
6003 +
6004 +(((
6005 +{
6006 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6007 + "isEnabled": true, ~/~/ Активность 
6008 + "name": "string", ~/~/ Наименование
6009 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6010 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6011 + "validity": 0, ~/~/ Срок действия в днях (1-90)
6012 + "autoProlongation": true, ~/~/ Автопродление срока действия
6013 + "url": "string", ~/~/ Ссылка
6014 + "language": 0 ~/~/ Язык
6015 +}
6016 +)))
6017 +
6018 +
6019 +Пример ответа:
6020 +
6021 +200 ~/~/ Success
6022 +
6023 +
6024 +== **Удалить локатор** ==
6025 +
6026 +(% class="box warningmessage" %)
6027 +(((
6028 +**DELETE /api/v3/locators**
6029 +)))
6030 +
6031 +Пример запроса:
6032 +
6033 +(((
6034 +[
6035 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6036 +]
6037 +)))
6038 +
6039 +
6040 +
6041 += **Раздел: Яндекс Маршруты** =
6042 +
6043 +
6044 +== **Возвращение списка маршрутов** ==
6045 +
6046 +(% class="box infomessage" %)
6047 +(((
6048 +**GET /api/v3/TransportRoutes**
6049 +)))
6050 +
6051 +Пример запроса:
6052 +Id  ~/~/ Идентификатор поля
6053 +
6054 +
6055 +Пример ответа:
6056 +
6057 +(((
6058 +[
6059 + {
6060 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6061 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6062 + "name": "string", ~/~/ Наименование маршрута.
6063 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6064 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6065 + 0
6066 + ]
6067 + }
6068 +]
6069 +)))
6070 +
6071 +
6072 +
6073 +== **Добавить маршрут** ==
6074 +
6075 +(% class="box infomessage" %)
6076 +(((
6077 +**POST /api/v3/TransportRoutes**
6078 +)))
6079 +
6080 +Пример запроса: 
6081 +{
6082 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6083 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6084 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6085 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6086 + 0
6087 + ]
6088 +}
6089 +
6090 +
6091 +Пример ответа:
6092 +
6093 +(((
6094 +{
6095 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6096 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6097 + "name": "string", ~/~/ Определяет наименование маршрута 
6098 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6099 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6100 + 0
6101 + ]
6102 +}
6103 +)))
6104 +
6105 +
6106 +== **Обновление маршрута** ==
6107 +
6108 +(% class="box successmessage" %)
6109 +(((
6110 +**PUT /api/v3/TransportRoutes**
6111 +)))
6112 +
6113 +Пример запроса:
6114 +
6115 +(((
6116 +{
6117 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6118 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6119 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6120 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6121 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6122 + 0
6123 + ]
6124 +}
6125 +)))
6126 +
6127 +
6128 +Пример ответа:
6129 +
6130 +(((
6131 +{
6132 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6133 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6134 + "name": "string", ~/~/ Определяет наименование маршрута 
6135 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6136 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6137 + 0
6138 + ]
6139 +}
6140 +)))
6141 +
6142 +
6143 +== **Получить связки маршрутов ТС** ==
6144 +
6145 +(% class="box infomessage" %)
6146 +(((
6147 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6148 +)))
6149 +
6150 +Пример запроса:
6151 +
6152 +(((
6153 +[
6154 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6155 +]
6156 +)))
6157 +
6158 +
6159 +Пример ответа:
6160 +
6161 +(((
6162 +[
6163 + {
6164 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6165 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6166 + }
6167 +]
6168 +)))
6169 +
6170 +
6171 +== **Удалить маршрут** ==
6172 +
6173 +(% class="box warningmessage" %)
6174 +(((
6175 +**DELETE /api/v3/TransportRoutes/{id}**
6176 +)))
6177 +
6178 +Пример запроса:
6179 +Id  ~/~/ Идентификатор поля
6180 +
6181 +
6182 +==== ====
6183 +
6184 += **Раздел: Управление доступа к машинам** =
6185 +
6186 +
6187 +== Получение списка транспортных средств видимых пользователю ==
6188 +
6189 +(% class="box infomessage" %)
6190 +(((
6191 +**GET /api/v3/UserVisibleVehicles/{userId}**
6192 +)))
6193 +
6194 +Пример ответа:
6195 +
6196 +(((
6197 +{
6198 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6199 + 0
6200 + ]
6201 +}
6202 +)))
6203 +
6204 +
6205 +
6206 +== Задает видимость транспортных средств пользователю ==
6207 +
6208 +(% class="box infomessage" %)
6209 +(((
6210 +**POST /api/v3/UserVisibleVehicles**
6211 +)))
6212 +
6213 +Пример запроса:
6214 +
6215 +(((
6216 +(((
6217 +{
6218 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6219 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6220 + 0
6221 + ]
6222 +}
6223 +)))
6224 +
6225 +(((
6226 +
6227 +)))
6228 +
6229 +(((
6230 +
6231 +)))
6232 +
6233 +(((
6234 +Пример ответа :
6235 +)))
6236 +
6237 +(((
6238 +
6239 +)))
6240 +
6241 +(((
6242 +200 ~/~/ Success
6243 +)))
6244 +)))
6245 +
6246 +
6247 +
6248 +
6249 +
6250 +
2836 2836  (% class="box" lang="en-US" style="text-align: center;" %)
2837 2837  (((
2838 2838  (% 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 г.