Version 252.1 by Андрей Калиновский on 2025/07/29 15:41
Show last authors
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 = =
748
749 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
750
751 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
752
753 (% class="box infomessage" %)
754 (((
755 (% lang="en-US" %)**GET /api/v3/models/{Id}**
756 )))
757
758 Метод возвращает полную информацию о модели объекта.
759
760 (% style="color:#000000" %)Метод запроса: **GET**
761
762 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
763
764 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
765
766 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
767
768 (% style="color:#000000" %)Ответ:
769
770 (% style="color:#000000" %){
771 "parentName": "string",
772 "name": "string",
773 "picture": "string",
774 "minspeed": 0,
775 "maxspeed": 0,
776 "width": 0,
777 "imbeddedtrailer": true,
778 "hoppercapacity": 0,
779 "hopperdischargespeed": 0,
780 "modelType": 0,
781 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
782 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
783 "deleted": true
784 }
785
786 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
787 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
788 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
789 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
790 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
791 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
792 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
793 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
794 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
795 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
796 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
797 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
798 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
799 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
800
801 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
802
803 (% class="box successmessage" %)
804 (((
805 (% lang="en-US" %)**POST /api/v3/models/find**
806 )))
807
808 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
809
810 (% style="color:#000000" %)Метод запроса: **POST**
811
812 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
813
814 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
815
816 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
817
818 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
819 }
820
821 (% style="color:#000000" %)Ответ:
822
823 (% style="color:#000000" %)[
824 {
825 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
826 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
827 "parentName": "string",
828 "name": "string",
829 "modelType": 0
830 }
831 ]
832
833 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
834 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
835 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
836 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
837 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
838 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
839
840 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
841
842 (% class="box successmessage" %)
843 (((
844 (% lang="en-US" %)**POST /api/v3/models**
845 )))
846
847 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
848
849 (% style="color:#000000" %)Метод запроса: **POST**
850
851 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
852
853 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
854
855 (% style="color:#000000" %)Параметры в теле запроса (JSON):
856
857 {
858 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
859 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
860 "deleted": false,
861 "extId": "string",
862 "name": "string",
863 "picture": "string",
864 "minspeed": 0,
865 "maxspeed": 0,
866 "width": 0,
867 "imbeddedtrailer": true,
868 "fueloutlay": 0,
869 "hoppercapacity": 0,
870 "hopperdischargespeed": 0,
871 "modelType": 0
872 }
873
874 Ответ:
875
876 {
877 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
878 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
879 "deleted": false,
880 "extId": "string",
881 "name": "string",
882 "picture": "string",
883 "minspeed": 0,
884 "maxspeed": 0,
885 "width": 0,
886 "imbeddedtrailer": true,
887 "hoppercapacity": 0,
888 "hopperdischargespeed": 0,
889 "modelType": 0
890 }
891
892 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
893 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
894 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
895 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
896 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
897 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
898 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
899 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
900 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
901 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
902 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
903 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
904 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
905
906 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
907
908 (% class="box warningmessage" %)
909 (((
910 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
911 )))
912
913 (% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
914
915 (% style="color:#000000" %)Метод запроса: **PUT**
916
917 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
918
919 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
920
921 (% style="color:#000000" %)Параметры в теле запроса (JSON):
922
923 {
924 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
925 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
926 "deleted": true,
927 "extId": "string",
928 "name": "string",
929 "picture": "string",
930 "minspeed": 0,
931 "maxspeed": 0,
932 "width": 0,
933 "imbeddedtrailer": true,
934 "fueloutlay": 0,
935 "hoppercapacity": 0,
936 "hopperdischargespeed": 0,
937 "modelType": 0
938 }
939
940 Ответ:
941
942 {
943 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
944 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
945 "deleted": true,
946 "extId": "string",
947 "name": "string",
948 "picture": "string",
949 "minspeed": 0,
950 "maxspeed": 0,
951 "width": 0,
952 "imbeddedtrailer": true,
953 "fueloutlay": 0,
954 "hoppercapacity": 0,
955 "hopperdischargespeed": 0,
956 "modelType": 0
957 }
958
959 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
960 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
961 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
962 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
963 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
964 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
965 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
966 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
967 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
968 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
969 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
970 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
971 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
972
973 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
974
975 (% class="box errormessage" %)
976 (((
977 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
978 )))
979
980 (% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
981
982 (% style="color:#000000" %)Метод запроса: **DELETE**
983
984 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
985
986 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
987
988 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
989
990 Ответ: В случае успеха **Success 200**
991
992 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
993
994 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
995
996 (% class="box infomessage" %)
997 (((
998 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
999 )))
1000
1001 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1002
1003 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1004
1005 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1006
1007 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1008
1009 (% style="color:#000000" %)Метод запроса: **GET**
1010
1011 (% 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}
1012
1013 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1014
1015 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1016
1017 (% style="color:#000000" %)Ответ:
1018
1019 (((
1020 {
1021
1022 (((
1023 "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1024 "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1025 )))
1026
1027 (((
1028 ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1029 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1030 )))
1031
1032 "vehicleId": "", ~/~/ ID объекта
1033 "name": "", ~/~/ Имя объекта
1034 "imei": "", ~/~/ IMEI объекта
1035 "deviceTypeId": , ~/~/ ID типа устройства
1036 "deviceTypeName": "", ~/~/ Название типа устройства
1037 "sim1": "", ~/~/ Номер SIM1
1038 "sim2": "", ~/~/ Номер SIM2
1039 "parentId": "", ~/~/ ID клиента-родителя
1040 "parentName": "", ~/~/ Наименование клиента-родителя
1041 "modelId": "", ~/~/ ID модели объекта
1042 "modelName": "", ~/~/ Имя модели объекта
1043 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1044 "unitName": "string", ~/~/ Наименование подразделения
1045 "status": 0, ~/~/ Статус объекта
1046 "createdAt": "", ~/~/ Дата создания объекта
1047 },
1048 "customFields": [ ~/~/ Произвольные поля
1049 {
1050 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1051 "name": "string", ~/~/ Имя поля
1052 "value": "string", ~/~/ Значение поля
1053 "forClient": true, ~/~/ Не используемая функция
1054 "forTooltip": true, ~/~/ Отображать в подсказке
1055 "forReport": true ~/~/ Отображать в отчете
1056 }
1057
1058 ], ~/~/ Данные с вкладки нормы
1059 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1060 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1061 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1062 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1063 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1064 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1065 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1066 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1067 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1068 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1069 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1070 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1071 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1072 "mileageCoeff": 0, ~/~/ коэффициент пробега
1073 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1074 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1075 "counters": { ~/~/ Счетчики
1076 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1077 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1078 "mileage": 0, ~/~/ Текущий пробег
1079 "motohours": 0, ~/~/ Текущие моточасы
1080 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1081 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1082 },
1083
1084 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1085 "id": "string", ~/~/ ID объекта
1086 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1087 "host": "string", ~/~/ CMSV6 Web Host
1088 "login": "string", ~/~/ CMSV6 Account
1089 "password": "string" ~/~/ CMSV6 Password
1090 },
1091
1092 "commandTemplates": [ ~/~/ Шаблоны команд
1093 {
1094 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1095 "name": "string", ~/~/ Наименование команды
1096 "command": "string", ~/~/ Текст команды
1097 "retries": 0 ~/~/ Количество попыток
1098 }
1099 ],
1100 "sensors": [ ~/~/ Датчики
1101 {
1102 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1103 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1104 "type": 0, ~/~/ Тип датчика
1105 "name": "string", ~/~/ Имя датчика
1106 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1107 "inputNumber": 0, ~/~/ Номер входа
1108 "pseudonym": "string", ~/~/ Псевдоним
1109 "medianDegree": 0, ~/~/ Медианная фильтрация
1110 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1111 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1112 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1113 "gradesTables": [ ~/~/ Массив таблиц тарировки
1114 {
1115 "grades": [ ~/~/ Таблица тарировки 1
1116 {
1117 "input": 0, ~/~/ Входящее значение
1118 "output": 0 ~/~/ Выходящее значение
1119 }
1120 ],
1121 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1122 }
1123 ],
1124 "showInTooltip": true, ~/~/ Отображать в подсказке
1125 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1126 "color": "string", ~/~/ Код цвета датчиков
1127 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1128 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1129 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1130 "expr": "string", ~/~/ Формула
1131 "children": [ ~/~/ массив дочерних датчиков
1132 "string"
1133 ],
1134 "customParams": { ~/~/ прочие произвольные параметры
1135 "additionalProp1": "string",
1136 "additionalProp2": "string",
1137 "additionalProp3": "string"
1138 },
1139
1140 ~/~/ Характерные для произвольного:
1141 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1142 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1143 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1144 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1145 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1146 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1147 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1148 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1149 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1150 ~/~/ "ValueOn": "Вкл.",
1151 ~/~/ "ValueOff": "Выкл."
1152 "summaryMaxValue": 0 ~/~/ Макс. значение
1153 }
1154 "drivers": [ ~/~/ Водители
1155 {
1156 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1157 "name": "string", ~/~/ Наименование
1158 "description": "string",
1159 "isDefault": true ~/~/ По умолчанию
1160 }
1161 ],
1162 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1163 {
1164 "id": "", ~/~/ ID  задания
1165 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1166 "name": "", ~/~/ Наименование задания
1167 "description": "", ~/~/ Описание задания
1168 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1169 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1170 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1171 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1172 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1173 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1174 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1175 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1176 }
1177 ],
1178 "statusHistory": [ ~/~/ История статусов
1179 {
1180 "status": 0,
1181 "date": "2023-05-22T09:57:39.562Z",
1182 "description": "string",
1183 "additionalInfo": "string"
1184
1185 (((
1186 }
1187 ],
1188 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1189 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1190 )))
1191
1192 (((
1193 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1194 }
1195
1196 )))
1197 )))
1198
1199 (% style="text-align:left" %)
1200 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1201
1202 (% style="text-align:left" %)
1203 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1204
1205
1206 == **Отправить команду на терминал** ==
1207
1208 (% class="box successmessage" %)
1209 (((
1210 (% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1211 )))
1212
1213 Команда для отправки на тс.
1214
1215 {  
1216 "id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1217 "command": "", ~/~/ Текст отправляемой команды
1218 "retries": "", ~/~/ Количество попыток отправки на терминал
1219 "idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1220 }
1221
1222 В ответ получаем cmdid
1223
1224
1225 == **Получить ответ на отправленную на ТС команду** ==
1226
1227 (% class="box infomessage" %)
1228 (((
1229 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1230 )))
1231
1232 Идентификатор команды: cmdId
1233
1234 Запрос от терминала на ответ команды
1235
1236 Пример ответ от терминала:
1237
1238 ID= "" ~/~/ идентификатор объекта
1239 Soft="" ~/~/ версия софта
1240 GPS=4 ~/~/ тип трекера
1241 Time=11:05:43 28.06.24 ~/~/ время запроса
1242 Lat=45.056221 ~/~/ широта
1243 Lon=39.035938 ~/~/ долгота
1244 Speed=0.0 ~/~/ скорость
1245 Course=181.4 ~/~/направление
1246
1247 (((
1248 == **Список отправленных объекту команд с ответами** ==
1249
1250 (% class="box infomessage" %)
1251 (((
1252 (% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1253 )))
1254
1255 Идентификатор ТС: vehicleId
1256
1257 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1258
1259 Пример ответа терминала
1260
1261 [ 
1262 {    
1263 "id": "", ~/~/ идентификатор пользователя
1264 "commandText": "", ~/~/Текст команды.
1265 "templateId": "", ~/~/Идентификатор шаблона
1266 "updated": "", ~/~/ Время отправки  
1267 "tryCount": 0, ~/~/ Количество попыток отправки команды
1268 "answer": "", ~/~/ Ответ терминала.
1269 "status": "" ~/~/ Статус отправки
1270 }
1271 ]
1272 )))
1273
1274 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1275
1276 (% class="box successmessage" %)
1277 (((
1278 (% lang="en-US" %)**POST /api/v3/vehicles**
1279 )))
1280
1281 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1282
1283 (% style="color:#000000" %)Метод запроса: **POST**
1284
1285 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1286
1287 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1288
1289 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1290
1291 (% style="color:#000000" %){
1292
1293
1294 (((
1295 "vehicleId": 0, ~/~/ ID ТС
1296 )))
1297
1298 "parentId": "" , ~/~/ ID клиента
1299 "name": "" , ~/~/ имя ТС
1300 "imei": "" , ~/~/ IMEI
1301 "deviceTypeId": "" , ~/~/ ID типа устройства
1302 "modelId": "" , ~/~/ ID модели
1303 "unitId": "" , ~/~/ ID подразделения
1304 "sim1": "" , ~/~/ Номер SIM 1
1305 "sim2": "" , ~/~/ Номер SIM2
1306 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1307 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1308 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1309 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1310 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1311 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1312 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1313 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1314 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1315 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1316 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1317 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1318 "mileageCalcMethod": 0,
1319 "mileageCoeff": 0,
1320 "locationByCellId": true,
1321 "dottedLineTrackWhenNoCoords": true,
1322 "counters": ~/~/ счетчики
1323 {
1324 "mileage": "" , ~/~/ пробег
1325 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1326 "motohours": "" , ~/~/ моточасы
1327 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1328 },
1329 "cmsv6Parameters": { ~/~/ параметры CMSv6
1330 "enabled": true, ~/~/ флаг включения
1331 "id": "" , ~/~/ идентификатор
1332 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1333 "login": "" , ~/~/ имя учетной записи
1334 "password": "" ~/~/ пароль учетной записи
1335 },
1336 "inspectionTasks": ~/~/ задания на ТО
1337 {
1338 "enabled": "" , ~/~/ Признак включения
1339 "name": "" , ~/~/ Имя задания
1340 "description": "" , ~/~/ Описание задания
1341 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1342 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1343 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1344 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1345 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1346 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1347 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1348 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1349 }
1350 "drivers": [ ~/~/ Водители
1351 {
1352 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1353 "isDefault": true
1354 }
1355 ],
1356 "commandTemplates": [ ~/~/ Шаблон команды
1357 {
1358 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1359 "name": "string",
1360 "command": "string",
1361 "retries": 0
1362 }
1363 ],
1364 "sensors": [ ~/~/ Датчики
1365 {
1366 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1367 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1368 "type": 0, ~/~/ Тип датчика
1369 "name": "string", ~/~/ Имя датчика
1370 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1371 "inputNumber": 0, ~/~/ Номер входа
1372 "pseudonym": "string", ~/~/ Псевдоним
1373 "medianDegree": 0, ~/~/ Медианная фильтрация
1374 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1375 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1376 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1377 "gradesTables": [ ~/~/ Массив таблиц тарировки
1378 {
1379 "grades": [ ~/~/ Таблица тарировки 1
1380 {
1381 "input": 0, ~/~/ Входящее значение
1382 "output": 0 ~/~/ Выходящее значение
1383 }
1384 ],
1385 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1386 }
1387 ],
1388 "showInTooltip": true, ~/~/ Отображать в подсказке
1389 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1390 "color": "string", ~/~/ код цвета датчиков
1391 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1392 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1393 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1394 "expr": "string", ~/~/ Формула
1395 "children": [ ~/~/ массив дочерних датчиков
1396 "string"
1397 ],
1398 "customParams": { ~/~/ прочие произвольные параметры
1399 "additionalProp1": "string",
1400 "additionalProp2": "string",
1401 "additionalProp3": "string"
1402 },
1403 ~/~/ Характерные для произвольного:
1404 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1405 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1406 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1407 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1408 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1409 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1410 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1411 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1412 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1413 ~/~/ "ValueOn": "Вкл.",
1414 ~/~/ "ValueOff": "Выкл."
1415 "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1416
1417 (((
1418 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1419 {
1420 "from": 0, ~/~/ С какого значения
1421 "color": "string", ~/~/ Каким цветом
1422 "text": "string" ~/~/ Текст подписи к этому интервалу
1423 }
1424 ]
1425 }
1426 ],
1427 )))
1428
1429 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1430
1431
1432 "customFields": [ ~/~/ Произвольные поля
1433 {
1434 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1435 "name": "string", ~/~/ Наименование произвольного поля
1436 "value": "string", ~/~/ Значение произвольного поля
1437 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1438 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1439 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1440
1441 (((
1442 }
1443 ],
1444 "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1445 )))
1446
1447 (((
1448 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1449 }
1450 )))
1451
1452
1453 (% style="color:#000000" %)Ответ:
1454
1455
1456 (((
1457 (((
1458 (((
1459 {
1460 "vehicleId": 0,  ~/~/ ID ТС
1461 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1462 "name": "string", ~/~/ Имя объекта
1463 "imei": "string", ~/~/ IMEI
1464 "deviceTypeId": 0, ~/~/ ID типа устройства
1465 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1466 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1467 "sim1": "string", ~/~/ SIM1
1468 "sim2": "string", ~/~/ SIM2
1469 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1470 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1471 "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1472 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1473 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1474 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1475 "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1476 "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1477 "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1478 "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1479 "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1480 "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1481 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1482 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1483 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1484 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1485 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1486 "counters": {  ~/~/ Dto для состояний счётчиков
1487 "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1488 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1489 "mileage": 0, ~/~/ Пробег
1490 "motohours": 0 ~/~/ Моточасы
1491 },
1492 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1493 "id": "string", ~/~/ CMSV6 Идентификатор
1494 "enabled": true, ~/~/ Признак включения
1495 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1496 "login": "string", ~/~/ CMSV6 имя учетной записи
1497 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1498 },
1499 "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1500 {
1501 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1502 "enabled": true, ~/~/ Признак включения
1503 "name": "string", ~/~/ Имя задания
1504 "description": "string", ~/~/ Описание задания
1505 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1506 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1507 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1508 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1509 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1510 "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1511 "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1512 "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1513 }
1514 ],
1515 "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1516 {
1517 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1518 "inputNumber": 0, ~/~/ № входа.
1519 "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1520 "comment": "string", ~/~/ Комментарий
1521 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1522 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1523 "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1524 "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1525 }
1526 ],
1527 "commandTemplates": [  ~/~/ Список шаблонов команд
1528 {
1529 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1530 "name": "string", ~/~/ Название шаблона команд
1531 "command": "string", ~/~/ Команда на выполнение
1532 "retries": 0 ~/~/ Лимит попыток отправки
1533 }
1534 ],
1535 "sensors": [ ~/~/ Список датчиков
1536 {
1537 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1538 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1539 "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
1540 "name": "string",  ~/~/ Имя датчика
1541 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1542 "inputNumber": 0, ~/~/ Номер входа
1543 "pseudonym": "string", ~/~/ Псевдоним
1544 "medianDegree": 0, ~/~/ Степень медианной фильтрации
1545 "isInverted": true, ~/~/  Признак инверсии
1546 "disabled": true, ~/~/ Датчик не участвует в обработке
1547 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1548 "gradesTables": [ ~/~/ Тарировка
1549 {
1550 "grades": [ ~/~/ Таблицы тарировки
1551 {
1552 "input": 0, ~/~/ Вход
1553 "output": 0 ~/~/ Выход
1554 }
1555 ],
1556 "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1557 }
1558 ],
1559 "showInTooltip": true, ~/~/ Отображение в подсказке
1560 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1561 "color": "string", ~/~/ код цвета датчиков
1562 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1563 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1564 "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1565 "expr": "string", ~/~/ Выражение
1566 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1567 "string"
1568 ],
1569 "customParams": {
1570 "additionalProp1": "string",
1571 "additionalProp2": "string",
1572 "additionalProp3": "string"
1573 },
1574 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1575 "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1576 {
1577 "from": 0, ~/~/ С какого значения
1578 "color": "string", ~/~/ Каким цветом
1579 )))
1580
1581 (((
1582 "text": "string" ~/~/ Текст подписи к этому интервалу
1583 }
1584 ]
1585 }
1586 ],
1587 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1588 "customFields": [ ~/~/ Список произвольных полей
1589 {
1590 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1591 "name": "string", ~/~/ Наименование произвольного поля
1592 "value": "string", ~/~/ Значение произвольного поля
1593 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1594 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1595 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1596 }
1597 ],
1598 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1599 }
1600 )))
1601 )))
1602 )))
1603
1604
1605 **Валидация:**
1606 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1607 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1608 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1609
1610
1611 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1612
1613 (% class="box infomessage" %)
1614 (((
1615 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1616 )))
1617
1618 (% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1619
1620 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1621
1622 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1623
1624 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1625
1626 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1627
1628 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1629
1630 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1631
1632 (% style="color:#000000" %)Метод запроса: **POST**
1633
1634 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1635
1636 (% style="color:#000000" %)В заголовках запроса:
1637
1638 (% style="color:#000000" %)− Content-Type: __**application/json**__
1639
1640 (% style="color:#000000" %)− X-Auth: Токен авторизации
1641
1642 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1643
1644 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1645
1646 {
1647 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1648 "name": null, ~/~/ Имя ТС (string, опционально)
1649 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1650 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1651 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1652 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1653 "unitName": "string",  ~/~/ Название подразделения (опционально)
1654 "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1655 "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1656 "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1657 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1658 }
1659
1660 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1661
1662 (% style="color:#000000" %)Ответ:
1663
1664 (% style="color:#000000" %)[
1665 {
1666
1667 (((
1668 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1669 )))
1670
1671 (((
1672 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1673 "name": "" ~/~/ наименование объекта
1674 "imei": "" ~/~/ IMEI объекта
1675 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1676 "deviceTypeName": "" ~/~/ наименование типа устройства
1677 "sim1": "" ~/~/ первый номер телефона
1678 "sim2": "" ~/~/ второй номер телефона
1679 "parentId": "" ~/~/ идентификатор клиента-родителя
1680 "parentName": "" ~/~/ наименование клиента-родителя
1681 "modelId": "" ~/~/ идентификатор модели объекта
1682 "modelName": "" ~/~/ наименование модели объекта
1683 "unitId": "" ~/~/ идентификатор подразделения
1684 "unitName": "" ~/~/ наименование подразделения
1685 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1686 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1687 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1688 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1689 "customFields": [ 
1690 {
1691 "id": "", ~/~/ идентификатор произвольного поля
1692 "name": "", ~/~/ имя произвольного поля
1693 "value": "", ~/~/ значение произвольного поля
1694 "forClient": true, ~/~/ право на отображение у клиента
1695 "forTooltip": false, ~/~/ право на отображение в подсказке
1696 "forReport": false ~/~/ право на отображение в отчетах
1697 )))
1698
1699 (((
1700 }
1701 ],
1702 "vehicleGroups": [  ~/~/ Группы ТС
1703 {
1704 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1705 "name": "string" ~/~/ Наименование группы ТС
1706 }
1707 ]
1708 }
1709 ]
1710 )))
1711
1712 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1713
1714 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1715
1716 (% class="box successmessage" %)
1717 (((
1718 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1719 )))
1720
1721 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1722
1723 (% style="color:#000000" %)Метод запроса: **POST**
1724
1725 (% 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}
1726
1727 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1728
1729 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1730
1731 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1732
1733 (% style="color:#000000" %){
1734
1735 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1736 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1737 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1738 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1739 "description": "", ~/~/ Описание
1740 "data": "", ~/~/ Данные
1741 "overwrite": false, ~/~/ Флаг перезаписи
1742 "stage": "", ~/~/ Состояние, может быть null
1743 (% style="color:#000000" %)}
1744
1745 (% style="color:#000000" %)Ответ:
1746
1747 (% style="color:#000000" %){(%%)
1748 "status": "", ~/~/ значение статуса
1749 "date": "", ~/~/ Дата смены статуса 
1750 "description": "", ~/~/ Описание
1751 "data": "", ~/~/ Данные
1752 "overwrite": false, ~/~/ Флаг перезаписи
1753 "stage": "", ~/~/ Состояние
1754 (% style="color:#000000" %) }
1755
1756
1757 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1758
1759 (% class="box warningmessage" %)
1760 (((
1761 (% lang="en-US" %)**PUT /api/v3/vehicles**
1762 )))
1763
1764 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1765
1766 (% style="color:#000000" %)Метод запроса: **PUT**
1767
1768 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1769
1770 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1771
1772 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1773
1774 (% style="color:#000000" %){
1775 "vehicleId": , ~/~/ ID объекта
1776 "parentId": "" , ~/~/ ID клиента
1777 "name": "" , ~/~/ имя ТС
1778 "imei": "" , ~/~/ IMEI
1779 "deviceTypeId": "" , ~/~/ ID типа устройства
1780 "modelId": "" , ~/~/ ID модели
1781 "unitId": "" , ~/~/ ID подразделения
1782 "sim1": "" , ~/~/ Номер SIM 1
1783 "sim2": "" , ~/~/ Номер SIM2
1784 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1785 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1786 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1787 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1788 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1789 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1790 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1791 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1792 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1793 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1794 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1795 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1796
1797 "mileageCalcMethod": 0,
1798 "mileageCoeff": 0,
1799 "locationByCellId": true,
1800 "dottedLineTrackWhenNoCoords": true,
1801 "counters": ~/~/ счетчики
1802 {
1803 "mileage": "" , ~/~/ пробег
1804 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1805 "motohours": "" , ~/~/ моточасы
1806 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1807 },
1808 "cmsv6Parameters": { ~/~/ параметры CMSv6
1809 "enabled": true, ~/~/ флаг включения
1810 "id": "" , ~/~/ идентификатор
1811 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1812 "login": "" , ~/~/ имя учетной записи
1813 "password": "" ~/~/ пароль учетной записи
1814 },
1815 "inspectionTasks": ~/~/ задания на ТО
1816 {
1817 "enabled": "" , ~/~/ Признак включения
1818 "name": "" , ~/~/ Имя задания
1819 "description": "" , ~/~/ Описание задания
1820 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1821 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1822 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1823 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1824 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1825 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1826 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1827 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1828 }
1829
1830 "drivers": [ ~/~/ Водители
1831 {
1832
1833 (((
1834 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1835 "inputNumber": 0, ~/~/ № входа.
1836 "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1837 "comment": "string", ~/~/ Комментарий.
1838 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1839 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1840 "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1841 "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1842 )))
1843
1844 } 
1845 ],
1846 "commandTemplates": [ ~/~/ Шаблон команды
1847 {
1848 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1849 "name": "string",
1850 "command": "string",
1851 "retries": 0
1852 }
1853 ],
1854 "sensors": [ ~/~/ Датчики
1855 {
1856 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1857 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1858 "type": 0, ~/~/ Тип датчика
1859 "name": "string", ~/~/ Имя датчика
1860 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1861 "inputNumber": 0, ~/~/ Номер входа
1862 "pseudonym": "string", ~/~/ Псевдоним
1863 "medianDegree": 0, ~/~/ Медианная фильтрация
1864 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1865 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1866 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1867 "gradesTables": [ ~/~/ Массив таблиц тарировки
1868 {
1869 "grades": [ ~/~/ Таблица тарировки 1
1870 {
1871 "input": 0, ~/~/ Входящее значение
1872 "output": 0 ~/~/ Выходящее значение
1873 }
1874 ],
1875 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1876 }
1877 ],
1878 "showInTooltip": true, ~/~/ Отображать в подсказке
1879 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1880
1881 (((
1882 "color": "string",** ~/~/ **Цвет датчика
1883 )))
1884
1885 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1886 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1887 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1888 "expr": "string", ~/~/ Формула
1889 "children": [ ~/~/ массив дочерних датчиков
1890 "string"
1891 ],
1892 "customParams": { ~/~/ прочие произвольные параметры
1893 "additionalProp1": "string",
1894 "additionalProp2": "string",
1895 "additionalProp3": "string"
1896 },
1897 ~/~/ Характерные для произвольного:
1898 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1899 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1900 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1901 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1902 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1903 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1904 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1905 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1906 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1907 ~/~/ "ValueOn": "Вкл.",
1908 ~/~/ "ValueOff": "Выкл."
1909 "summaryMaxValue": 0 ~/~/ Макс. значение
1910
1911 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1912 {
1913 "from": 0, ~/~/ С какого значения
1914 "color": "string", ~/~/ Каким цветом
1915 "text": "string" ~/~/ Текст подписи к этому интервалу
1916 }
1917 ]
1918 }
1919 ],
1920 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1921
1922 "customFields": [ ~/~/ Произвольные поля
1923 {     
1924 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1925 "name": "string", ~/~/ Наименование произвольного поля
1926 "value": "string", ~/~/ Значение произвольного поля
1927 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1928 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1929 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1930 }
1931
1932 (((
1933 ],
1934 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1935 )))
1936
1937 }
1938
1939
1940 (% style="color:#000000" %)Ответ:
1941
1942 (((
1943 {
1944 "vehicleId": 0, ~/~/ ID ТС
1945 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1946 "name": "string", ~/~/ Имя объекта
1947 "imei": "string", ~/~/ IMEI
1948 "deviceTypeId": 0, ~/~/ ID типа устройства
1949 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1950 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1951 "sim1": "string", ~/~/ SIM1
1952 "sim2": "string", ~/~/ SIM2
1953 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1954 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1955 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1956 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1957 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1958 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1959 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1960 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1961 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1962 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1963 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1964 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1965 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1966 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1967 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1968 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1969 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1970 "counters": { ~/~/ состояний счётчиков
1971 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1972 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1973 "mileage": 0, ~/~/ Пробег
1974 "motohours": 0 ~/~/ Моточасы 
1975 },
1976 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1977 "id": "string", ~/~/ CMSV6 Идентификатор
1978 "enabled": true, ~/~/ Признак включения
1979 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1980 )))
1981
1982
1983 (((
1984 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1985 "login": "string", ~/~/ CMSV6 имя учетной записи
1986 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1987 },
1988 "inspectionTasks": [ ~/~/ Задания на ТО
1989 {
1990 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1991 "enabled": true, ~/~/ Признак включения
1992 "name": "string", ~/~/ Имя задания
1993 "description": "string", ~/~/ Описание задания
1994 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1995 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1996 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1997 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1998 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1999 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2000 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2001 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2002 }
2003 ],
2004 "drivers": [  ~/~/ Список водителей
2005 {
2006 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2007 "inputNumber": 0, ~/~/ № входа.
2008 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2009 "comment": "string", ~/~/ Комментарий.
2010 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2011 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2012 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2013 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2014 }
2015 ],
2016 "commandTemplates": [ ~/~/ Список шаблонов команд
2017 {
2018 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2019 "name": "string", ~/~/ Название шаблона команд
2020 "command": "string", ~/~/ Команда на выполнение
2021 "retries": 0 ~/~/ Лимит попыток отправки
2022 }
2023 ],
2024 "sensors": [  ~/~/ Список датчиков 
2025 {
2026 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2027 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2028 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2029 )))
2030
2031 (((
2032 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2033 )))
2034
2035 (((
2036 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2037 )))
2038
2039 (((
2040 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2041 )))
2042
2043 (((
2044 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2045 )))
2046
2047 (((
2048 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2049 "name": "string", ~/~/ Имя датчика
2050 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2051 )))
2052
2053 (((
2054 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2055 "inputNumber": 0, ~/~/ Номер входа
2056 "pseudonym": "string", ~/~/ Псевдоним
2057 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2058 "isInverted": true, ~/~/ Признак инверсии
2059 "disabled": true, ~/~/ Датчик не участвует в обработке
2060 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2061 "gradesTables": [ ~/~/ Тарировка
2062 {
2063 "grades": [ ~/~/ Таблицы тарировки
2064 {
2065 "input": 0, ~/~/ Вход
2066 "output": 0 ~/~/ Выход
2067 }
2068 ],
2069 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2070 }
2071 ],
2072 "showInTooltip": true, ~/~/ Отображение в подсказке
2073 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2074
2075 (((
2076 "color": "string", ~/~/ цвет уведомлений
2077 )))
2078
2079 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2080 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2081 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2082 "expr": "string", ~/~/ Выражение
2083 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2084 "string" 
2085 ],
2086 "customParams": { ~/~/ Дополнительные настройки
2087 "additionalProp1": "string",
2088 "additionalProp2": "string",
2089 "additionalProp3": "string"
2090 },
2091 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2092 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2093 {
2094 "from": 0, ~/~/ С какого значения
2095 "color": "string", ~/~/ Каким цветом
2096 "text": "string" ~/~/ Текст подписи к этому интервалу
2097 }
2098 ]
2099 }
2100 ],
2101 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2102 "customFields": [ ~/~/ Список произвольных полей
2103 {
2104 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2105 "name": "string", ~/~/ Наименование произвольного поля
2106 "value": "string", ~/~/ Значение произвольного поля
2107 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2108 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2109 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2110 }
2111 ],
2112 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2113 }
2114 )))
2115
2116 **Валидация:**
2117 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2118 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2119 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2120
2121 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2122
2123 (% class="box errormessage" %)
2124 (((
2125 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2126 )))
2127
2128 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2129
2130 (% style="color:#000000" %)Метод запроса: **DELETE**
2131
2132 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2133
2134 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2135
2136 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2137
2138 (% style="text-align:left" %)
2139 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2140
2141 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2142
2143 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2144
2145 (% class="box infomessage" %)
2146 (((
2147 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2148 )))
2149
2150 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2151
2152 (% style="color:#000000" %)Метод запроса: **GET**
2153
2154 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2155
2156 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2157
2158 (% style="color:#000000" %)Ответ:
2159
2160 (% style="color:#000000" %){(%%)
2161 "deviceTypeId" : "", ~/~/ ID типа устройства
2162 "deviceTypeName" : "" ~/~/ Название типа устройства
2163 (% style="color:#000000" %)}
2164
2165 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2166
2167 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2168
2169 (% class="box infomessage" %)
2170 (((
2171 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2172 )))
2173
2174 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2175
2176 (% style="color:#000000" %)Метод запроса: **GET**
2177
2178 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2179
2180 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2181
2182 (% style="color:#000000" %)Ответ:
2183
2184 (% style="color:#000000" %){(%%)
2185 "id": "", ~/~/ ID типа датчика 
2186 "name": "", ~/~/ Название
2187 "description": "", ~/~/ Описание
2188 (% style="color:#000000" %)}
2189
2190 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2191
2192 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2193
2194 (% class="box infomessage" style="text-align: left;" %)
2195 (((
2196 **POST /api/v3/terminalMessages/count**
2197 )))
2198
2199 (% style="text-align: left;" %)
2200 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2201
2202 (% style="text-align: left;" %)
2203 Метод запроса **POST**
2204
2205 (% style="text-align: left;" %)
2206 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2207
2208 (% style="text-align: left;" %)
2209 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2210
2211 (% style="text-align: left;" %)
2212 {
2213 "vehicleIds": [
2214 id ~/~/ здесь передается список идентификаторов объектов
2215 ],
2216 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2217 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2218 }
2219
2220 (% style="text-align: left;" %)
2221 Ответ:
2222
2223 (% style="text-align: left;" %)
2224 [
2225 {
2226 "vehicleId": 0, ~/~/ идентификатор объекта
2227 "count": 0 ~/~/ количество сообщений за период
2228 }
2229 ]
2230
2231 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2232
2233 (% class="box infomessage" style="text-align: left;" %)
2234 (((
2235 **POST /api/v3/terminalMessages/mapping**
2236 )))
2237
2238 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2239
2240 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2241
2242 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2243
2244 {
2245 "protocolType": 0,
2246 "params": ["string"]
2247 }
2248
2249 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2250 |protocolType|ID типа протокола
2251 |params|(((
2252 Массив наименований параметров в сообщении
2253 )))
2254
2255 Ответ:
2256
2257 {
2258 "protocolType": 0,
2259 "mapping": {
2260 "additionalProp1": {
2261 "inputType": 0,
2262 "inputNumber": 0
2263 },
2264 "additionalProp2": {
2265 "inputType": 0,
2266 "inputNumber": 0
2267 }
2268 }
2269 }
2270
2271 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2272 |protocolType|Тип протокола
2273 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2274 |inputNumber|(((
2275 Номер входа
2276 )))
2277
2278 (% class="wikigeneratedid" %)
2279 Перечень 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/]]
2280
2281 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2282
2283 (% class="box infomessage" %)
2284 (((
2285 **POST /api/v3/terminalMessages**
2286 )))
2287
2288 Метод возвращает список сообщений терминала объекта за выбранный период.
2289
2290 (% style="text-align: left;" %)
2291 Метод запроса **POST**
2292
2293 (% style="text-align: left;" %)
2294 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2295
2296 (% style="text-align: left;" %)
2297 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2298
2299 {
2300 "vehicleId": 0, ~/~/ id объекта
2301 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2302 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2303 }
2304
2305 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2306 |vehicleId|ID объекта
2307 |from|Дата и время начала периода запроса
2308 |to|Дата и время окончания периода запроса
2309
2310 Ответ:
2311
2312 [
2313 {
2314 "messages": [
2315 {
2316 "deviceTime": "2023-11-29T07:40:44.052Z",
2317 "serverTime": "2023-11-29T07:40:44.052Z",
2318 "speed": 0,
2319 "altitude": 0,
2320 "latitude": 0,
2321 "longitude": 0,
2322 "satellites": 0,
2323 "course": 0,
2324 "voltage": 0,
2325 "parameters": {
2326 "additionalProp1": "string",
2327 "additionalProp2": "string",
2328 "additionalProp3": "string"
2329 },
2330 "photoCount": 0,
2331 "lbsCorrectedCoords": true,
2332 "protocolType": 0
2333 }
2334 ]
2335 }
2336 ]
2337
2338 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2339 |deviceTime|Время сообщения терминала
2340 |serverTime|Время когда сообщение поступило на сервер
2341 |speed|Скорость
2342 |altitude|Высота над уровнем моря
2343 |latitude|Широта
2344 |longitude|Долгота
2345 |satellites|Кол-во спутников
2346 |course|Курс
2347 |voltage|Бортовое напряжение
2348 |parameters|Список параметров и их значений
2349 |photoCount|Количество фото
2350 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2351 |protocolType|ID типа протокола
2352
2353 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2354
2355 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2356
2357 (% class="box infomessage" %)
2358 (((
2359 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2360 )))
2361
2362 (% style="color:#000000" %)Метод запроса: **POST**
2363
2364 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2365
2366 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2367
2368 (% style="text-align:left" %)
2369 Тело запроса:
2370
2371 {
2372 "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2373 "vehicleIds": [0], ~/~/ Список ID объектов
2374 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2375 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2376 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2377 }
2378
2379 Ответ:
2380
2381 [
2382 {
2383 "vehicleId": 0, ~/~/ ID объекта
2384 "name": "string", ~/~/ Имя ТС
2385 "periods": [ ~/~/ Периоды
2386 {
2387 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2388 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2389 "mileage": 0, ~/~/ Пробег за период, километры
2390 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2391 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2392 "motohours": 0, ~/~/ Моточасы за период, секунды
2393 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2394 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2395 "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2396
2397 }
2398 ]
2399 }
2400 ]
2401
2402 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2403
2404 (% class="box infomessage" %)
2405 (((
2406 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2407 )))
2408
2409 (% style="color:#000000" %)Метод запроса: **POST**
2410
2411 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2412
2413 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2414
2415 (% style="text-align:left" %)
2416 Тело запроса:
2417
2418 {
2419 "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2420 "vehicleIds": [0], ~/~/ Список ID объектов
2421 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2422 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2423 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2424 }
2425
2426 Ответ:
2427
2428 [
2429 {
2430 "vehicleId": 0, ~/~/ ID объекта
2431 "name": "string", ~/~/ Имя ТС
2432 "periods": [ ~/~/ Периоды
2433 {
2434 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2435 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2436 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2437 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2438 "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2439 "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2440 "fuelConsumption": 0, ~/~/ Расход топлива
2441 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2442 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2443
2444 }
2445 ]
2446 }
2447 ]
2448
2449 (% class="box warningmessage" %)
2450 (((
2451 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2452 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2453 )))
2454
2455 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2456
2457 (% class="box infomessage" %)
2458 (((
2459 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2460 )))
2461
2462 (% style="color:#000000" %)Метод запроса: **POST**
2463
2464 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2465
2466 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2467
2468 (% style="text-align:left" %)
2469 Тело запроса:
2470
2471 {
2472 "vehicleIds": [0], ~/~/ Список ID объектов
2473 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2474 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2475 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2476 }
2477
2478 Ответ:
2479
2480 [
2481 {
2482 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2483 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2484 "vehicleId": 0, ~/~/ ID объекта
2485 "name": "string", ~/~/ Имя объекта
2486 "model": "string", ~/~/ Модель объекта
2487 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2488 {
2489 "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
2490
2491 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2492 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2493 "valueFuel": 0, ~/~/ Количество
2494 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2495 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2496 }
2497 ]
2498 }
2499 ]
2500
2501
2502 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2503
2504 (% class="box infomessage" %)
2505 (((
2506 **POST /api/v3/vehicles/moveStop**
2507 )))
2508
2509 Метод запроса: **POST**
2510
2511 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2512
2513 В заголовках запроса: X-Auth: Токен авторизации
2514
2515
2516 Тело запроса:
2517
2518 {
2519 "vehicleIds": [ ], ~/~/ Список ID объектов
2520 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2521 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2522 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2523 }
2524
2525 Ответ:
2526
2527 [ 
2528 {
2529 "vehicleId": 0, ~/~/ ID объекта
2530 "vehicleName": "string", ~/~/ Имя объекта
2531 "moves": [ ~/~/ Событие движения
2532 {
2533 "mileage": 0, ~/~/ Пробег, км
2534 "eventId": 0, ~/~/ Идентификатор события
2535 "eventName": "string", ~/~/ Название события
2536 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2537 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2538 "duration": 0 ~/~/ Продолжительность события, секунд
2539 }
2540 ],
2541 "stops": [ ~/~/ События стоянок
2542 {
2543 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2544 "eventId": 0, ~/~/ Идентификатор события
2545 "eventName": "string", ~/~/ Название события
2546 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2547 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2548 "duration": 0 ~/~/ Продолжительность события, секунд
2549 }
2550 ]
2551 }
2552 ]
2553
2554
2555 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2556
2557 (% class="box infomessage" %)
2558 (((
2559 **POST /api/v3/vehicles/getlastdata**
2560 )))
2561
2562 Метод запроса: **POST**
2563
2564 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2565
2566 В заголовках запроса: X-Auth: Токен авторизации
2567
2568
2569 В массиве указываем id объектов через запятую
2570
2571 Ответ:
2572
2573 [
2574 {
2575 "vehicleId": 55728, ~/~/ Идентификатор объекта 
2576 "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2577 "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2578 "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2579 "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2580 "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2581 "speed": 31, ~/~/ Скорость объекта 
2582 "course": 116, ~/~/ Курс движения [0;360]
2583 "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2584 "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2585 "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2586 "geozones": [ ~/~/ Сведения по геозонам. 
2587 {
2588 "id": 10225647, ~/~/ ID Геозоны 
2589 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2590 },
2591 {
2592 "id": 10282875, ~/~/ ID Геозоны 
2593 "name": "Ё2" ~/~/ Наименование геозоны 
2594 },
2595 {
2596 "id": 10226240, ~/~/ ID Геозоны 
2597 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2598 },
2599 {
2600 "id": 9747869, ~/~/ ID Геозоны 
2601 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2602 },
2603 {
2604 "id": 10221123, ~/~/ ID Геозоны 
2605 "name": "53r" ~/~/ Наименование геозоны 
2606 },
2607 {
2608 "id": 10197638, ~/~/ ID Геозоны 
2609 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2610 }
2611 ]
2612 }
2613
2614
2615 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2616
2617 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2618
2619 (% class="box infomessage" %)
2620 (((
2621 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2622 )))
2623
2624 (% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2625
2626 (% style="color:#000000" %)Метод запроса: **POST**
2627
2628 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2629
2630 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2631
2632 (% style="text-align:left" %)
2633 Тело запроса:
2634
2635 (% style="text-align:left" %)
2636 {
2637 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2638 }
2639
2640 (% style="text-align:left" %)
2641 Ответ:
2642
2643 [
2644 {
2645 "id": 0, ~/~/ Идентификатор объекта геозоны
2646 "name": "string", ~/~/ Название объекта геозоны
2647 "type": 0, ~/~/ Тип объекта геозоны
2648 "fname": "string", ~/~/ Имя файла
2649 "parentId": "string", ~/~/ Идентификатор клиента
2650 "radius": 0, ~/~/ Радиус геообъекта
2651 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2652 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2653 "description": "string", ~/~/ Описание
2654 "area": 0, ~/~/ Площадь, м^^2^^
2655 "perimetr": 0, ~/~/ Периметр, м
2656 "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2657 }
2658 ]
2659
2660 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2661
2662 (% class="box infomessage" %)
2663 (((
2664 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2665 )))
2666
2667 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2668
2669 (% style="color:#000000" %)Метод запроса: **POST**
2670
2671 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2672
2673 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2674
2675 (% style="text-align:left" %)
2676 Тело запроса:
2677
2678 {
2679 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2680 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2681 "ids": [ ], ~/~/ Массив id объектов
2682 "byTime": 0, ~/~/ Объединение событий по времени 
2683 "byDist": 0, ~/~/ Объединение событий по расстоянию
2684 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2685 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2686 }
2687
2688 Ответ:
2689 [
2690 {
2691 "geozoneId": 0, ~/~/ ID геообъекта
2692 "geozoneName": "string", ~/~/ Название геообъекта
2693 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2694 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2695 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2696 "vehicleId": 0, ~/~/ ID объекта
2697 "vehicleName": "string" ~/~/ Имя объекта
2698 }
2699 ]
2700
2701 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2702
2703 (% class="box infomessage" %)
2704 (((
2705 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2706 )))
2707
2708 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2709
2710 (% style="color:#000000" %)Метод запроса: **POST**
2711
2712 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2713
2714 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2715
2716 (% style="text-align:left" %)
2717 Тело запроса:
2718
2719 {
2720 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2721 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2722 "ids": [ ], ~/~/ Массив id геообъектов
2723 "byTime": 0, ~/~/ Объединение событий по времени 
2724 "byDist": 0, ~/~/ Объединение событий по расстоянию
2725 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2726 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2727 }
2728
2729 Ответ:
2730
2731 [
2732 {
2733 "geozoneId": 0, ~/~/ ID геообъекта
2734 "geozoneName": "string", ~/~/ Название геообъекта
2735 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2736 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2737 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2738 "vehicleId": 0, ~/~/ ID объекта
2739 "vehicleName": "string" ~/~/ Имя объекта
2740 }
2741 ]
2742
2743
2744 == (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2745
2746 (% class="box successmessage" %)
2747 (((
2748 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2749 )))
2750
2751 (% style="color:#000000" %)Метод запроса: **PUT**
2752
2753 Пример запроса:
2754
2755 (((
2756 {
2757 "id": 0,  ~/~/ Идентификатор объекта геозоны
2758 "name": "string",  ~/~/ Наименование объекта геозоны
2759 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2760 "description": "string", ~/~/ Описание объекта геозоны
2761 "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2762 "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2763 "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2764 }
2765 )))
2766
2767
2768 Пример ответа:
2769
2770 200 ~/~/ Success
2771
2772 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2773
2774 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2775
2776 (% class="box infomessage" %)
2777 (((
2778 **POST /api/v3/notifications/find**
2779 )))
2780
2781 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2782
2783 (% style="text-align: left;" %)
2784 Метод запроса **POST**
2785
2786 (% style="text-align: left;" %)
2787 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2788
2789 (% style="text-align: left;" %)
2790 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2791
2792 {
2793 "parentId": "" ~/~/ id клиента
2794 }
2795
2796 Ответ:
2797
2798 [
2799 {
2800 "id": 0, ~/~/ ID уведомления
2801 "name": "string", ~/~/ Название уведомления
2802 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2803 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2804 "userId": "", ~/~/ Пользователь, создавший уведомление
2805 "parentId": "", ~/~/ Идентификатор клиента
2806 "parentName": "string" ~/~/ Имя клиента
2807 }
2808 ]
2809
2810
2811 == (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2812
2813 (% class="box infomessage" %)
2814 (((
2815 **POST /api/v3/notifications**
2816 )))
2817
2818 Метод запроса **POST**
2819
2820 (% style="text-align: left;" %)
2821 (% style="color:#000000" %)Пример запроса
2822
2823 (((
2824 {
2825 "id": 0, ~/~/ ID правила
2826 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2827 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2828 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2829 "name": "string", ~/~/ Имя правила
2830 "active": true, ~/~/ Активность правила
2831 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2832 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2833 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2834 ],
2835 "vehicleIds": [ ~/~/ Список объектов для анализа.
2836 0
2837 ],
2838 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2839 0
2840 ],
2841 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2842 0
2843 ],
2844 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2845 "additionalProp1": "string",  
2846 "additionalProp2": "string",
2847 "additionalProp3": "string"
2848 },
2849 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2850 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2851 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2852 ],
2853 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2854 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2855 "string"
2856 ],
2857 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2858 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2859 {
2860 "id": 0, ~/~/ Идентификатор участника чата.
2861 "info": "string" ~/~/ Дополнительные сведения.
2862 }
2863 ],
2864 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2865 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2866 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2867 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2868 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2869 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2870 "timezone": 0, ~/~/ часовой пояс 
2871 "validity": 0, ~/~/ Срок действия в днях (1-90).
2872 "autoProlongation": true, ~/~/ Автопродление срока действия.
2873 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2874 {
2875 "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 - Срок действия правила истек
2876 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2877 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2878 "additionalProp1": "string",
2879 "additionalProp2": "string",
2880 "additionalProp3": "string"
2881 }
2882 }
2883 ]
2884 }
2885 )))
2886
2887 (((
2888
2889 )))
2890
2891 (((
2892
2893 )))
2894
2895 Ответ:
2896
2897 {
2898 "id": 0, ~/~/ ID правила
2899 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2900 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2901 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2902 "name": "string", ~/~/ Имя правила
2903 "active": true, ~/~/ Активность правила
2904 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2905 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2906 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2907 ],
2908 "vehicleIds": [ ~/~/ Список объектов для анализа.
2909 0
2910 ],
2911 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2912 0
2913 ],
2914 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2915 0
2916 ],
2917 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2918 "additionalProp1": "string",  
2919 "additionalProp2": "string",
2920 "additionalProp3": "string"
2921 },
2922 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2923 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2924 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2925 ],
2926 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2927 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2928 "string"
2929 ],
2930 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2931 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2932 {
2933 "id": 0, ~/~/ Идентификатор участника чата.
2934 "info": "string" ~/~/ Дополнительные сведения.
2935 }
2936 ],
2937 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2938 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2939 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2940 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2941 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2942 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2943 "timezone": 0, ~/~/ часовой пояс 
2944 "validity": 0, ~/~/ Срок действия в днях (1-90).
2945 "autoProlongation": true, ~/~/ Автопродление срока действия.
2946 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2947 {
2948 "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 - Срок действия правила истек
2949 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2950 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2951 "additionalProp1": "string",
2952 "additionalProp2": "string",
2953 "additionalProp3": "string"
2954 }
2955 }
2956 ]
2957 }
2958
2959 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2960
2961 (% class="box infomessage" %)
2962 (((
2963 **GET /api/v3/notifications/{id}**
2964 )))
2965
2966 Метод возвращает данные правил формирования выбранного уведомления.
2967
2968 (% style="text-align: left;" %)
2969 Метод запроса **GET**
2970
2971 (% style="text-align: left;" %)
2972 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2973
2974 (% style="text-align: left;" %)
2975 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2976
2977 (% style="text-align: left;" %)
2978 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2979
2980 (% style="text-align: left;" %)
2981 (% style="color:#000000" %)Ответ:
2982
2983 (% style="text-align: left;" %)
2984 (% style="color:#000000" %){
2985 "id": 0, ~/~/ (%%)id уведомления
2986 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2987 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2988 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2989 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2990 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2991 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2992 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2993 (% style="color:#000000" %) 0
2994 ],
2995 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2996 (% style="color:#000000" %) 0
2997 ],
2998 "fieldids": [ ~/~/ (%%)Список id полей для анализа
2999 (% style="color:#000000" %) 0
3000 ],
3001 "settings": { ~/~/ Список параметров уведомления
3002 "additionalProp1": "string",
3003 "additionalProp2": "string",
3004 "additionalProp3": "string"
3005 },
3006 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3007 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3008 (% style="color:#000000" %) ""
3009 ],
3010 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3011 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
3012 (% style="color:#000000" %) "string"
3013 ],
3014 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
3015 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
3016 (% style="color:#000000" %) {
3017 "id": 0, ~/~/ (%%)Идентификатор участника чата
3018 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
3019 (% style="color:#000000" %) }
3020 ],
3021 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
3022 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
3023 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3024 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
3025 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3026 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
3027 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
3028 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
3029 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
3030 (% style="color:#000000" %)}
3031
3032 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
3033
3034 (% class="box warningmessage" %)
3035 (((
3036 **PUT /api/v3/notifications/**
3037 )))
3038
3039 Метод позволяет отредактировать уведомление.
3040
3041 Метод запроса **PUT**
3042
3043 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
3044
3045 В заголовках запроса: X-Auth: Токен авторизации
3046
3047 Тело запроса:
3048 {
3049 "id": 0, ~/~/ id уведомления
3050 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
3051 "userId": "", ~/~/ Пользователь, создавший уведомление
3052 "parentId": "", ~/~/ Идентификатор клиента
3053 "parentName": "string", ~/~/ Имя клиента
3054 "name": "string", ~/~/ Название уведомления
3055 "active": true, ~/~/ Состояние true - активен, false - деактивирован
3056 "vehicleIds": [ ~/~/ Список id объектов для анализа
3057 0
3058 ],
3059 "geoids": [ ~/~/ Список id геообъектов для анализа
3060 0
3061 ],
3062 "fieldids": [ ~/~/ Список id полей для анализа
3063 0
3064 ],
3065 "settings": { ~/~/ Список параметров уведомления
3066 "additionalProp1": "string",
3067 "additionalProp2": "string",
3068 "additionalProp3": "string"
3069 },
3070 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3071 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3072 ""
3073 ],
3074 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3075 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
3076 "string"
3077 ],
3078 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
3079 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
3080 {
3081 "id": 0, ~/~/ Идентификатор участника чата
3082 "info": "string" ~/~/ Дополнительные сведения
3083 }
3084 ],
3085 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
3086 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
3087 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3088 "kind": 0, ~/~/ Определяет вид уведомления
3089 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3090 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
3091 "timezone": 0, ~/~/ Сдвиг часового пояса
3092 "validity": 0, ~/~/ Срок действия в днях (1-90)
3093 "autoProlongation": true ~/~/ Автопродление срока действия
3094 }
3095
3096 Ответ:
3097
3098 Success
3099
3100
3101 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
3102
3103 (% class="box warningmessage" %)
3104 (((
3105 **PUT** /api/v3/notifications/prolongation
3106 )))
3107
3108 Метод позволяет продлить уведомления.
3109
3110 Метод запроса **PUT**
3111
3112 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
3113
3114 В заголовках запроса: X-Auth: Токен авторизации.
3115
3116 Тело запроса:
3117
3118 [
3119
3120 0
3121
3122 ]
3123
3124 где 0 идентификатор ids.
3125
3126 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
3127
3128 (% class="box errormessage" %)
3129 (((
3130 **DELETE /api/v3/notifications/{id}**
3131 )))
3132
3133 Метод позволяет удалить выбранное уведомление.
3134
3135 Метод запроса **DELETE**
3136
3137 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3138
3139 Передаваемый параметр: {id} - id уведомления
3140
3141 В заголовках запроса: X-Auth: Токен авторизации
3142
3143 Ответ:
3144
3145 Success
3146
3147
3148 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3149
3150 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3151
3152 (% class="box infomessage" %)
3153 (((
3154 **POST /api/v3/Drivers/find**
3155 )))
3156
3157 Передается параметр: parentId - ID клиента-родителя
3158
3159 Ответ:
3160
3161 [
3162 {
3163 "name": "string", ~/~/ Определяет наименование
3164 "description": "string", ~/~/ Определяет описание
3165 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3166 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3167 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3168 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3169 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3170 "deleted": true ~/~/ Признак удаления
3171 }
3172 ]
3173
3174 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3175
3176 (% class="box infomessage" %)
3177 (((
3178 **GET /api/v3/Drivers/{driverGuid}**
3179 )))
3180
3181 Передается параметр: ID водителя
3182
3183 Ответ:
3184
3185 {
3186 "name": "string", ~/~/ Определяет наименование
3187 "description": "string", ~/~/ Определяет описание
3188 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3189 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3190 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3191 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3192 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3193 "deleted": true ~/~/ Признак удаления
3194 }
3195
3196 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3197
3198 (% class="box successmessage" %)
3199 (((
3200 **POST /api/v3/Drivers**
3201 )))
3202
3203 Запрос:
3204
3205 {
3206 "name": "string",
3207 "description": "string",
3208 "hiredate": "2023-06-30T12:50:54.020Z",
3209 "chopdate": "2023-06-30T12:50:54.020Z",
3210 "exclusive": true,
3211 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3212 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3213 "deleted": true
3214 }
3215
3216 Ответ:
3217
3218 {
3219 "name": "string",
3220 "description": "string",
3221 "hiredate": "2023-06-30T12:50:54.051Z",
3222 "chopdate": "2023-06-30T12:50:54.051Z",
3223 "exclusive": true,
3224 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3225 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3226 "deleted": true
3227 }
3228
3229
3230 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3231
3232 (% class="box warningmessage" %)
3233 (((
3234 **PUT /api/v3/Drivers**
3235 )))
3236
3237 Запрос:
3238
3239 {
3240 "name": "string",
3241 "description": "string",
3242 "hiredate": "2023-06-30T12:50:27.910Z",
3243 "chopdate": "2023-06-30T12:50:27.910Z",
3244 "exclusive": true,
3245 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3246 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3247 "deleted": true
3248 }
3249
3250 Ответ:
3251
3252 {
3253 "name": "string",
3254 "description": "string",
3255 "hiredate": "2023-06-30T12:50:27.929Z",
3256 "chopdate": "2023-06-30T12:50:27.929Z",
3257 "exclusive": true,
3258 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3259 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3260 "deleted": true
3261 }
3262
3263
3264 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3265
3266 (% class="box errormessage" %)
3267 (((
3268 **DELETE /api/v3/Drivers/{driverGuid}**
3269 )))
3270
3271 Передается параметр: ID водителя
3272
3273 Ответ:
3274
3275 Success
3276
3277
3278 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3279
3280 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3281
3282 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3283
3284 (% class="box infomessage" %)
3285 (((
3286 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3287 )))
3288
3289 Запрос:
3290
3291 {
3292 "Ids": [
3293 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3294 ],
3295 "BeginTime": "2023-06-30T12:49:04.365Z",
3296 "EndTime": "2023-06-30T12:49:04.365Z"
3297 }
3298
3299 Ответ:
3300
3301 [
3302 {
3303 "VehicleId": 0,
3304 "CreateTime": "2023-06-30T09:52:31.240Z",
3305 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3306 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3307 "BeginTime": "2023-06-30T09:52:31.240Z",
3308 "EndTime": "2023-06-30T09:52:31.240Z"
3309 }
3310 ]
3311
3312
3313 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3314
3315 (% class="box infomessage" %)
3316 (((
3317 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3318 )))
3319
3320 Запрос:
3321
3322 {
3323 "Ids": [
3324 0
3325 ],
3326 "BeginTime": "2023-06-30T12:48:39.419Z",
3327 "EndTime": "2023-06-30T12:48:39.419Z"
3328 }
3329
3330 Ответ:
3331
3332 [
3333 {
3334 "VehicleId": 0,
3335 "CreateTime": "2023-06-30T09:54:01.631Z",
3336 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3337 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3338 "BeginTime": "2023-06-30T09:54:01.631Z",
3339 "EndTime": "2023-06-30T09:54:01.631Z"
3340 }
3341 ]
3342
3343
3344 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3345
3346 (% class="box successmessage" %)
3347 (((
3348 **POST /api/v3/DriversVehiclesAssignments**
3349 )))
3350
3351 Передается массив назначений
3352
3353 Запрос:
3354
3355 [
3356 {
3357 "VehicleId": 0, ~/~/ Идентификатор объекта
3358 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3359 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3360 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3361 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3362 }
3363 ]
3364
3365 Ответ:
3366
3367 [
3368 {
3369 "VehicleId": 0,
3370 "CreateTime": "2023-06-30T11:04:46.903Z",
3371 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3372 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3373 "BeginTime": "2023-06-30T11:04:46.903Z",
3374 "EndTime": "2023-06-30T11:04:46.903Z"
3375 }
3376 ]
3377
3378
3379 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3380
3381 (% class="box warningmessage" %)
3382 (((
3383 **PUT /api/v3/DriversVehiclesAssignments**
3384 )))
3385
3386 Запрос:
3387
3388 [
3389 {
3390 "VehicleId": 0,
3391 "CreateTime": "2023-06-30T11:14:08.117Z",
3392 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3393 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3394 "BeginTime": "2023-06-30T11:14:08.117Z",
3395 "EndTime": "2023-06-30T11:14:08.117Z"
3396 }
3397 ]
3398
3399 Ответ:
3400
3401 [
3402 {
3403 "VehicleId": 0,
3404 "CreateTime": "2023-06-30T11:14:53.349Z",
3405 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3406 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3407 "BeginTime": "2023-06-30T11:14:53.349Z",
3408 "EndTime": "2023-06-30T11:14:53.349Z"
3409 }
3410 ]
3411
3412
3413 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3414
3415 (% class="box errormessage" %)
3416 (((
3417 **DELETE /api/v3/DriversVehiclesAssignments**
3418 )))
3419
3420 Запрос:
3421
3422 [
3423 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3424 ]
3425
3426 Ответ:
3427
3428 Success
3429
3430
3431 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3432
3433 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3434
3435 (% class="box infomessage" %)
3436 (((
3437 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3438 )))
3439
3440 Запрос:
3441
3442 {
3443 "Ids": [
3444 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3445 ],
3446 "BeginTime": "2023-06-30T12:47:12.162Z",
3447 "EndTime": "2023-06-30T12:47:12.162Z"
3448 }
3449
3450 Ответ:
3451
3452 [
3453 {
3454 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3455 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3456 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3457 "BeginTime": "2023-06-30T11:19:40.703Z",
3458 "EndTime": "2023-06-30T11:19:40.703Z"
3459 }
3460 ]
3461
3462
3463 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3464
3465 (% class="box infomessage" %)
3466 (((
3467 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3468 )))
3469
3470 Запрос:
3471
3472 {
3473 "Ids": [
3474 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3475 ],
3476 "BeginTime": "2023-06-30T12:47:12.162Z",
3477 "EndTime": "2023-06-30T12:47:12.162Z"
3478 }
3479
3480 Ответ:
3481
3482 [
3483 {
3484 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3485 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3486 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3487 "BeginTime": "2023-06-30T11:19:40.703Z",
3488 "EndTime": "2023-06-30T11:19:40.703Z"
3489 }
3490 ]
3491
3492
3493 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3494
3495 (% class="box successmessage" %)
3496 (((
3497 **POST /api/v3/DriversRfidsAssignments**
3498 )))
3499
3500 Запрос:
3501
3502 [
3503 {
3504 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3505 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3506 "BeginTime": "2023-06-30T11:27:08.635Z",
3507 "EndTime": "2023-06-30T11:27:08.635Z"
3508 }
3509 ]
3510
3511 Ответ:
3512
3513 [
3514 {
3515 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3516 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3517 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3518 "BeginTime": "2023-06-30T11:27:08.677Z",
3519 "EndTime": "2023-06-30T11:27:08.677Z"
3520 }
3521 ]
3522
3523
3524 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3525
3526 (% class="box warningmessage" %)
3527 (((
3528 **PUT /api/v3/DriversRfidsAssignments**
3529 )))
3530
3531 Запрос:
3532
3533 [
3534 {
3535 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3536 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3537 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3538 "BeginTime": "2023-06-30T11:28:43.330Z",
3539 "EndTime": "2023-06-30T11:28:43.330Z"
3540 }
3541 ]
3542
3543 Ответ:
3544
3545 [
3546 {
3547 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3548 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3549 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3550 "BeginTime": "2023-06-30T11:28:43.331Z",
3551 "EndTime": "2023-06-30T11:28:43.331Z"
3552 }
3553 ]
3554
3555
3556 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3557
3558 (% class="box errormessage" %)
3559 (((
3560 **DELETE /api/v3/DriversRfidsAssignments**
3561 )))
3562
3563 Запрос:
3564
3565 [
3566 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3567 ]
3568
3569 Ответ:
3570
3571 Success
3572
3573
3574 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3575
3576 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3577
3578 (% class="box infomessage" %)
3579 (((
3580 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3581 )))
3582
3583 Запрос:
3584
3585 {
3586 "Ids": [
3587 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3588 ],
3589 "BeginTime": "2023-06-30T12:45:10.852Z",
3590 "EndTime": "2023-06-30T12:45:10.852Z"
3591 }
3592
3593 Ответ:
3594
3595 [
3596 {
3597 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3598 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3599 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3600 "BeginTime": "2023-06-30T11:58:04.695Z",
3601 "EndTime": "2023-06-30T11:58:04.695Z"
3602 }
3603 ]
3604
3605
3606 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3607
3608 (% class="box infomessage" %)
3609 (((
3610 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3611 )))
3612
3613 Запрос:
3614
3615 {
3616 "Ids": [
3617 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3618 ],
3619 "BeginTime": "2023-06-30T12:45:10.852Z",
3620 "EndTime": "2023-06-30T12:45:10.852Z"
3621 }
3622
3623 Ответ:
3624
3625 [
3626 {
3627 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3628 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3629 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3630 "BeginTime": "2023-06-30T11:58:04.695Z",
3631 "EndTime": "2023-06-30T11:58:04.695Z"
3632 }
3633 ]
3634
3635
3636 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3637
3638 (% class="box successmessage" %)
3639 (((
3640 **POST /api/v3/DriversFuelCardsAssignments**
3641 )))
3642
3643 Запрос:
3644
3645 [
3646 {
3647 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3648 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3649 "BeginTime": "2023-06-30T12:09:53.175Z",
3650 "EndTime": "2023-06-30T12:09:53.175Z"
3651 }
3652 ]
3653
3654 Ответ:
3655
3656 [
3657 {
3658 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3659 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3660 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3661 "BeginTime": "2023-06-30T12:09:53.201Z",
3662 "EndTime": "2023-06-30T12:09:53.201Z"
3663 }
3664 ]
3665
3666
3667 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3668
3669 (% class="box warningmessage" %)
3670 (((
3671 **PUT /api/v3/DriversFuelCardsAssignments**
3672 )))
3673
3674 Запрос:
3675
3676 [
3677 {
3678 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3679 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3680 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3681 "BeginTime": "2023-06-30T12:09:53.201Z",
3682 "EndTime": "2023-06-30T12:09:53.201Z"
3683 }
3684 ]
3685
3686 Ответ:
3687
3688 [
3689 {
3690 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3691 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3692 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3693 "BeginTime": "2023-06-30T12:09:53.201Z",
3694 "EndTime": "2023-06-30T12:09:53.201Z"
3695 }
3696 ]
3697
3698
3699 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3700
3701 (% class="box errormessage" %)
3702 (((
3703 **DELETE /api/v3/DriversFuelCardsAssignments**
3704 )))
3705
3706 Запрос:
3707
3708 [
3709 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3710 ]
3711
3712 Ответ:
3713
3714 Success
3715
3716
3717 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3718
3719 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3720
3721 (% class="box infomessage" %)
3722 (((
3723 **POST /api/v3/Trailers**
3724 )))
3725
3726 Пример запроса:
3727
3728 {
3729 "startDate": "2023-11-14T10:48:03.671Z",
3730 "endDate": "2023-11-14T10:48:03.671Z",
3731 "ids": [ 0 ],
3732 "timezone": 0
3733 }
3734
3735 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3736 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3737 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3738 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3739 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3740
3741 Пример ответа:
3742
3743 [
3744 {
3745 "SD": "2023-11-14T10:48:03.717Z",
3746 "ED": "2023-11-14T10:48:03.717Z", 
3747 "id": 0,
3748 "SLat": 0,
3749 "SLon": 0,
3750 "ELat": 0,
3751 "ELon": 0,
3752 "mileage": 0
3753 "Duration": 0
3754 "Address": "string",
3755 "Address2": "string",
3756 "name": "string",
3757 "rid": "string",
3758 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3759 "trailer": {
3760 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3761 "Number": "string",
3762 "Description": "string",
3763 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3764 "ExternalID": "string",
3765 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3766 "CreateTime": "2023-11-14T10:48:03.717Z",
3767 "UpdateTime": "2023-11-14T10:48:03.717Z",
3768 "IsDeleted": true
3769 },
3770 "filesCount": 0,
3771 }
3772 ]
3773
3774 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3775 |SD|Дата и время начала события
3776 |ED|Дата и время окончания события
3777 |id|ID объекта
3778 |SLat|Широта начальной координаты
3779 |SLon|Долгота начальной координаты
3780 |ELat|Широта конечной координаты
3781 |ELon|Долгота конечной координаты
3782 |mileage|Пробег
3783 |Duration|Продолжительность
3784 |Address|Адрес начального местоположения
3785 |Address2|Адрес конечного местоположения
3786 |name|Имя радиометки
3787 |rid|Номер радиометки
3788 |rguid|ID радиометки
3789 |trailer|Информация об агрегате
3790 |ModelGuid|ID агрегата
3791 |Number|Название/номер агрегата
3792 |Description|Текст примечания агрегата
3793
3794 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3795
3796 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3797
3798 (% class="box infomessage" %)
3799 (((
3800 **POST /api/v3/Rfids/find**
3801 )))
3802
3803 Запрос:
3804
3805 {
3806 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3807 }
3808
3809 Ответ:
3810
3811 [
3812 {
3813 "name": "string",
3814 "number": 0,
3815 "period": 0,
3816 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3817 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3818 }
3819 ]
3820
3821 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3822 |parentId|ID клиента
3823 |name|Название карты-метки
3824 |number|Номер
3825 |period|Период запросов в секундах (работает только для агрегатов)
3826 |id|ID карты-метки
3827
3828 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3829
3830 (% class="box infomessage" %)
3831 (((
3832 **GET /api/v3/Rfids/{rfidGuid}**
3833 )))
3834
3835 Передаем параметр rfidGuid - идентификатор карты-метки
3836
3837 Ответ:
3838
3839 [
3840 {
3841 "name": "string",
3842 "number": 0,
3843 "period": 0,
3844 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3845 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3846 }
3847 ]
3848
3849 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3850 |name|Название карты-метки
3851 |number|Номер
3852 |period|Период запросов в секундах (работает только для агрегатов)
3853 |id|ID карты-метки
3854 |parentId|ID клиента
3855
3856 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3857
3858 (% class="box successmessage" %)
3859 (((
3860 **POST /api/v3/Rfids**
3861 )))
3862
3863 Запрос:
3864
3865 {
3866 "name": "string",
3867 "number": 0,
3868 "period": 0,
3869 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3870 }
3871
3872 Ответ:
3873
3874 {
3875 "name": "string",
3876 "number": 0,
3877 "period": 0,
3878 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3879 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3880 }
3881
3882 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3883 |name|Название карты-метки
3884 |number|Номер
3885 |period|Период запросов в секундах (работает только для агрегатов)
3886 |id|ID карты-метки
3887 |parentId|ID клиента
3888
3889 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3890
3891 (% class="box warningmessage" %)
3892 (((
3893 **PUT /api/v3/Rfids**
3894 )))
3895
3896 Запрос:
3897
3898 {
3899 "name": "string",
3900 "number": 0,
3901 "period": 0,
3902 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3903 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3904 }
3905
3906 Ответ:
3907
3908 {
3909 "name": "string",
3910 "number": 0,
3911 "period": 0,
3912 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3913 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3914 }
3915
3916 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3917 |name|Название карты-метки
3918 |number|Номер
3919 |period|Период запросов в секундах (работает только для агрегатов)
3920 |id|ID карты-метки
3921 |parentId|ID клиента
3922
3923 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3924
3925 (% class="box errormessage" %)
3926 (((
3927 **DELETE /api/v3/Rfids/{rfidGuid}**
3928 )))
3929
3930 Передаем параметр **rfidGuid** - идентификатор карты-метки
3931
3932 Ответ:
3933
3934 Success
3935
3936
3937 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3938
3939 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3940
3941 (% class="box infomessage" %)
3942 (((
3943 **GET /api/v3/Billing/client/balance/{clientId}**
3944 )))
3945
3946 Параметр запроса: **clientId **- идентификатор клиента.
3947
3948 Ответ:
3949
3950 {
3951 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3952 "Balance": 0
3953 }
3954
3955 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3956 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3957 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3958
3959 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3960
3961 (% class="box infomessage" %)
3962 (((
3963 **GET /api/v3/Billing/client/constraint/{clientId}**
3964 )))
3965
3966 Параметр запроса: **clientId **- идентификатор клиента.
3967
3968 Ответ:
3969
3970 {
3971 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3972 "CalculationType": 0,
3973 "PermissibleBalance": 0,
3974 "DefermentDays": 0,
3975 "SendUiNotifications": true,
3976 "SendEmailNotifications": true,
3977 "IsPrivate": true,
3978 }
3979
3980 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3981 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3982 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3983 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3984 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3985 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3986 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3987 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3988
3989 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3990
3991 (% class="box infomessage" %)
3992 (((
3993 **GET /api/v3/Billing/client/plan/{clientId}**
3994 )))
3995
3996 Параметры запроса:
3997
3998 **clientId **- идентификатор клиента.
3999
4000 **planId **- идентификатор тарифного плана.
4001
4002 Ответ:
4003
4004 {
4005 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4006 "Plan": { **~/~/ Описание тарифного плана**
4007 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4008 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4009 "Name": "string",
4010 "IsArchived": true,
4011 "Constraint": {
4012 "CalculationType": 0,
4013 "PermissibleBalance": 0,
4014 "DefermentDays": 0
4015 },
4016 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
4017 {
4018 "Feature": "string",
4019 "IsFactual": true,
4020 "Limit": 0,
4021 "Price": 0,
4022 "PeriodValue": 0,
4023 "PeriodType": 0
4024 }
4025 ]
4026 },
4027 "DebitDate": "2023-10-18T12:46:24.213Z",
4028 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
4029 {
4030 "Feature": "string",
4031 "IsEnabled": true,
4032 "IsPrivate": true,
4033 "IsFactual": true,
4034 "Limit": 0,
4035 "Price": 0,
4036 "DebitDate": "2023-10-18T12:46:24.213Z",
4037 "PeriodValue": 0,
4038 "PeriodType": 0
4039 }
4040 ]
4041 }
4042
4043 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4044 |ClientId|Идентификатор клиента
4045 |Id|Идентификатор тарифного плана
4046 |OwnerId|Идентификатор клиента-владельца
4047 |Name|Наименование тарифного плана
4048 |IsArchived|Признак, определяющий архивный тарифный план
4049 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4050 |PermissibleBalance|Допустимый баланс
4051 |DefermentDays|Отсрочка, количество дней
4052 |Feature|Код услуги
4053 |IsEnabled|Признак, определяющий активирована ли услуга
4054 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4055 |IsFactual|Признак, определяющий расчёт по факту
4056 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4057 |Price|Цена за единицу.
4058 |DebitDate|Следующий момент времени списания с баланса за услугу.
4059 |PeriodValue|Значение периода.
4060 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4061
4062 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
4063
4064 (% class="box infomessage" %)
4065 (((
4066 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4067 )))
4068
4069 Параметр запроса: **clientId **- идентификатор клиента.
4070
4071 Ответ:
4072
4073 [
4074 {
4075 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4076 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4077 "Name": "string",
4078 "IsArchived": true,
4079 "Constraint": {
4080 "CalculationType": 0,
4081 "PermissibleBalance": 0,
4082 "DefermentDays": 0
4083 },
4084 "Features": [
4085 {
4086 "Feature": "string",
4087 "IsFactual": true,
4088 "Limit": 0,
4089 "Price": 0,
4090 "PeriodValue": 0,
4091 "PeriodType": 0
4092 }
4093 ]
4094 }
4095 ]
4096
4097 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4098 |ClientId|Идентификатор клиента
4099 |Id|Идентификатор тарифного плана
4100 |OwnerId|Идентификатор клиента-владельца
4101 |Name|Наименование тарифного плана
4102 |IsArchived|Признак, определяющий архивный тарифный план
4103 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4104 |PermissibleBalance|Допустимый баланс
4105 |DefermentDays|Отсрочка, количество дней
4106 |Feature|Код услуги
4107 |IsFactual|Признак, определяющий расчёт по факту
4108 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4109 |Price|Цена за единицу.
4110 |PeriodValue|Значение периода.
4111 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4112
4113 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
4114
4115 (% class="box infomessage" %)
4116 (((
4117 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4118 )))
4119
4120 Параметр запроса: **clientId **- идентификатор клиента.
4121
4122 Ответ:
4123
4124 [
4125 {
4126 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4127 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4128 "Name": "string",
4129 "IsArchived": true,
4130 "Constraint": {
4131 "CalculationType": 0,
4132 "PermissibleBalance": 0,
4133 "DefermentDays": 0
4134 },
4135 "Features": [
4136 {
4137 "Feature": "string",
4138 "IsFactual": true,
4139 "Limit": 0,
4140 "Price": 0,
4141 "PeriodValue": 0,
4142 "PeriodType": 0
4143 }
4144 ]
4145 }
4146 ]
4147
4148 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4149 |ClientId|Идентификатор клиента
4150 |Id|Идентификатор тарифного плана
4151 |OwnerId|Идентификатор клиента-владельца
4152 |Name|Наименование тарифного плана
4153 |IsArchived|Признак, определяющий архивный тарифный план
4154 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4155 |PermissibleBalance|Допустимый баланс
4156 |DefermentDays|Отсрочка, количество дней
4157 |Feature|Код услуги
4158 |IsFactual|Признак, определяющий расчёт по факту
4159 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4160 |Price|Цена за единицу.
4161 |PeriodValue|Значение периода.
4162 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4163
4164 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4165
4166 (% class="box warningmessage" %)
4167 (((
4168 **PUT /api/v3/Billing/client/balance**
4169 )))
4170
4171 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4172
4173 Тело запроса:
4174
4175 {
4176 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4177 "Balance": 0 ~/~/ Значение баланса.
4178 }
4179
4180 Ответ: Success
4181
4182 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4183
4184 (% class="box warningmessage" %)
4185 (((
4186 **PUT /api/v3/billing/client/balance/deposit**
4187 )))
4188
4189 Создает операцию **Пополнение **с указанной суммой
4190
4191 Тело запроса:
4192
4193 (((
4194 {
4195 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4196 "amount": 0 ~/~/ Сумма пополнения баланса 
4197 }
4198 )))
4199
4200 (((
4201
4202 )))
4203
4204 Ответ: Success
4205
4206 (((
4207 {
4208 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4209 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4210 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4211 "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4212 "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4213 "Description": "string" ~/~/ Описание корректировки.
4214 }
4215 )))
4216
4217 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4218
4219 Создает операцию **Списание **с указанной суммой
4220
4221 (% class="box warningmessage" %)
4222 (((
4223 **PUT /api/v3/billing/client/balance/withdraw**
4224 )))
4225
4226 Тело запроса:
4227
4228 (((
4229 {
4230 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4231 "amount": 0 ~/~/ Сумма списания с баланса
4232 }
4233 )))
4234
4235 Ответ: Success
4236
4237 (((
4238 {
4239 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4240 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4241 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4242 "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4243 "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4244 "Description": "string" ~/~/ Описание корректировки
4245 }
4246 )))
4247
4248 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4249
4250 (% class="box warningmessage" %)
4251 (((
4252 **PUT /api/v3/Billing/client/constraint**
4253 )))
4254
4255 Тело запроса:
4256
4257 (((
4258 {
4259 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4260 "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4261 "PermissibleBalance": 0, ~/~/ Допустимый баланс
4262 "DefermentDays": 0, ~/~/ Отсрочка (дни).
4263 "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4264 "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4265 }
4266 )))
4267
4268 (((
4269
4270 )))
4271
4272 Ответ: Success
4273
4274 (((
4275 {
4276 "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4277 "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4278 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4279 "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4280 "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4281 "DefermentDays": 0, ~/~/ Отсрочка (дни)
4282 "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4283 "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4284 }
4285 )))
4286
4287 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4288
4289 (% class="box warningmessage" %)
4290 (((
4291 **PUT /api/v3/Billing/client/plan**
4292 )))
4293
4294 Тело запроса:
4295
4296 {
4297 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4298 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4299 "Features": [ ~/~/ Набор услуг по тарифу клиента.
4300 {
4301 "Feature": "string", ~/~/ Код услуги.
4302 "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4303 "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4304 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4305 "Price": 0, ~/~/ Цена за единицу.
4306 "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4307 "PeriodValue": 0, ~/~/ Значение периода.
4308 "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4309 }
4310 ]
4311 }
4312
4313
4314 Ответ: Success
4315
4316 (((
4317 {
4318 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4319 "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4320 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4321 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4322 "Name": "string", ~/~/ Наименование.
4323 "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4324 "Constraint": { ~/~/ Ограничения по тарифу 
4325 "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4326 "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4327 "DefermentDays": 0 ~/~/ Отсрочка (дни)
4328 },
4329 "Features": [ ~/~/ Набор услуг по тарифному плану.
4330 {
4331 "Feature": "string", ~/~/Код услуги.
4332 "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4333 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4334 "Price": 0, ~/~/ Цена за единицу.
4335 "PeriodValue": 0, ~/~/ Значение периода.
4336 "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4337 }
4338 ],
4339 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4340 "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4341 "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4342 },
4343 "Features": [ ~/~/ Набор услуг по тарифу клиента.
4344 {
4345 "Feature": "string", ~/~/ Код услуги.
4346 "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4347 "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4348 "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4349 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4350 "Price": 0, ~/~/ Цена за единицу.
4351 "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4352 "PeriodValue": 0, ~/~/ Значение периода.
4353 "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4354 "Quantity": 0 ~/~/ Количество использования услуги.
4355 }
4356 ]
4357 }
4358 )))
4359
4360 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4361
4362 (% class="box warningmessage" %)
4363 (((
4364 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4365 )))
4366
4367 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4368
4369 (% class="box infomessage" %)
4370 (((
4371 **POST /api/v3/vehicles/import/{agentId}**
4372 )))
4373
4374 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4375
4376 В пути указывается **agentId** - id клиента.
4377
4378 **Заголовок**
4379
4380 **X-Auth: [токен авторизации]**
4381
4382 **Параметры**
4383
4384 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4385 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4386 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4387
4388 В теле использовать тип **form-data,** тип значения** file**
4389
4390 **Ключи**
4391
4392 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4393 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4394 |csv|В значении передаем файл датчиков, формат **csv**
4395
4396 Ответ:
4397
4398 {
4399 "vehicleId": 0,
4400 "name": "string",
4401 "errors": ["string"]
4402 }
4403
4404 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4405 |vehicleId|ID созданного объекта
4406 |name|Имя созданного объекта
4407 |errors|Ошибки и их описание
4408
4409 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4410
4411 (% class="box infomessage" %)
4412 (((
4413 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4414 )))
4415
4416 (% class="wikigeneratedid" %)
4417 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4418
4419 (% class="wikigeneratedid" %)
4420 В пути указывается **vehicleId **- id объекта.
4421
4422 **Заголовок**
4423
4424 **X-Auth: [токен авторизации]**
4425
4426 В теле использовать тип **form-data.**
4427
4428 Ключи:
4429
4430 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4431 |**history**|В значении передавать файл с историей
4432
4433 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4434
4435 Ответ:
4436
4437 {
4438 "results": [
4439 {
4440 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4441 "vehicleId": 0,
4442 "errors": [
4443 "string"
4444 ],
4445 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4446 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4447 "producedCount": 0,
4448 "msgCount": 0
4449 }
4450 ]
4451 }
4452
4453 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4454 |results|Результаты импорта в разрезе ТС
4455 |vehicleGuid|Guid ТС
4456 |vehicleId|ID ТС
4457 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4458 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4459 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4460 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4461 |msgCount|Кол-во обработанных сообщений всего
4462
4463 == **Импортировать историю ТС (Асинхронный запрос)** ==
4464
4465 (% class="box successmessage" %)
4466 (((
4467 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4468 )))
4469
4470 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4471
4472 Метод запроса: **POST**
4473
4474 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4475
4476 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4477
4478
4479 Ответ:
4480
4481 {
4482
4483 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4484
4485 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4486
4487 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4488
4489 "Message": "string", ~/~/ Информация о выполнении запроса
4490
4491 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4492
4493 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4494
4495 "Data": "string" ~/~/ Данные
4496
4497 }
4498
4499
4500 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4501
4502 (% class="box infomessage" %)
4503 (((
4504 **GET /api/v3/vehicles/import/history/status**
4505 )))
4506
4507 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4508
4509 Ответ:
4510
4511 {
4512 "activity": true,
4513 "progress": 0,
4514 "message": "string"
4515 }
4516
4517 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4518 **Параметр**
4519 )))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4520 **Описание**
4521 )))
4522 |(((
4523 activity
4524 )))|(((
4525 Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4526 )))
4527 |(((
4528 progress
4529 )))|(((
4530 Guid ТС
4531 )))
4532
4533 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
4534
4535 (% class="box infomessage" %)
4536 (((
4537 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4538 )))
4539
4540 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4541
4542 Метод запроса: **GET**
4543
4544 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4545
4546 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4547
4548
4549 Ответ:
4550
4551 {
4552
4553 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4554
4555 "Status": 0, ~/~/ Перечисление состояний выполения запроса
4556 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4557
4558 "Message": "string", ~/~/ Информация о выполнении запроса
4559
4560 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4561
4562 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4563
4564 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4565
4566 "Data": "string" ~/~/ Данные
4567
4568 }
4569
4570 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4571
4572 (% class="box infomessage" %)
4573 (((
4574 **POST /api/v3/vehicles/export**
4575 )))
4576
4577 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4578
4579 Тело запроса:
4580
4581 [
4582 id
4583 ]
4584
4585 Ответ: Success 200, получаете файлы с настройками.
4586
4587 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4588
4589 (% class="box infomessage" %)
4590 (((
4591 **POST /api/v3/vehicles/export/history**
4592 )))
4593
4594 Метод возвращает список сообщений терминала объекта за выбранный период.
4595
4596 Тело запроса:
4597
4598 {
4599 "vehicleId": 0,
4600 "asArchive": true,
4601 "from": "2023-09-27T12:17:45.973Z",
4602 "to": "2023-09-27T12:17:45.973Z"
4603 }
4604
4605 Ответ:
4606
4607 Получаете файл. Сообщение: Code 200/Success
4608
4609 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4610 |vehicleId|ID объекта
4611 |asArchive|true - Архивировать файл, False - не архивировать
4612 |from|Дата и время начала запроса
4613 |to|Дата и время окончания запроса
4614
4615 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4616
4617 (% class="box infomessage" %)
4618 (((
4619 **GET /api/v3/vehicles/export/history/status**
4620 )))
4621
4622 Метод возвращает список сообщений терминала объекта за выбранный период.
4623
4624 Ответ:
4625
4626 {
4627 "activity": true,
4628 "progress": 0,
4629 "message": "string"
4630 }
4631
4632 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4633 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4634 |progress|Прогресс экспорта, от 0 до 100%
4635 |message|Текст описывающий статус
4636
4637 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4638
4639 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4640
4641 (% class="box infomessage" %)
4642 (((
4643 **POST /api/v3/EcoDriving/rating**
4644 )))
4645
4646 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4647
4648 Тело запроса:
4649
4650 {
4651 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4652 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4653 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4654 }
4655
4656 Ответ:
4657
4658 {
4659 "items": [  ~/~/ Список в разрезе ТС
4660 {
4661 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4662 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4663 "vehicleId": 0, ~/~/ ID ТС
4664 "vehicleName": "string", ~/~/ Название ТС
4665 "vehicleModel": "string", ~/~/ Модель ТС
4666 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4667 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4668 "totalViolations": 0, ~/~/ Нарушений всего
4669 "violationsByType": { ~/~/ Информация о нарушениях по типу
4670 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4671 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4672 "brakingViolations": 0, ~/~/ Нарушений торможения
4673 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4674 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4675 "sensorViolations": 0 ~/~/ Нарушений по датчику
4676 },
4677
4678 (((
4679
4680 )))
4681
4682 "moveTime": 0, ~/~/ Продолжительность движения, сек
4683 "mileage": 0, ~/~/ Пробег, м
4684 "tripsCount": 0, ~/~/ Кол-во рейсов
4685 "trips": [  ~/~/ Информация по рейсу
4686 {
4687 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4688 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4689 "violationsCount": 0, ~/~/ Всего нарушений
4690 "violationsByType": { ~/~/ Информация о нарушениях по типу
4691 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4692 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4693 "brakingViolations": 0, ~/~/ Нарушений торможения
4694 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4695 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4696 "sensorViolations": 0 ~/~/ Нарушений по датчику
4697 },
4698
4699 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4700 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4701 "moveTime": 0, ~/~/ Продолжительность движения, сек
4702 "mileage": 0, ~/~/ Пробег, м
4703 "motohours": 0, ~/~/ Моточасы, секунды
4704 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4705 "startAddress": "string", ~/~/ Адрес начала рейса
4706 "endAddress": "string", ~/~/ Адрес конца рейса
4707 "drivers": [  ~/~/ Список водителей
4708 {
4709 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4710 "driverName": "string", ~/~/ФИО водителя
4711 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4712 }
4713 ]
4714 }
4715 ]
4716 }
4717 ]
4718 }
4719
4720 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4721
4722 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4723
4724 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4725
4726 (% class="box infomessage" %)
4727 (((
4728 **POST /api/v3/fuelcards/transactions**
4729 )))
4730
4731 Метод запроса: POST
4732
4733 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4734 \\В заголовках запроса: X-Auth: Токен авторизации
4735
4736 Параметры в теле запроса (JSON):
4737
4738 {
4739 "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4740 "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4741 "ids": [ 
4742 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4743 ],
4744 "timezone": 0 ~/~/ Часовой пояс
4745 }
4746
4747
4748 Ответ:
4749 {
4750 "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4751 "driver": "string", ~/~/ Водители, привязанные к ТК
4752 "object": "string", ~/~/ Наименование ТС
4753 "amount": 0, ~/~/ Количество топлива
4754 "amountDut": 0, ~/~/ Количество по ДУТ
4755 "amountDiff": 0, ~/~/ Разница, л
4756 "amountDiffPerc": 0, ~/~/ Разница, %
4757 "summa": 0, ~/~/ Стоимость, руб
4758 "serviceName": "string", ~/~/ Тип топлива
4759 "price": 0, ~/~/ Цена за литр, руб
4760 "cardName": "string", ~/~/ Наименование ТК
4761 "cardNum": "string", ~/~/ Номер ТК
4762 "operator": "string", ~/~/ Оператор ТК
4763 "address": "string" ~/~/ Адрес АЗС
4764 }
4765
4766 == (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4767
4768 (% class="box infomessage" %)
4769 (((
4770 **GET /api/v3/fuelcards**
4771 )))
4772
4773 Метод запроса: GET
4774
4775 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4776
4777 Ответ:
4778
4779 [
4780 {
4781 "Name": "string", ~/~/ Определяет наименование карты.
4782 "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4783 "Number": "string", ~/~/ Определяет № карты.
4784 "Enabled": true, ~/~/ Определяет признак активности карты.
4785 "Description": "string", ~/~/ Определяет описание карты.
4786 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4787 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4788 "deleted": true ~/~/ Признак удаления
4789 }
4790 ]
4791
4792 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4793
4794
4795 == **Получение полных данных о ретрансляторе** ==
4796
4797 (% class="box infomessage" %)
4798 (((
4799 **GET ** **/api/v3/retranslations/{id}**
4800 )))
4801
4802 id - Идентификатор ретранслятора
4803
4804
4805 Пример ответа:
4806
4807 {  
4808 "description": "", ~/~/ Поле описания ретранслятора
4809 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4810 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4811 "isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4812 "address": "string", ~/~/ Адрес и порт принимающего сервера
4813 "objects": [ ~/~/ Объекты для ретрансляции
4814 {      
4815 "id": "",  ~/~/ Идентификатор объекта ретрансляции
4816 "name": "", ~/~/ Наименование объекта ретрансляции
4817 "imei": "", ~/~/ IMEI объекта  ретрансляции
4818 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4819 }
4820 ],  
4821 "id": "", ~/~/ Идентификатор ретранслятора 
4822 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4823 "deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4824 }
4825
4826
4827 == **Удаление данных ретранслятора** ==
4828
4829 (% class="box infomessage" %)
4830 (((
4831 **DELETE** **/api/v3/retranslations/{id}**
4832 )))
4833
4834 id - Идентификатор ретранслятора
4835
4836
4837 == **Создание ретранслятора** ==
4838
4839 (% class="box infomessage" %)
4840 (((
4841 **POST ** **/api/v3/retranslations/{id}**
4842 )))
4843
4844 Запрос:
4845
4846 {  
4847 "description": "", ~/~/ Поле описания ретранслятора
4848 "subscriberId": "", ~/~/ Идентификатор подписчика
4849 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4850 "address": "", ~/~/ Адрес и порт принимающего сервера
4851 "isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4852 "objects": [ ~/~/Объекты для ретрансляции
4853 {      
4854 "id": "", ~/~/ Идентификатор ретранслятора 
4855 "imei": "", ~/~/ IMEI объекта ретрансляции
4856 "isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4857 }
4858 ]
4859 }
4860
4861
4862 Ответ:
4863
4864 {  
4865 "description": "", ~/~/ Поле описания ретранслятора
4866 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4867 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4868 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4869 "address": "string", ~/~/ Адрес и порт принимающего сервера
4870 "objects": [ ~/~/ Объекты для ретрансляции
4871 {      
4872 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4873 "name": "string", ~/~/ Наименование объекта ретрансляции    
4874 "imei": "", ~/~/ IMEI объекта ретрансляции
4875 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4876 }
4877 ],
4878 "id": "", ~/~/ Идентификатор ретранслятора   
4879 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4880 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4881 }
4882
4883
4884 == **Редактирование ретранслятора** ==
4885
4886 (% class="box infomessage" %)
4887 (((
4888 **PUT** **/api/v3/retranslations**
4889 )))
4890
4891 Пример запроса:
4892
4893 {  
4894 "id": "", ~/~/ Идентификатор ретранслятора   
4895 "description": "string", ~/~/ Поле описания ретранслятора
4896 "subscriberId": "", ~/~/ Идентификатор подписчика
4897 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4898 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4899 "address": "string", ~/~/ Адрес и порт принимающего сервера
4900 "objects": ~/~/ Объекты для ретрансляции
4901 [    
4902 {      
4903 "id": "",  ~/~/ Идентификатор объекта ретрансляции 
4904 "imei": "", ~/~/ IMEI объекта ретрансляции
4905 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4906 }
4907 ]
4908 }
4909
4910
4911 Пример ответа:
4912
4913 {  
4914 "description": "", ~/~/ Поле описания ретранслятора
4915 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4916 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4917 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4918 "address": "string", ~/~/ Адрес и порт принимающего сервера
4919 "objects": [ ~/~/ Объекты для ретрансляции
4920 {      
4921 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4922 "name": "string", ~/~/ Наименование объекта ретрансляции    
4923 "imei": "", ~/~/ IMEI объекта ретрансляции
4924 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4925 }
4926 ],
4927 "id": "", ~/~/ Идентификатор ретранслятора   
4928 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4929 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4930 }
4931
4932
4933 == **Получение списка ретранслятора клиента** ==
4934
4935 (% class="box infomessage" %)
4936 (((
4937 **POST /api/v3/retranslations/find**
4938 )))
4939
4940 Пример запроса:
4941
4942 {  
4943 "id": "", ~/~/ Идентификатор ретранслятора   
4944 "search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4945 "parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4946 }
4947
4948 Ответ:
4949
4950 [ 
4951 {    
4952 "description": "", ~/~/ Поле описания ретранслятора
4953 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4954 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4955 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4956 "address": "string", ~/~/ Адрес и порт принимающего сервера
4957 "id": "", ~/~/ Идентификатор ретранслятора   
4958 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4959 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4960 }
4961 ]
4962
4963
4964 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4965
4966 == **API для отчета по выгрузке комбайнов** ==
4967
4968 (% class="box infomessage" %)
4969 (((
4970 **POST /api/v3/Reports/harvesterUnloading**
4971 )))
4972
4973 Пример запроса:
4974
4975 {
4976 "byTime": 0, ~/~/ Объединение событий по времени
4977 "byDist": 0, ~/~/ Объединение событий по расстоянию
4978 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4979 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4980 "showNearestObjects": true, ~/~/Показывать объекты рядом?
4981 "vehicleIds": [ ~/~/ Список id объектов для анализа
4982 0
4983 ],
4984 "from": "", ~/~/ Дата и время начало запроса
4985 "to": "", ~/~/ Дата и время окончания запроса
4986 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4987 }
4988
4989 Пример ответа:
4990
4991 [ 
4992 {
4993 "harvesterName": "", ~/~/Комбайн, номер
4994 "harvesterId": 0, ~/~/Комбайн, id
4995 "harvesterModel": "", ~/~/ Модель комбайна
4996 "hopperCapacity": 0, ~/~/ Объем бункера м3
4997 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4998 "events": [ ~/~/Список событий в разрезе комбайна
4999 {
5000 "driverId": "", ~/~/Идентификатор водителя
5001 "driverName": "", ~/~/Водитель комбайна, ФИО
5002 "RFID": "", ~/~/ идентификатор карты-метки
5003 "rfidName": "", ~/~/Водитель комбайна, имя метки
5004 "vehicleId": 0, ~/~/идентификатор объекта
5005 "vehicleName": "string", ~/~/ Имя объекта
5006 "modelName": "string", ~/~/ Имя модели объекта
5007 "nearestVehicles": [ ~/~/Объекты рядом
5008 {
5009 "vehicleId": 0, ~/~/идентификатор объекта
5010 "vehicleName": "string" ~/~/ Имя объекта
5011 }
5012 ],
5013 "fields": [ ~/~/Поля, где происходила выгрузка
5014 {
5015 "id": 0, ~/~/ идентификатор пользователя 
5016 "name": "string" ~/~/ имя пользователя 
5017 }
5018 ],
5019 "event": "string", ~/~/Событие
5020 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
5021 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
5022 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
5023 "cultureName": "string", ~/~/ название культуры
5024 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
5025 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
5026 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
5027 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
5028 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
5029 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
5030 "issued": 0, ~/~/Выдано, бункеров
5031 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
5032 "latitude": 0, ~/~/Широта
5033 "longitude": 0, ~/~/ Долгота
5034 "litresAway": 0, ~/~/Отдано, л
5035 "m3Away": 0 ~/~/Отдано, м3
5036 }
5037 ]
5038 }
5039 ]
5040
5041
5042 == **Отчет трек-датчики** ==
5043
5044 (% class="box infomessage" %)
5045 (((
5046 **POST /api/v3/Reports/sensorsWorks**
5047 )))
5048
5049 **Пример запроса:**
5050
5051 {
5052 "vehicleIds": [ ~/~/ Список ID объектов
5053 0
5054 ],
5055 "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
5056 "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
5057 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5058 }
5059
5060 **Пример ответа:**
5061
5062 (((
5063 {
5064 "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
5065 {
5066 "vehicleId": 0, ~/~/ Идентификатор ТС
5067 "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
5068 {
5069 "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
5070 "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
5071 "duration": 0, ~/~/  Продолжительность интервала в секундах.
5072 "name": "string", ~/~/ Наименование оборудования.
5073 "mileage": 0, ~/~/ Пробег за время работы оборудования.
5074 "totalMileage": 0, ~/~/ Общий пробег.
5075 "avgSpeed": 0 ~/~/ Средняя скорость.
5076 }
5077 ]
5078 }
5079 ]
5080 }
5081
5082
5083 == **Превышение скорости** ==
5084
5085 (% class="box infomessage" %)
5086 (((
5087 **POST /api/v3/Reports/overSpeedDuration**
5088 )))
5089
5090 Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
5091
5092 Пример запроса:
5093
5094 (((
5095 {
5096 "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
5097 "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
5098 "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
5099 "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5100 "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
5101 }
5102 )))
5103
5104 (((
5105
5106 )))
5107
5108 (((
5109 Пример ответа:
5110 )))
5111
5112 (((
5113 (((
5114 [
5115 {
5116 "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
5117 "duration": 0, ~/~/ Продолжительность события в секундах 
5118 "maxSpeed": 0, ~/~/ Максимальная скорость 
5119 "speedLimit": 0 ~/~/ Ограничение скорости 
5120 }
5121 ]
5122 )))
5123 )))
5124 )))
5125
5126 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
5127
5128
5129 == **Запрос списка полей** ==
5130
5131 (% class="box successmessage" %)
5132 (((
5133 **POST /api/v3/agroLands/find**
5134 )))
5135
5136 Пример запроса:
5137
5138 (((
5139 (((
5140 (((
5141 {
5142 "year": 0, ~/~/ Фильтр по году
5143 "name": "string", ~/~/ Фильтр по названию
5144 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
5145 }
5146 )))
5147 )))
5148
5149
5150 )))
5151
5152 Пример ответа:
5153
5154 (((
5155 [
5156 {
5157 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5158 "year": 0, ~/~/ Год поля
5159 "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
5160 "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
5161 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5162 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5163 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5164 "counts": { ~/~/ Счётчики с/х поля 
5165 "fieldOperations": 0, ~/~/ Количество операций на поле
5166 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5167 "facts": 0 ~/~/ Счётчик факта
5168 },
5169 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5170 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5171 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5172 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5173 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5174 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5175 "planComment": "string", ~/~/ Комментарий к полю
5176 "productivity": 0, ~/~/ Урожайность.
5177 "id": 0, ~/~/ Идентификатор объекта геозоны
5178 "name": "string", ~/~/ Название объекта геозоны
5179 "type": 0, ~/~/ Тип объекта геозоны
5180 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5181 "fname": "string", ~/~/ Имя файла
5182 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5183 "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
5184 "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
5185 "description": "string", ~/~/ Описание объекта геозоны
5186 "area": 0, ~/~/ Площадь, м2
5187 "perimetr": 0, ~/~/ Периметр, м
5188 "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
5189 }
5190 ]
5191
5192
5193 == **Создание нового поля ** ==
5194
5195 (% class="box successmessage" %)
5196 (((
5197 **POST /api/v3/agroLands**
5198 )))
5199
5200 Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5201 X-agent  - ID клиента
5202
5203 Пример запроса:
5204
5205 (((
5206 {
5207 "extId": "string", 
5208 "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5209 "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5210 "display": "string", ~/~/ Настройки отображения
5211 "year": 0, ~/~/ Год поля
5212 "name": "string", ~/~/ Наименование
5213 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5214 "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5215 "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5216 "planComment": "string", ~/~/ Комментарий к полю
5217 "cropRotations": [ ~/~/ Данные по севообороту
5218 {
5219 "landId": 0, ~/~/ ID поля
5220 "landName": "string", ~/~/ Название поля
5221 "year": 0, ~/~/ Год урожая
5222 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5223 "cultureName": "string", ~/~/ Название культуры
5224 "productivity": 0, ~/~/ Урожайность
5225 "area": 0, ~/~/ Площадь поля, Га
5226 "total": 0, ~/~/ Валовый сбор
5227 "productivityFact": 0, ~/~/ Фактическая урожайность
5228 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5229 "totalFact": 0, ~/~/ Фактический валовый сбор
5230 "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5231 "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5232 "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5233 "isyearplan": true, ~/~/ Годовой план 
5234 "comment": "string" ~/~/ Комментарий
5235 }
5236 ]
5237 }
5238 )))
5239
5240 (((
5241
5242 )))
5243
5244 Пример ответа:
5245
5246 (((
5247 (((
5248 {
5249 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5250 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5251 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5252 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5253 "cropRotations": [ ~/~/ Данные по севообороту
5254 {
5255 "landId": 0, ~/~/ ID поля
5256 "landName": "string", ~/~/ Название поля
5257 "year": 0, ~/~/ Год урожая 
5258 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5259 "cultureName": "string", ~/~/ Название культуры
5260 "productivity": 0, ~/~/ Урожайность
5261 "area": 0, ~/~/ Площадь поля, Га.
5262 "total": 0, ~/~/ Валовый сбор
5263 "productivityFact": 0, ~/~/ Фактическая урожайность
5264 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5265 "totalFact": 0, ~/~/ Фактический валовый сбор
5266 "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5267 "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5268 "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5269 "isyearplan": true, ~/~/ годовой план 
5270 "comment": "string" ~/~/ Комментарий
5271 }
5272 ],
5273 "cropVegetation": [ ~/~/ История вегетации поля
5274 {
5275 "values": [  ~/~/ Данные вегетации и состояния посева
5276 {
5277 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5278 "ndvi": 0 ~/~/ Индекс вегетации
5279 }
5280 ],
5281 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5282 {
5283 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5284 "type": "string", ~/~/ Тип
5285 "pictureid": "string" ~/~/ Идентификатор ресурса
5286 }
5287 ],
5288 "states": [ ~/~/ Ключевые даты развития поля
5289 {
5290 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5291 "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5292 }
5293 ]
5294 }
5295 ],
5296 "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5297 "counts": {
5298 "fieldOperations": 0, ~/~/ Количество операций на поле
5299 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5300 "facts": 0 ~/~/ Счётчик факта
5301 },
5302 "planComment": "string", ~/~/ Комментарий к полю
5303 )))
5304
5305 (((
5306 "productivity": 0, ~/~/ Урожайность.
5307 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5308 "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5309 "year": 0, ~/~/ Год поля
5310 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5311 "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5312 "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5313 "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5314 "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5315 "id": 0, ~/~/ Идентификатор объекта геозоны
5316 "name": "string", ~/~/ Название объекта геозоны
5317 "type": 0, ~/~/ Тип объекта геозоны
5318 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5319 "fname": "string", ~/~/ Имя файла
5320 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5321 "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5322 "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5323 "description": "string", ~/~/ Описание объекта геозоны
5324 "area": 0, ~/~/ Площадь, м2
5325 "perimetr": 0, ~/~/ Периметр, м
5326 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5327 }
5328
5329
5330 )))
5331 )))
5332 )))
5333
5334 == **Получение поля по id** ==
5335
5336 (% class="box infomessage" %)
5337 (((
5338 **GET /api/v3/agroLands/{id}**
5339 )))
5340
5341 Пример запроса:
5342 id  ~/~/ Идентификатор поля
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-20T07:45:52.611Z", ~/~/ Дата начала работ
5366 "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5367 "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5368 "isyearplan": true, ~/~/ План года 
5369 "comment": "string" ~/~/ Комментарий
5370 }
5371 ],
5372 "cropVegetation": [ ~/~/ История вегетации поля
5373 {
5374 "values": [ ~/~/ Данные вегетации и состояния посева
5375 {
5376 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5377 "ndvi": 0 ~/~/ Индекс вегетации
5378 }
5379 ],
5380 "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5381 {
5382 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5383 "type": "string", ~/~/ Тип 
5384 "pictureid": "string" ~/~/ Идентификатор ресурса
5385 }
5386 ],
5387 "states": [ ~/~/ Ключевые даты развития поля
5388 {
5389 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5390 "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5391 }
5392 ]
5393 }
5394 ],
5395 "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5396 "counts": {
5397 "fieldOperations": 0, ~/~/ Количество операций на поле
5398 "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5399 "facts": 0 ~/~/ Счётчик факта
5400 },
5401 "planComment": "string", ~/~/ Комментарий к полю
5402 "productivity": 0, ~/~/ Урожайность.
5403 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5404 )))
5405
5406 (((
5407 (((
5408 "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5409 "year": 0, ~/~/ Год поля
5410 "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5411 "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5412 "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5413 "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5414 "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5415 "id": 0, ~/~/ Идентификатор объекта геозоны
5416 "name": "string", ~/~/ Название объекта геозоны
5417 "type": 0, ~/~/ Тип объекта геозоны 
5418 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5419 "fname": "string", ~/~/ Имя файла
5420 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5421 "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5422 "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5423 "description": "string", ~/~/ Описание объекта геозоны
5424 "area": 0, ~/~/ Площадь, м2
5425 "perimetr": 0, ~/~/ Периметр, м
5426 "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5427 }
5428 )))
5429
5430
5431
5432 (((
5433
5434 )))
5435
5436 (((
5437 (((
5438 (((
5439 == **Изменение поля** ==
5440
5441 (% class="box infomessage" %)
5442 (((
5443 **PUT /api/v3/agroLands**
5444 )))
5445
5446 Пример запроса:
5447
5448 (((
5449 (((
5450 {
5451 "id": 0, ~/~/ Идентификатор поля
5452 "extId": "string", ~/~/ ExtId
5453 "shape": "string", ~/~/ Форма поля
5454 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5455 "display": "string", ~/~/ Настройки отображения
5456 "year": 0, ~/~/ Год поля
5457 "name": "string", ~/~/ Наименование
5458 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5459 "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5460 "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5461 "planComment": "string", ~/~/Комментарий к полю
5462 "cropRotations": [  ~/~/ Данные по севообороту
5463 {
5464 "landId": 0, ~/~/ ID поля
5465 "landName": "string", ~/~/ Название поля
5466 "year": 0, ~/~/ Год урожая
5467 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5468 "cultureName": "string", ~/~/ Название культуры
5469 "productivity": 0, ~/~/ Урожайность
5470 "area": 0, ~/~/ Площадь поля, Га.
5471 "total": 0, ~/~/ Валовый сбор
5472 "productivityFact": 0, ~/~/ Фактическая урожайность
5473 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5474 "totalFact": 0, ~/~/ Фактический валовый сбор
5475 "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5476 "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5477 "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5478 "isyearplan": true, 
5479 "comment": "string" ~/~/ Комментарий
5480 }
5481 ],
5482 "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5483 }
5484 )))
5485 )))
5486
5487 (((
5488
5489 )))
5490
5491 Пример ответа:
5492
5493 (((
5494 (((
5495 (((
5496 {
5497 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5498 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5499 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5500 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5501 "cropRotations": [ ~/~/ Данные по севообороту
5502 {
5503 "landId": 0, ~/~/ ID поля
5504 "landName": "string", ~/~/ Название поля
5505 "year": 0, ~/~/  Год урожая
5506 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5507 "cultureName": "string", ~/~/ Название культуры
5508 "productivity": 0, ~/~/ Урожайность
5509 "area": 0, ~/~/ Площадь поля, Га
5510 "total": 0, ~/~/ Валовый сбор
5511 "productivityFact": 0, ~/~/ Фактическая урожайность
5512 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5513 "totalFact": 0, ~/~/ Фактический валовый сбор
5514 "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5515 "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5516 "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5517 "isyearplan": true, ~/~/ 
5518 "comment": "string" ~/~/ Комментарий
5519 }
5520 ],
5521 "cropVegetation": [ ~/~/ История вегетации поля
5522 {
5523 "values": [ ~/~/ Данные вегетации и состояния посева
5524 {
5525 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5526 "ndvi": 0 ~/~/ Индекс вегетации
5527 }
5528 ],
5529 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5530 {
5531 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5532 "type": "string", ~/~/ Тип
5533 "pictureid": "string" ~/~/ Идентификатор ресурса
5534 }
5535 ],
5536 "states": [ ~/~/ Ключевые даты развития поля 
5537 {
5538 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5539 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5540 }
5541 ]
5542 }
5543 ],
5544 "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5545 "counts": { 
5546 "fieldOperations": 0, ~/~/ Количество операций на поле
5547 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5548 "facts": 0 ~/~/ Счётчик факта
5549 },
5550 "planComment": "string", ~/~/ Комментарий к полю
5551 "productivity": 0, ~/~/ Урожайность.
5552 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5553 "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5554 "year": 0, ~/~/ Год поля
5555 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5556 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5557 "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5558 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5559 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5560 "id": 0, ~/~/ Идентификатор объекта геозоны
5561 "name": "string", ~/~/ Название объекта геозоны
5562 "type": 0, ~/~/ Тип объекта геозоны
5563 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5564 "fname": "string", ~/~/ Имя файла
5565 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5566 "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5567 "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5568 "description": "string", ~/~/ Описание объекта геозоны
5569 "area": 0, ~/~/ Площадь, м2
5570 "perimetr": 0, ~/~/ Периметр, м
5571 "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5572 }
5573 )))
5574 )))
5575 )))
5576 )))
5577 )))
5578
5579
5580 == **Редактирование года урожая ** ==
5581
5582 (% class="box successmessage" %)
5583 (((
5584 **POST /api/v3/agroLands/updateOpenCloseYear**
5585 )))
5586
5587 Пример запроса:
5588
5589 (((
5590 (((
5591 {
5592 "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5593 0
5594 ],
5595 "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5596 "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5597 }
5598 )))
5599
5600
5601 )))
5602
5603 Пример ответа:
5604
5605 (((
5606 (((
5607 {
5608 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5609 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5610 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5611 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5612 "cropRotations": [ ~/~/ Данные по севообороту
5613 {
5614 "landId": 0, ~/~/ ID поля
5615 "landName": "string", ~/~/ Название поля
5616 "year": 0, ~/~/ Год урожая
5617 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5618 "cultureName": "string", ~/~/ Название культуры
5619 "productivity": 0, ~/~/ Урожайность
5620 "area": 0, ~/~/ Площадь поля, Га.
5621 "total": 0, ~/~/ Валовый сбор
5622 "productivityFact": 0, ~/~/ Фактическая урожайность
5623 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5624 "totalFact": 0, ~/~/ Фактический валовый сбор
5625 "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5626 "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5627 "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5628 "isyearplan": true, ~/~/ 
5629 "comment": "string" ~/~/ Комментарий
5630 }
5631 ],
5632 "cropVegetation": [ ~/~/ История вегетации поля
5633 {
5634 "values": [ ~/~/ Данные вегетации и состояния посева
5635 {
5636 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5637 "ndvi": 0 ~/~/ Индекс вегетации
5638 }
5639 ],
5640 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5641 {
5642 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5643 "type": "string", ~/~/ Тип
5644 "pictureid": "string" ~/~/ Идентификатор ресурса
5645 }
5646 ],
5647 "states": [ ~/~/ Ключевые даты развития поля
5648 {
5649 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5650 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5651 }
5652 ]
5653 }
5654 ],
5655 "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5656 "counts": { 
5657 "fieldOperations": 0, ~/~/ Количество операций на поле
5658 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5659 "facts": 0 ~/~/ Счётчик факта
5660 },
5661 "planComment": "string", ~/~/ Комментарий к полю
5662 "productivity": 0, ~/~/ Урожайность.
5663 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5664 "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5665 "year": 0, ~/~/ Год поля
5666 "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5667 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5668 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5669 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5670 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5671 "id": 0, ~/~/ Идентификатор объекта геозоны
5672 "name": "string", ~/~/ Название объекта геозоны
5673 "type": 0, ~/~/ Тип объекта геозоны
5674 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5675 "fname": "string", ~/~/ Имя файла
5676 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5677 "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5678 "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5679 "description": "string", ~/~/ Описание объекта геозоны
5680 "area": 0, ~/~/ Площадь, м2
5681 "perimetr": 0, ~/~/ ериметр, м
5682 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5683 }
5684
5685
5686 == **Какие поля посещал объект** ==
5687
5688 (% class="box successmessage" %)
5689 (((
5690 **POST /api/v3/agroLands/visitingByVehicle**
5691 )))
5692
5693 Пример запроса:
5694
5695 {
5696 "vehicleId": 0, ~/~/ id объекта 
5697 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5698 "byTime": 0, ~/~/ Объединение событий по времени
5699 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5700 "byDist": 0, ~/~/ Объединение событий по расстоянию
5701 "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5702 "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5703 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5704 }
5705
5706 Пример ответа:
5707
5708 [
5709 {
5710 "fieldId": 0, ~/~/ id объекта 
5711 "vehicleName": "string", ~/~/ Наименование объекта 
5712 "fieldName": "string", ~/~/ Наименование поля 
5713 "fuelUsage": 0, ~/~/ Расход топлива, л/га
5714 "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5715 "vehicleId": 0, ~/~/ Идентификатор ТС
5716 "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5717 "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5718 "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5719 "mileage": 0 ~/~/ Пробег 
5720 }
5721 ]
5722 )))
5723
5724
5725 == **Посещение поля объектами ** ==
5726
5727 (% class="box successmessage" %)
5728 (((
5729 **POST /api/v3/agroLands/visitingByField**
5730 )))
5731
5732 Пример запроса:
5733 {
5734 "fieldId": 0, ~/~/ ID поля
5735 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5736 "byTime": 0, ~/~/ Объединение событий по времени
5737 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5738 "byDist": 0, ~/~/ Объединение событий по расстоянию
5739 "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5740 "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5741 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5742 }
5743
5744 Пример ответа:
5745
5746 [
5747 {
5748 "fieldId": 0, ~/~/ ID поля
5749 "vehicleName": "string", ~/~/ Наименование объекта 
5750 "fieldName": "string", ~/~/ Имя поля
5751 "fuelUsage": 0, ~/~/ Расход топлива, л/га
5752 "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5753 "vehicleId": 0, ~/~/ Идентификатор ТС
5754 "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5755 "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5756 "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5757 "mileage": 0 ~/~/ Пробег
5758 }
5759 ]
5760
5761
5762 == **Удаление существующего поля** ==
5763
5764 (% class="box errormessage" %)
5765 (((
5766 **DELETE /api/v3/agroLands/{id}**
5767 )))
5768
5769 Пример запроса:
5770 id  ~/~/ Идентификатор поля
5771
5772 Пример ответа:
5773
5774 (((
5775 200 ~/~/ Успех
5776
5777
5778 )))
5779
5780 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5781 )))
5782 )))
5783 )))
5784
5785 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5786
5787
5788 (% class="box infomessage" %)
5789 (((
5790 **GET api/v3/Vehicles/recyclebin/all**
5791 )))
5792
5793 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5794
5795 Параметр запроса: {parentId} - идентификатор агента
5796
5797 В заголовках запроса: X-Auth: Токен авторизации
5798
5799 Ответ:
5800
5801 [ 
5802 {
5803 "recordTime": "", ~/~/Время записи
5804 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5805 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5806 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5807 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5808 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5809 "details": { ~/~/Список деталей объекта, помещённого в корзину
5810 "items": [ ~/~/ 
5811 nullable: true ~/~/Детали
5812 {
5813 "name": "string", ~/~/наименование столбца
5814 "value": "string" ~/~/содержание столбца
5815 }
5816 ]
5817 },
5818 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5819 "string"
5820 ]
5821 }
5822 ]
5823
5824
5825 == (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5826
5827 (% class="box infomessage" %)
5828 (((
5829 **POST api/v3/Vehicles/recyclebin/erase**
5830 )))
5831
5832 В заголовках запроса: X-Auth: Токен авторизации
5833
5834 Пример запроса:
5835
5836 [
5837 0
5838 ]
5839
5840
5841 Пример ответа:
5842
5843 [ 
5844 {
5845 "recordTime": "", ~/~/Время записи
5846 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5847 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5848 "objectId": 0, ~/~/ID объекта, помещённого в корзин
5849 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5850 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5851 "details": { ~/~/Список деталей объекта, помещённого в корзину
5852 "items": [ ~/~/Детали
5853 {
5854 "name": "", ~/~/Имя свойства
5855 "value": "" ~/~/Значение свойства
5856 }
5857 ]
5858 },
5859 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5860 ""
5861 ]
5862 }
5863 ]
5864
5865 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5866
5867 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5868
5869 (% class="box infomessage" %)
5870 (((
5871 **POST api/v3/Vehicles/recyclebin/restore**
5872 )))
5873
5874 В заголовках запроса: X-Auth: Токен авторизации
5875
5876 Параметры в теле запроса (JSON):
5877
5878 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5879
5880 В заголовках запроса: X-Auth: Токен авторизации
5881
5882
5883 Пример запроса:
5884
5885 (((
5886 [
5887 )))
5888
5889 (((
5890 0
5891 )))
5892
5893 (((
5894 ]
5895 )))
5896
5897
5898 Пример ответа:
5899
5900 [
5901 {
5902 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5903 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5904 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5905 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5906 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5907 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5908 "details": { ~/~/Список деталей объекта, помещённого в корзину
5909 "items": [ ~/~/Детали
5910 {
5911 "name": "string", ~/~/Имя свойства
5912 "value": "string" ~/~/Значение свойства
5913 }
5914 ]
5915 },
5916 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5917 "string"
5918 ]
5919 }
5920 ]
5921
5922
5923 = **Раздел: Журнал заданий ** =
5924
5925
5926 == **Создание задания в Журнале заданий** ==
5927
5928 (% class="box infomessage" %)
5929 (((
5930 **POST /api/v3/vehicletasks**
5931 )))
5932
5933 Пример запроса:
5934
5935 (((
5936 {
5937 "vehicleId": 0, ~/~/ Идентификатор ТС
5938 "description": "string", ~/~/ Описание
5939 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5940 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5941 "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5942 "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5943 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5944 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5945 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5946 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5947 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5948 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5949 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5950 "cost": { 
5951 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5952 "Name": "string", ~/~/ Наименование
5953 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5954 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5955 "Norm": 0 ~/~/ Норма внесения
5956 },
5957 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5958 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5959 "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5960 "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5961 "deleted": true, ~/~/ Признак удаления
5962 "extId": "string", 
5963 "GeoIds": [ ~/~/ Cвязанные поля
5964 0
5965 ]
5966 }
5967 )))
5968
5969
5970 Пример ответа:
5971
5972 {
5973 "vehicleId": 0, ~/~/ Идентификатор ТС
5974 "description": "string", ~/~/ Описание
5975 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5976 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5977 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5978 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5979 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5980 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5981 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5982 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5983 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5984 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5985 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5986 "cost": { 
5987 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5988 "Name": "string", ~/~/ Наименование
5989 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5990 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5991 "Norm": 0 ~/~/ Норма внесения
5992 },
5993 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5994 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5995 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5996 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5997 "deleted": true, ~/~/ Признак удаления
5998 "extId": "string", ~/~/ ExtId
5999 "GeoIds": [ ~/~/ Связанные поля
6000 0
6001 ]
6002 }
6003
6004
6005 == **Редактирование задания в Журнале заданий** ==
6006
6007 (% class="box successmessage" %)
6008 (((
6009 **PUT /api/v3/vehicletasks**
6010 )))
6011
6012 Пример запроса:
6013
6014 (((
6015 {
6016 "vehicleId": 0, ~/~/ Идентификатор ТС
6017 "description": "string", ~/~/ Описание
6018 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6019 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6020 "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
6021 "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
6022 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6023 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6024 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6025 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6026 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6027 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6028 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6029 "cost": { 
6030 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6031 "Name": "string", ~/~/ Наименование
6032 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6033 "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6034 "Norm": 0 ~/~/ Норма внесения
6035 },
6036 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6037 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6038 "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
6039 "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
6040 "deleted": true, ~/~/ Признак удаления
6041 "extId": "string", ~/~/ ExtId
6042 "GeoIds": [ ~/~/ Связанные поля
6043 0
6044 ]
6045 }
6046 )))
6047
6048
6049 Пример ответа:
6050
6051 {
6052 "vehicleId": 0, ~/~/ Идентификатор ТС
6053 "description": "string", ~/~/ Описание
6054 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6055 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6056 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6057 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6058 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6059 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6060 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6061 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6062 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6063 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6064 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6065 "cost": { 
6066 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6067 "Name": "string", ~/~/ Наименование
6068 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6069 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6070 "Norm": 0 ~/~/ Норма внесения
6071 },
6072 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6073 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6074 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6075 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6076 "deleted": true, ~/~/ Признак удаления
6077 "extId": "string", ~/~/ ExtId
6078 "GeoIds": [ ~/~/ Связанные поля
6079 0
6080 ]
6081 }
6082
6083
6084 == **Удаление задания в Журнале заданий** ==
6085
6086 (% class="box warningmessage" %)
6087 (((
6088 **DELETE /api/v3/vehicletasks**
6089 )))
6090
6091 Пример запроса:
6092
6093 (((
6094 [
6095 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
6096 ]
6097 )))
6098
6099 (((
6100
6101 )))
6102
6103 Пример ответа:
6104
6105 {
6106 "vehicleId": 0, ~/~/ Идентификатор ТС
6107 "description": "string", ~/~/ Описание
6108 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6109 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6110 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6111 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6112 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6113 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6114 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6115 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6116 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6117 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6118 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6119 "cost": { 
6120 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6121 "Name": "string", ~/~/ Наименование
6122 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6123 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6124 "Norm": 0 ~/~/ Норма внесения
6125 },
6126 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6127 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6128 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6129 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6130 "deleted": true, ~/~/ Признак удаления
6131 "extId": "string", ~/~/ ExtId
6132 "GeoIds": [ ~/~/ Связанные поля
6133 0
6134 ]
6135 }
6136
6137
6138 == **Получение списка Журнала заданий** ==
6139
6140 (% class="box infomessage" %)
6141 (((
6142 **POST /api/v3/vehicletasks/getbyperiod**
6143 )))
6144
6145 Пример запроса:
6146
6147 (((
6148 {
6149 "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
6150 "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
6151 "TimeZone": 0, ~/~/ Часовой пояс.
6152 "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
6153 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
6154 ],
6155 "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
6156 0
6157 ],
6158 "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
6159 0
6160 ],
6161 "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
6162 "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
6163 }
6164 )))
6165
6166
6167 Пример ответа:
6168
6169 (((
6170 {
6171 "total": 0,  ~/~/ Общее количество записей
6172 "pages": 0,  ~/~/ Общее количество страниц
6173 "currentPage": 0, ~/~/ Текущая страница
6174 "items": [  ~/~/ Записи 
6175 {
6176 "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6177 "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
6178 "name": "string", ~/~/ Название задания.
6179 "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
6180 "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
6181 "workKind": "string", ~/~/ Вид работ
6182 "techOp": "string", ~/~/ Тех. операция
6183 "trailerModel": "string", ~/~/ Модель агрегата
6184 "width": "string", ~/~/ Ширина, м
6185 "speed": "string", ~/~/ Тех. скорость
6186 "fields": "string", ~/~/ Поля
6187 "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
6188 "vehicles": "string", ~/~/ Объект-модель
6189 "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
6190 "drivers": "string", ~/~/ Водители
6191 "tmc": "string", ~/~/ ТМЦ
6192 "client": "string", ~/~/  Клиент
6193 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6194 "dep": "string", ~/~/ Подразделение
6195 "geoIds": [ ~/~/  Связанные поля
6196 0
6197 ]
6198 }
6199 ]
6200 }
6201 )))
6202
6203
6204 = **Раздел: Роли** =
6205
6206 == **Получение списка клиентских и системных ролей пользователя ** ==
6207
6208 (% class="box successmessage" %)
6209 (((
6210 **POST /api/v3/groups/find**
6211 )))
6212
6213 Пример запроса:
6214
6215 (((
6216 {
6217 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6218 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6219 }
6220 )))
6221
6222 (((
6223
6224 )))
6225
6226 (((
6227 Пример ответа:
6228 )))
6229
6230 (((
6231 (((
6232 {
6233 "groups": [  ~/~/ Системные роли пользователя
6234 {
6235 "code": "string", ~/~/ Код роли.
6236 "name": "string", ~/~/ Имя  
6237 "shortName": "string" ~/~/ Короткое имя 
6238 }
6239 ],
6240 "customGroups": [ ~/~/ Системные роли пользователя
6241 {
6242 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6243 "name": "string", ~/~/ Наименование 
6244 "shortName": "string", ~/~/ Короткое наименование 
6245 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6246 }
6247 ]
6248 }
6249 )))
6250 )))
6251
6252 (((
6253
6254 )))
6255
6256 (((
6257
6258 )))
6259
6260 = **Раздел: Локатор ** =
6261
6262
6263 == **Получение данных по локатору** ==
6264
6265 (% class="box infomessage" %)
6266 (((
6267 **GET /api/v3/locators/{locatorId}**
6268 )))
6269
6270 В запросе указывается locatorid - идентификатор локатора
6271
6272
6273 Пример ответа:
6274
6275 (((
6276 (((
6277 {
6278 "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6279 0
6280 ],
6281 "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6282 0
6283 ],
6284 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6285 0
6286 ],
6287 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6288 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6289 "agentName": "string", ~/~/ Наименование агента.
6290 "isEnabled": true, ~/~/ Активность 
6291 "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6292 "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6293 "name": "string", ~/~/ Наименование.
6294 "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6295 "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6296 "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6297 "validity": 0, ~/~/ Значение срока действия
6298 "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6299 "autoProlongation": true, ~/~/ Автопродление срока действия.
6300 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6301 "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6302 "url": "string", ~/~/ Ссылка
6303 "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6304
6305 "showVehicleName": true, ~/~/ Наименование объекта
6306 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6307 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6308 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6309 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6310 "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ГИС)
6311
6312 1
6313
6314 ]
6315 }
6316 )))
6317 )))
6318
6319
6320 (((
6321 (((
6322
6323 )))
6324 )))
6325
6326
6327 == **Создание локатора** ==
6328
6329 (% class="box successmessage" %)
6330 (((
6331 **POST /api/v3/locators**
6332 )))
6333
6334 Пример запроса:
6335
6336 (((
6337 {
6338 "isEnabled": true, ~/~/ Активность
6339 "name": "string", ~/~/ Наименование локатора
6340 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
6341 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
6342 "validity": 0, ~/~/ Срок действия в днях (1-90)
6343 "autoProlongation": true, ~/~/ Автопродление срока действия.
6344 "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6345 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6346 "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6347 0
6348 ],
6349 "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6350 0
6351 ],
6352 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6353 0
6354 ],
6355
6356 "showVehicleName": true, ~/~/ Наименование объекта
6357 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6358 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6359 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6360 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6361 "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ГИС)
6362
6363 1
6364
6365 ]
6366 }
6367 )))
6368
6369
6370 Пример ответа:
6371
6372 (((
6373 3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
6374 )))
6375
6376
6377 == **Выводит список локаторов ** ==
6378
6379 (% class="box successmessage" %)
6380 (((
6381 **POST /api/v3/locators/find**
6382 )))
6383
6384 Пример запроса:
6385
6386 (((
6387 {
6388 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6389 }
6390 )))
6391
6392 (((
6393
6394 )))
6395
6396 (((
6397
6398 )))
6399
6400
6401 Пример ответа:
6402
6403 (((
6404 [
6405 {
6406 "vehiclesCount": 0, ~/~/ Количество объектов.
6407 "geozonesCount": 0, ~/~/ Количество геозон.
6408 "fieldsCount": 0, ~/~/ Количество полей.
6409 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6410 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6411 "agentName": "string", ~/~/ Наименование агента.
6412 "isEnabled": true, ~/~/ Активность локатора
6413 "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6414 "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6415 "name": "string", ~/~/ Наименование локатора 
6416 "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6417 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6418 "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6419 "validity": 0, ~/~/ Срок действия в днях (1-90)
6420 "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6421 "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6422 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6423 "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6424 "url": "string", ~/~/ ссылка на локатор 
6425 "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6426 "showVehicleName": true, ~/~/ Наименование объекта
6427 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6428 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6429 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6430 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6431 "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ГИС)
6432
6433 0
6434 ]
6435 }
6436 ]
6437 )))
6438
6439
6440 == **Изменение локатора** ==
6441
6442 (% class="box infomessage" %)
6443 (((
6444 **PUT /api/v3/locators**
6445 )))
6446
6447 Пример запроса:
6448
6449 (((
6450 {
6451 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6452 "isEnabled": true, ~/~/ Активность 
6453 "name": "string", ~/~/ Наименование
6454 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6455 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6456 "validity": 0, ~/~/ Срок действия в днях (1-90)
6457 "autoProlongation": true, ~/~/ Автопродление срока действия
6458 "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6459 "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6460 0
6461 ],
6462 "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6463 0
6464 ],
6465 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6466 0
6467 ],
6468 "showVehicleName": true, ~/~/ Наименование объекта
6469 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6470 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6471 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6472 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6473 "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ГИС)
6474
6475 0
6476
6477 ]
6478 }
6479
6480
6481 )))
6482
6483 Пример ответа:
6484
6485 200 ~/~/ Success
6486
6487
6488 == **Удалить локатор** ==
6489
6490 (% class="box warningmessage" %)
6491 (((
6492 **DELETE /api/v3/locators**
6493 )))
6494
6495 Пример запроса:
6496
6497 (((
6498 [
6499 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6500 ]
6501 )))
6502
6503
6504 = **Раздел: Яндекс Маршруты** =
6505
6506
6507 == **Возвращение списка маршрутов** ==
6508
6509 (% class="box infomessage" %)
6510 (((
6511 **GET /api/v3/TransportRoutes**
6512 )))
6513
6514 Пример запроса:
6515 Id  ~/~/ Идентификатор поля
6516
6517 Пример ответа:
6518
6519 (((
6520 [
6521 {
6522 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6523 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6524 "name": "string", ~/~/ Наименование маршрута.
6525 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6526 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6527 0
6528 ]
6529 }
6530 ]
6531 )))
6532
6533
6534 == **Добавить маршрут** ==
6535
6536 (% class="box infomessage" %)
6537 (((
6538 **POST /api/v3/TransportRoutes**
6539 )))
6540
6541 Пример запроса: 
6542 {
6543 "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6544 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6545 "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6546 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6547 0
6548 ]
6549 }
6550
6551
6552 Пример ответа:
6553
6554 (((
6555 {
6556 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6557 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6558 "name": "string", ~/~/ Определяет наименование маршрута 
6559 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6560 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6561 0
6562 ]
6563 }
6564 )))
6565
6566
6567 == **Обновление маршрута** ==
6568
6569 (% class="box successmessage" %)
6570 (((
6571 **PUT /api/v3/TransportRoutes**
6572 )))
6573
6574 Пример запроса:
6575
6576 (((
6577 {
6578 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6579 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6580 "name": "string", ~/~/ Опредлеляет наименование маршрута.
6581 "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6582 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6583 0
6584 ]
6585 }
6586 )))
6587
6588 Пример ответа:
6589
6590 (((
6591 {
6592 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6593 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6594 "name": "string", ~/~/ Определяет наименование маршрута 
6595 "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6596 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6597 0
6598 ]
6599 }
6600 )))
6601
6602
6603 == **Получить связки маршрутов ТС** ==
6604
6605 (% class="box infomessage" %)
6606 (((
6607 **POST /api/v3/TransportRoutes/getroutesvehicles**
6608 )))
6609
6610 Пример запроса:
6611
6612 (((
6613 [
6614 "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6615 ]
6616 )))
6617
6618 Пример ответа:
6619
6620 (((
6621 [
6622 {
6623 "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6624 "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6625 }
6626 ]
6627 )))
6628
6629
6630 == **Удалить маршрут** ==
6631
6632 (% class="box warningmessage" %)
6633 (((
6634 **DELETE /api/v3/TransportRoutes/{id}**
6635 )))
6636
6637 Пример запроса:
6638 Id  ~/~/ Идентификатор поля
6639
6640
6641 = **Раздел: Управление доступа к машинам** =
6642
6643
6644 == Получение списка транспортных средств видимых пользователю ==
6645
6646 (% class="box infomessage" %)
6647 (((
6648 **GET /api/v3/UserVisibleVehicles/{userId}**
6649 )))
6650
6651 Пример ответа:
6652
6653 (((
6654 {
6655 "vehicleIds": [  ~/~/ Идентификаторы ТС
6656 0
6657 ]
6658 }
6659 )))
6660
6661
6662 == Задает видимость транспортных средств пользователю ==
6663
6664 (% class="box infomessage" %)
6665 (((
6666 **POST /api/v3/UserVisibleVehicles**
6667 )))
6668
6669 Пример запроса:
6670
6671 (((
6672 (((
6673 {
6674 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6675 "vehicleIds": [ ~/~/ Идентификаторы ТС
6676 0
6677 ]
6678 }
6679 )))
6680
6681 (((
6682
6683 )))
6684
6685 (((
6686 Пример ответа :
6687 )))
6688
6689 (((
6690
6691 )))
6692
6693 (((
6694 200 ~/~/ Success
6695 )))
6696 )))
6697
6698
6699 (% class="box" lang="en-US" style="text-align: center;" %)
6700 (((
6701 (% 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]] **
6702 )))
ГЛОНАССSoft wiki - 2024 г.