Редактировал(а) Андрей Калиновский 2025/09/11 10:51
Последние авторы
1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 (((
3 (% class="box warningmessage" %)
4 (((
5 (% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно
6 просим вас соблюдать несколько простых правил при использовании API-команд:##
7 )))
8
9 * Формировать не более 3 отчётов одновременно.
10 * Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50.
11
12 В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13
14 (% class="box infomessage" %)
15 (((
16 **Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 \\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 )))
19
20 **Содержание страницы:**
21 )))
22
23 {{toc/}}
24
25
26 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
27
28 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
29
30 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
31
32 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
33
34 (% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
35
36
37 (% style="color:#000000; font-size:16px" %)**Рекомендации**
38
39 - Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
40
41 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
42
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 )))
48
49 (% class="box successmessage" %)
50 (((
51 (% lang="en-US" %)**POST /api/v3/auth/login**
52 )))
53
54 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
55
56 (% style="color:#000000" %)Метод запроса: **POST**
57
58 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
59
60 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
61
62 (% style="color:#000000" %)Параметры в теле запроса (JSON):
63
64 (% style="color:#000000" %){
65 "login": "testuser",
66 "password": "testuser"
67 }
68
69 (% style="color:#000000" %)**Ответ:**
70
71 (% lang="en-US" %)
72 (% style="color:#000000" %){
73 "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
74 "User": "testuser" , ~/~/ имя пользователя(%%)
75 }
76
77 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
78
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
88 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
89
90 (% class="box infomessage" %)
91 (((
92 (% lang="en-US" %)**GET /api/v3/auth/check**
93 )))
94
95 (% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
96
97 (% style="color:#000000" %)Метод запроса: **GET**
98
99 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
100
101 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
102
103 (% lang="en-US" %)
104 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
105
106 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
107
108 == (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
109
110 (% class="box infomessage" %)
111 (((
112 **GET api/v3/agents/{id}**
113 )))
114
115 Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
116
117 (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
118
119 (% style="color:#000000" %)Метод запроса: **GET**
120
121 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
122
123 Запрос должен содержать данные параметра "**agentId**"
124
125 (% style="color:#000000" %)Ответ:
126
127 (((
128 {
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 )))
159
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
183 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
184
185 (% class="box infomessage" %)
186 (((
187 (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
188 )))
189
190 (% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
191
192 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
193
194 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
195
196 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
197
198 (% style="color:#000000" %)Метод запроса: **POST**
199
200 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
201
202 (% style="color:#000000" %)Параметр запроса:
203
204 (% style="color:#000000" %){
205 "parentId": "string"
206 }
207
208 (% style="color:#000000" %)Ответ:
209
210 {
211 "agentId": "",(% style="color:#000000" %)   (%%)
212 "parentId": "",
213 "name": "string",
214 "fullName": "string",
215 "agentInfoType": 0,
216 (% style="color:#000000" %) "status": "",
217 }
218
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
228 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
229
230 (% class="box successmessage" %)
231 (((
232 **POST /api/v3/agents **
233 )))
234
235 Метод позволяет добавить клиента, указанного в запросе.
236
237 Метод запроса: **POST**
238
239 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
240
241 В заголовках запроса: X-Auth: Токен авторизации
242
243 Параметры в теле запроса (JSON):
244
245 {
246 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
247 "name": "string", ~/~/ имя
248 "fullName": "string", ~/~/ полное наименование
249 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
250 "isForeign": true, ~/~/ иностранный контрагент
251 "district": "string", ~/~/ округ
252 "region": "string", ~/~/ регион
253 "city": "string", ~/~/ город
254 "inn": "string", ~/~/ ИНН
255 "kpp": "string", ~/~/ КПП
256 "address": "string", ~/~/ юридический адрес
257 "addressFact": "string", ~/~/ фактический адрес
258 "email": "string", ~/~/ email
259 "director": "string", ~/~/ ФИО руководителя
260 "bankName": "string", ~/~/ банк
261 "bankBIK": "string", ~/~/ БИК
262 "bankRS": "string", ~/~/ номер счёта
263 "bankKS": "string" ~/~/ корр. счёт
264 }
265
266 Ответ:
267
268 {
269 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
270 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
271 "name": "string", ~/~/ имя
272 "fullName": "string", ~/~/ полное наименование
273 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
274 "isForeign": true, ~/~/ иностранный контрагент
275 "district": "string", ~/~/ округ
276 "region": "string", ~/~/ регион
277 "city": "string", ~/~/ город
278 "inn": "string", ~/~/ ИНН
279 "kpp": "string", ~/~/ КПП
280 "address": "string", ~/~/ юридический адрес
281 "addressFact": "string", ~/~/ фактический адрес
282 "email": "string", ~/~/ email
283 "director": "string", ~/~/ ФИО руководителя
284 "bankName": "string", ~/~/ банк
285 "bankBIK": "string", ~/~/ БИК
286 "bankRS": "string", ~/~/ номер счёта
287 "bankKS": "string" ~/~/ корр. счёт
288 }
289
290 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
291
292 (% class="box warningmessage" %)
293 (((
294 **PUT /api/v3/agents**
295 )))
296
297 Метод позволяет отредактировать клиента, указанного в запросе.
298
299 Метод запроса: **PUT**
300
301 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
302
303 В заголовках запроса: X-Auth: Токен авторизации
304
305 Параметры в теле запроса (JSON):
306
307 {
308 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
309 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
310 "name": "string", ~/~/ имя
311 "fullName": "string", ~/~/ полное наименование
312 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
313 "isForeign": true, ~/~/ иностранный контрагент
314 "district": "string", ~/~/ округ
315 "region": "string", ~/~/ регион
316 "city": "string", ~/~/ город
317 "inn": "string", ~/~/ ИНН
318 "kpp": "string", ~/~/ КПП
319 "address": "string", ~/~/ юридический адрес
320 "addressFact": "string", ~/~/ фактический адрес
321 "email": "string", ~/~/ email
322 "director": "string", ~/~/ ФИО руководителя
323 "bankName": "string", ~/~/ банк
324 "bankBIK": "string", ~/~/ БИК
325 "bankRS": "string", ~/~/ номер счёта
326 "bankKS": "string" ~/~/ корр. счёт
327 }
328
329 Ответ:
330
331 {
332 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
333 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
334 "name": "string", ~/~/ имя
335 "fullName": "string", ~/~/ полное наименование
336 "isForeign": true, ~/~/ иностранный контрагент
337 "district": "string", ~/~/ округ
338 "region": "string", ~/~/ регион
339 "city": "string", ~/~/ город
340 "inn": "string", ~/~/ ИНН
341 "kpp": "string", ~/~/ КПП
342 "address": "string", ~/~/ юридический адрес
343 "addressFact": "string", ~/~/ фактический адрес
344 "email": "string", ~/~/ email
345 "director": "string", ~/~/ ФИО руководителя
346 "bankName": "string", ~/~/ банк
347 "bankBIK": "string", ~/~/ БИК
348 "bankRS": "string", ~/~/ номер счёта
349 "bankKS": "string" ~/~/ корр. счёт
350 }
351
352 == (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
353
354 (% class="box errormessage" %)
355 (((
356 **DELETE /api/v3/agents/{clientId}**
357 )))
358
359 Метод позволяет удалить клиента, указанного в строке запроса.
360
361 Метод запроса: **DELETE**
362
363 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
364
365 Параметр запроса: **{clientId}** - Guid пользователя
366
367 В заголовках запроса: X-Auth: Токен авторизации
368
369 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
370
371 == (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
372
373 (% class="box warningmessage" %)
374 (((
375 **PUT /api/v3/agents/{id}/changeStatus/{status}**
376 )))
377
378 Метод позволяет изменить статус клиента, указанного в запросе.
379
380 В пути указывается GUID клиента и статус клиента.
381
382 **status **- значение 0 - заблокирован, 1 - активен.
383
384 Ответ: Code 204
385
386 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
387
388 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
389
390 (% class="box successmessage" %)
391 (((
392 (% lang="en-US" %)**POST /api/v3/users**
393 )))
394
395 (% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
396
397 (% style="color:#000000" %)Метод запроса: **POST**
398
399 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
400
401 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
402
403 (% style="color:#000000" %)Параметры в теле запроса (JSON):
404
405 (% style="color:#000000" %)
406 { 
407 "lastName": "", ~/~/ фамилия
408 "firstName": "", ~/~/ имя
409 "position": "", ~/~/ должность
410 "phone": "", ~/~/ телефон
411 "organization": "", ~/~/ организация
412 "login": "", ~/~/ логин (обязателен)
413 "password": "", ~/~/ пароль (обязателен)
414 "email": "", ~/~/ email (обязателен)
415 "description": "string", ~/~/ Описание
416 "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
417 "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
418 "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
419 "parentId": "", ~/~/ Guid родительского агента
420 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
421 "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
422 "doubleAuth":
423 {
424 "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
425 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
426 },
427 "groups":
428 [
429 "string" ~/~/ группы пользователя, перечисление названия системных ролей
430 ],
431 "customGroups":
432 [
433 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
434 ],
435 "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
436 }
437 {
438 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
439 "lastName": "string",
440 "firstName": "string",
441 "position": "string",
442 "phone": "string",
443 "organization": "string",
444 "login": "string",
445 "password": "string",
446 "email": "string",
447
448 (% style="text-align:left" %)
449 (% style="color:#000000; font-weight:normal" %)Ответ:
450 {     
451 "id": "" , ~/~/ ID пользователя
452 "lastName": "" , ~/~/ Фамилия ,
453 "firstName": "" , ~/~/ Имя
454 "position": "" , ~/~/ Должность
455 "phone": "" , ~/~/ Телефон
456 "organization": "" , ~/~/ Организация
457 "login": "" , ~/~/ Логин
458 "password": "" , ~/~/ Пароль
459 "email": "" , ~/~/ Email
460 "description": "" , ~/~/ Описание
461 "isEnabled": "" , ~/~/ Признак включения
462 "parentId": "" , ~/~/ Guid родительского агента
463 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
464 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
465 "kind": "" , ~/~/ тип аутентификации
466 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
467 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
468 }
469
470
471 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
472
473 (% class="box infomessage" %)
474 (((
475 (% lang="en-US" %)**POST /api/v3/users/find**
476 )))
477
478 (% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
479
480 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
481
482 (% style="color:#000000" %)Метод запроса: **POST**
483
484 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
485
486 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
487
488 (% style="color:#000000" %)Параметры в теле запроса (JSON):
489
490 (% style="color:#000000" %){(%%)
491 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
492 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
493 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
494 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
495 (% style="color:#000000" %)}
496
497 (% style="color:#000000" %)Ответ:
498
499 (% style="color:#000000" %){         (%%)
500 "id": "" , ~/~/ идентификатор пользователя
501 "lastName": "" , ~/~/ фамилия
502 "firstName": "" , ~/~/ имя
503 "position": "" , ~/~/ должность
504 "phone": "" , ~/~/ телефон
505 "parentId": "" , ~/~/ идентификатор клиента-родителя
506 "parentName": "" , ~/~/ наименование клиента-родителя
507 "organization": "" , ~/~/ организация
508 "login": "" , ~/~/ логин
509 "email": "" , ~/~/ E-mail
510 "sessionDuration":"", ~/~/ длительность сессии в минутах
511 "status": "1",  ~/~/ статус пользователя
512 "lastLogged": "", ~/~/ дата/время последней авторизации
513 (% style="color:#000000" %)}
514
515 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
516
517 (% class="box infomessage" %)
518 (((
519 (% lang="en-US" %)**GET /api/v3/users/{GUID}**
520 )))
521
522 (% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
523
524 (% style="color:#000000" %)Метод запроса: **GET**
525
526 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
527
528 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
529
530 (% style="color:#000000" %)Ответ:
531
532 (((
533 (((
534 {
535 "id": "", ~/~/ GUID пользователя
536 "lastName": "", ~/~/ Фамилия 
537 "firstName": "", ~/~/ Имя
538 "position": "", ~/~/ Должность
539 "phone": "", ~/~/ Номер телефона
540 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
541 "parentName": "", Наименование клиента, которому принадлежит пользователь
542 "organization": "", ~/~/ Организация
543 "login": "", ~/~/ Логин пользователя
544 "email": "", ~/~/ Адрес электронной почты
545 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
546 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
547 "description": "", ~/~/ Описание
548 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
549 "doubleAuth":
550 {
551 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
552 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
553 },
554 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
555 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
556 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
557 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
558 "groups": [], ~/~/ Список ролей пользователя
559 "customGroups": [], ~/~/ Список клиентских ролей пользователя
560 "authDevices": [ ], ~/~/ Список авторизованных устройств
561 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
562 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
563 }
564 )))
565 )))
566
567 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
568
569 (% class="box warningmessage" %)
570 (((
571 (% lang="en-US" %)**PUT /api/v3/users**
572 )))
573
574 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
575
576 (% style="color:#000000" %)Метод запроса: **PUT**
577
578 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
579
580 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
581
582 (% lang="en-US" style="text-align:left" %)
583 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
584
585 (% lang="en-US" style="text-align:left" %)
586 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
587 "id": "" , ~/~/ ID пользователя 
588 "lastName": "" , ~/~/ фамилия
589 "firstName": "" , ~/~/ имя
590 "position": "" , ~/~/ должность
591 "phone": "" , ~/~/ телефон
592 "organization": "" , ~/~/ организация
593 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
594 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
595 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
596 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
597 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
598 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
599 "isEnabled": "" , ~/~/ признак включения
600 "parentId": "" , ~/~/ Guid родительского агента
601 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
602 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
603 "doubleAuth":
604 {
605 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
606 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
607 },
608 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
609 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
610 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
611
612 (% lang="en-US" style="text-align:left" %)
613 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
614
615 (% lang="en-US" style="text-align:left" %)
616 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
617 "id": "" , ~/~/ идентификатор пользователя
618 "lastName": "" , ~/~/ фамилия
619 "firstName": "" , ~/~/ имя
620 "position": "" , ~/~/ должность
621 "phone": "" , ~/~/ телефон
622 "organization": "" , ~/~/ организация
623 "login": "" , ~/~/ логин
624 "password": "" , ~/~/ пароль 
625 "email": "" , ~/~/ email
626 "description": "" , ~/~/ описание
627 "isEnabled": "" , ~/~/ признак включения
628 "parentId": "" , ~/~/ Guid родительского агента
629 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
630 "doubleAuth":
631 {
632 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
633 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
634 },
635 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
636 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
637 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
638 }
639
640 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
641
642 (% class="box warningmessage" %)
643 (((
644 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
645 )))
646
647 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
648
649 (% style="color:#000000" %)Метод запроса: **PUT**
650
651 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/status/>>url:https://hosting.glonasssoft.ru/api/v3/users/status/]](% style="color:#000000" %){id}
652
653 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
654
655 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
656
657 (% style="color:#000000" %)Параметры в теле запроса (JSON):
658
659 (% style="color:#000000" %){(%%)
660 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
661 "description": "" , ~/~/ описание
662 "data": "" , ~/~/ данные, связанные со сменой статуса
663 (% style="color:#000000" %)}
664
665 (% style="text-align:left" %)
666 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
667
668 == (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
669
670 (% class="box warningmessage" %)
671 (((
672 **POST /api/v3/users/disable**
673 )))
674
675 Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
676
677 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
678
679 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
680
681 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
682
683 [ 
684 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
685 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
686 ]
687
688 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
689
690 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
691
692 (% class="box warningmessage" %)
693 (((
694 **POST /api/v3/users/enable**
695 )))
696
697 Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
698
699 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
700
701 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
702
703 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
704
705 [ 
706 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
707 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
708 ]
709
710 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
711 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
712
713 (((
714 В теле ответа:
715 {
716 "errorMessages": [
717 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
718 ],
719 "users": [
720 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
721 ]
722 }
723 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
724 "users" - массив id пользователей, которых не удалось включить или отключить.
725 )))
726
727 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
728
729 (% class="box errormessage" %)
730 (((
731 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
732 )))
733
734 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
735
736 (% style="color:#000000" %)Метод запроса: **DELETE**
737
738 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
739
740 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
741
742 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
743
744 (% style="text-align:left" %)
745 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
746
747 (% class="wikigeneratedid" id="H" %)
748 (((
749
750 )))
751
752 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
753
754 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
755
756 (% class="box infomessage" %)
757 (((
758 (% lang="en-US" %)**GET /api/v3/models/{Id}**
759 )))
760
761 Метод возвращает полную информацию о модели объекта.
762
763 (% style="color:#000000" %)Метод запроса: **GET**
764
765 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
766
767 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
768
769 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
770
771 (% style="color:#000000" %)Ответ:
772
773 (% style="color:#000000" %){
774 "parentName": "string",
775 "name": "string",
776 "picture": "string",
777 "minspeed": 0,
778 "maxspeed": 0,
779 "width": 0,
780 "imbeddedtrailer": true,
781 "hoppercapacity": 0,
782 "hopperdischargespeed": 0,
783 "modelType": 0,
784 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
785 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
786 "deleted": true
787 }
788
789 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
790 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
791 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
792 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
793 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
794 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
795 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
796 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
797 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
798 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
799 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
800 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
801 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
802 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
803
804 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
805
806 (% class="box successmessage" %)
807 (((
808 (% lang="en-US" %)**POST /api/v3/models/find**
809 )))
810
811 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
812
813 (% style="color:#000000" %)Метод запроса: **POST**
814
815 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
816
817 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
818
819 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
820
821 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
822 }
823
824 (% style="color:#000000" %)Ответ:
825
826 (% style="color:#000000" %)[
827 {
828 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
829 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
830 "parentName": "string",
831 "name": "string",
832 "modelType": 0
833 }
834 ]
835
836 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
837 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
838 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
839 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
840 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
841 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
842
843 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
844
845 (% class="box successmessage" %)
846 (((
847 (% lang="en-US" %)**POST /api/v3/models**
848 )))
849
850 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
851
852 (% style="color:#000000" %)Метод запроса: **POST**
853
854 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
855
856 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
857
858 (% style="color:#000000" %)Параметры в теле запроса (JSON):
859
860 {
861 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 "deleted": false,
864 "extId": "string",
865 "name": "string",
866 "picture": "string",
867 "minspeed": 0,
868 "maxspeed": 0,
869 "width": 0,
870 "imbeddedtrailer": true,
871 "fueloutlay": 0,
872 "hoppercapacity": 0,
873 "hopperdischargespeed": 0,
874 "modelType": 0
875 }
876
877 Ответ:
878
879 {
880 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882 "deleted": false,
883 "extId": "string",
884 "name": "string",
885 "picture": "string",
886 "minspeed": 0,
887 "maxspeed": 0,
888 "width": 0,
889 "imbeddedtrailer": true,
890 "hoppercapacity": 0,
891 "hopperdischargespeed": 0,
892 "modelType": 0
893 }
894
895 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
896 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
897 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
898 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
899 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
900 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
901 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
902 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
903 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
904 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
905 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
906 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
907 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
908
909 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
910
911 (% class="box warningmessage" %)
912 (((
913 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
914 )))
915
916 (% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
917
918 (% style="color:#000000" %)Метод запроса: **PUT**
919
920 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
921
922 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
923
924 (% style="color:#000000" %)Параметры в теле запроса (JSON):
925
926 {
927 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
928 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
929 "deleted": true,
930 "extId": "string",
931 "name": "string",
932 "picture": "string",
933 "minspeed": 0,
934 "maxspeed": 0,
935 "width": 0,
936 "imbeddedtrailer": true,
937 "fueloutlay": 0,
938 "hoppercapacity": 0,
939 "hopperdischargespeed": 0,
940 "modelType": 0
941 }
942
943 Ответ:
944
945 {
946 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
947 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
948 "deleted": true,
949 "extId": "string",
950 "name": "string",
951 "picture": "string",
952 "minspeed": 0,
953 "maxspeed": 0,
954 "width": 0,
955 "imbeddedtrailer": true,
956 "fueloutlay": 0,
957 "hoppercapacity": 0,
958 "hopperdischargespeed": 0,
959 "modelType": 0
960 }
961
962 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
963 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
964 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
965 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
966 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
967 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
968 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
969 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
970 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
971 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
972 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
973 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
974 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
975
976 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
977
978 (% class="box errormessage" %)
979 (((
980 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
981 )))
982
983 (% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
984
985 (% style="color:#000000" %)Метод запроса: **DELETE**
986
987 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
988
989 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
990
991 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
992
993 Ответ: В случае успеха **Success 200**
994
995 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
996
997 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
998
999 (% class="box infomessage" %)
1000 (((
1001 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1002 )))
1003
1004 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1005
1006 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1007
1008 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1009
1010 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1011
1012 (% style="color:#000000" %)Метод запроса: **GET**
1013
1014 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
1015
1016 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1017
1018 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1019
1020 (% style="color:#000000" %)Ответ:
1021
1022 (((
1023 {
1024
1025 (((
1026 "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1027 "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1028 )))
1029
1030 (((
1031 ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1032 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1033 )))
1034
1035 "vehicleId": "", ~/~/ ID объекта
1036 "name": "", ~/~/ Имя объекта
1037 "imei": "", ~/~/ IMEI объекта
1038 "deviceTypeId": , ~/~/ ID типа устройства
1039 "deviceTypeName": "", ~/~/ Название типа устройства
1040 "sim1": "", ~/~/ Номер SIM1
1041 "sim2": "", ~/~/ Номер SIM2
1042 "parentId": "", ~/~/ ID клиента-родителя
1043 "parentName": "", ~/~/ Наименование клиента-родителя
1044 "modelId": "", ~/~/ ID модели объекта
1045 "modelName": "", ~/~/ Имя модели объекта
1046 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1047 "unitName": "string", ~/~/ Наименование подразделения
1048 "status": 0, ~/~/ Статус объекта
1049 "createdAt": "", ~/~/ Дата создания объекта
1050 },
1051 "customFields": [ ~/~/ Произвольные поля
1052 {
1053 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1054 "name": "string", ~/~/ Имя поля
1055 "value": "string", ~/~/ Значение поля
1056 "forClient": true, ~/~/ Не используемая функция
1057 "forTooltip": true, ~/~/ Отображать в подсказке
1058 "forReport": true ~/~/ Отображать в отчете
1059 }
1060
1061 ], ~/~/ Данные с вкладки нормы
1062 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1063 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1064 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1065 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1066 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1067 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1068 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1069 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1070 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1071 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1072 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1073 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1074 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1075 "mileageCoeff": 0, ~/~/ коэффициент пробега
1076 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1077 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1078 "counters": { ~/~/ Счетчики
1079 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1080 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1081 "mileage": 0, ~/~/ Текущий пробег
1082 "motohours": 0, ~/~/ Текущие моточасы
1083 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1084 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1085 },
1086
1087 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1088 "id": "string", ~/~/ ID объекта
1089 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1090 "host": "string", ~/~/ CMSV6 Web Host
1091 "login": "string", ~/~/ CMSV6 Account
1092 "password": "string" ~/~/ CMSV6 Password
1093 },
1094
1095 "commandTemplates": [ ~/~/ Шаблоны команд
1096 {
1097 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1098 "name": "string", ~/~/ Наименование команды
1099 "command": "string", ~/~/ Текст команды
1100 "retries": 0 ~/~/ Количество попыток
1101 }
1102 ],
1103 "sensors": [ ~/~/ Датчики
1104 {
1105 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1106 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1107 "type": 0, ~/~/ Тип датчика
1108 "name": "string", ~/~/ Имя датчика
1109 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1110 "inputNumber": 0, ~/~/ Номер входа
1111 "pseudonym": "string", ~/~/ Псевдоним
1112 "medianDegree": 0, ~/~/ Медианная фильтрация
1113 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1114 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1115 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1116 "gradesTables": [ ~/~/ Массив таблиц тарировки
1117 {
1118 "grades": [ ~/~/ Таблица тарировки 1
1119 {
1120 "input": 0, ~/~/ Входящее значение
1121 "output": 0 ~/~/ Выходящее значение
1122 }
1123 ],
1124 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1125 }
1126 ],
1127 "showInTooltip": true, ~/~/ Отображать в подсказке
1128 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1129 "color": "string", ~/~/ Код цвета датчиков
1130 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1131 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1132 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1133 "expr": "string", ~/~/ Формула
1134 "children": [ ~/~/ массив дочерних датчиков
1135 "string"
1136 ],
1137 "customParams": { ~/~/ прочие произвольные параметры
1138 "additionalProp1": "string",
1139 "additionalProp2": "string",
1140 "additionalProp3": "string"
1141 },
1142
1143 ~/~/ Характерные для произвольного:
1144 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1145 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1146 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1147 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1148 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1149 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1150 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1151 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1152 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1153 ~/~/ "ValueOn": "Вкл.",
1154 ~/~/ "ValueOff": "Выкл."
1155 "summaryMaxValue": 0 ~/~/ Макс. значение
1156 }
1157 "drivers": [ ~/~/ Водители
1158 {
1159 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1160 "name": "string", ~/~/ Наименование
1161 "description": "string",
1162 "isDefault": true ~/~/ По умолчанию
1163 }
1164 ],
1165 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1166 {
1167 "id": "", ~/~/ ID  задания
1168 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1169 "name": "", ~/~/ Наименование задания
1170 "description": "", ~/~/ Описание задания
1171 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1172 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1173 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1174 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1175 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1176 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1177 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1178 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1179 }
1180 ],
1181 "statusHistory": [ ~/~/ История статусов
1182 {
1183 "status": 0,
1184 "date": "2023-05-22T09:57:39.562Z",
1185 "description": "string",
1186 "additionalInfo": "string"
1187
1188 (((
1189 }
1190 ],
1191 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1192 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1193 )))
1194
1195 (((
1196 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1197 }
1198
1199 )))
1200 )))
1201
1202 (% style="text-align:left" %)
1203 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1204
1205 (% style="text-align:left" %)
1206 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1207
1208
1209 == **Отправить команду на терминал** ==
1210
1211 (% class="box successmessage" %)
1212 (((
1213 (% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1214 )))
1215
1216 Команда для отправки на тс.
1217
1218 {  
1219 "id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1220 "command": "", ~/~/ Текст отправляемой команды
1221 "retries": "", ~/~/ Количество попыток отправки на терминал
1222 "idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1223 }
1224
1225 В ответ получаем cmdid
1226
1227
1228 == **Получить ответ на отправленную на ТС команду** ==
1229
1230 (% class="box infomessage" %)
1231 (((
1232 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1233 )))
1234
1235 Идентификатор команды: cmdId
1236
1237 Запрос от терминала на ответ команды
1238
1239 Пример ответ от терминала:
1240
1241 ID= "" ~/~/ идентификатор объекта
1242 Soft="" ~/~/ версия софта
1243 GPS=4 ~/~/ тип трекера
1244 Time=11:05:43 28.06.24 ~/~/ время запроса
1245 Lat=45.056221 ~/~/ широта
1246 Lon=39.035938 ~/~/ долгота
1247 Speed=0.0 ~/~/ скорость
1248 Course=181.4 ~/~/направление
1249
1250 (((
1251 == **Список отправленных объекту команд с ответами** ==
1252
1253 (% class="box infomessage" %)
1254 (((
1255 (% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1256 )))
1257
1258 Идентификатор ТС: vehicleId
1259
1260 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1261
1262 Пример ответа терминала
1263
1264 [ 
1265 {    
1266 "id": "", ~/~/ идентификатор пользователя
1267 "commandText": "", ~/~/Текст команды.
1268 "templateId": "", ~/~/Идентификатор шаблона
1269 "updated": "", ~/~/ Время отправки  
1270 "tryCount": 0, ~/~/ Количество попыток отправки команды
1271 "answer": "", ~/~/ Ответ терминала.
1272 "status": "" ~/~/ Статус отправки
1273 }
1274 ]
1275 )))
1276
1277 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1278
1279 (% class="box successmessage" %)
1280 (((
1281 (% lang="en-US" %)**POST /api/v3/vehicles**
1282 )))
1283
1284 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1285
1286 (% style="color:#000000" %)Метод запроса: **POST**
1287
1288 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1289
1290 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1291
1292 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1293
1294 (% style="color:#000000" %){
1295
1296
1297 (((
1298 "vehicleId": 0, ~/~/ ID ТС
1299 )))
1300
1301 "parentId": "" , ~/~/ ID клиента
1302 "name": "" , ~/~/ имя ТС
1303 "imei": "" , ~/~/ IMEI
1304 "deviceTypeId": "" , ~/~/ ID типа устройства
1305 "modelId": "" , ~/~/ ID модели
1306 "unitId": "" , ~/~/ ID подразделения
1307 "sim1": "" , ~/~/ Номер SIM 1
1308 "sim2": "" , ~/~/ Номер SIM2
1309 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1310 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1311 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1312 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1313 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1314 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1315 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1316 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1317 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1318 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1319 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1320 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1321 "mileageCalcMethod": 0,
1322 "mileageCoeff": 0,
1323 "locationByCellId": true,
1324 "dottedLineTrackWhenNoCoords": true,
1325 "counters": ~/~/ счетчики
1326 {
1327 "mileage": "" , ~/~/ пробег
1328 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1329 "motohours": "" , ~/~/ моточасы
1330 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1331 },
1332 "cmsv6Parameters": { ~/~/ параметры CMSv6
1333 "enabled": true, ~/~/ флаг включения
1334 "id": "" , ~/~/ идентификатор
1335 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1336 "login": "" , ~/~/ имя учетной записи
1337 "password": "" ~/~/ пароль учетной записи
1338 },
1339 "inspectionTasks": ~/~/ задания на ТО
1340 {
1341 "enabled": "" , ~/~/ Признак включения
1342 "name": "" , ~/~/ Имя задания
1343 "description": "" , ~/~/ Описание задания
1344 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1345 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1346 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1347 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1348 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1349 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1350 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1351 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1352 }
1353 "drivers": [ ~/~/ Водители
1354 {
1355 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1356 "isDefault": true
1357 }
1358 ],
1359 "commandTemplates": [ ~/~/ Шаблон команды
1360 {
1361 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1362 "name": "string",
1363 "command": "string",
1364 "retries": 0
1365 }
1366 ],
1367 "sensors": [ ~/~/ Датчики
1368 {
1369 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1370 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1371 "type": 0, ~/~/ Тип датчика
1372 "name": "string", ~/~/ Имя датчика
1373 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1374 "inputNumber": 0, ~/~/ Номер входа
1375 "pseudonym": "string", ~/~/ Псевдоним
1376 "medianDegree": 0, ~/~/ Медианная фильтрация
1377 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1378 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1379 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1380 "gradesTables": [ ~/~/ Массив таблиц тарировки
1381 {
1382 "grades": [ ~/~/ Таблица тарировки 1
1383 {
1384 "input": 0, ~/~/ Входящее значение
1385 "output": 0 ~/~/ Выходящее значение
1386 }
1387 ],
1388 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1389 }
1390 ],
1391 "showInTooltip": true, ~/~/ Отображать в подсказке
1392 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1393 "color": "string", ~/~/ код цвета датчиков
1394 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1395 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1396 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1397 "expr": "string", ~/~/ Формула
1398 "children": [ ~/~/ массив дочерних датчиков
1399 "string"
1400 ],
1401 "customParams": { ~/~/ прочие произвольные параметры
1402 "additionalProp1": "string",
1403 "additionalProp2": "string",
1404 "additionalProp3": "string"
1405 },
1406 ~/~/ Характерные для произвольного:
1407 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1408 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1409 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1410 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1411 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1412 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1413 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1414 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1415 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1416 ~/~/ "ValueOn": "Вкл.",
1417 ~/~/ "ValueOff": "Выкл."
1418 "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1419
1420 (((
1421 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1422 {
1423 "from": 0, ~/~/ С какого значения
1424 "color": "string", ~/~/ Каким цветом
1425 "text": "string" ~/~/ Текст подписи к этому интервалу
1426 }
1427 ]
1428 }
1429 ],
1430 )))
1431
1432 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1433
1434
1435 "customFields": [ ~/~/ Произвольные поля
1436 {
1437 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1438 "name": "string", ~/~/ Наименование произвольного поля
1439 "value": "string", ~/~/ Значение произвольного поля
1440 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1441 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1442 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1443
1444 (((
1445 }
1446 ],
1447 "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1448 )))
1449
1450 (((
1451 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1452 }
1453 )))
1454
1455
1456 (% style="color:#000000" %)Ответ:
1457
1458
1459 (((
1460 (((
1461 (((
1462 {
1463 "vehicleId": 0,  ~/~/ ID ТС
1464 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1465 "name": "string", ~/~/ Имя объекта
1466 "imei": "string", ~/~/ IMEI
1467 "deviceTypeId": 0, ~/~/ ID типа устройства
1468 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1469 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1470 "sim1": "string", ~/~/ SIM1
1471 "sim2": "string", ~/~/ SIM2
1472 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1473 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1474 "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1475 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1476 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1477 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1478 "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1479 "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1480 "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1481 "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1482 "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1483 "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1484 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1485 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1486 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1487 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1488 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1489 "counters": {  ~/~/ Dto для состояний счётчиков
1490 "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1491 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1492 "mileage": 0, ~/~/ Пробег
1493 "motohours": 0 ~/~/ Моточасы
1494 },
1495 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1496 "id": "string", ~/~/ CMSV6 Идентификатор
1497 "enabled": true, ~/~/ Признак включения
1498 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1499 "login": "string", ~/~/ CMSV6 имя учетной записи
1500 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1501 },
1502 "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1503 {
1504 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1505 "enabled": true, ~/~/ Признак включения
1506 "name": "string", ~/~/ Имя задания
1507 "description": "string", ~/~/ Описание задания
1508 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1509 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1510 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1511 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1512 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1513 "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1514 "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1515 "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1516 }
1517 ],
1518 "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1519 {
1520 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1521 "inputNumber": 0, ~/~/ № входа.
1522 "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1523 "comment": "string", ~/~/ Комментарий
1524 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1525 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1526 "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1527 "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1528 }
1529 ],
1530 "commandTemplates": [  ~/~/ Список шаблонов команд
1531 {
1532 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1533 "name": "string", ~/~/ Название шаблона команд
1534 "command": "string", ~/~/ Команда на выполнение
1535 "retries": 0 ~/~/ Лимит попыток отправки
1536 }
1537 ],
1538 "sensors": [ ~/~/ Список датчиков
1539 {
1540 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1541 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1542 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1543 "name": "string",  ~/~/ Имя датчика
1544 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1545 "inputNumber": 0, ~/~/ Номер входа
1546 "pseudonym": "string", ~/~/ Псевдоним
1547 "medianDegree": 0, ~/~/ Степень медианной фильтрации
1548 "isInverted": true, ~/~/  Признак инверсии
1549 "disabled": true, ~/~/ Датчик не участвует в обработке
1550 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1551 "gradesTables": [ ~/~/ Тарировка
1552 {
1553 "grades": [ ~/~/ Таблицы тарировки
1554 {
1555 "input": 0, ~/~/ Вход
1556 "output": 0 ~/~/ Выход
1557 }
1558 ],
1559 "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1560 }
1561 ],
1562 "showInTooltip": true, ~/~/ Отображение в подсказке
1563 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1564 "color": "string", ~/~/ код цвета датчиков
1565 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1566 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1567 "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1568 "expr": "string", ~/~/ Выражение
1569 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1570 "string"
1571 ],
1572 "customParams": {
1573 "additionalProp1": "string",
1574 "additionalProp2": "string",
1575 "additionalProp3": "string"
1576 },
1577 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1578 "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1579 {
1580 "from": 0, ~/~/ С какого значения
1581 "color": "string", ~/~/ Каким цветом
1582 )))
1583
1584 (((
1585 "text": "string" ~/~/ Текст подписи к этому интервалу
1586 }
1587 ]
1588 }
1589 ],
1590 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1591 "customFields": [ ~/~/ Список произвольных полей
1592 {
1593 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1594 "name": "string", ~/~/ Наименование произвольного поля
1595 "value": "string", ~/~/ Значение произвольного поля
1596 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1597 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1598 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1599 }
1600 ],
1601 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1602 }
1603 )))
1604 )))
1605 )))
1606
1607
1608 **Валидация:**
1609 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1610 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1611 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1612
1613
1614 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1615
1616 (% class="box infomessage" %)
1617 (((
1618 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1619 )))
1620
1621 (% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1622
1623 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1624
1625 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1626
1627 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1628
1629 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1630
1631 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1632
1633 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1634
1635 (% style="color:#000000" %)Метод запроса: **POST**
1636
1637 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1638
1639 (% style="color:#000000" %)В заголовках запроса:
1640
1641 (% style="color:#000000" %)− Content-Type: __**application/json**__
1642
1643 (% style="color:#000000" %)− X-Auth: Токен авторизации
1644
1645 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1646
1647 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1648
1649 {
1650 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1651 "name": null, ~/~/ Имя ТС (string, опционально)
1652 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1653 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1654 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1655 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1656 "unitName": "string",  ~/~/ Название подразделения (опционально)
1657 "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1658 "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1659 "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1660 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1661 }
1662
1663 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1664
1665 (% style="color:#000000" %)Ответ:
1666
1667 (% style="color:#000000" %)[
1668 {
1669
1670 (((
1671 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1672 )))
1673
1674 (((
1675 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1676 "name": "" ~/~/ наименование объекта
1677 "imei": "" ~/~/ IMEI объекта
1678 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1679 "deviceTypeName": "" ~/~/ наименование типа устройства
1680 "sim1": "" ~/~/ первый номер телефона
1681 "sim2": "" ~/~/ второй номер телефона
1682 "parentId": "" ~/~/ идентификатор клиента-родителя
1683 "parentName": "" ~/~/ наименование клиента-родителя
1684 "modelId": "" ~/~/ идентификатор модели объекта
1685 "modelName": "" ~/~/ наименование модели объекта
1686 "unitId": "" ~/~/ идентификатор подразделения
1687 "unitName": "" ~/~/ наименование подразделения
1688 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1689 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1690 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1691 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1692 "customFields": [ 
1693 {
1694 "id": "", ~/~/ идентификатор произвольного поля
1695 "name": "", ~/~/ имя произвольного поля
1696 "value": "", ~/~/ значение произвольного поля
1697 "forClient": true, ~/~/ право на отображение у клиента
1698 "forTooltip": false, ~/~/ право на отображение в подсказке
1699 "forReport": false ~/~/ право на отображение в отчетах
1700 )))
1701
1702 (((
1703 }
1704 ],
1705 "vehicleGroups": [  ~/~/ Группы ТС
1706 {
1707 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1708 "name": "string" ~/~/ Наименование группы ТС
1709 }
1710 ]
1711 }
1712 ]
1713 )))
1714
1715 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1716
1717 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1718
1719 (% class="box successmessage" %)
1720 (((
1721 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1722 )))
1723
1724 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1725
1726 (% style="color:#000000" %)Метод запроса: **POST**
1727
1728 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
1729
1730 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1731
1732 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1733
1734 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1735
1736 (% style="color:#000000" %){
1737
1738 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1739 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1740 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1741 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1742 "description": "", ~/~/ Описание
1743 "data": "", ~/~/ Данные
1744 "overwrite": false, ~/~/ Флаг перезаписи
1745 "stage": "", ~/~/ Состояние, может быть null
1746 (% style="color:#000000" %)}
1747
1748 (% style="color:#000000" %)Ответ:
1749
1750 (% style="color:#000000" %){(%%)
1751 "status": "", ~/~/ значение статуса
1752 "date": "", ~/~/ Дата смены статуса 
1753 "description": "", ~/~/ Описание
1754 "data": "", ~/~/ Данные
1755 "overwrite": false, ~/~/ Флаг перезаписи
1756 "stage": "", ~/~/ Состояние
1757 (% style="color:#000000" %) }
1758
1759
1760 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1761
1762 (% class="box warningmessage" %)
1763 (((
1764 (% lang="en-US" %)**PUT /api/v3/vehicles**
1765 )))
1766
1767 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1768
1769 (% style="color:#000000" %)Метод запроса: **PUT**
1770
1771 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1772
1773 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1774
1775 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1776
1777 (% style="color:#000000" %){
1778 "vehicleId": , ~/~/ ID объекта
1779 "parentId": "" , ~/~/ ID клиента
1780 "name": "" , ~/~/ имя ТС
1781 "imei": "" , ~/~/ IMEI
1782 "deviceTypeId": "" , ~/~/ ID типа устройства
1783 "modelId": "" , ~/~/ ID модели
1784 "unitId": "" , ~/~/ ID подразделения
1785 "sim1": "" , ~/~/ Номер SIM 1
1786 "sim2": "" , ~/~/ Номер SIM2
1787 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1788 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1789 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1790 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1791 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1792 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1793 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1794 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1795 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1796 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1797 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1798 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1799
1800 "mileageCalcMethod": 0,
1801 "mileageCoeff": 0,
1802 "locationByCellId": true,
1803 "dottedLineTrackWhenNoCoords": true,
1804 "counters": ~/~/ счетчики
1805 {
1806 "mileage": "" , ~/~/ пробег
1807 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1808 "motohours": "" , ~/~/ моточасы
1809 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1810 },
1811 "cmsv6Parameters": { ~/~/ параметры CMSv6
1812 "enabled": true, ~/~/ флаг включения
1813 "id": "" , ~/~/ идентификатор
1814 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1815 "login": "" , ~/~/ имя учетной записи
1816 "password": "" ~/~/ пароль учетной записи
1817 },
1818 "inspectionTasks": ~/~/ задания на ТО
1819 {
1820 "enabled": "" , ~/~/ Признак включения
1821 "name": "" , ~/~/ Имя задания
1822 "description": "" , ~/~/ Описание задания
1823 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1824 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1825 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1826 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1827 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1828 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1829 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1830 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1831 }
1832
1833 "drivers": [ ~/~/ Водители
1834 {
1835
1836 (((
1837 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1838 "inputNumber": 0, ~/~/ № входа.
1839 "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1840 "comment": "string", ~/~/ Комментарий.
1841 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1842 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1843 "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1844 "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1845 )))
1846
1847 } 
1848 ],
1849 "commandTemplates": [ ~/~/ Шаблон команды
1850 {
1851 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1852 "name": "string",
1853 "command": "string",
1854 "retries": 0
1855 }
1856 ],
1857 "sensors": [ ~/~/ Датчики
1858 {
1859 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1860 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1861 "type": 0, ~/~/ Тип датчика
1862 "name": "string", ~/~/ Имя датчика
1863 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1864 "inputNumber": 0, ~/~/ Номер входа
1865 "pseudonym": "string", ~/~/ Псевдоним
1866 "medianDegree": 0, ~/~/ Медианная фильтрация
1867 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1868 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1869 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1870 "gradesTables": [ ~/~/ Массив таблиц тарировки
1871 {
1872 "grades": [ ~/~/ Таблица тарировки 1
1873 {
1874 "input": 0, ~/~/ Входящее значение
1875 "output": 0 ~/~/ Выходящее значение
1876 }
1877 ],
1878 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1879 }
1880 ],
1881 "showInTooltip": true, ~/~/ Отображать в подсказке
1882 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1883
1884 (((
1885 "color": "string",** ~/~/ **Цвет датчика
1886 )))
1887
1888 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1889 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1890 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1891 "expr": "string", ~/~/ Формула
1892 "children": [ ~/~/ массив дочерних датчиков
1893 "string"
1894 ],
1895 "customParams": { ~/~/ прочие произвольные параметры
1896 "additionalProp1": "string",
1897 "additionalProp2": "string",
1898 "additionalProp3": "string"
1899 },
1900 ~/~/ Характерные для произвольного:
1901 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1902 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1903 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1904 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1905 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1906 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1907 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1908 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1909 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1910 ~/~/ "ValueOn": "Вкл.",
1911 ~/~/ "ValueOff": "Выкл."
1912 "summaryMaxValue": 0 ~/~/ Макс. значение
1913
1914 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1915 {
1916 "from": 0, ~/~/ С какого значения
1917 "color": "string", ~/~/ Каким цветом
1918 "text": "string" ~/~/ Текст подписи к этому интервалу
1919 }
1920 ]
1921 }
1922 ],
1923 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1924
1925 "customFields": [ ~/~/ Произвольные поля
1926 {     
1927 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1928 "name": "string", ~/~/ Наименование произвольного поля
1929 "value": "string", ~/~/ Значение произвольного поля
1930 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1931 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1932 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1933 }
1934
1935 (((
1936 ],
1937 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1938 )))
1939
1940 }
1941
1942
1943 (% style="color:#000000" %)Ответ:
1944
1945 (((
1946 {
1947 "vehicleId": 0, ~/~/ ID ТС
1948 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1949 "name": "string", ~/~/ Имя объекта
1950 "imei": "string", ~/~/ IMEI
1951 "deviceTypeId": 0, ~/~/ ID типа устройства
1952 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1953 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1954 "sim1": "string", ~/~/ SIM1
1955 "sim2": "string", ~/~/ SIM2
1956 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1957 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1958 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1959 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1960 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1961 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1962 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1963 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1964 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1965 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1966 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1967 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1968 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1969 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1970 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1971 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1972 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1973 "counters": { ~/~/ состояний счётчиков
1974 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1975 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1976 "mileage": 0, ~/~/ Пробег
1977 "motohours": 0 ~/~/ Моточасы 
1978 },
1979 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1980 "id": "string", ~/~/ CMSV6 Идентификатор
1981 "enabled": true, ~/~/ Признак включения
1982 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1983 )))
1984
1985
1986 (((
1987 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1988 "login": "string", ~/~/ CMSV6 имя учетной записи
1989 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1990 },
1991 "inspectionTasks": [ ~/~/ Задания на ТО
1992 {
1993 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1994 "enabled": true, ~/~/ Признак включения
1995 "name": "string", ~/~/ Имя задания
1996 "description": "string", ~/~/ Описание задания
1997 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1998 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1999 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2000 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2001 "periodicCondition": 0, ~/~/ Условие периодичности по времени
2002 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2003 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2004 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2005 }
2006 ],
2007 "drivers": [  ~/~/ Список водителей
2008 {
2009 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2010 "inputNumber": 0, ~/~/ № входа.
2011 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2012 "comment": "string", ~/~/ Комментарий.
2013 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2014 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2015 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2016 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2017 }
2018 ],
2019 "commandTemplates": [ ~/~/ Список шаблонов команд
2020 {
2021 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2022 "name": "string", ~/~/ Название шаблона команд
2023 "command": "string", ~/~/ Команда на выполнение
2024 "retries": 0 ~/~/ Лимит попыток отправки
2025 }
2026 ],
2027 "sensors": [  ~/~/ Список датчиков 
2028 {
2029 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2030 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2031 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2032 )))
2033
2034 (((
2035 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2036 )))
2037
2038 (((
2039 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2040 )))
2041
2042 (((
2043 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2044 )))
2045
2046 (((
2047 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2048 )))
2049
2050 (((
2051 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2052 "name": "string", ~/~/ Имя датчика
2053 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2054 )))
2055
2056 (((
2057 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2058 "inputNumber": 0, ~/~/ Номер входа
2059 "pseudonym": "string", ~/~/ Псевдоним
2060 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2061 "isInverted": true, ~/~/ Признак инверсии
2062 "disabled": true, ~/~/ Датчик не участвует в обработке
2063 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2064 "gradesTables": [ ~/~/ Тарировка
2065 {
2066 "grades": [ ~/~/ Таблицы тарировки
2067 {
2068 "input": 0, ~/~/ Вход
2069 "output": 0 ~/~/ Выход
2070 }
2071 ],
2072 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2073 }
2074 ],
2075 "showInTooltip": true, ~/~/ Отображение в подсказке
2076 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2077
2078 (((
2079 "color": "string", ~/~/ цвет уведомлений
2080 )))
2081
2082 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2083 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2084 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2085 "expr": "string", ~/~/ Выражение
2086 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2087 "string" 
2088 ],
2089 "customParams": { ~/~/ Дополнительные настройки
2090 "additionalProp1": "string",
2091 "additionalProp2": "string",
2092 "additionalProp3": "string"
2093 },
2094 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2095 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2096 {
2097 "from": 0, ~/~/ С какого значения
2098 "color": "string", ~/~/ Каким цветом
2099 "text": "string" ~/~/ Текст подписи к этому интервалу
2100 }
2101 ]
2102 }
2103 ],
2104 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2105 "customFields": [ ~/~/ Список произвольных полей
2106 {
2107 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2108 "name": "string", ~/~/ Наименование произвольного поля
2109 "value": "string", ~/~/ Значение произвольного поля
2110 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2111 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2112 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2113 }
2114 ],
2115 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2116 }
2117 )))
2118
2119 **Валидация:**
2120 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2121 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2122 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2123
2124 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2125
2126 (% class="box errormessage" %)
2127 (((
2128 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2129 )))
2130
2131 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2132
2133 (% style="color:#000000" %)Метод запроса: **DELETE**
2134
2135 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2136
2137 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2138
2139 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2140
2141 (% style="text-align:left" %)
2142 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2143
2144 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2145
2146 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2147
2148 (% class="box infomessage" %)
2149 (((
2150 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2151 )))
2152
2153 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2154
2155 (% style="color:#000000" %)Метод запроса: **GET**
2156
2157 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2158
2159 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2160
2161 (% style="color:#000000" %)Ответ:
2162
2163 (% style="color:#000000" %){(%%)
2164 "deviceTypeId" : "", ~/~/ ID типа устройства
2165 "deviceTypeName" : "" ~/~/ Название типа устройства
2166 (% style="color:#000000" %)}
2167
2168 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2169
2170 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2171
2172 (% class="box infomessage" %)
2173 (((
2174 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2175 )))
2176
2177 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2178
2179 (% style="color:#000000" %)Метод запроса: **GET**
2180
2181 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2182
2183 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2184
2185 (% style="color:#000000" %)Ответ:
2186
2187 (% style="color:#000000" %){(%%)
2188 "id": "", ~/~/ ID типа датчика 
2189 "name": "", ~/~/ Название
2190 "description": "", ~/~/ Описание
2191 (% style="color:#000000" %)}
2192
2193 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2194
2195 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2196
2197 (% class="box infomessage" style="text-align: left;" %)
2198 (((
2199 **POST /api/v3/terminalMessages/count**
2200 )))
2201
2202 (% style="text-align: left;" %)
2203 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2204
2205 (% style="text-align: left;" %)
2206 Метод запроса **POST**
2207
2208 (% style="text-align: left;" %)
2209 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2210
2211 (% style="text-align: left;" %)
2212 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2213
2214 (% style="text-align: left;" %)
2215 {
2216 "vehicleIds": [
2217 id ~/~/ здесь передается список идентификаторов объектов
2218 ],
2219 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2220 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2221 }
2222
2223 (% style="text-align: left;" %)
2224 Ответ:
2225
2226 (% style="text-align: left;" %)
2227 [
2228 {
2229 "vehicleId": 0, ~/~/ идентификатор объекта
2230 "count": 0 ~/~/ количество сообщений за период
2231 }
2232 ]
2233
2234 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2235
2236 (% class="box infomessage" style="text-align: left;" %)
2237 (((
2238 **POST /api/v3/terminalMessages/mapping**
2239 )))
2240
2241 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2242
2243 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2244
2245 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2246
2247 {
2248 "protocolType": 0,
2249 "params": ["string"]
2250 }
2251
2252 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2253 |protocolType|ID типа протокола
2254 |params|(((
2255 Массив наименований параметров в сообщении
2256 )))
2257
2258 Ответ:
2259
2260 {
2261 "protocolType": 0,
2262 "mapping": {
2263 "additionalProp1": {
2264 "inputType": 0,
2265 "inputNumber": 0
2266 },
2267 "additionalProp2": {
2268 "inputType": 0,
2269 "inputNumber": 0
2270 }
2271 }
2272 }
2273
2274 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2275 |protocolType|Тип протокола
2276 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2277 |inputNumber|(((
2278 Номер входа
2279 )))
2280
2281 (% class="wikigeneratedid" %)
2282 Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2283
2284 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2285
2286 (% class="box infomessage" %)
2287 (((
2288 **POST /api/v3/terminalMessages**
2289 )))
2290
2291 Метод возвращает список сообщений терминала объекта за выбранный период.
2292
2293 (% style="text-align: left;" %)
2294 Метод запроса **POST**
2295
2296 (% style="text-align: left;" %)
2297 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2298
2299 (% style="text-align: left;" %)
2300 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2301
2302 {
2303 "vehicleId": 0, ~/~/ id объекта
2304 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2305 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2306 }
2307
2308 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2309 |vehicleId|ID объекта
2310 |from|Дата и время начала периода запроса
2311 |to|Дата и время окончания периода запроса
2312
2313 Ответ:
2314
2315 [
2316 {
2317 "messages": [
2318 {
2319 "deviceTime": "2023-11-29T07:40:44.052Z",
2320 "serverTime": "2023-11-29T07:40:44.052Z",
2321 "speed": 0,
2322 "altitude": 0,
2323 "latitude": 0,
2324 "longitude": 0,
2325 "satellites": 0,
2326 "course": 0,
2327 "voltage": 0,
2328 "parameters": {
2329 "additionalProp1": "string",
2330 "additionalProp2": "string",
2331 "additionalProp3": "string"
2332 },
2333 "photoCount": 0,
2334 "lbsCorrectedCoords": true,
2335 "protocolType": 0
2336 }
2337 ]
2338 }
2339 ]
2340
2341 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2342 |deviceTime|Время сообщения терминала
2343 |serverTime|Время когда сообщение поступило на сервер
2344 |speed|Скорость
2345 |altitude|Высота над уровнем моря
2346 |latitude|Широта
2347 |longitude|Долгота
2348 |satellites|Кол-во спутников
2349 |course|Курс
2350 |voltage|Бортовое напряжение
2351 |parameters|Список параметров и их значений
2352 |photoCount|Количество фото
2353 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2354 |protocolType|ID типа протокола
2355
2356 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2357
2358 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2359
2360 (% class="box infomessage" %)
2361 (((
2362 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2363 )))
2364
2365 (% style="color:#000000" %)Метод запроса: **POST**
2366
2367 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2368
2369 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2370
2371 (% style="text-align:left" %)
2372 Тело запроса:
2373
2374 {
2375 "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2376 "vehicleIds": [0], ~/~/ Список ID объектов
2377 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2378 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2379 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2380 }
2381
2382 Ответ:
2383
2384 [
2385 {
2386 "vehicleId": 0, ~/~/ ID объекта
2387 "name": "string", ~/~/ Имя ТС
2388 "periods": [ ~/~/ Периоды
2389 {
2390 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2391 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2392 "mileage": 0, ~/~/ Пробег за период, километры
2393 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2394 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2395 "motohours": 0, ~/~/ Моточасы за период, секунды
2396 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2397 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2398 "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2399
2400 }
2401 ]
2402 }
2403 ]
2404
2405 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2406
2407 (% class="box infomessage" %)
2408 (((
2409 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2410 )))
2411
2412 (% style="color:#000000" %)Метод запроса: **POST**
2413
2414 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2415
2416 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2417
2418 (% style="text-align:left" %)
2419 Тело запроса:
2420
2421 {
2422 "sampling": 86400, ~/~/ Частота дискретизации, секунд, минимум - 60 (если передано, то весь период бъётся на подпериоды с указанной частотой)
2423 "vehicleIds": [0], ~/~/ Список ID объектов
2424 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2425 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2426 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2427 }
2428
2429 Ответ:
2430
2431 [
2432 {
2433 "vehicleId": 0, ~/~/ ID объекта
2434 "name": "string", ~/~/ Имя ТС
2435 "periods": [ ~/~/ Периоды
2436 {
2437 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2438 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2439 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2440 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2441 "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2442 "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2443 "fuelConsumption": 0, ~/~/ Расход топлива
2444 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2445 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2446
2447 }
2448 ]
2449 }
2450 ]
2451
2452 (% class="box warningmessage" %)
2453 (((
2454 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2455 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2456 )))
2457
2458 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2459
2460 (% class="box infomessage" %)
2461 (((
2462 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2463 )))
2464
2465 (% style="color:#000000" %)Метод запроса: **POST**
2466
2467 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2468
2469 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2470
2471 (% style="text-align:left" %)
2472 Тело запроса:
2473
2474 {
2475 "vehicleIds": [0], ~/~/ Список ID объектов
2476 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2477 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2478 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2479 }
2480
2481 Ответ:
2482
2483 [
2484 {
2485 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2486 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2487 "vehicleId": 0, ~/~/ ID объекта
2488 "name": "string", ~/~/ Имя объекта
2489 "model": "string", ~/~/ Модель объекта
2490 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2491 {
2492 "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
2493
2494 (((
2495 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2496 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2497 "valueFuel": 0, ~/~/ Количество
2498 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2499 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2500 )))
2501
2502 (((
2503 "latitude": 0, ~/~/ Широта.
2504 "longitude": 0 ~/~/ Долгота.
2505 )))
2506
2507 }
2508 ]
2509 }
2510 ]
2511
2512
2513 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2514
2515 (% class="box infomessage" %)
2516 (((
2517 **POST /api/v3/vehicles/moveStop**
2518 )))
2519
2520 Метод запроса: **POST**
2521
2522 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2523
2524 В заголовках запроса: X-Auth: Токен авторизации
2525
2526
2527 Тело запроса:
2528
2529 {
2530 "vehicleIds": [ ], ~/~/ Список ID объектов
2531 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2532 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2533 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2534 }
2535
2536 Ответ:
2537
2538 [ 
2539 {
2540 "vehicleId": 0, ~/~/ ID объекта
2541 "vehicleName": "string", ~/~/ Имя объекта
2542 "moves": [ ~/~/ Событие движения
2543 {
2544 "mileage": 0, ~/~/ Пробег, км
2545 "eventId": 0, ~/~/ Идентификатор события
2546 "eventName": "string", ~/~/ Название события
2547 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2548 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2549 "duration": 0 ~/~/ Продолжительность события, секунд
2550 }
2551 ],
2552 "stops": [ ~/~/ События стоянок
2553 {
2554 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2555 "eventId": 0, ~/~/ Идентификатор события
2556 "eventName": "string", ~/~/ Название события
2557 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2558 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2559 "duration": 0 ~/~/ Продолжительность события, секунд
2560 }
2561 ]
2562 }
2563 ]
2564
2565
2566 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2567
2568 (% class="box infomessage" %)
2569 (((
2570 **POST /api/v3/vehicles/getlastdata**
2571 )))
2572
2573 Метод запроса: **POST**
2574
2575 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2576
2577 В заголовках запроса: X-Auth: Токен авторизации
2578
2579
2580 В массиве указываем id объектов через запятую
2581
2582 Ответ:
2583
2584 [
2585 {
2586 "vehicleId": 55728, ~/~/ Идентификатор объекта 
2587 "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2588 "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2589 "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2590 "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2591 "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2592 "speed": 31, ~/~/ Скорость объекта 
2593 "course": 116, ~/~/ Курс движения [0;360]
2594 "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2595 "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2596 "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2597 "geozones": [ ~/~/ Сведения по геозонам. 
2598 {
2599 "id": 10225647, ~/~/ ID Геозоны 
2600 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2601 },
2602 {
2603 "id": 10282875, ~/~/ ID Геозоны 
2604 "name": "Ё2" ~/~/ Наименование геозоны 
2605 },
2606 {
2607 "id": 10226240, ~/~/ ID Геозоны 
2608 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2609 },
2610 {
2611 "id": 9747869, ~/~/ ID Геозоны 
2612 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2613 },
2614 {
2615 "id": 10221123, ~/~/ ID Геозоны 
2616 "name": "53r" ~/~/ Наименование геозоны 
2617 },
2618 {
2619 "id": 10197638, ~/~/ ID Геозоны 
2620 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2621 }
2622 ]
2623 }
2624
2625
2626 = =
2627
2628 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2629
2630 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2631
2632 (% class="box infomessage" %)
2633 (((
2634 **POST /api/v3/notifications/find**
2635 )))
2636
2637 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2638
2639 (% style="text-align: left;" %)
2640 Метод запроса **POST**
2641
2642 (% style="text-align: left;" %)
2643 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2644
2645 (% style="text-align: left;" %)
2646 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2647
2648 {
2649 "parentId": "" ~/~/ id клиента
2650 }
2651
2652 Ответ:
2653
2654 [
2655 {
2656 "id": 0, ~/~/ ID уведомления
2657 "name": "string", ~/~/ Название уведомления
2658 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2659 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2660 "userId": "", ~/~/ Пользователь, создавший уведомление
2661 "parentId": "", ~/~/ Идентификатор клиента
2662 "parentName": "string" ~/~/ Имя клиента
2663 }
2664 ]
2665
2666
2667 == (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2668
2669 (% class="box infomessage" %)
2670 (((
2671 **POST /api/v3/notifications**
2672 )))
2673
2674 Метод запроса **POST**
2675
2676 (% style="text-align: left;" %)
2677 (% style="color:#000000" %)Пример запроса
2678
2679 (((
2680 {
2681 "id": 0, ~/~/ ID правила
2682 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2683 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2684 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2685 "name": "string", ~/~/ Имя правила
2686 "active": true, ~/~/ Активность правила
2687 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2688 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2689 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2690 ],
2691 "vehicleIds": [ ~/~/ Список объектов для анализа.
2692 0
2693 ],
2694 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2695 0
2696 ],
2697 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2698 0
2699 ],
2700 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2701 "additionalProp1": "string",  
2702 "additionalProp2": "string",
2703 "additionalProp3": "string"
2704 },
2705 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2706 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2707 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2708 ],
2709 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2710 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2711 "string"
2712 ],
2713 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2714 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2715 {
2716 "id": 0, ~/~/ Идентификатор участника чата.
2717 "info": "string" ~/~/ Дополнительные сведения.
2718 }
2719 ],
2720 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2721 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2722 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2723 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2724 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2725 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2726 "timezone": 0, ~/~/ часовой пояс 
2727 "validity": 0, ~/~/ Срок действия в днях (1-90).
2728 "autoProlongation": true, ~/~/ Автопродление срока действия.
2729 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2730 {
2731 "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2732 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2733 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2734 "additionalProp1": "string",
2735 "additionalProp2": "string",
2736 "additionalProp3": "string"
2737 }
2738 }
2739 ]
2740 }
2741 )))
2742
2743 (((
2744
2745 )))
2746
2747 (((
2748
2749 )))
2750
2751 Ответ:
2752
2753 {
2754 "id": 0, ~/~/ ID правила
2755 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2756 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2757 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2758 "name": "string", ~/~/ Имя правила
2759 "active": true, ~/~/ Активность правила
2760 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2761 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2762 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2763 ],
2764 "vehicleIds": [ ~/~/ Список объектов для анализа.
2765 0
2766 ],
2767 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2768 0
2769 ],
2770 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2771 0
2772 ],
2773 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2774 "additionalProp1": "string",  
2775 "additionalProp2": "string",
2776 "additionalProp3": "string"
2777 },
2778 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2779 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2780 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2781 ],
2782 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2783 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2784 "string"
2785 ],
2786 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2787 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2788 {
2789 "id": 0, ~/~/ Идентификатор участника чата.
2790 "info": "string" ~/~/ Дополнительные сведения.
2791 }
2792 ],
2793 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2794 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2795 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2796 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2797 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2798 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2799 "timezone": 0, ~/~/ часовой пояс 
2800 "validity": 0, ~/~/ Срок действия в днях (1-90).
2801 "autoProlongation": true, ~/~/ Автопродление срока действия.
2802 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2803 {
2804 "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2805 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2806 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2807 "additionalProp1": "string",
2808 "additionalProp2": "string",
2809 "additionalProp3": "string"
2810 }
2811 }
2812 ]
2813 }
2814
2815 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2816
2817 (% class="box infomessage" %)
2818 (((
2819 **GET /api/v3/notifications/{id}**
2820 )))
2821
2822 Метод возвращает данные правил формирования выбранного уведомления.
2823
2824 (% style="text-align: left;" %)
2825 Метод запроса **GET**
2826
2827 (% style="text-align: left;" %)
2828 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2829
2830 (% style="text-align: left;" %)
2831 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2832
2833 (% style="text-align: left;" %)
2834 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2835
2836 (% style="text-align: left;" %)
2837 (% style="color:#000000" %)Ответ:
2838
2839 (% style="text-align: left;" %)
2840 (% style="color:#000000" %){
2841 "id": 0, ~/~/ (%%)id уведомления
2842 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2843 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2844 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2845 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2846 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2847 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2848 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2849 (% style="color:#000000" %) 0
2850 ],
2851 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2852 (% style="color:#000000" %) 0
2853 ],
2854 "fieldids": [ ~/~/ (%%)Список id полей для анализа
2855 (% style="color:#000000" %) 0
2856 ],
2857 "settings": { ~/~/ Список параметров уведомления
2858 "additionalProp1": "string",
2859 "additionalProp2": "string",
2860 "additionalProp3": "string"
2861 },
2862 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2863 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2864 (% style="color:#000000" %) ""
2865 ],
2866 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2867 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2868 (% style="color:#000000" %) "string"
2869 ],
2870 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2871 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2872 (% style="color:#000000" %) {
2873 "id": 0, ~/~/ (%%)Идентификатор участника чата
2874 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2875 (% style="color:#000000" %) }
2876 ],
2877 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2878 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2879 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2880 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2881 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2882 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2883 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2884 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2885 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2886 (% style="color:#000000" %)}
2887
2888 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2889
2890 (% class="box warningmessage" %)
2891 (((
2892 **PUT /api/v3/notifications/**
2893 )))
2894
2895 Метод позволяет отредактировать уведомление.
2896
2897 Метод запроса **PUT**
2898
2899 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2900
2901 В заголовках запроса: X-Auth: Токен авторизации
2902
2903 Тело запроса:
2904 {
2905 "id": 0, ~/~/ id уведомления
2906 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2907 "userId": "", ~/~/ Пользователь, создавший уведомление
2908 "parentId": "", ~/~/ Идентификатор клиента
2909 "parentName": "string", ~/~/ Имя клиента
2910 "name": "string", ~/~/ Название уведомления
2911 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2912 "vehicleIds": [ ~/~/ Список id объектов для анализа
2913 0
2914 ],
2915 "geoids": [ ~/~/ Список id геообъектов для анализа
2916 0
2917 ],
2918 "fieldids": [ ~/~/ Список id полей для анализа
2919 0
2920 ],
2921 "settings": { ~/~/ Список параметров уведомления
2922 "additionalProp1": "string",
2923 "additionalProp2": "string",
2924 "additionalProp3": "string"
2925 },
2926 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2927 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2928 ""
2929 ],
2930 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2931 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2932 "string"
2933 ],
2934 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2935 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2936 {
2937 "id": 0, ~/~/ Идентификатор участника чата
2938 "info": "string" ~/~/ Дополнительные сведения
2939 }
2940 ],
2941 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2942 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2943 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2944 "kind": 0, ~/~/ Определяет вид уведомления
2945 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2946 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2947 "timezone": 0, ~/~/ Сдвиг часового пояса
2948 "validity": 0, ~/~/ Срок действия в днях (1-90)
2949 "autoProlongation": true ~/~/ Автопродление срока действия
2950 }
2951
2952 Ответ:
2953
2954 Success
2955
2956
2957 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2958
2959 (% class="box warningmessage" %)
2960 (((
2961 **PUT** /api/v3/notifications/prolongation
2962 )))
2963
2964 Метод позволяет продлить уведомления.
2965
2966 Метод запроса **PUT**
2967
2968 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2969
2970 В заголовках запроса: X-Auth: Токен авторизации.
2971
2972 Тело запроса:
2973
2974 [
2975
2976 0
2977
2978 ]
2979
2980 где 0 идентификатор ids.
2981
2982 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2983
2984 (% class="box errormessage" %)
2985 (((
2986 **DELETE /api/v3/notifications/{id}**
2987 )))
2988
2989 Метод позволяет удалить выбранное уведомление.
2990
2991 Метод запроса **DELETE**
2992
2993 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2994
2995 Передаваемый параметр: {id} - id уведомления
2996
2997 В заголовках запроса: X-Auth: Токен авторизации
2998
2999 Ответ:
3000
3001 Success
3002
3003
3004 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3005
3006 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3007
3008 (% class="box infomessage" %)
3009 (((
3010 **POST /api/v3/Drivers/find**
3011 )))
3012
3013 Передается параметр: parentId - ID клиента-родителя
3014
3015 Ответ:
3016
3017 [
3018 {
3019 "name": "string", ~/~/ Определяет наименование
3020 "description": "string", ~/~/ Определяет описание
3021 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3022 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3023 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3024 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3025 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3026 "deleted": true ~/~/ Признак удаления
3027 }
3028 ]
3029
3030 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3031
3032 (% class="box infomessage" %)
3033 (((
3034 **GET /api/v3/Drivers/{driverGuid}**
3035 )))
3036
3037 Передается параметр: ID водителя
3038
3039 Ответ:
3040
3041 {
3042 "name": "string", ~/~/ Определяет наименование
3043 "description": "string", ~/~/ Определяет описание
3044 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3045 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3046 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3047 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3048 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3049 "deleted": true ~/~/ Признак удаления
3050 }
3051
3052 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3053
3054 (% class="box successmessage" %)
3055 (((
3056 **POST /api/v3/Drivers**
3057 )))
3058
3059 Запрос:
3060
3061 {
3062 "name": "string",
3063 "description": "string",
3064 "hiredate": "2023-06-30T12:50:54.020Z",
3065 "chopdate": "2023-06-30T12:50:54.020Z",
3066 "exclusive": true,
3067 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3068 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3069 "deleted": true
3070 }
3071
3072 Ответ:
3073
3074 {
3075 "name": "string",
3076 "description": "string",
3077 "hiredate": "2023-06-30T12:50:54.051Z",
3078 "chopdate": "2023-06-30T12:50:54.051Z",
3079 "exclusive": true,
3080 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3081 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3082 "deleted": true
3083 }
3084
3085
3086 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3087
3088 (% class="box warningmessage" %)
3089 (((
3090 **PUT /api/v3/Drivers**
3091 )))
3092
3093 Запрос:
3094
3095 {
3096 "name": "string",
3097 "description": "string",
3098 "hiredate": "2023-06-30T12:50:27.910Z",
3099 "chopdate": "2023-06-30T12:50:27.910Z",
3100 "exclusive": true,
3101 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3102 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3103 "deleted": true
3104 }
3105
3106 Ответ:
3107
3108 {
3109 "name": "string",
3110 "description": "string",
3111 "hiredate": "2023-06-30T12:50:27.929Z",
3112 "chopdate": "2023-06-30T12:50:27.929Z",
3113 "exclusive": true,
3114 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3115 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3116 "deleted": true
3117 }
3118
3119
3120 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3121
3122 (% class="box errormessage" %)
3123 (((
3124 **DELETE /api/v3/Drivers/{driverGuid}**
3125 )))
3126
3127 Передается параметр: ID водителя
3128
3129 Ответ:
3130
3131 Success
3132
3133
3134 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3135
3136 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3137
3138 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3139
3140 (% class="box infomessage" %)
3141 (((
3142 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3143 )))
3144
3145 Запрос:
3146
3147 {
3148 "Ids": [
3149 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3150 ],
3151 "BeginTime": "2023-06-30T12:49:04.365Z",
3152 "EndTime": "2023-06-30T12:49:04.365Z"
3153 }
3154
3155 Ответ:
3156
3157 [
3158 {
3159 "VehicleId": 0,
3160 "CreateTime": "2023-06-30T09:52:31.240Z",
3161 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3162 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3163 "BeginTime": "2023-06-30T09:52:31.240Z",
3164 "EndTime": "2023-06-30T09:52:31.240Z"
3165 }
3166 ]
3167
3168
3169 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3170
3171 (% class="box infomessage" %)
3172 (((
3173 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3174 )))
3175
3176 Запрос:
3177
3178 {
3179 "Ids": [
3180 0
3181 ],
3182 "BeginTime": "2023-06-30T12:48:39.419Z",
3183 "EndTime": "2023-06-30T12:48:39.419Z"
3184 }
3185
3186 Ответ:
3187
3188 [
3189 {
3190 "VehicleId": 0,
3191 "CreateTime": "2023-06-30T09:54:01.631Z",
3192 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3193 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3194 "BeginTime": "2023-06-30T09:54:01.631Z",
3195 "EndTime": "2023-06-30T09:54:01.631Z"
3196 }
3197 ]
3198
3199
3200 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3201
3202 (% class="box successmessage" %)
3203 (((
3204 **POST /api/v3/DriversVehiclesAssignments**
3205 )))
3206
3207 Передается массив назначений
3208
3209 Запрос:
3210
3211 [
3212 {
3213 "VehicleId": 0, ~/~/ Идентификатор объекта
3214 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3215 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3216 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3217 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3218 }
3219 ]
3220
3221 Ответ:
3222
3223 [
3224 {
3225 "VehicleId": 0,
3226 "CreateTime": "2023-06-30T11:04:46.903Z",
3227 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3228 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3229 "BeginTime": "2023-06-30T11:04:46.903Z",
3230 "EndTime": "2023-06-30T11:04:46.903Z"
3231 }
3232 ]
3233
3234
3235 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3236
3237 (% class="box warningmessage" %)
3238 (((
3239 **PUT /api/v3/DriversVehiclesAssignments**
3240 )))
3241
3242 Запрос:
3243
3244 [
3245 {
3246 "VehicleId": 0,
3247 "CreateTime": "2023-06-30T11:14:08.117Z",
3248 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3249 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3250 "BeginTime": "2023-06-30T11:14:08.117Z",
3251 "EndTime": "2023-06-30T11:14:08.117Z"
3252 }
3253 ]
3254
3255 Ответ:
3256
3257 [
3258 {
3259 "VehicleId": 0,
3260 "CreateTime": "2023-06-30T11:14:53.349Z",
3261 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3262 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3263 "BeginTime": "2023-06-30T11:14:53.349Z",
3264 "EndTime": "2023-06-30T11:14:53.349Z"
3265 }
3266 ]
3267
3268
3269 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3270
3271 (% class="box errormessage" %)
3272 (((
3273 **DELETE /api/v3/DriversVehiclesAssignments**
3274 )))
3275
3276 Запрос:
3277
3278 [
3279 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3280 ]
3281
3282 Ответ:
3283
3284 Success
3285
3286
3287 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3288
3289 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3290
3291 (% class="box infomessage" %)
3292 (((
3293 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3294 )))
3295
3296 Запрос:
3297
3298 {
3299 "Ids": [
3300 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3301 ],
3302 "BeginTime": "2023-06-30T12:47:12.162Z",
3303 "EndTime": "2023-06-30T12:47:12.162Z"
3304 }
3305
3306 Ответ:
3307
3308 [
3309 {
3310 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3311 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3312 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3313 "BeginTime": "2023-06-30T11:19:40.703Z",
3314 "EndTime": "2023-06-30T11:19:40.703Z"
3315 }
3316 ]
3317
3318
3319 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3320
3321 (% class="box infomessage" %)
3322 (((
3323 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3324 )))
3325
3326 Запрос:
3327
3328 {
3329 "Ids": [
3330 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3331 ],
3332 "BeginTime": "2023-06-30T12:47:12.162Z",
3333 "EndTime": "2023-06-30T12:47:12.162Z"
3334 }
3335
3336 Ответ:
3337
3338 [
3339 {
3340 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3341 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3342 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3343 "BeginTime": "2023-06-30T11:19:40.703Z",
3344 "EndTime": "2023-06-30T11:19:40.703Z"
3345 }
3346 ]
3347
3348
3349 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3350
3351 (% class="box successmessage" %)
3352 (((
3353 **POST /api/v3/DriversRfidsAssignments**
3354 )))
3355
3356 Запрос:
3357
3358 [
3359 {
3360 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3361 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3362 "BeginTime": "2023-06-30T11:27:08.635Z",
3363 "EndTime": "2023-06-30T11:27:08.635Z"
3364 }
3365 ]
3366
3367 Ответ:
3368
3369 [
3370 {
3371 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3372 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3373 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3374 "BeginTime": "2023-06-30T11:27:08.677Z",
3375 "EndTime": "2023-06-30T11:27:08.677Z"
3376 }
3377 ]
3378
3379
3380 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3381
3382 (% class="box warningmessage" %)
3383 (((
3384 **PUT /api/v3/DriversRfidsAssignments**
3385 )))
3386
3387 Запрос:
3388
3389 [
3390 {
3391 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3392 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3393 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3394 "BeginTime": "2023-06-30T11:28:43.330Z",
3395 "EndTime": "2023-06-30T11:28:43.330Z"
3396 }
3397 ]
3398
3399 Ответ:
3400
3401 [
3402 {
3403 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3404 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3405 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3406 "BeginTime": "2023-06-30T11:28:43.331Z",
3407 "EndTime": "2023-06-30T11:28:43.331Z"
3408 }
3409 ]
3410
3411
3412 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3413
3414 (% class="box errormessage" %)
3415 (((
3416 **DELETE /api/v3/DriversRfidsAssignments**
3417 )))
3418
3419 Запрос:
3420
3421 [
3422 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3423 ]
3424
3425 Ответ:
3426
3427 Success
3428
3429
3430 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3431
3432 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3433
3434 (% class="box infomessage" %)
3435 (((
3436 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3437 )))
3438
3439 Запрос:
3440
3441 {
3442 "Ids": [
3443 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3444 ],
3445 "BeginTime": "2023-06-30T12:45:10.852Z",
3446 "EndTime": "2023-06-30T12:45:10.852Z"
3447 }
3448
3449 Ответ:
3450
3451 [
3452 {
3453 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3454 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3455 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3456 "BeginTime": "2023-06-30T11:58:04.695Z",
3457 "EndTime": "2023-06-30T11:58:04.695Z"
3458 }
3459 ]
3460
3461
3462 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3463
3464 (% class="box infomessage" %)
3465 (((
3466 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3467 )))
3468
3469 Запрос:
3470
3471 {
3472 "Ids": [
3473 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3474 ],
3475 "BeginTime": "2023-06-30T12:45:10.852Z",
3476 "EndTime": "2023-06-30T12:45:10.852Z"
3477 }
3478
3479 Ответ:
3480
3481 [
3482 {
3483 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3484 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3485 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3486 "BeginTime": "2023-06-30T11:58:04.695Z",
3487 "EndTime": "2023-06-30T11:58:04.695Z"
3488 }
3489 ]
3490
3491
3492 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3493
3494 (% class="box successmessage" %)
3495 (((
3496 **POST /api/v3/DriversFuelCardsAssignments**
3497 )))
3498
3499 Запрос:
3500
3501 [
3502 {
3503 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3504 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3505 "BeginTime": "2023-06-30T12:09:53.175Z",
3506 "EndTime": "2023-06-30T12:09:53.175Z"
3507 }
3508 ]
3509
3510 Ответ:
3511
3512 [
3513 {
3514 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3515 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3516 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3517 "BeginTime": "2023-06-30T12:09:53.201Z",
3518 "EndTime": "2023-06-30T12:09:53.201Z"
3519 }
3520 ]
3521
3522
3523 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3524
3525 (% class="box warningmessage" %)
3526 (((
3527 **PUT /api/v3/DriversFuelCardsAssignments**
3528 )))
3529
3530 Запрос:
3531
3532 [
3533 {
3534 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3535 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3536 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3537 "BeginTime": "2023-06-30T12:09:53.201Z",
3538 "EndTime": "2023-06-30T12:09:53.201Z"
3539 }
3540 ]
3541
3542 Ответ:
3543
3544 [
3545 {
3546 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3547 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3548 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3549 "BeginTime": "2023-06-30T12:09:53.201Z",
3550 "EndTime": "2023-06-30T12:09:53.201Z"
3551 }
3552 ]
3553
3554
3555 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3556
3557 (% class="box errormessage" %)
3558 (((
3559 **DELETE /api/v3/DriversFuelCardsAssignments**
3560 )))
3561
3562 Запрос:
3563
3564 [
3565 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3566 ]
3567
3568 Ответ:
3569
3570 Success
3571
3572
3573 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3574
3575 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3576
3577 (% class="box infomessage" %)
3578 (((
3579 **POST /api/v3/Trailers**
3580 )))
3581
3582 Пример запроса:
3583
3584 {
3585 "startDate": "2023-11-14T10:48:03.671Z",
3586 "endDate": "2023-11-14T10:48:03.671Z",
3587 "ids": [ 0 ],
3588 "timezone": 0
3589 }
3590
3591 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3592 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3593 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3594 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3595 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3596
3597 Пример ответа:
3598
3599 [
3600 {
3601 "SD": "2023-11-14T10:48:03.717Z",
3602 "ED": "2023-11-14T10:48:03.717Z", 
3603 "id": 0,
3604 "SLat": 0,
3605 "SLon": 0,
3606 "ELat": 0,
3607 "ELon": 0,
3608 "mileage": 0
3609 "Duration": 0
3610 "Address": "string",
3611 "Address2": "string",
3612 "name": "string",
3613 "rid": "string",
3614 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3615 "trailer": {
3616 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3617 "Number": "string",
3618 "Description": "string",
3619 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3620 "ExternalID": "string",
3621 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3622 "CreateTime": "2023-11-14T10:48:03.717Z",
3623 "UpdateTime": "2023-11-14T10:48:03.717Z",
3624 "IsDeleted": true
3625 },
3626 "filesCount": 0,
3627 }
3628 ]
3629
3630 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3631 |SD|Дата и время начала события
3632 |ED|Дата и время окончания события
3633 |id|ID объекта
3634 |SLat|Широта начальной координаты
3635 |SLon|Долгота начальной координаты
3636 |ELat|Широта конечной координаты
3637 |ELon|Долгота конечной координаты
3638 |mileage|Пробег
3639 |Duration|Продолжительность
3640 |Address|Адрес начального местоположения
3641 |Address2|Адрес конечного местоположения
3642 |name|Имя радиометки
3643 |rid|Номер радиометки
3644 |rguid|ID радиометки
3645 |trailer|Информация об агрегате
3646 |ModelGuid|ID агрегата
3647 |Number|Название/номер агрегата
3648 |Description|Текст примечания агрегата
3649
3650 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3651
3652 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3653
3654 (% class="box infomessage" %)
3655 (((
3656 **POST /api/v3/Rfids/find**
3657 )))
3658
3659 Запрос:
3660
3661 {
3662 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3663 }
3664
3665 Ответ:
3666
3667 [
3668 {
3669 "name": "string",
3670 "number": 0,
3671 "period": 0,
3672 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3673 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3674 }
3675 ]
3676
3677 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3678 |parentId|ID клиента
3679 |name|Название карты-метки
3680 |number|Номер
3681 |period|Период запросов в секундах (работает только для агрегатов)
3682 |id|ID карты-метки
3683
3684 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3685
3686 (% class="box infomessage" %)
3687 (((
3688 **GET /api/v3/Rfids/{rfidGuid}**
3689 )))
3690
3691 Передаем параметр rfidGuid - идентификатор карты-метки
3692
3693 Ответ:
3694
3695 [
3696 {
3697 "name": "string",
3698 "number": 0,
3699 "period": 0,
3700 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3701 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3702 }
3703 ]
3704
3705 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3706 |name|Название карты-метки
3707 |number|Номер
3708 |period|Период запросов в секундах (работает только для агрегатов)
3709 |id|ID карты-метки
3710 |parentId|ID клиента
3711
3712 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3713
3714 (% class="box successmessage" %)
3715 (((
3716 **POST /api/v3/Rfids**
3717 )))
3718
3719 Запрос:
3720
3721 {
3722 "name": "string",
3723 "number": 0,
3724 "period": 0,
3725 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3726 }
3727
3728 Ответ:
3729
3730 {
3731 "name": "string",
3732 "number": 0,
3733 "period": 0,
3734 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3735 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3736 }
3737
3738 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3739 |name|Название карты-метки
3740 |number|Номер
3741 |period|Период запросов в секундах (работает только для агрегатов)
3742 |id|ID карты-метки
3743 |parentId|ID клиента
3744
3745 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3746
3747 (% class="box warningmessage" %)
3748 (((
3749 **PUT /api/v3/Rfids**
3750 )))
3751
3752 Запрос:
3753
3754 {
3755 "name": "string",
3756 "number": 0,
3757 "period": 0,
3758 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3759 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3760 }
3761
3762 Ответ:
3763
3764 {
3765 "name": "string",
3766 "number": 0,
3767 "period": 0,
3768 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3769 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3770 }
3771
3772 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3773 |name|Название карты-метки
3774 |number|Номер
3775 |period|Период запросов в секундах (работает только для агрегатов)
3776 |id|ID карты-метки
3777 |parentId|ID клиента
3778
3779 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3780
3781 (% class="box errormessage" %)
3782 (((
3783 **DELETE /api/v3/Rfids/{rfidGuid}**
3784 )))
3785
3786 Передаем параметр **rfidGuid** - идентификатор карты-метки
3787
3788 Ответ:
3789
3790 Success
3791
3792
3793 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3794
3795 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3796
3797 (% class="box infomessage" %)
3798 (((
3799 **GET /api/v3/Billing/client/balance/{clientId}**
3800 )))
3801
3802 Параметр запроса: **clientId **- идентификатор клиента.
3803
3804 Ответ:
3805
3806 {
3807 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3808 "Balance": 0
3809 }
3810
3811 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3812 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3813 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3814
3815 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3816
3817 (% class="box infomessage" %)
3818 (((
3819 **GET /api/v3/Billing/client/constraint/{clientId}**
3820 )))
3821
3822 Параметр запроса: **clientId **- идентификатор клиента.
3823
3824 Ответ:
3825
3826 {
3827 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3828 "CalculationType": 0,
3829 "PermissibleBalance": 0,
3830 "DefermentDays": 0,
3831 "SendUiNotifications": true,
3832 "SendEmailNotifications": true,
3833 "IsPrivate": true,
3834 }
3835
3836 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3837 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3838 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3839 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3840 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3841 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3842 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3843 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3844
3845 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3846
3847 (% class="box infomessage" %)
3848 (((
3849 **GET /api/v3/Billing/client/plan/{clientId}**
3850 )))
3851
3852 Параметры запроса:
3853
3854 **clientId **- идентификатор клиента.
3855
3856 **planId **- идентификатор тарифного плана.
3857
3858 Ответ:
3859
3860 {
3861 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3862 "Plan": { **~/~/ Описание тарифного плана**
3863 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3864 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3865 "Name": "string",
3866 "IsArchived": true,
3867 "Constraint": {
3868 "CalculationType": 0,
3869 "PermissibleBalance": 0,
3870 "DefermentDays": 0
3871 },
3872 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3873 {
3874 "Feature": "string",
3875 "IsFactual": true,
3876 "Limit": 0,
3877 "Price": 0,
3878 "PeriodValue": 0,
3879 "PeriodType": 0
3880 }
3881 ]
3882 },
3883 "DebitDate": "2023-10-18T12:46:24.213Z",
3884 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3885 {
3886 "Feature": "string",
3887 "IsEnabled": true,
3888 "IsPrivate": true,
3889 "IsFactual": true,
3890 "Limit": 0,
3891 "Price": 0,
3892 "DebitDate": "2023-10-18T12:46:24.213Z",
3893 "PeriodValue": 0,
3894 "PeriodType": 0
3895 }
3896 ]
3897 }
3898
3899 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3900 |ClientId|Идентификатор клиента
3901 |Id|Идентификатор тарифного плана
3902 |OwnerId|Идентификатор клиента-владельца
3903 |Name|Наименование тарифного плана
3904 |IsArchived|Признак, определяющий архивный тарифный план
3905 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3906 |PermissibleBalance|Допустимый баланс
3907 |DefermentDays|Отсрочка, количество дней
3908 |Feature|Код услуги
3909 |IsEnabled|Признак, определяющий активирована ли услуга
3910 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3911 |IsFactual|Признак, определяющий расчёт по факту
3912 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3913 |Price|Цена за единицу.
3914 |DebitDate|Следующий момент времени списания с баланса за услугу.
3915 |PeriodValue|Значение периода.
3916 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3917
3918 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3919
3920 (% class="box infomessage" %)
3921 (((
3922 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3923 )))
3924
3925 Параметр запроса: **clientId **- идентификатор клиента.
3926
3927 Ответ:
3928
3929 [
3930 {
3931 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3932 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3933 "Name": "string",
3934 "IsArchived": true,
3935 "Constraint": {
3936 "CalculationType": 0,
3937 "PermissibleBalance": 0,
3938 "DefermentDays": 0
3939 },
3940 "Features": [
3941 {
3942 "Feature": "string",
3943 "IsFactual": true,
3944 "Limit": 0,
3945 "Price": 0,
3946 "PeriodValue": 0,
3947 "PeriodType": 0
3948 }
3949 ]
3950 }
3951 ]
3952
3953 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3954 |ClientId|Идентификатор клиента
3955 |Id|Идентификатор тарифного плана
3956 |OwnerId|Идентификатор клиента-владельца
3957 |Name|Наименование тарифного плана
3958 |IsArchived|Признак, определяющий архивный тарифный план
3959 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3960 |PermissibleBalance|Допустимый баланс
3961 |DefermentDays|Отсрочка, количество дней
3962 |Feature|Код услуги
3963 |IsFactual|Признак, определяющий расчёт по факту
3964 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3965 |Price|Цена за единицу.
3966 |PeriodValue|Значение периода.
3967 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3968
3969 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3970
3971 (% class="box infomessage" %)
3972 (((
3973 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3974 )))
3975
3976 Параметр запроса: **clientId **- идентификатор клиента.
3977
3978 Ответ:
3979
3980 [
3981 {
3982 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3983 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3984 "Name": "string",
3985 "IsArchived": true,
3986 "Constraint": {
3987 "CalculationType": 0,
3988 "PermissibleBalance": 0,
3989 "DefermentDays": 0
3990 },
3991 "Features": [
3992 {
3993 "Feature": "string",
3994 "IsFactual": true,
3995 "Limit": 0,
3996 "Price": 0,
3997 "PeriodValue": 0,
3998 "PeriodType": 0
3999 }
4000 ]
4001 }
4002 ]
4003
4004 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4005 |ClientId|Идентификатор клиента
4006 |Id|Идентификатор тарифного плана
4007 |OwnerId|Идентификатор клиента-владельца
4008 |Name|Наименование тарифного плана
4009 |IsArchived|Признак, определяющий архивный тарифный план
4010 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4011 |PermissibleBalance|Допустимый баланс
4012 |DefermentDays|Отсрочка, количество дней
4013 |Feature|Код услуги
4014 |IsFactual|Признак, определяющий расчёт по факту
4015 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4016 |Price|Цена за единицу.
4017 |PeriodValue|Значение периода.
4018 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4019
4020 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4021
4022 (% class="box warningmessage" %)
4023 (((
4024 **PUT /api/v3/Billing/client/balance**
4025 )))
4026
4027 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4028
4029 Тело запроса:
4030
4031 {
4032 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4033 "Balance": 0 ~/~/ Значение баланса.
4034 }
4035
4036 Ответ: Success
4037
4038 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4039
4040 (% class="box warningmessage" %)
4041 (((
4042 **PUT /api/v3/billing/client/balance/deposit**
4043 )))
4044
4045 Создает операцию **Пополнение **с указанной суммой
4046
4047 Тело запроса:
4048
4049 (((
4050 {
4051 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4052 "amount": 0 ~/~/ Сумма пополнения баланса 
4053 }
4054 )))
4055
4056 (((
4057
4058 )))
4059
4060 Ответ: Success
4061
4062 (((
4063 {
4064 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4065 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4066 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4067 "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4068 "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4069 "Description": "string" ~/~/ Описание корректировки.
4070 }
4071 )))
4072
4073 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4074
4075 Создает операцию **Списание **с указанной суммой
4076
4077 (% class="box warningmessage" %)
4078 (((
4079 **PUT /api/v3/billing/client/balance/withdraw**
4080 )))
4081
4082 Тело запроса:
4083
4084 (((
4085 {
4086 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4087 "amount": 0 ~/~/ Сумма списания с баланса
4088 }
4089 )))
4090
4091 Ответ: Success
4092
4093 (((
4094 {
4095 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4096 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4097 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4098 "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4099 "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4100 "Description": "string" ~/~/ Описание корректировки
4101 }
4102 )))
4103
4104 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4105
4106 (% class="box warningmessage" %)
4107 (((
4108 **PUT /api/v3/Billing/client/constraint**
4109 )))
4110
4111 Тело запроса:
4112
4113 (((
4114 {
4115 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4116 "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4117 "PermissibleBalance": 0, ~/~/ Допустимый баланс
4118 "DefermentDays": 0, ~/~/ Отсрочка (дни).
4119 "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4120 "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4121 }
4122 )))
4123
4124 (((
4125
4126 )))
4127
4128 Ответ: Success
4129
4130 (((
4131 {
4132 "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4133 "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4134 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4135 "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4136 "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4137 "DefermentDays": 0, ~/~/ Отсрочка (дни)
4138 "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4139 "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4140 }
4141 )))
4142
4143 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4144
4145 (% class="box warningmessage" %)
4146 (((
4147 **PUT /api/v3/Billing/client/plan**
4148 )))
4149
4150 Тело запроса:
4151
4152 {
4153 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4154 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4155 "Features": [ ~/~/ Набор услуг по тарифу клиента.
4156 {
4157 "Feature": "string", ~/~/ Код услуги.
4158 "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4159 "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4160 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4161 "Price": 0, ~/~/ Цена за единицу.
4162 "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4163 "PeriodValue": 0, ~/~/ Значение периода.
4164 "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4165 }
4166 ]
4167 }
4168
4169
4170 Ответ: Success
4171
4172 (((
4173 {
4174 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4175 "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4176 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4177 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4178 "Name": "string", ~/~/ Наименование.
4179 "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4180 "Constraint": { ~/~/ Ограничения по тарифу 
4181 "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4182 "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4183 "DefermentDays": 0 ~/~/ Отсрочка (дни)
4184 },
4185 "Features": [ ~/~/ Набор услуг по тарифному плану.
4186 {
4187 "Feature": "string", ~/~/Код услуги.
4188 "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4189 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4190 "Price": 0, ~/~/ Цена за единицу.
4191 "PeriodValue": 0, ~/~/ Значение периода.
4192 "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4193 }
4194 ],
4195 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4196 "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4197 "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4198 },
4199 "Features": [ ~/~/ Набор услуг по тарифу клиента.
4200 {
4201 "Feature": "string", ~/~/ Код услуги.
4202 "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4203 "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4204 "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4205 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4206 "Price": 0, ~/~/ Цена за единицу.
4207 "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4208 "PeriodValue": 0, ~/~/ Значение периода.
4209 "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4210 "Quantity": 0 ~/~/ Количество использования услуги.
4211 }
4212 ]
4213 }
4214 )))
4215
4216 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4217
4218 (% class="box warningmessage" %)
4219 (((
4220 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4221 )))
4222
4223 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4224
4225 (% class="box infomessage" %)
4226 (((
4227 **POST /api/v3/vehicles/import/{agentId}**
4228 )))
4229
4230 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4231
4232 В пути указывается **agentId** - id клиента.
4233
4234 **Заголовок**
4235
4236 **X-Auth: [токен авторизации]**
4237
4238 **Параметры**
4239
4240 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4241 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4242 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4243
4244 В теле использовать тип **form-data,** тип значения** file**
4245
4246 **Ключи**
4247
4248 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4249 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4250 |csv|В значении передаем файл датчиков, формат **csv**
4251
4252 Ответ:
4253
4254 {
4255 "vehicleId": 0,
4256 "name": "string",
4257 "errors": ["string"]
4258 }
4259
4260 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4261 |vehicleId|ID созданного объекта
4262 |name|Имя созданного объекта
4263 |errors|Ошибки и их описание
4264
4265 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4266
4267 (% class="box infomessage" %)
4268 (((
4269 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4270 )))
4271
4272 (% class="wikigeneratedid" %)
4273 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4274
4275 (% class="wikigeneratedid" %)
4276 В пути указывается **vehicleId **- id объекта.
4277
4278 **Заголовок**
4279
4280 **X-Auth: [токен авторизации]**
4281
4282 В теле использовать тип **form-data.**
4283
4284 Ключи:
4285
4286 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4287 |**history**|В значении передавать файл с историей
4288
4289 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4290
4291 Ответ:
4292
4293 {
4294 "results": [
4295 {
4296 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4297 "vehicleId": 0,
4298 "errors": [
4299 "string"
4300 ],
4301 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4302 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4303 "producedCount": 0,
4304 "msgCount": 0
4305 }
4306 ]
4307 }
4308
4309 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4310 |results|Результаты импорта в разрезе ТС
4311 |vehicleGuid|Guid ТС
4312 |vehicleId|ID ТС
4313 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4314 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4315 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4316 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4317 |msgCount|Кол-во обработанных сообщений всего
4318
4319 == **Импортировать историю ТС (Асинхронный запрос)** ==
4320
4321 (% class="box successmessage" %)
4322 (((
4323 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4324 )))
4325
4326 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4327
4328 Метод запроса: **POST**
4329
4330 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4331
4332 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4333
4334
4335 Ответ:
4336
4337 {
4338
4339 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4340
4341 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4342
4343 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4344
4345 "Message": "string", ~/~/ Информация о выполнении запроса
4346
4347 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4348
4349 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4350
4351 "Data": "string" ~/~/ Данные
4352
4353 }
4354
4355
4356 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4357
4358 (% class="box infomessage" %)
4359 (((
4360 **GET /api/v3/vehicles/import/history/status**
4361 )))
4362
4363 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4364
4365 Ответ:
4366
4367 {
4368 "activity": true,
4369 "progress": 0,
4370 "message": "string"
4371 }
4372
4373 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4374 **Параметр**
4375 )))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4376 **Описание**
4377 )))
4378 |(((
4379 activity
4380 )))|(((
4381 Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4382 )))
4383 |(((
4384 progress
4385 )))|(((
4386 Guid ТС
4387 )))
4388
4389 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
4390
4391 (% class="box infomessage" %)
4392 (((
4393 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4394 )))
4395
4396 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4397
4398 Метод запроса: **GET**
4399
4400 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4401
4402 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4403
4404
4405 Ответ:
4406
4407 {
4408
4409 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4410
4411 "Status": 0, ~/~/ Перечисление состояний выполения запроса
4412 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4413
4414 "Message": "string", ~/~/ Информация о выполнении запроса
4415
4416 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4417
4418 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4419
4420 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4421
4422 "Data": "string" ~/~/ Данные
4423
4424 }
4425
4426 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4427
4428 (% class="box infomessage" %)
4429 (((
4430 **POST /api/v3/vehicles/export**
4431 )))
4432
4433 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4434
4435 Тело запроса:
4436
4437 [
4438 id
4439 ]
4440
4441 Ответ: Success 200, получаете файлы с настройками.
4442
4443 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4444
4445 (% class="box infomessage" %)
4446 (((
4447 **POST /api/v3/vehicles/export/history**
4448 )))
4449
4450 Метод возвращает список сообщений терминала объекта за выбранный период.
4451
4452 Тело запроса:
4453
4454 {
4455 "vehicleId": 0,
4456 "asArchive": true,
4457 "from": "2023-09-27T12:17:45.973Z",
4458 "to": "2023-09-27T12:17:45.973Z"
4459 }
4460
4461 Ответ:
4462
4463 Получаете файл. Сообщение: Code 200/Success
4464
4465 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4466 |vehicleId|ID объекта
4467 |asArchive|true - Архивировать файл, False - не архивировать
4468 |from|Дата и время начала запроса
4469 |to|Дата и время окончания запроса
4470
4471 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4472
4473 (% class="box infomessage" %)
4474 (((
4475 **GET /api/v3/vehicles/export/history/status**
4476 )))
4477
4478 Метод возвращает список сообщений терминала объекта за выбранный период.
4479
4480 Ответ:
4481
4482 {
4483 "activity": true,
4484 "progress": 0,
4485 "message": "string"
4486 }
4487
4488 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4489 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4490 |progress|Прогресс экспорта, от 0 до 100%
4491 |message|Текст описывающий статус
4492
4493 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4494
4495 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4496
4497 (% class="box infomessage" %)
4498 (((
4499 **POST /api/v3/EcoDriving/rating**
4500 )))
4501
4502 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4503
4504 Тело запроса:
4505
4506 {
4507 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4508 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4509 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4510 }
4511
4512 Ответ:
4513
4514 {
4515 "items": [  ~/~/ Список в разрезе ТС
4516 {
4517 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4518 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4519 "vehicleId": 0, ~/~/ ID ТС
4520 "vehicleName": "string", ~/~/ Название ТС
4521 "vehicleModel": "string", ~/~/ Модель ТС
4522 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4523 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4524 "totalViolations": 0, ~/~/ Нарушений всего
4525 "violationsByType": { ~/~/ Информация о нарушениях по типу
4526 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4527 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4528 "brakingViolations": 0, ~/~/ Нарушений торможения
4529 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4530 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4531 "sensorViolations": 0 ~/~/ Нарушений по датчику
4532 },
4533
4534 (((
4535
4536 )))
4537
4538 "moveTime": 0, ~/~/ Продолжительность движения, сек
4539 "mileage": 0, ~/~/ Пробег, м
4540 "tripsCount": 0, ~/~/ Кол-во рейсов
4541 "trips": [  ~/~/ Информация по рейсу
4542 {
4543 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4544 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4545 "violationsCount": 0, ~/~/ Всего нарушений
4546 "violationsByType": { ~/~/ Информация о нарушениях по типу
4547 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4548 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4549 "brakingViolations": 0, ~/~/ Нарушений торможения
4550 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4551 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4552 "sensorViolations": 0 ~/~/ Нарушений по датчику
4553 },
4554
4555 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4556 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4557 "moveTime": 0, ~/~/ Продолжительность движения, сек
4558 "mileage": 0, ~/~/ Пробег, м
4559 "motohours": 0, ~/~/ Моточасы, секунды
4560 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4561 "startAddress": "string", ~/~/ Адрес начала рейса
4562 "endAddress": "string", ~/~/ Адрес конца рейса
4563 "drivers": [  ~/~/ Список водителей
4564 {
4565 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4566 "driverName": "string", ~/~/ФИО водителя
4567 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4568 }
4569 ]
4570 }
4571 ]
4572 }
4573 ]
4574 }
4575
4576 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4577
4578 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4579
4580 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4581
4582 (% class="box infomessage" %)
4583 (((
4584 **POST /api/v3/fuelcards/transactions**
4585 )))
4586
4587 Метод запроса: POST
4588
4589 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4590 \\В заголовках запроса: X-Auth: Токен авторизации
4591
4592 Параметры в теле запроса (JSON):
4593
4594 {
4595 "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4596 "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4597 "ids": [ 
4598 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4599 ],
4600 "timezone": 0 ~/~/ Часовой пояс
4601 }
4602
4603
4604 Ответ:
4605 {
4606 "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4607 "driver": "string", ~/~/ Водители, привязанные к ТК
4608 "object": "string", ~/~/ Наименование ТС
4609 "amount": 0, ~/~/ Количество топлива
4610 "amountDut": 0, ~/~/ Количество по ДУТ
4611 "amountDiff": 0, ~/~/ Разница, л
4612 "amountDiffPerc": 0, ~/~/ Разница, %
4613 "summa": 0, ~/~/ Стоимость, руб
4614 "serviceName": "string", ~/~/ Тип топлива
4615 "price": 0, ~/~/ Цена за литр, руб
4616 "cardName": "string", ~/~/ Наименование ТК
4617 "cardNum": "string", ~/~/ Номер ТК
4618 "operator": "string", ~/~/ Оператор ТК
4619 "address": "string" ~/~/ Адрес АЗС
4620 }
4621
4622 == (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4623
4624 (% class="box infomessage" %)
4625 (((
4626 **GET /api/v3/fuelcards**
4627 )))
4628
4629 Метод запроса: GET
4630
4631 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4632
4633 Ответ:
4634
4635 [
4636 {
4637 "Name": "string", ~/~/ Определяет наименование карты.
4638 "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4639 "Number": "string", ~/~/ Определяет № карты.
4640 "Enabled": true, ~/~/ Определяет признак активности карты.
4641 "Description": "string", ~/~/ Определяет описание карты.
4642 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4643 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4644 "deleted": true ~/~/ Признак удаления
4645 }
4646 ]
4647
4648 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4649
4650
4651 == **Получение полных данных о ретрансляторе** ==
4652
4653 (% class="box infomessage" %)
4654 (((
4655 **GET ** **/api/v3/retranslations/{id}**
4656 )))
4657
4658 id - Идентификатор ретранслятора
4659
4660
4661 Пример ответа:
4662
4663 {  
4664 "description": "", ~/~/ Поле описания ретранслятора
4665 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4666 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4667 "isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4668 "address": "string", ~/~/ Адрес и порт принимающего сервера
4669 "objects": [ ~/~/ Объекты для ретрансляции
4670 {      
4671 "id": "",  ~/~/ Идентификатор объекта ретрансляции
4672 "name": "", ~/~/ Наименование объекта ретрансляции
4673 "imei": "", ~/~/ IMEI объекта  ретрансляции
4674 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4675 }
4676 ],  
4677 "id": "", ~/~/ Идентификатор ретранслятора 
4678 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4679 "deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4680 }
4681
4682
4683 == **Удаление данных ретранслятора** ==
4684
4685 (% class="box infomessage" %)
4686 (((
4687 **DELETE** **/api/v3/retranslations/{id}**
4688 )))
4689
4690 id - Идентификатор ретранслятора
4691
4692
4693 == **Создание ретранслятора** ==
4694
4695 (% class="box infomessage" %)
4696 (((
4697 **POST ** **/api/v3/retranslations/{id}**
4698 )))
4699
4700 Запрос:
4701
4702 {  
4703 "description": "", ~/~/ Поле описания ретранслятора
4704 "subscriberId": "", ~/~/ Идентификатор подписчика
4705 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4706 "address": "", ~/~/ Адрес и порт принимающего сервера
4707 "isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4708 "objects": [ ~/~/Объекты для ретрансляции
4709 {      
4710 "id": "", ~/~/ Идентификатор ретранслятора 
4711 "imei": "", ~/~/ IMEI объекта ретрансляции
4712 "isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4713 }
4714 ]
4715 }
4716
4717
4718 Ответ:
4719
4720 {  
4721 "description": "", ~/~/ Поле описания ретранслятора
4722 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4723 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4724 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4725 "address": "string", ~/~/ Адрес и порт принимающего сервера
4726 "objects": [ ~/~/ Объекты для ретрансляции
4727 {      
4728 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4729 "name": "string", ~/~/ Наименование объекта ретрансляции    
4730 "imei": "", ~/~/ IMEI объекта ретрансляции
4731 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4732 }
4733 ],
4734 "id": "", ~/~/ Идентификатор ретранслятора   
4735 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4736 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4737 }
4738
4739
4740 == **Редактирование ретранслятора** ==
4741
4742 (% class="box infomessage" %)
4743 (((
4744 **PUT** **/api/v3/retranslations**
4745 )))
4746
4747 Пример запроса:
4748
4749 {  
4750 "id": "", ~/~/ Идентификатор ретранслятора   
4751 "description": "string", ~/~/ Поле описания ретранслятора
4752 "subscriberId": "", ~/~/ Идентификатор подписчика
4753 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4754 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4755 "address": "string", ~/~/ Адрес и порт принимающего сервера
4756 "objects": ~/~/ Объекты для ретрансляции
4757 [    
4758 {      
4759 "id": "",  ~/~/ Идентификатор объекта ретрансляции 
4760 "imei": "", ~/~/ IMEI объекта ретрансляции
4761 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4762 }
4763 ]
4764 }
4765
4766
4767 Пример ответа:
4768
4769 {  
4770 "description": "", ~/~/ Поле описания ретранслятора
4771 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4772 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4773 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4774 "address": "string", ~/~/ Адрес и порт принимающего сервера
4775 "objects": [ ~/~/ Объекты для ретрансляции
4776 {      
4777 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4778 "name": "string", ~/~/ Наименование объекта ретрансляции    
4779 "imei": "", ~/~/ IMEI объекта ретрансляции
4780 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4781 }
4782 ],
4783 "id": "", ~/~/ Идентификатор ретранслятора   
4784 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4785 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4786 }
4787
4788
4789 == **Получение списка ретранслятора клиента** ==
4790
4791 (% class="box infomessage" %)
4792 (((
4793 **POST /api/v3/retranslations/find**
4794 )))
4795
4796 Пример запроса:
4797
4798 {  
4799 "id": "", ~/~/ Идентификатор ретранслятора   
4800 "search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4801 "parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4802 }
4803
4804 Ответ:
4805
4806 [ 
4807 {    
4808 "description": "", ~/~/ Поле описания ретранслятора
4809 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4810 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4811 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4812 "address": "string", ~/~/ Адрес и порт принимающего сервера
4813 "id": "", ~/~/ Идентификатор ретранслятора   
4814 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4815 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4816 }
4817 ]
4818
4819
4820 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4821
4822 == **API для отчета по выгрузке комбайнов** ==
4823
4824 (% class="box infomessage" %)
4825 (((
4826 **POST /api/v3/Reports/harvesterUnloading**
4827 )))
4828
4829 Пример запроса:
4830
4831 {
4832 "byTime": 0, ~/~/ Объединение событий по времени
4833 "byDist": 0, ~/~/ Объединение событий по расстоянию
4834 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4835 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4836 "showNearestObjects": true, ~/~/Показывать объекты рядом?
4837 "vehicleIds": [ ~/~/ Список id объектов для анализа
4838 0
4839 ],
4840 "from": "", ~/~/ Дата и время начало запроса
4841 "to": "", ~/~/ Дата и время окончания запроса
4842 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4843 }
4844
4845 Пример ответа:
4846
4847 [ 
4848 {
4849 "harvesterName": "", ~/~/Комбайн, номер
4850 "harvesterId": 0, ~/~/Комбайн, id
4851 "harvesterModel": "", ~/~/ Модель комбайна
4852 "hopperCapacity": 0, ~/~/ Объем бункера м3
4853 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4854 "events": [ ~/~/Список событий в разрезе комбайна
4855 {
4856 "driverId": "", ~/~/Идентификатор водителя
4857 "driverName": "", ~/~/Водитель комбайна, ФИО
4858 "RFID": "", ~/~/ идентификатор карты-метки
4859 "rfidName": "", ~/~/Водитель комбайна, имя метки
4860 "vehicleId": 0, ~/~/идентификатор объекта
4861 "vehicleName": "string", ~/~/ Имя объекта
4862 "modelName": "string", ~/~/ Имя модели объекта
4863 "nearestVehicles": [ ~/~/Объекты рядом
4864 {
4865 "vehicleId": 0, ~/~/идентификатор объекта
4866 "vehicleName": "string" ~/~/ Имя объекта
4867 }
4868 ],
4869 "fields": [ ~/~/Поля, где происходила выгрузка
4870 {
4871 "id": 0, ~/~/ идентификатор пользователя 
4872 "name": "string" ~/~/ имя пользователя 
4873 }
4874 ],
4875 "event": "string", ~/~/Событие
4876 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4877 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4878 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4879 "cultureName": "string", ~/~/ название культуры
4880 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4881 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4882 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4883 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4884 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4885 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4886 "issued": 0, ~/~/Выдано, бункеров
4887 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4888 "latitude": 0, ~/~/Широта
4889 "longitude": 0, ~/~/ Долгота
4890 "litresAway": 0, ~/~/Отдано, л
4891 "m3Away": 0 ~/~/Отдано, м3
4892 }
4893 ]
4894 }
4895 ]
4896
4897
4898 == **Отчет трек-датчики** ==
4899
4900 (% class="box infomessage" %)
4901 (((
4902 **POST /api/v3/Reports/sensorsWorks**
4903 )))
4904
4905 **Пример запроса:**
4906
4907 {
4908 "vehicleIds": [ ~/~/ Список ID объектов
4909 0
4910 ],
4911 "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4912 "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4913 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4914 }
4915
4916 **Пример ответа:**
4917
4918 (((
4919 {
4920 "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4921 {
4922 "vehicleId": 0, ~/~/ Идентификатор ТС
4923 "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4924 {
4925 "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4926 "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4927 "duration": 0, ~/~/  Продолжительность интервала в секундах.
4928 "name": "string", ~/~/ Наименование оборудования.
4929 "mileage": 0, ~/~/ Пробег за время работы оборудования.
4930 "totalMileage": 0, ~/~/ Общий пробег.
4931 "avgSpeed": 0 ~/~/ Средняя скорость.
4932 }
4933 ]
4934 }
4935 ]
4936 }
4937
4938
4939 == **Превышение скорости** ==
4940
4941 (% class="box infomessage" %)
4942 (((
4943 **POST /api/v3/Reports/overSpeedDuration**
4944 )))
4945
4946 Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4947
4948 Пример запроса:
4949
4950 (((
4951 {
4952 "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4953 "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4954 "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4955 "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4956 "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4957 }
4958 )))
4959
4960 (((
4961
4962 )))
4963
4964 (((
4965 Пример ответа:
4966 )))
4967
4968 (((
4969 (((
4970 [
4971 {
4972 "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4973 "duration": 0, ~/~/ Продолжительность события в секундах 
4974 "maxSpeed": 0, ~/~/ Максимальная скорость 
4975 "speedLimit": 0 ~/~/ Ограничение скорости 
4976 }
4977 ]
4978 )))
4979 )))
4980 )))
4981
4982 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4983
4984
4985 == **Запрос списка полей** ==
4986
4987 (% class="box successmessage" %)
4988 (((
4989 **POST /api/v3/agroLands/find**
4990 )))
4991
4992 Пример запроса:
4993
4994 (((
4995 (((
4996 (((
4997 {
4998 "year": 0, ~/~/ Фильтр по году
4999 "name": "string", ~/~/ Фильтр по названию
5000 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
5001 }
5002 )))
5003 )))
5004
5005
5006 )))
5007
5008 Пример ответа:
5009
5010 (((
5011 [
5012 {
5013 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5014 "year": 0, ~/~/ Год поля
5015 "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
5016 "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
5017 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5018 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5019 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5020 "counts": { ~/~/ Счётчики с/х поля 
5021 "fieldOperations": 0, ~/~/ Количество операций на поле
5022 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5023 "facts": 0 ~/~/ Счётчик факта
5024 },
5025 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5026 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5027 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5028 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5029 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5030 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5031 "planComment": "string", ~/~/ Комментарий к полю
5032 "productivity": 0, ~/~/ Урожайность.
5033 "id": 0, ~/~/ Идентификатор объекта геозоны
5034 "name": "string", ~/~/ Название объекта геозоны
5035 "type": 0, ~/~/ Тип объекта геозоны
5036 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5037 "fname": "string", ~/~/ Имя файла
5038 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5039 "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
5040 "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
5041 "description": "string", ~/~/ Описание объекта геозоны
5042 "area": 0, ~/~/ Площадь, м2
5043 "perimetr": 0, ~/~/ Периметр, м
5044 "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
5045 }
5046 ]
5047
5048
5049 == **Создание нового поля ** ==
5050
5051 (% class="box successmessage" %)
5052 (((
5053 **POST /api/v3/agroLands**
5054 )))
5055
5056 Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5057 X-agent  - ID клиента
5058
5059 Пример запроса:
5060
5061 (((
5062 {
5063 "extId": "string", 
5064 "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5065 "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5066 "display": "string", ~/~/ Настройки отображения
5067 "year": 0, ~/~/ Год поля
5068 "name": "string", ~/~/ Наименование
5069 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5070 "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5071 "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5072 "planComment": "string", ~/~/ Комментарий к полю
5073 "cropRotations": [ ~/~/ Данные по севообороту
5074 {
5075 "landId": 0, ~/~/ ID поля
5076 "landName": "string", ~/~/ Название поля
5077 "year": 0, ~/~/ Год урожая
5078 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5079 "cultureName": "string", ~/~/ Название культуры
5080 "productivity": 0, ~/~/ Урожайность
5081 "area": 0, ~/~/ Площадь поля, Га
5082 "total": 0, ~/~/ Валовый сбор
5083 "productivityFact": 0, ~/~/ Фактическая урожайность
5084 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5085 "totalFact": 0, ~/~/ Фактический валовый сбор
5086 "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5087 "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5088 "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5089 "isyearplan": true, ~/~/ Годовой план 
5090 "comment": "string" ~/~/ Комментарий
5091 }
5092 ]
5093 }
5094 )))
5095
5096 (((
5097
5098 )))
5099
5100 Пример ответа:
5101
5102 (((
5103 (((
5104 {
5105 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5106 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5107 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5108 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5109 "cropRotations": [ ~/~/ Данные по севообороту
5110 {
5111 "landId": 0, ~/~/ ID поля
5112 "landName": "string", ~/~/ Название поля
5113 "year": 0, ~/~/ Год урожая 
5114 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5115 "cultureName": "string", ~/~/ Название культуры
5116 "productivity": 0, ~/~/ Урожайность
5117 "area": 0, ~/~/ Площадь поля, Га.
5118 "total": 0, ~/~/ Валовый сбор
5119 "productivityFact": 0, ~/~/ Фактическая урожайность
5120 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5121 "totalFact": 0, ~/~/ Фактический валовый сбор
5122 "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5123 "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5124 "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5125 "isyearplan": true, ~/~/ годовой план 
5126 "comment": "string" ~/~/ Комментарий
5127 }
5128 ],
5129 "cropVegetation": [ ~/~/ История вегетации поля
5130 {
5131 "values": [  ~/~/ Данные вегетации и состояния посева
5132 {
5133 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5134 "ndvi": 0 ~/~/ Индекс вегетации
5135 }
5136 ],
5137 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5138 {
5139 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5140 "type": "string", ~/~/ Тип
5141 "pictureid": "string" ~/~/ Идентификатор ресурса
5142 }
5143 ],
5144 "states": [ ~/~/ Ключевые даты развития поля
5145 {
5146 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5147 "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5148 }
5149 ]
5150 }
5151 ],
5152 "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5153 "counts": {
5154 "fieldOperations": 0, ~/~/ Количество операций на поле
5155 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5156 "facts": 0 ~/~/ Счётчик факта
5157 },
5158 "planComment": "string", ~/~/ Комментарий к полю
5159 )))
5160
5161 (((
5162 "productivity": 0, ~/~/ Урожайность.
5163 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5164 "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5165 "year": 0, ~/~/ Год поля
5166 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5167 "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5168 "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5169 "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5170 "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5171 "id": 0, ~/~/ Идентификатор объекта геозоны
5172 "name": "string", ~/~/ Название объекта геозоны
5173 "type": 0, ~/~/ Тип объекта геозоны
5174 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5175 "fname": "string", ~/~/ Имя файла
5176 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5177 "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5178 "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5179 "description": "string", ~/~/ Описание объекта геозоны
5180 "area": 0, ~/~/ Площадь, м2
5181 "perimetr": 0, ~/~/ Периметр, м
5182 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5183 }
5184
5185
5186 )))
5187 )))
5188 )))
5189
5190 == **Получение поля по id** ==
5191
5192 (% class="box infomessage" %)
5193 (((
5194 **GET /api/v3/agroLands/{id}**
5195 )))
5196
5197 Пример запроса:
5198 id  ~/~/ Идентификатор поля
5199
5200 Пример ответа:
5201
5202 (((
5203 {
5204 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5205 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5206 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5207 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5208 "cropRotations": [ ~/~/ Данные по севообороту
5209 {
5210 "landId": 0, ~/~/ ID поля
5211 "landName": "string", ~/~/ Название поля
5212 "year": 0, ~/~/ Год урожая
5213 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5214 "cultureName": "string", ~/~/ Название культуры
5215 "productivity": 0, ~/~/ Урожайность
5216 "area": 0, ~/~/ Площадь поля, Га
5217 "total": 0, ~/~/ Валовый сбор
5218 "productivityFact": 0, ~/~/ Фактическая урожайность
5219 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5220 "totalFact": 0, ~/~/ Фактический валовый сбор
5221 "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5222 "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5223 "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5224 "isyearplan": true, ~/~/ План года 
5225 "comment": "string" ~/~/ Комментарий
5226 }
5227 ],
5228 "cropVegetation": [ ~/~/ История вегетации поля
5229 {
5230 "values": [ ~/~/ Данные вегетации и состояния посева
5231 {
5232 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5233 "ndvi": 0 ~/~/ Индекс вегетации
5234 }
5235 ],
5236 "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5237 {
5238 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5239 "type": "string", ~/~/ Тип 
5240 "pictureid": "string" ~/~/ Идентификатор ресурса
5241 }
5242 ],
5243 "states": [ ~/~/ Ключевые даты развития поля
5244 {
5245 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5246 "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5247 }
5248 ]
5249 }
5250 ],
5251 "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5252 "counts": {
5253 "fieldOperations": 0, ~/~/ Количество операций на поле
5254 "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5255 "facts": 0 ~/~/ Счётчик факта
5256 },
5257 "planComment": "string", ~/~/ Комментарий к полю
5258 "productivity": 0, ~/~/ Урожайность.
5259 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5260 )))
5261
5262 (((
5263 (((
5264 "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5265 "year": 0, ~/~/ Год поля
5266 "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5267 "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5268 "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5269 "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5270 "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5271 "id": 0, ~/~/ Идентификатор объекта геозоны
5272 "name": "string", ~/~/ Название объекта геозоны
5273 "type": 0, ~/~/ Тип объекта геозоны 
5274 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5275 "fname": "string", ~/~/ Имя файла
5276 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5277 "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5278 "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5279 "description": "string", ~/~/ Описание объекта геозоны
5280 "area": 0, ~/~/ Площадь, м2
5281 "perimetr": 0, ~/~/ Периметр, м
5282 "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5283 }
5284 )))
5285
5286
5287 (((
5288 (((
5289 (((
5290 == **Изменение поля** ==
5291
5292 (% class="box infomessage" %)
5293 (((
5294 **PUT /api/v3/agroLands**
5295 )))
5296
5297 Пример запроса:
5298
5299 (((
5300 (((
5301 {
5302 "id": 0, ~/~/ Идентификатор поля
5303 "extId": "string", ~/~/ ExtId
5304 "shape": "string", ~/~/ Форма поля
5305 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5306 "display": "string", ~/~/ Настройки отображения
5307 "year": 0, ~/~/ Год поля
5308 "name": "string", ~/~/ Наименование
5309 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5310 "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5311 "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5312 "planComment": "string", ~/~/Комментарий к полю
5313 "cropRotations": [  ~/~/ Данные по севообороту
5314 {
5315 "landId": 0, ~/~/ ID поля
5316 "landName": "string", ~/~/ Название поля
5317 "year": 0, ~/~/ Год урожая
5318 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5319 "cultureName": "string", ~/~/ Название культуры
5320 "productivity": 0, ~/~/ Урожайность
5321 "area": 0, ~/~/ Площадь поля, Га.
5322 "total": 0, ~/~/ Валовый сбор
5323 "productivityFact": 0, ~/~/ Фактическая урожайность
5324 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5325 "totalFact": 0, ~/~/ Фактический валовый сбор
5326 "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5327 "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5328 "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5329 "isyearplan": true, 
5330 "comment": "string" ~/~/ Комментарий
5331 }
5332 ],
5333 "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5334 }
5335 )))
5336 )))
5337
5338 (((
5339
5340 )))
5341
5342 Пример ответа:
5343
5344 (((
5345 (((
5346 (((
5347 {
5348 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5349 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5350 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5351 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5352 "cropRotations": [ ~/~/ Данные по севообороту
5353 {
5354 "landId": 0, ~/~/ ID поля
5355 "landName": "string", ~/~/ Название поля
5356 "year": 0, ~/~/  Год урожая
5357 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5358 "cultureName": "string", ~/~/ Название культуры
5359 "productivity": 0, ~/~/ Урожайность
5360 "area": 0, ~/~/ Площадь поля, Га
5361 "total": 0, ~/~/ Валовый сбор
5362 "productivityFact": 0, ~/~/ Фактическая урожайность
5363 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5364 "totalFact": 0, ~/~/ Фактический валовый сбор
5365 "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5366 "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5367 "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5368 "isyearplan": true, ~/~/ 
5369 "comment": "string" ~/~/ Комментарий
5370 }
5371 ],
5372 "cropVegetation": [ ~/~/ История вегетации поля
5373 {
5374 "values": [ ~/~/ Данные вегетации и состояния посева
5375 {
5376 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5377 "ndvi": 0 ~/~/ Индекс вегетации
5378 }
5379 ],
5380 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5381 {
5382 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5383 "type": "string", ~/~/ Тип
5384 "pictureid": "string" ~/~/ Идентификатор ресурса
5385 }
5386 ],
5387 "states": [ ~/~/ Ключевые даты развития поля 
5388 {
5389 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5390 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5391 }
5392 ]
5393 }
5394 ],
5395 "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5396 "counts": { 
5397 "fieldOperations": 0, ~/~/ Количество операций на поле
5398 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5399 "facts": 0 ~/~/ Счётчик факта
5400 },
5401 "planComment": "string", ~/~/ Комментарий к полю
5402 "productivity": 0, ~/~/ Урожайность.
5403 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5404 "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5405 "year": 0, ~/~/ Год поля
5406 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5407 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5408 "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5409 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5410 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5411 "id": 0, ~/~/ Идентификатор объекта геозоны
5412 "name": "string", ~/~/ Название объекта геозоны
5413 "type": 0, ~/~/ Тип объекта геозоны
5414 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5415 "fname": "string", ~/~/ Имя файла
5416 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5417 "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5418 "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5419 "description": "string", ~/~/ Описание объекта геозоны
5420 "area": 0, ~/~/ Площадь, м2
5421 "perimetr": 0, ~/~/ Периметр, м
5422 "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5423 }
5424 )))
5425 )))
5426 )))
5427 )))
5428 )))
5429
5430
5431 == **Редактирование года урожая ** ==
5432
5433 (% class="box successmessage" %)
5434 (((
5435 **POST /api/v3/agroLands/updateOpenCloseYear**
5436 )))
5437
5438 Пример запроса:
5439
5440 (((
5441 (((
5442 {
5443 "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5444 0
5445 ],
5446 "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5447 "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5448 }
5449 )))
5450
5451
5452 )))
5453
5454 Пример ответа:
5455
5456 (((
5457 (((
5458 {
5459 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5460 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5461 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5462 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5463 "cropRotations": [ ~/~/ Данные по севообороту
5464 {
5465 "landId": 0, ~/~/ ID поля
5466 "landName": "string", ~/~/ Название поля
5467 "year": 0, ~/~/ Год урожая
5468 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5469 "cultureName": "string", ~/~/ Название культуры
5470 "productivity": 0, ~/~/ Урожайность
5471 "area": 0, ~/~/ Площадь поля, Га.
5472 "total": 0, ~/~/ Валовый сбор
5473 "productivityFact": 0, ~/~/ Фактическая урожайность
5474 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5475 "totalFact": 0, ~/~/ Фактический валовый сбор
5476 "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5477 "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5478 "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5479 "isyearplan": true, ~/~/ 
5480 "comment": "string" ~/~/ Комментарий
5481 }
5482 ],
5483 "cropVegetation": [ ~/~/ История вегетации поля
5484 {
5485 "values": [ ~/~/ Данные вегетации и состояния посева
5486 {
5487 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5488 "ndvi": 0 ~/~/ Индекс вегетации
5489 }
5490 ],
5491 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5492 {
5493 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5494 "type": "string", ~/~/ Тип
5495 "pictureid": "string" ~/~/ Идентификатор ресурса
5496 }
5497 ],
5498 "states": [ ~/~/ Ключевые даты развития поля
5499 {
5500 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5501 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5502 }
5503 ]
5504 }
5505 ],
5506 "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5507 "counts": { 
5508 "fieldOperations": 0, ~/~/ Количество операций на поле
5509 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5510 "facts": 0 ~/~/ Счётчик факта
5511 },
5512 "planComment": "string", ~/~/ Комментарий к полю
5513 "productivity": 0, ~/~/ Урожайность.
5514 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5515 "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5516 "year": 0, ~/~/ Год поля
5517 "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5518 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5519 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5520 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5521 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5522 "id": 0, ~/~/ Идентификатор объекта геозоны
5523 "name": "string", ~/~/ Название объекта геозоны
5524 "type": 0, ~/~/ Тип объекта геозоны
5525 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5526 "fname": "string", ~/~/ Имя файла
5527 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5528 "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5529 "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5530 "description": "string", ~/~/ Описание объекта геозоны
5531 "area": 0, ~/~/ Площадь, м2
5532 "perimetr": 0, ~/~/ ериметр, м
5533 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5534 }
5535
5536
5537 == **Какие поля посещал объект** ==
5538
5539 (% class="box successmessage" %)
5540 (((
5541 **POST /api/v3/agroLands/visitingByVehicle**
5542 )))
5543
5544 Пример запроса:
5545
5546 {
5547 "vehicleId": 0, ~/~/ id объекта 
5548 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5549 "byTime": 0, ~/~/ Объединение событий по времени
5550 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5551 "byDist": 0, ~/~/ Объединение событий по расстоянию
5552 "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5553 "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5554 "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5555 }
5556
5557 Пример ответа:
5558
5559 [
5560 {
5561 "fieldId": 0, ~/~/ id объекта 
5562 "vehicleName": "string", ~/~/ Наименование объекта 
5563 "fieldName": "string", ~/~/ Наименование поля 
5564 "fuelUsage": 0, ~/~/ Расход топлива, л/га
5565 "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5566 "vehicleId": 0, ~/~/ Идентификатор ТС
5567 "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5568 "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5569 "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5570 "mileage": 0 ~/~/ Пробег 
5571 }
5572 ]
5573 )))
5574
5575
5576 == **Посещение поля объектами ** ==
5577
5578 (% class="box successmessage" %)
5579 (((
5580 **POST /api/v3/agroLands/visitingByField**
5581 )))
5582
5583 Пример запроса:
5584 {
5585 "fieldId": 0, ~/~/ ID поля
5586 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5587 "byTime": 0, ~/~/ Объединение событий по времени
5588 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5589 "byDist": 0, ~/~/ Объединение событий по расстоянию
5590 "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5591 "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5592 "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5593 }
5594
5595 Пример ответа:
5596
5597 [
5598 {
5599 "fieldId": 0, ~/~/ ID поля
5600 "vehicleName": "string", ~/~/ Наименование объекта 
5601 "fieldName": "string", ~/~/ Имя поля
5602 "fuelUsage": 0, ~/~/ Расход топлива, л/га
5603 "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5604 "vehicleId": 0, ~/~/ Идентификатор ТС
5605 "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5606 "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5607 "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5608 "mileage": 0 ~/~/ Пробег
5609 }
5610 ]
5611
5612
5613 == **Удаление существующего поля** ==
5614
5615 (% class="box errormessage" %)
5616 (((
5617 **DELETE /api/v3/agroLands/{id}**
5618 )))
5619
5620 Пример запроса:
5621 id  ~/~/ Идентификатор поля
5622
5623 Пример ответа:
5624
5625 (((
5626 200 ~/~/ Успех
5627
5628
5629 )))
5630
5631 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5632 )))
5633 )))
5634 )))
5635
5636 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5637
5638
5639 (% class="box infomessage" %)
5640 (((
5641 **GET api/v3/Vehicles/recyclebin/all**
5642 )))
5643
5644 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5645
5646 Параметр запроса: {parentId} - идентификатор агента
5647
5648 В заголовках запроса: X-Auth: Токен авторизации
5649
5650 Ответ:
5651
5652 [ 
5653 {
5654 "recordTime": "", ~/~/Время записи
5655 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5656 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5657 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5658 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5659 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5660 "details": { ~/~/Список деталей объекта, помещённого в корзину
5661 "items": [ ~/~/ 
5662 nullable: true ~/~/Детали
5663 {
5664 "name": "string", ~/~/наименование столбца
5665 "value": "string" ~/~/содержание столбца
5666 }
5667 ]
5668 },
5669 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5670 "string"
5671 ]
5672 }
5673 ]
5674
5675
5676 == (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5677
5678 (% class="box infomessage" %)
5679 (((
5680 **POST api/v3/Vehicles/recyclebin/erase**
5681 )))
5682
5683 В заголовках запроса: X-Auth: Токен авторизации
5684
5685 Пример запроса:
5686
5687 [
5688 0
5689 ]
5690
5691
5692 Пример ответа:
5693
5694 [ 
5695 {
5696 "recordTime": "", ~/~/Время записи
5697 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5698 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5699 "objectId": 0, ~/~/ID объекта, помещённого в корзин
5700 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5701 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5702 "details": { ~/~/Список деталей объекта, помещённого в корзину
5703 "items": [ ~/~/Детали
5704 {
5705 "name": "", ~/~/Имя свойства
5706 "value": "" ~/~/Значение свойства
5707 }
5708 ]
5709 },
5710 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5711 ""
5712 ]
5713 }
5714 ]
5715
5716 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5717
5718 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5719
5720 (% class="box infomessage" %)
5721 (((
5722 **POST api/v3/Vehicles/recyclebin/restore**
5723 )))
5724
5725 В заголовках запроса: X-Auth: Токен авторизации
5726
5727 Параметры в теле запроса (JSON):
5728
5729 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5730
5731 В заголовках запроса: X-Auth: Токен авторизации
5732
5733
5734 Пример запроса:
5735
5736 (((
5737 [
5738 )))
5739
5740 (((
5741 0
5742 )))
5743
5744 (((
5745 ]
5746 )))
5747
5748
5749 Пример ответа:
5750
5751 [
5752 {
5753 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5754 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5755 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5756 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5757 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5758 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5759 "details": { ~/~/Список деталей объекта, помещённого в корзину
5760 "items": [ ~/~/Детали
5761 {
5762 "name": "string", ~/~/Имя свойства
5763 "value": "string" ~/~/Значение свойства
5764 }
5765 ]
5766 },
5767 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5768 "string"
5769 ]
5770 }
5771 ]
5772
5773
5774 = **Раздел: Журнал заданий ** =
5775
5776
5777 == **Создание задания в Журнале заданий** ==
5778
5779 (% class="box infomessage" %)
5780 (((
5781 **POST /api/v3/vehicletasks**
5782 )))
5783
5784 Пример запроса:
5785
5786 (((
5787 {
5788 "vehicleId": 0, ~/~/ Идентификатор ТС
5789 "description": "string", ~/~/ Описание
5790 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5791 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5792 "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5793 "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5794 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5795 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5796 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5797 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5798 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5799 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5800 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5801 "cost": { 
5802 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5803 "Name": "string", ~/~/ Наименование
5804 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5805 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5806 "Norm": 0 ~/~/ Норма внесения
5807 },
5808 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5809 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5810 "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5811 "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5812 "deleted": true, ~/~/ Признак удаления
5813 "extId": "string", 
5814 "GeoIds": [ ~/~/ Cвязанные поля
5815 0
5816 ]
5817 }
5818 )))
5819
5820
5821 Пример ответа:
5822
5823 {
5824 "vehicleId": 0, ~/~/ Идентификатор ТС
5825 "description": "string", ~/~/ Описание
5826 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5827 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5828 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5829 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5830 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5831 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5832 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5833 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5834 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5835 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5836 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5837 "cost": { 
5838 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5839 "Name": "string", ~/~/ Наименование
5840 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5841 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5842 "Norm": 0 ~/~/ Норма внесения
5843 },
5844 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5845 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5846 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5847 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5848 "deleted": true, ~/~/ Признак удаления
5849 "extId": "string", ~/~/ ExtId
5850 "GeoIds": [ ~/~/ Связанные поля
5851 0
5852 ]
5853 }
5854
5855
5856 == **Редактирование задания в Журнале заданий** ==
5857
5858 (% class="box successmessage" %)
5859 (((
5860 **PUT /api/v3/vehicletasks**
5861 )))
5862
5863 Пример запроса:
5864
5865 (((
5866 {
5867 "vehicleId": 0, ~/~/ Идентификатор ТС
5868 "description": "string", ~/~/ Описание
5869 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5870 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5871 "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5872 "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5873 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5874 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5875 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5876 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5877 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5878 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5879 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5880 "cost": { 
5881 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5882 "Name": "string", ~/~/ Наименование
5883 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5884 "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5885 "Norm": 0 ~/~/ Норма внесения
5886 },
5887 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5888 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5889 "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5890 "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5891 "deleted": true, ~/~/ Признак удаления
5892 "extId": "string", ~/~/ ExtId
5893 "GeoIds": [ ~/~/ Связанные поля
5894 0
5895 ]
5896 }
5897 )))
5898
5899
5900 Пример ответа:
5901
5902 {
5903 "vehicleId": 0, ~/~/ Идентификатор ТС
5904 "description": "string", ~/~/ Описание
5905 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5906 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5907 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5908 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5909 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5910 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5911 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5912 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5913 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5914 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5915 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5916 "cost": { 
5917 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5918 "Name": "string", ~/~/ Наименование
5919 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5920 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5921 "Norm": 0 ~/~/ Норма внесения
5922 },
5923 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5924 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5925 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5926 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5927 "deleted": true, ~/~/ Признак удаления
5928 "extId": "string", ~/~/ ExtId
5929 "GeoIds": [ ~/~/ Связанные поля
5930 0
5931 ]
5932 }
5933
5934
5935 == **Удаление задания в Журнале заданий** ==
5936
5937 (% class="box warningmessage" %)
5938 (((
5939 **DELETE /api/v3/vehicletasks**
5940 )))
5941
5942 Пример запроса:
5943
5944 (((
5945 [
5946 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5947 ]
5948 )))
5949
5950 (((
5951
5952 )))
5953
5954 Пример ответа:
5955
5956 {
5957 "vehicleId": 0, ~/~/ Идентификатор ТС
5958 "description": "string", ~/~/ Описание
5959 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5960 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5961 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5962 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5963 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5964 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5965 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5966 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5967 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5968 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5969 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5970 "cost": { 
5971 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5972 "Name": "string", ~/~/ Наименование
5973 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5974 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5975 "Norm": 0 ~/~/ Норма внесения
5976 },
5977 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5978 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5979 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5980 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5981 "deleted": true, ~/~/ Признак удаления
5982 "extId": "string", ~/~/ ExtId
5983 "GeoIds": [ ~/~/ Связанные поля
5984 0
5985 ]
5986 }
5987
5988
5989 == **Получение списка Журнала заданий** ==
5990
5991 (% class="box infomessage" %)
5992 (((
5993 **POST /api/v3/vehicletasks/getbyperiod**
5994 )))
5995
5996 Пример запроса:
5997
5998 (((
5999 {
6000 "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
6001 "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
6002 "TimeZone": 0, ~/~/ Часовой пояс.
6003 "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
6004 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
6005 ],
6006 "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
6007 0
6008 ],
6009 "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
6010 0
6011 ],
6012 "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
6013 "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
6014 }
6015 )))
6016
6017
6018 Пример ответа:
6019
6020 (((
6021 {
6022 "total": 0,  ~/~/ Общее количество записей
6023 "pages": 0,  ~/~/ Общее количество страниц
6024 "currentPage": 0, ~/~/ Текущая страница
6025 "items": [  ~/~/ Записи 
6026 {
6027 "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6028 "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
6029 "name": "string", ~/~/ Название задания.
6030 "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
6031 "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
6032 "workKind": "string", ~/~/ Вид работ
6033 "techOp": "string", ~/~/ Тех. операция
6034 "trailerModel": "string", ~/~/ Модель агрегата
6035 "width": "string", ~/~/ Ширина, м
6036 "speed": "string", ~/~/ Тех. скорость
6037 "fields": "string", ~/~/ Поля
6038 "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
6039 "vehicles": "string", ~/~/ Объект-модель
6040 "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
6041 "drivers": "string", ~/~/ Водители
6042 "tmc": "string", ~/~/ ТМЦ
6043 "client": "string", ~/~/  Клиент
6044 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6045 "dep": "string", ~/~/ Подразделение
6046 "geoIds": [ ~/~/  Связанные поля
6047 0
6048 ]
6049 }
6050 ]
6051 }
6052 )))
6053
6054
6055 = **Раздел: Роли** =
6056
6057 == **Получение списка клиентских и системных ролей пользователя ** ==
6058
6059 (% class="box successmessage" %)
6060 (((
6061 **POST /api/v3/groups/find**
6062 )))
6063
6064 Пример запроса:
6065
6066 (((
6067 {
6068 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6069 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6070 }
6071 )))
6072
6073 (((
6074
6075 )))
6076
6077 (((
6078 Пример ответа:
6079 )))
6080
6081 (((
6082 (((
6083 {
6084 "groups": [  ~/~/ Системные роли пользователя
6085 {
6086 "code": "string", ~/~/ Код роли.
6087 "name": "string", ~/~/ Имя  
6088 "shortName": "string" ~/~/ Короткое имя 
6089 }
6090 ],
6091 "customGroups": [ ~/~/ Системные роли пользователя
6092 {
6093 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6094 "name": "string", ~/~/ Наименование 
6095 "shortName": "string", ~/~/ Короткое наименование 
6096 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6097 }
6098 ]
6099 }
6100 )))
6101 )))
6102
6103 (((
6104
6105 )))
6106
6107 (((
6108
6109 )))
6110
6111 = **Раздел: Локатор ** =
6112
6113
6114 == **Получение данных по локатору** ==
6115
6116 (% class="box infomessage" %)
6117 (((
6118 **GET /api/v3/locators/{locatorId}**
6119 )))
6120
6121 В запросе указывается locatorid - идентификатор локатора
6122
6123
6124 Пример ответа:
6125
6126 (((
6127 (((
6128 {
6129 "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6130 0
6131 ],
6132 "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6133 0
6134 ],
6135 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6136 0
6137 ],
6138 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6139 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6140 "agentName": "string", ~/~/ Наименование агента.
6141 "isEnabled": true, ~/~/ Активность 
6142 "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6143 "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6144 "name": "string", ~/~/ Наименование.
6145 "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6146 "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6147 "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6148 "validity": 0, ~/~/ Значение срока действия
6149 "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6150 "autoProlongation": true, ~/~/ Автопродление срока действия.
6151 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6152 "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6153 "url": "string", ~/~/ Ссылка
6154 "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6155
6156 "showVehicleName": true, ~/~/ Наименование объекта
6157 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6158 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6159 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6160 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6161 "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6162
6163 1
6164
6165 ]
6166 }
6167 )))
6168 )))
6169
6170
6171 (((
6172 (((
6173
6174 )))
6175 )))
6176
6177
6178 == **Создание локатора** ==
6179
6180 (% class="box successmessage" %)
6181 (((
6182 **POST /api/v3/locators**
6183 )))
6184
6185 Пример запроса:
6186
6187 (((
6188 {
6189 "isEnabled": true, ~/~/ Активность
6190 "name": "string", ~/~/ Наименование локатора
6191 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
6192 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
6193 "validity": 0, ~/~/ Срок действия в днях (1-90)
6194 "autoProlongation": true, ~/~/ Автопродление срока действия.
6195 "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6196 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6197 "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6198 0
6199 ],
6200 "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6201 0
6202 ],
6203 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6204 0
6205 ],
6206
6207 "showVehicleName": true, ~/~/ Наименование объекта
6208 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6209 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6210 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6211 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6212 "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6213
6214 1
6215
6216 ]
6217 }
6218 )))
6219
6220
6221 Пример ответа:
6222
6223 (((
6224 3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
6225 )))
6226
6227
6228 == **Выводит список локаторов ** ==
6229
6230 (% class="box successmessage" %)
6231 (((
6232 **POST /api/v3/locators/find**
6233 )))
6234
6235 Пример запроса:
6236
6237 (((
6238 {
6239 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6240 }
6241 )))
6242
6243 (((
6244
6245 )))
6246
6247 (((
6248
6249 )))
6250
6251
6252 Пример ответа:
6253
6254 (((
6255 [
6256 {
6257 "vehiclesCount": 0, ~/~/ Количество объектов.
6258 "geozonesCount": 0, ~/~/ Количество геозон.
6259 "fieldsCount": 0, ~/~/ Количество полей.
6260 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6261 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6262 "agentName": "string", ~/~/ Наименование агента.
6263 "isEnabled": true, ~/~/ Активность локатора
6264 "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6265 "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6266 "name": "string", ~/~/ Наименование локатора 
6267 "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6268 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6269 "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6270 "validity": 0, ~/~/ Срок действия в днях (1-90)
6271 "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6272 "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6273 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6274 "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6275 "url": "string", ~/~/ ссылка на локатор 
6276 "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6277 "showVehicleName": true, ~/~/ Наименование объекта
6278 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6279 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6280 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6281 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6282 "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6283
6284 0
6285 ]
6286 }
6287 ]
6288 )))
6289
6290
6291 == **Изменение локатора** ==
6292
6293 (% class="box infomessage" %)
6294 (((
6295 **PUT /api/v3/locators**
6296 )))
6297
6298 Пример запроса:
6299
6300 (((
6301 {
6302 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6303 "isEnabled": true, ~/~/ Активность 
6304 "name": "string", ~/~/ Наименование
6305 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6306 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6307 "validity": 0, ~/~/ Срок действия в днях (1-90)
6308 "autoProlongation": true, ~/~/ Автопродление срока действия
6309 "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6310 "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6311 0
6312 ],
6313 "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6314 0
6315 ],
6316 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6317 0
6318 ],
6319 "showVehicleName": true, ~/~/ Наименование объекта
6320 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6321 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6322 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6323 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6324 "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС)
6325
6326 0
6327
6328 ]
6329 }
6330
6331
6332 )))
6333
6334 Пример ответа:
6335
6336 200 ~/~/ Success
6337
6338
6339 == **Удалить локатор** ==
6340
6341 (% class="box warningmessage" %)
6342 (((
6343 **DELETE /api/v3/locators**
6344 )))
6345
6346 Пример запроса:
6347
6348 (((
6349 [
6350 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6351 ]
6352 )))
6353
6354
6355 = **Раздел: Яндекс Маршруты** =
6356
6357
6358 == **Возвращение списка маршрутов** ==
6359
6360 (% class="box infomessage" %)
6361 (((
6362 **GET /api/v3/TransportRoutes**
6363 )))
6364
6365 Пример запроса:
6366 Id  ~/~/ Идентификатор поля
6367
6368 Пример ответа:
6369
6370 (((
6371 [
6372 {
6373 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6374 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6375 "name": "string", ~/~/ Наименование маршрута.
6376 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6377 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6378 0
6379 ]
6380 }
6381 ]
6382 )))
6383
6384
6385 == **Добавить маршрут** ==
6386
6387 (% class="box infomessage" %)
6388 (((
6389 **POST /api/v3/TransportRoutes**
6390 )))
6391
6392 Пример запроса: 
6393 {
6394 "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6395 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6396 "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6397 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6398 0
6399 ]
6400 }
6401
6402
6403 Пример ответа:
6404
6405 (((
6406 {
6407 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6408 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6409 "name": "string", ~/~/ Определяет наименование маршрута 
6410 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6411 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6412 0
6413 ]
6414 }
6415 )))
6416
6417
6418 == **Обновление маршрута** ==
6419
6420 (% class="box successmessage" %)
6421 (((
6422 **PUT /api/v3/TransportRoutes**
6423 )))
6424
6425 Пример запроса:
6426
6427 (((
6428 {
6429 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6430 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6431 "name": "string", ~/~/ Опредлеляет наименование маршрута.
6432 "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6433 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6434 0
6435 ]
6436 }
6437 )))
6438
6439 Пример ответа:
6440
6441 (((
6442 {
6443 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6444 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6445 "name": "string", ~/~/ Определяет наименование маршрута 
6446 "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6447 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6448 0
6449 ]
6450 }
6451 )))
6452
6453
6454 == **Получить связки маршрутов ТС** ==
6455
6456 (% class="box infomessage" %)
6457 (((
6458 **POST /api/v3/TransportRoutes/getroutesvehicles**
6459 )))
6460
6461 Пример запроса:
6462
6463 (((
6464 [
6465 "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6466 ]
6467 )))
6468
6469 Пример ответа:
6470
6471 (((
6472 [
6473 {
6474 "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6475 "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6476 }
6477 ]
6478 )))
6479
6480
6481 == **Удалить маршрут** ==
6482
6483 (% class="box warningmessage" %)
6484 (((
6485 **DELETE /api/v3/TransportRoutes/{id}**
6486 )))
6487
6488 Пример запроса:
6489 Id  ~/~/ Идентификатор поля
6490
6491
6492 = **Раздел: Управление доступа к машинам** =
6493
6494
6495 == Получение списка транспортных средств видимых пользователю ==
6496
6497 (% class="box infomessage" %)
6498 (((
6499 **GET /api/v3/UserVisibleVehicles/{userId}**
6500 )))
6501
6502 Пример ответа:
6503
6504 (((
6505 {
6506 "vehicleIds": [  ~/~/ Идентификаторы ТС
6507 0
6508 ]
6509 }
6510 )))
6511
6512
6513 == Задает видимость транспортных средств пользователю ==
6514
6515 (% class="box infomessage" %)
6516 (((
6517 **POST /api/v3/UserVisibleVehicles**
6518 )))
6519
6520 Пример запроса:
6521
6522 (((
6523 (((
6524 {
6525 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6526 "vehicleIds": [ ~/~/ Идентификаторы ТС
6527 0
6528 ]
6529 }
6530 )))
6531
6532 (((
6533
6534 )))
6535
6536 (((
6537 Пример ответа :
6538 )))
6539
6540 (((
6541
6542 )))
6543
6544 (((
6545 200 ~/~/ Success
6546 )))
6547 )))
6548
6549
6550 (% class="box" lang="en-US" style="text-align: center;" %)
6551 (((
6552 (% 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]] **
6553 )))

Меню

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