Version 256.2 by Павел Субботин on 2025/12/04 10:49
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 (% class="wikigeneratedid" id="H" %)
748 (((
749
750 )))
751
752 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
753
754 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
755
756 (% class="box infomessage" %)
757 (((
758 (% lang="en-US" %)**GET /api/v3/models/{Id}**
759 )))
760
761 Метод возвращает полную информацию о модели объекта.
762
763 (% style="color:#000000" %)Метод запроса: **GET**
764
765 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
766
767 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
768
769 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
770
771 (% style="color:#000000" %)Ответ:
772
773 (% style="color:#000000" %){
774 "parentName": "string",
775 "name": "string",
776 "picture": "string",
777 "minspeed": 0,
778 "maxspeed": 0,
779 "width": 0,
780 "imbeddedtrailer": true,
781 "hoppercapacity": 0,
782 "hopperdischargespeed": 0,
783 "modelType": 0,
784 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
785 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
786 "deleted": true
787 }
788
789 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
790 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
791 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
792 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
793 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
794 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
795 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
796 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
797 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
798 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
799 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
800 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
801 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
802 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
803
804 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
805
806 (% class="box successmessage" %)
807 (((
808 (% lang="en-US" %)**POST /api/v3/models/find**
809 )))
810
811 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
812
813 (% style="color:#000000" %)Метод запроса: **POST**
814
815 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
816
817 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
818
819 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
820
821 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
822 }
823
824 (% style="color:#000000" %)Ответ:
825
826 (% style="color:#000000" %)[
827 {
828 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
829 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
830 "parentName": "string",
831 "name": "string",
832 "modelType": 0
833 }
834 ]
835
836 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
837 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
838 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
839 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
840 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
841 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
842
843 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
844
845 (% class="box successmessage" %)
846 (((
847 (% lang="en-US" %)**POST /api/v3/models**
848 )))
849
850 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
851
852 (% style="color:#000000" %)Метод запроса: **POST**
853
854 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
855
856 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
857
858 (% style="color:#000000" %)Параметры в теле запроса (JSON):
859
860 {
861 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 "deleted": false,
864 "extId": "string",
865 "name": "string",
866 "picture": "string",
867 "minspeed": 0,
868 "maxspeed": 0,
869 "width": 0,
870 "imbeddedtrailer": true,
871 "fueloutlay": 0,
872 "hoppercapacity": 0,
873 "hopperdischargespeed": 0,
874 "modelType": 0
875 }
876
877 Ответ:
878
879 {
880 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882 "deleted": false,
883 "extId": "string",
884 "name": "string",
885 "picture": "string",
886 "minspeed": 0,
887 "maxspeed": 0,
888 "width": 0,
889 "imbeddedtrailer": true,
890 "hoppercapacity": 0,
891 "hopperdischargespeed": 0,
892 "modelType": 0
893 }
894
895 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
896 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
897 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
898 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
899 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
900 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
901 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
902 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
903 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
904 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
905 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
906 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
907 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
908
909 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
910
911 (% class="box warningmessage" %)
912 (((
913 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
914 )))
915
916 (% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
917
918 (% style="color:#000000" %)Метод запроса: **PUT**
919
920 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
921
922 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
923
924 (% style="color:#000000" %)Параметры в теле запроса (JSON):
925
926 {
927 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
928 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
929 "deleted": true,
930 "extId": "string",
931 "name": "string",
932 "picture": "string",
933 "minspeed": 0,
934 "maxspeed": 0,
935 "width": 0,
936 "imbeddedtrailer": true,
937 "fueloutlay": 0,
938 "hoppercapacity": 0,
939 "hopperdischargespeed": 0,
940 "modelType": 0
941 }
942
943 Ответ:
944
945 {
946 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
947 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
948 "deleted": true,
949 "extId": "string",
950 "name": "string",
951 "picture": "string",
952 "minspeed": 0,
953 "maxspeed": 0,
954 "width": 0,
955 "imbeddedtrailer": true,
956 "fueloutlay": 0,
957 "hoppercapacity": 0,
958 "hopperdischargespeed": 0,
959 "modelType": 0
960 }
961
962 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
963 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
964 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
965 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
966 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
967 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
968 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
969 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
970 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
971 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
972 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
973 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
974 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
975
976 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
977
978 (% class="box errormessage" %)
979 (((
980 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
981 )))
982
983 (% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
984
985 (% style="color:#000000" %)Метод запроса: **DELETE**
986
987 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
988
989 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
990
991 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
992
993 Ответ: В случае успеха **Success 200**
994
995 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
996
997 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
998
999 (% class="box infomessage" %)
1000 (((
1001 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1002 )))
1003
1004 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1005
1006 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1007
1008 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1009
1010 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1011
1012 (% style="color:#000000" %)Метод запроса: **GET**
1013
1014 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
1015
1016 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1017
1018 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1019
1020 (% style="color:#000000" %)Ответ:
1021
1022 (((
1023 {
1024
1025 (((
1026 "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1027 "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1028 )))
1029
1030 (((
1031 ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1032 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1033 )))
1034
1035 "vehicleId": "", ~/~/ ID объекта
1036 "name": "", ~/~/ Имя объекта
1037 "imei": "", ~/~/ IMEI объекта
1038 "deviceTypeId": , ~/~/ ID типа устройства
1039 "deviceTypeName": "", ~/~/ Название типа устройства
1040 "sim1": "", ~/~/ Номер SIM1
1041 "sim2": "", ~/~/ Номер SIM2
1042 "parentId": "", ~/~/ ID клиента-родителя
1043 "parentName": "", ~/~/ Наименование клиента-родителя
1044 "modelId": "", ~/~/ ID модели объекта
1045 "modelName": "", ~/~/ Имя модели объекта
1046 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1047 "unitName": "string", ~/~/ Наименование подразделения
1048 "status": 0, ~/~/ Статус объекта
1049 "createdAt": "", ~/~/ Дата создания объекта
1050 },
1051 "customFields": [ ~/~/ Произвольные поля
1052 {
1053 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1054 "name": "string", ~/~/ Имя поля
1055 "value": "string", ~/~/ Значение поля
1056 "forClient": true, ~/~/ Не используемая функция
1057 "forTooltip": true, ~/~/ Отображать в подсказке
1058 "forReport": true ~/~/ Отображать в отчете
1059 }
1060
1061 ], ~/~/ Данные с вкладки нормы
1062 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1063 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1064 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1065 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1066 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1067 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1068 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1069 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1070 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1071 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1072 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1073 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1074 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1075 "mileageCoeff": 0, ~/~/ коэффициент пробега
1076 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1077 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1078 "counters": { ~/~/ Счетчики
1079 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1080 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1081 "mileage": 0, ~/~/ Текущий пробег
1082 "motohours": 0, ~/~/ Текущие моточасы
1083 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1084 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1085 },
1086
1087 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1088 "id": "string", ~/~/ ID объекта
1089 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1090 "host": "string", ~/~/ CMSV6 Web Host
1091 "login": "string", ~/~/ CMSV6 Account
1092 "password": "string" ~/~/ CMSV6 Password
1093 },
1094
1095 "commandTemplates": [ ~/~/ Шаблоны команд
1096 {
1097 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1098 "name": "string", ~/~/ Наименование команды
1099 "command": "string", ~/~/ Текст команды
1100 "retries": 0 ~/~/ Количество попыток
1101 }
1102 ],
1103 "sensors": [ ~/~/ Датчики
1104 {
1105 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1106 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1107 "type": 0, ~/~/ Тип датчика
1108 "name": "string", ~/~/ Имя датчика
1109 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1110 "inputNumber": 0, ~/~/ Номер входа
1111 "pseudonym": "string", ~/~/ Псевдоним
1112 "medianDegree": 0, ~/~/ Медианная фильтрация
1113 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1114 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1115 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1116 "gradesTables": [ ~/~/ Массив таблиц тарировки
1117 {
1118 "grades": [ ~/~/ Таблица тарировки 1
1119 {
1120 "input": 0, ~/~/ Входящее значение
1121 "output": 0 ~/~/ Выходящее значение
1122 }
1123 ],
1124 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1125 }
1126 ],
1127 "showInTooltip": true, ~/~/ Отображать в подсказке
1128 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1129 "color": "string", ~/~/ Код цвета датчиков
1130 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1131 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1132 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1133 "expr": "string", ~/~/ Формула
1134 "children": [ ~/~/ массив дочерних датчиков
1135 "string"
1136 ],
1137 "customParams": { ~/~/ прочие произвольные параметры
1138 "additionalProp1": "string",
1139 "additionalProp2": "string",
1140 "additionalProp3": "string"
1141 },
1142
1143 ~/~/ Характерные для произвольного:
1144 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1145 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1146 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1147 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1148 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1149 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1150 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1151 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1152 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1153 ~/~/ "ValueOn": "Вкл.",
1154 ~/~/ "ValueOff": "Выкл."
1155 "summaryMaxValue": 0 ~/~/ Макс. значение
1156 }
1157 "drivers": [ ~/~/ Водители
1158 {
1159 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1160 "name": "string", ~/~/ Наименование
1161 "description": "string",
1162 "isDefault": true ~/~/ По умолчанию
1163 }
1164 ],
1165 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1166 {
1167 "id": "", ~/~/ ID  задания
1168 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1169 "name": "", ~/~/ Наименование задания
1170 "description": "", ~/~/ Описание задания
1171 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1172 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1173 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1174 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1175 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1176 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1177 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1178 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1179 }
1180 ],
1181 "statusHistory": [ ~/~/ История статусов
1182 {
1183 "status": 0,
1184 "date": "2023-05-22T09:57:39.562Z",
1185 "description": "string",
1186 "additionalInfo": "string"
1187
1188 (((
1189 }
1190 ],
1191 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1192 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1193 )))
1194
1195 (((
1196 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1197 }
1198
1199 )))
1200 )))
1201
1202 (% style="text-align:left" %)
1203 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1204
1205 (% style="text-align:left" %)
1206 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1207
1208
1209 == **Отправить команду на терминал** ==
1210
1211 (% class="box successmessage" %)
1212 (((
1213 (% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1214 )))
1215
1216 Команда для отправки на тс.
1217
1218 {  
1219 "id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1220 "command": "", ~/~/ Текст отправляемой команды
1221 "retries": "", ~/~/ Количество попыток отправки на терминал
1222 "idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1223 }
1224
1225 В ответ получаем cmdid
1226
1227
1228 == **Получить ответ на отправленную на ТС команду** ==
1229
1230 (% class="box infomessage" %)
1231 (((
1232 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1233 )))
1234
1235 Идентификатор команды: cmdId
1236
1237 Запрос от терминала на ответ команды
1238
1239 Пример ответ от терминала:
1240
1241 ID= "" ~/~/ идентификатор объекта
1242 Soft="" ~/~/ версия софта
1243 GPS=4 ~/~/ тип трекера
1244 Time=11:05:43 28.06.24 ~/~/ время запроса
1245 Lat=45.056221 ~/~/ широта
1246 Lon=39.035938 ~/~/ долгота
1247 Speed=0.0 ~/~/ скорость
1248 Course=181.4 ~/~/направление
1249
1250 (((
1251 == **Список отправленных объекту команд с ответами** ==
1252
1253 (% class="box infomessage" %)
1254 (((
1255 (% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1256 )))
1257
1258 Идентификатор ТС: vehicleId
1259
1260 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1261
1262 Пример ответа терминала
1263
1264 [ 
1265 {    
1266 "id": "", ~/~/ идентификатор пользователя
1267 "commandText": "", ~/~/Текст команды.
1268 "templateId": "", ~/~/Идентификатор шаблона
1269 "updated": "", ~/~/ Время отправки  
1270 "tryCount": 0, ~/~/ Количество попыток отправки команды
1271 "answer": "", ~/~/ Ответ терминала.
1272 "status": "" ~/~/ Статус отправки
1273 }
1274 ]
1275 )))
1276
1277 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1278
1279 (% class="box successmessage" %)
1280 (((
1281 (% lang="en-US" %)**POST /api/v3/vehicles**
1282 )))
1283
1284 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1285
1286 (% style="color:#000000" %)Метод запроса: **POST**
1287
1288 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1289
1290 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1291
1292 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1293
1294 (% style="color:#000000" %){
1295
1296
1297 (((
1298 "vehicleId": 0, ~/~/ ID ТС
1299 )))
1300
1301 "parentId": "" , ~/~/ ID клиента
1302 "name": "" , ~/~/ имя ТС
1303 "imei": "" , ~/~/ IMEI
1304 "deviceTypeId": "" , ~/~/ ID типа устройства
1305 "modelId": "" , ~/~/ ID модели
1306 "unitId": "" , ~/~/ ID подразделения
1307 "sim1": "" , ~/~/ Номер SIM 1
1308 "sim2": "" , ~/~/ Номер SIM2
1309 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1310 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1311 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1312 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1313 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1314 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1315 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1316 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1317 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1318 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1319 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1320 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1321 "mileageCalcMethod": 0,
1322 "mileageCoeff": 0,
1323 "locationByCellId": true,
1324 "dottedLineTrackWhenNoCoords": true,
1325 "counters": ~/~/ счетчики
1326 {
1327 "mileage": "" , ~/~/ пробег
1328 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1329 "motohours": "" , ~/~/ моточасы
1330 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1331 },
1332 "cmsv6Parameters": { ~/~/ параметры CMSv6
1333 "enabled": true, ~/~/ флаг включения
1334 "id": "" , ~/~/ идентификатор
1335 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1336 "login": "" , ~/~/ имя учетной записи
1337 "password": "" ~/~/ пароль учетной записи
1338 },
1339 "inspectionTasks": ~/~/ задания на ТО
1340 {
1341 "enabled": "" , ~/~/ Признак включения
1342 "name": "" , ~/~/ Имя задания
1343 "description": "" , ~/~/ Описание задания
1344 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1345 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1346 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1347 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1348 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1349 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1350 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1351 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1352 }
1353 "drivers": [ ~/~/ Водители
1354 {
1355 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1356 "isDefault": true
1357 }
1358 ],
1359 "commandTemplates": [ ~/~/ Шаблон команды
1360 {
1361 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1362 "name": "string",
1363 "command": "string",
1364 "retries": 0
1365 }
1366 ],
1367 "sensors": [ ~/~/ Датчики
1368 {
1369 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1370 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1371 "type": 0, ~/~/ Тип датчика
1372 "name": "string", ~/~/ Имя датчика
1373 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1374 "inputNumber": 0, ~/~/ Номер входа
1375 "pseudonym": "string", ~/~/ Псевдоним
1376 "medianDegree": 0, ~/~/ Медианная фильтрация
1377 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1378 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1379 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1380 "gradesTables": [ ~/~/ Массив таблиц тарировки
1381 {
1382 "grades": [ ~/~/ Таблица тарировки 1
1383 {
1384 "input": 0, ~/~/ Входящее значение
1385 "output": 0 ~/~/ Выходящее значение
1386 }
1387 ],
1388 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1389 }
1390 ],
1391 "showInTooltip": true, ~/~/ Отображать в подсказке
1392 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1393 "color": "string", ~/~/ код цвета датчиков
1394 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1395 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1396 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1397 "expr": "string", ~/~/ Формула
1398 "children": [ ~/~/ массив дочерних датчиков
1399 "string"
1400 ],
1401 "customParams": { ~/~/ прочие произвольные параметры
1402 "additionalProp1": "string",
1403 "additionalProp2": "string",
1404 "additionalProp3": "string"
1405 },
1406 ~/~/ Характерные для произвольного:
1407 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1408 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1409 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1410 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1411 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1412 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1413 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1414 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1415 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1416 ~/~/ "ValueOn": "Вкл.",
1417 ~/~/ "ValueOff": "Выкл."
1418 "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1419
1420 (((
1421 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1422 {
1423 "from": 0, ~/~/ С какого значения
1424 "color": "string", ~/~/ Каким цветом
1425 "text": "string" ~/~/ Текст подписи к этому интервалу
1426 }
1427 ]
1428 }
1429 ],
1430 )))
1431
1432 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1433
1434
1435 "customFields": [ ~/~/ Произвольные поля
1436 {
1437 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1438 "name": "string", ~/~/ Наименование произвольного поля
1439 "value": "string", ~/~/ Значение произвольного поля
1440 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1441 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1442 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1443
1444 (((
1445 }
1446 ],
1447 "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1448 )))
1449
1450 (((
1451 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1452 }
1453 )))
1454
1455
1456 (% style="color:#000000" %)Ответ:
1457
1458
1459 (((
1460 (((
1461 (((
1462 {
1463 "vehicleId": 0,  ~/~/ ID ТС
1464 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1465 "name": "string", ~/~/ Имя объекта
1466 "imei": "string", ~/~/ IMEI
1467 "deviceTypeId": 0, ~/~/ ID типа устройства
1468 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1469 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1470 "sim1": "string", ~/~/ SIM1
1471 "sim2": "string", ~/~/ SIM2
1472 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1473 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1474 "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1475 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1476 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1477 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1478 "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1479 "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1480 "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1481 "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1482 "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1483 "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1484 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1485 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1486 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1487 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1488 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1489 "counters": {  ~/~/ Dto для состояний счётчиков
1490 "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1491 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1492 "mileage": 0, ~/~/ Пробег
1493 "motohours": 0 ~/~/ Моточасы
1494 },
1495 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1496 "id": "string", ~/~/ CMSV6 Идентификатор
1497 "enabled": true, ~/~/ Признак включения
1498 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1499 "login": "string", ~/~/ CMSV6 имя учетной записи
1500 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1501 },
1502 "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1503 {
1504 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1505 "enabled": true, ~/~/ Признак включения
1506 "name": "string", ~/~/ Имя задания
1507 "description": "string", ~/~/ Описание задания
1508 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1509 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1510 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1511 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1512 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1513 "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1514 "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1515 "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1516 }
1517 ],
1518 "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1519 {
1520 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1521 "inputNumber": 0, ~/~/ № входа.
1522 "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1523 "comment": "string", ~/~/ Комментарий
1524 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1525 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1526 "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1527 "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1528 }
1529 ],
1530 "commandTemplates": [  ~/~/ Список шаблонов команд
1531 {
1532 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1533 "name": "string", ~/~/ Название шаблона команд
1534 "command": "string", ~/~/ Команда на выполнение
1535 "retries": 0 ~/~/ Лимит попыток отправки
1536 }
1537 ],
1538 "sensors": [ ~/~/ Список датчиков
1539 {
1540 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1541 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1542 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1543 "name": "string",  ~/~/ Имя датчика
1544 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1545 "inputNumber": 0, ~/~/ Номер входа
1546 "pseudonym": "string", ~/~/ Псевдоним
1547 "medianDegree": 0, ~/~/ Степень медианной фильтрации
1548 "isInverted": true, ~/~/  Признак инверсии
1549 "disabled": true, ~/~/ Датчик не участвует в обработке
1550 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1551 "gradesTables": [ ~/~/ Тарировка
1552 {
1553 "grades": [ ~/~/ Таблицы тарировки
1554 {
1555 "input": 0, ~/~/ Вход
1556 "output": 0 ~/~/ Выход
1557 }
1558 ],
1559 "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1560 }
1561 ],
1562 "showInTooltip": true, ~/~/ Отображение в подсказке
1563 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1564 "color": "string", ~/~/ код цвета датчиков
1565 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1566 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1567 "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1568 "expr": "string", ~/~/ Выражение
1569 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1570 "string"
1571 ],
1572 "customParams": {
1573 "additionalProp1": "string",
1574 "additionalProp2": "string",
1575 "additionalProp3": "string"
1576 },
1577 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1578 "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1579 {
1580 "from": 0, ~/~/ С какого значения
1581 "color": "string", ~/~/ Каким цветом
1582 )))
1583
1584 (((
1585 "text": "string" ~/~/ Текст подписи к этому интервалу
1586 }
1587 ]
1588 }
1589 ],
1590 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1591 "customFields": [ ~/~/ Список произвольных полей
1592 {
1593 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1594 "name": "string", ~/~/ Наименование произвольного поля
1595 "value": "string", ~/~/ Значение произвольного поля
1596 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1597 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1598 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1599 }
1600 ],
1601 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1602 }
1603 )))
1604 )))
1605 )))
1606
1607
1608 **Валидация:**
1609 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1610 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1611 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1612
1613
1614 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1615
1616 (% class="box infomessage" %)
1617 (((
1618 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1619 )))
1620
1621 (% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1622
1623 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1624
1625 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1626
1627 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1628
1629 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1630
1631 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1632
1633 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1634
1635 (% style="color:#000000" %)Метод запроса: **POST**
1636
1637 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1638
1639 (% style="color:#000000" %)В заголовках запроса:
1640
1641 (% style="color:#000000" %)− Content-Type: __**application/json**__
1642
1643 (% style="color:#000000" %)− X-Auth: Токен авторизации
1644
1645 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1646
1647 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1648
1649 {
1650 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1651 "name": null, ~/~/ Имя ТС (string, опционально)
1652 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1653 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1654 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1655 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1656 "unitName": "string",  ~/~/ Название подразделения (опционально)
1657 "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1658 "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1659 "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1660 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1661 }
1662
1663 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1664
1665 (% style="color:#000000" %)Ответ:
1666
1667 (% style="color:#000000" %)[
1668 {
1669
1670 (((
1671 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1672 )))
1673
1674 (((
1675 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1676 "name": "" ~/~/ наименование объекта
1677 "imei": "" ~/~/ IMEI объекта
1678 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1679 "deviceTypeName": "" ~/~/ наименование типа устройства
1680 "sim1": "" ~/~/ первый номер телефона
1681 "sim2": "" ~/~/ второй номер телефона
1682 "parentId": "" ~/~/ идентификатор клиента-родителя
1683 "parentName": "" ~/~/ наименование клиента-родителя
1684 "modelId": "" ~/~/ идентификатор модели объекта
1685 "modelName": "" ~/~/ наименование модели объекта
1686 "unitId": "" ~/~/ идентификатор подразделения
1687 "unitName": "" ~/~/ наименование подразделения
1688 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1689 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1690 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1691 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1692 "customFields": [ 
1693 {
1694 "id": "", ~/~/ идентификатор произвольного поля
1695 "name": "", ~/~/ имя произвольного поля
1696 "value": "", ~/~/ значение произвольного поля
1697 "forClient": true, ~/~/ право на отображение у клиента
1698 "forTooltip": false, ~/~/ право на отображение в подсказке
1699 "forReport": false ~/~/ право на отображение в отчетах
1700 )))
1701
1702 (((
1703 }
1704 ],
1705 "vehicleGroups": [  ~/~/ Группы ТС
1706 {
1707 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1708 "name": "string" ~/~/ Наименование группы ТС
1709 }
1710 ]
1711 }
1712 ]
1713 )))
1714
1715 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1716
1717 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1718
1719 (% class="box successmessage" %)
1720 (((
1721 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1722 )))
1723
1724 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1725
1726 (% style="color:#000000" %)Метод запроса: **POST**
1727
1728 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/changeStatus/]](% style="color:#000000" %){vehicleId}
1729
1730 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1731
1732 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1733
1734 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1735
1736 (% style="color:#000000" %){
1737
1738 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1739 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1740 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1741 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1742 "description": "", ~/~/ Описание
1743 "data": "", ~/~/ Данные
1744 "overwrite": false, ~/~/ Флаг перезаписи
1745 "stage": "", ~/~/ Состояние, может быть null
1746 (% style="color:#000000" %)}
1747
1748 (% style="color:#000000" %)Ответ:
1749
1750 (% style="color:#000000" %){(%%)
1751 "status": "", ~/~/ значение статуса
1752 "date": "", ~/~/ Дата смены статуса 
1753 "description": "", ~/~/ Описание
1754 "data": "", ~/~/ Данные
1755 "overwrite": false, ~/~/ Флаг перезаписи
1756 "stage": "", ~/~/ Состояние
1757 (% style="color:#000000" %) }
1758
1759
1760 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1761
1762 (% class="box warningmessage" %)
1763 (((
1764 (% lang="en-US" %)**PUT /api/v3/vehicles**
1765 )))
1766
1767 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1768
1769 (% style="color:#000000" %)Метод запроса: **PUT**
1770
1771 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1772
1773 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1774
1775 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1776
1777 (% style="color:#000000" %){
1778 "vehicleId": , ~/~/ ID объекта
1779 "parentId": "" , ~/~/ ID клиента
1780 "name": "" , ~/~/ имя ТС
1781 "imei": "" , ~/~/ IMEI
1782 "deviceTypeId": "" , ~/~/ ID типа устройства
1783 "modelId": "" , ~/~/ ID модели
1784 "unitId": "" , ~/~/ ID подразделения
1785 "sim1": "" , ~/~/ Номер SIM 1
1786 "sim2": "" , ~/~/ Номер SIM2
1787 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1788 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1789 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1790 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1791 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1792 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1793 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1794 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1795 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1796 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1797 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1798 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1799
1800 "mileageCalcMethod": 0,
1801 "mileageCoeff": 0,
1802 "locationByCellId": true,
1803 "dottedLineTrackWhenNoCoords": true,
1804 "counters": ~/~/ счетчики
1805 {
1806 "mileage": "" , ~/~/ пробег
1807 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1808 "motohours": "" , ~/~/ моточасы
1809 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1810 },
1811 "cmsv6Parameters": { ~/~/ параметры CMSv6
1812 "enabled": true, ~/~/ флаг включения
1813 "id": "" , ~/~/ идентификатор
1814 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1815 "login": "" , ~/~/ имя учетной записи
1816 "password": "" ~/~/ пароль учетной записи
1817 },
1818 "inspectionTasks": ~/~/ задания на ТО
1819 {
1820 "enabled": "" , ~/~/ Признак включения
1821 "name": "" , ~/~/ Имя задания
1822 "description": "" , ~/~/ Описание задания
1823 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1824 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1825 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1826 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1827 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1828 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1829 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1830 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1831 }
1832
1833 "drivers": [ ~/~/ Водители
1834 {
1835
1836 (((
1837 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1838 "inputNumber": 0, ~/~/ № входа.
1839 "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1840 "comment": "string", ~/~/ Комментарий.
1841 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1842 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1843 "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1844 "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1845 )))
1846
1847 } 
1848 ],
1849 "commandTemplates": [ ~/~/ Шаблон команды
1850 {
1851 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1852 "name": "string",
1853 "command": "string",
1854 "retries": 0
1855 }
1856 ],
1857 "sensors": [ ~/~/ Датчики
1858 {
1859 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1860 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1861 "type": 0, ~/~/ Тип датчика
1862 "name": "string", ~/~/ Имя датчика
1863 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1864 "inputNumber": 0, ~/~/ Номер входа
1865 "pseudonym": "string", ~/~/ Псевдоним
1866 "medianDegree": 0, ~/~/ Медианная фильтрация
1867 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1868 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1869 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1870 "gradesTables": [ ~/~/ Массив таблиц тарировки
1871 {
1872 "grades": [ ~/~/ Таблица тарировки 1
1873 {
1874 "input": 0, ~/~/ Входящее значение
1875 "output": 0 ~/~/ Выходящее значение
1876 }
1877 ],
1878 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1879 }
1880 ],
1881 "showInTooltip": true, ~/~/ Отображать в подсказке
1882 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1883
1884 (((
1885 "color": "string",** ~/~/ **Цвет датчика
1886 )))
1887
1888 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1889 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1890 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1891 "expr": "string", ~/~/ Формула
1892 "children": [ ~/~/ массив дочерних датчиков
1893 "string"
1894 ],
1895 "customParams": { ~/~/ прочие произвольные параметры
1896 "additionalProp1": "string",
1897 "additionalProp2": "string",
1898 "additionalProp3": "string"
1899 },
1900 ~/~/ Характерные для произвольного:
1901 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1902 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1903 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1904 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1905 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1906 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1907 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1908 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1909 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1910 ~/~/ "ValueOn": "Вкл.",
1911 ~/~/ "ValueOff": "Выкл."
1912 "summaryMaxValue": 0 ~/~/ Макс. значение
1913
1914 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1915 {
1916 "from": 0, ~/~/ С какого значения
1917 "color": "string", ~/~/ Каким цветом
1918 "text": "string" ~/~/ Текст подписи к этому интервалу
1919 }
1920 ]
1921 }
1922 ],
1923 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1924
1925 "customFields": [ ~/~/ Произвольные поля
1926 {     
1927 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1928 "name": "string", ~/~/ Наименование произвольного поля
1929 "value": "string", ~/~/ Значение произвольного поля
1930 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1931 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1932 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1933 }
1934
1935 (((
1936 ],
1937 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1938 )))
1939
1940 }
1941
1942
1943 (% style="color:#000000" %)Ответ:
1944
1945 (((
1946 {
1947 "vehicleId": 0, ~/~/ ID ТС
1948 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
1949 "name": "string", ~/~/ Имя объекта
1950 "imei": "string", ~/~/ IMEI
1951 "deviceTypeId": 0, ~/~/ ID типа устройства
1952 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
1953 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1954 "sim1": "string", ~/~/ SIM1
1955 "sim2": "string", ~/~/ SIM2
1956 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1957 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1958 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
1959 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1960 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1961 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1962 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1963 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1964 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1965 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1966 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1967 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1968 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
1969 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1970 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1971 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1972 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1973 "counters": { ~/~/ состояний счётчиков
1974 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
1975 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1976 "mileage": 0, ~/~/ Пробег
1977 "motohours": 0 ~/~/ Моточасы 
1978 },
1979 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1980 "id": "string", ~/~/ CMSV6 Идентификатор
1981 "enabled": true, ~/~/ Признак включения
1982 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
1983 )))
1984
1985
1986 (((
1987 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1988 "login": "string", ~/~/ CMSV6 имя учетной записи
1989 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1990 },
1991 "inspectionTasks": [ ~/~/ Задания на ТО
1992 {
1993 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1994 "enabled": true, ~/~/ Признак включения
1995 "name": "string", ~/~/ Имя задания
1996 "description": "string", ~/~/ Описание задания
1997 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1998 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1999 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2000 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2001 "periodicCondition": 0, ~/~/ Условие периодичности по времени
2002 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2003 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2004 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2005 }
2006 ],
2007 "drivers": [  ~/~/ Список водителей
2008 {
2009 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2010 "inputNumber": 0, ~/~/ № входа.
2011 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2012 "comment": "string", ~/~/ Комментарий.
2013 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2014 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2015 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2016 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2017 }
2018 ],
2019 "commandTemplates": [ ~/~/ Список шаблонов команд
2020 {
2021 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2022 "name": "string", ~/~/ Название шаблона команд
2023 "command": "string", ~/~/ Команда на выполнение
2024 "retries": 0 ~/~/ Лимит попыток отправки
2025 }
2026 ],
2027 "sensors": [  ~/~/ Список датчиков 
2028 {
2029 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2030 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2031 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2032 )))
2033
2034 (((
2035 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2036 )))
2037
2038 (((
2039 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2040 )))
2041
2042 (((
2043 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2044 )))
2045
2046 (((
2047 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2048 )))
2049
2050 (((
2051 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2052 "name": "string", ~/~/ Имя датчика
2053 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2054 )))
2055
2056 (((
2057 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2058 "inputNumber": 0, ~/~/ Номер входа
2059 "pseudonym": "string", ~/~/ Псевдоним
2060 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2061 "isInverted": true, ~/~/ Признак инверсии
2062 "disabled": true, ~/~/ Датчик не участвует в обработке
2063 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2064 "gradesTables": [ ~/~/ Тарировка
2065 {
2066 "grades": [ ~/~/ Таблицы тарировки
2067 {
2068 "input": 0, ~/~/ Вход
2069 "output": 0 ~/~/ Выход
2070 }
2071 ],
2072 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2073 }
2074 ],
2075 "showInTooltip": true, ~/~/ Отображение в подсказке
2076 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2077
2078 (((
2079 "color": "string", ~/~/ цвет уведомлений
2080 )))
2081
2082 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2083 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2084 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2085 "expr": "string", ~/~/ Выражение
2086 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2087 "string" 
2088 ],
2089 "customParams": { ~/~/ Дополнительные настройки
2090 "additionalProp1": "string",
2091 "additionalProp2": "string",
2092 "additionalProp3": "string"
2093 },
2094 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2095 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2096 {
2097 "from": 0, ~/~/ С какого значения
2098 "color": "string", ~/~/ Каким цветом
2099 "text": "string" ~/~/ Текст подписи к этому интервалу
2100 }
2101 ]
2102 }
2103 ],
2104 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2105 "customFields": [ ~/~/ Список произвольных полей
2106 {
2107 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2108 "name": "string", ~/~/ Наименование произвольного поля
2109 "value": "string", ~/~/ Значение произвольного поля
2110 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2111 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2112 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2113 }
2114 ],
2115 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2116 }
2117 )))
2118
2119 **Валидация:**
2120 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2121 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2122 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2123
2124 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2125
2126 (% class="box errormessage" %)
2127 (((
2128 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2129 )))
2130
2131 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2132
2133 (% style="color:#000000" %)Метод запроса: **DELETE**
2134
2135 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2136
2137 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2138
2139 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2140
2141 (% style="text-align:left" %)
2142 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2143
2144 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2145
2146 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2147
2148 (% class="box infomessage" %)
2149 (((
2150 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2151 )))
2152
2153 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2154
2155 (% style="color:#000000" %)Метод запроса: **GET**
2156
2157 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2158
2159 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2160
2161 (% style="color:#000000" %)Ответ:
2162
2163 (% style="color:#000000" %){(%%)
2164 "deviceTypeId" : "", ~/~/ ID типа устройства
2165 "deviceTypeName" : "" ~/~/ Название типа устройства
2166 (% style="color:#000000" %)}
2167
2168 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2169
2170 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2171
2172 (% class="box infomessage" %)
2173 (((
2174 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2175 )))
2176
2177 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2178
2179 (% style="color:#000000" %)Метод запроса: **GET**
2180
2181 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2182
2183 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2184
2185 (% style="color:#000000" %)Ответ:
2186
2187 (% style="color:#000000" %){(%%)
2188 "id": "", ~/~/ ID типа датчика 
2189 "name": "", ~/~/ Название
2190 "description": "", ~/~/ Описание
2191 (% style="color:#000000" %)}
2192
2193 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2194
2195 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2196
2197 (% class="box infomessage" style="text-align: left;" %)
2198 (((
2199 **POST /api/v3/terminalMessages/count**
2200 )))
2201
2202 (% style="text-align: left;" %)
2203 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2204
2205 (% style="text-align: left;" %)
2206 Метод запроса **POST**
2207
2208 (% style="text-align: left;" %)
2209 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2210
2211 (% style="text-align: left;" %)
2212 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2213
2214 (% style="text-align: left;" %)
2215 {
2216 "vehicleIds": [
2217 id ~/~/ здесь передается список идентификаторов объектов
2218 ],
2219 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2220 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2221 }
2222
2223 (% style="text-align: left;" %)
2224 Ответ:
2225
2226 (% style="text-align: left;" %)
2227 [
2228 {
2229 "vehicleId": 0, ~/~/ идентификатор объекта
2230 "count": 0 ~/~/ количество сообщений за период
2231 }
2232 ]
2233
2234 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2235
2236 (% class="box infomessage" style="text-align: left;" %)
2237 (((
2238 **POST /api/v3/terminalMessages/mapping**
2239 )))
2240
2241 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2242
2243 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2244
2245 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2246
2247 {
2248 "protocolType": 0,
2249 "params": ["string"]
2250 }
2251
2252 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2253 |protocolType|ID типа протокола
2254 |params|(((
2255 Массив наименований параметров в сообщении
2256 )))
2257
2258 Ответ:
2259
2260 {
2261 "protocolType": 0,
2262 "mapping": {
2263 "additionalProp1": {
2264 "inputType": 0,
2265 "inputNumber": 0
2266 },
2267 "additionalProp2": {
2268 "inputType": 0,
2269 "inputNumber": 0
2270 }
2271 }
2272 }
2273
2274 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2275 |protocolType|Тип протокола
2276 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2277 |inputNumber|(((
2278 Номер входа
2279 )))
2280
2281 (% class="wikigeneratedid" %)
2282 Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
2283
2284 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2285
2286 (% class="box infomessage" %)
2287 (((
2288 **POST /api/v3/terminalMessages**
2289 )))
2290
2291 Метод возвращает список сообщений терминала объекта за выбранный период.
2292
2293 (% style="text-align: left;" %)
2294 Метод запроса **POST**
2295
2296 (% style="text-align: left;" %)
2297 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2298
2299 (% style="text-align: left;" %)
2300 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2301
2302 {
2303 "vehicleId": 0, ~/~/ id объекта
2304 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2305 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2306 }
2307
2308 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2309 |vehicleId|ID объекта
2310 |from|Дата и время начала периода запроса
2311 |to|Дата и время окончания периода запроса
2312
2313 Ответ:
2314
2315 [
2316 {
2317 "messages": [
2318 {
2319 "deviceTime": "2023-11-29T07:40:44.052Z",
2320 "serverTime": "2023-11-29T07:40:44.052Z",
2321 "speed": 0,
2322 "altitude": 0,
2323 "latitude": 0,
2324 "longitude": 0,
2325 "satellites": 0,
2326 "course": 0,
2327 "voltage": 0,
2328 "parameters": {
2329 "additionalProp1": "string",
2330 "additionalProp2": "string",
2331 "additionalProp3": "string"
2332 },
2333 "photoCount": 0,
2334 "lbsCorrectedCoords": true,
2335 "protocolType": 0
2336 }
2337 ]
2338 }
2339 ]
2340
2341 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2342 |deviceTime|Время сообщения терминала
2343 |serverTime|Время когда сообщение поступило на сервер
2344 |speed|Скорость
2345 |altitude|Высота над уровнем моря
2346 |latitude|Широта
2347 |longitude|Долгота
2348 |satellites|Кол-во спутников
2349 |course|Курс
2350 |voltage|Бортовое напряжение
2351 |parameters|Список параметров и их значений
2352 |photoCount|Количество фото
2353 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2354 |protocolType|ID типа протокола
2355
2356 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2357
2358 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2359
2360 (% class="box infomessage" %)
2361 (((
2362 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2363 )))
2364
2365 (% style="color:#000000" %)Метод запроса: **POST**
2366
2367 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2368
2369 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2370
2371 (% style="text-align:left" %)
2372 Тело запроса:
2373
2374 {
2375 "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2376 "vehicleIds": [0], ~/~/ Список ID объектов
2377 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2378 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2379 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2380 }
2381
2382 Ответ:
2383
2384 [
2385 {
2386 "vehicleId": 0, ~/~/ ID объекта
2387 "name": "string", ~/~/ Имя ТС
2388 "periods": [ ~/~/ Периоды
2389 {
2390 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2391 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2392 "mileage": 0, ~/~/ Пробег за период, километры
2393 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2394 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2395 "motohours": 0, ~/~/ Моточасы за период, секунды
2396 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2397 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2398 "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2399
2400 }
2401 ]
2402 }
2403 ]
2404
2405 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2406
2407 (% class="box infomessage" %)
2408 (((
2409 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2410 )))
2411
2412 (% style="color:#000000" %)Метод запроса: **POST**
2413
2414 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2415
2416 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2417
2418 (% style="text-align:left" %)
2419 Тело запроса:
2420
2421 {
2422 "sampling": 86400, ~/~/ Частота дискретизации, секунд, минимум - 60 (если передано, то весь период бъётся на подпериоды с указанной частотой)
2423 "vehicleIds": [0], ~/~/ Список ID объектов
2424 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2425 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2426 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2427 }
2428
2429 Ответ:
2430
2431 [
2432 {
2433 "vehicleId": 0, ~/~/ ID объекта
2434 "name": "string", ~/~/ Имя ТС
2435 "periods": [ ~/~/ Периоды
2436 {
2437 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2438 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2439 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2440 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2441 "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2442 "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2443 "fuelConsumption": 0, ~/~/ Расход топлива
2444 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2445 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2446
2447 }
2448 ]
2449 }
2450 ]
2451
2452 (% class="box warningmessage" %)
2453 (((
2454 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2455 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2456 )))
2457
2458 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2459
2460 (% class="box infomessage" %)
2461 (((
2462 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2463 )))
2464
2465 (% style="color:#000000" %)Метод запроса: **POST**
2466
2467 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2468
2469 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2470
2471 (% style="text-align:left" %)
2472 Тело запроса:
2473
2474 {
2475 "vehicleIds": [0], ~/~/ Список ID объектов
2476 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2477 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2478 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2479 }
2480
2481 Ответ:
2482
2483 [
2484 {
2485 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2486 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2487 "vehicleId": 0, ~/~/ ID объекта
2488 "name": "string", ~/~/ Имя объекта
2489 "model": "string", ~/~/ Модель объекта
2490 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2491 {
2492 "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
2493
2494 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2495 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2496 "valueFuel": 0, ~/~/ Количество
2497 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2498 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2499 }
2500 ]
2501 }
2502 ]
2503
2504
2505 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2506
2507 (% class="box infomessage" %)
2508 (((
2509 **POST /api/v3/vehicles/moveStop**
2510 )))
2511
2512 Метод запроса: **POST**
2513
2514 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2515
2516 В заголовках запроса: X-Auth: Токен авторизации
2517
2518
2519 Тело запроса:
2520
2521 {
2522 "vehicleIds": [ ], ~/~/ Список ID объектов
2523 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2524 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2525 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2526 }
2527
2528 Ответ:
2529
2530 [ 
2531 {
2532 "vehicleId": 0, ~/~/ ID объекта
2533 "vehicleName": "string", ~/~/ Имя объекта
2534 "moves": [ ~/~/ Событие движения
2535 {
2536 "mileage": 0, ~/~/ Пробег, км
2537 "eventId": 0, ~/~/ Идентификатор события
2538 "eventName": "string", ~/~/ Название события
2539 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2540 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2541 "duration": 0 ~/~/ Продолжительность события, секунд
2542 }
2543 ],
2544 "stops": [ ~/~/ События стоянок
2545 {
2546 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2547 "eventId": 0, ~/~/ Идентификатор события
2548 "eventName": "string", ~/~/ Название события
2549 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2550 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2551 "duration": 0 ~/~/ Продолжительность события, секунд
2552 }
2553 ]
2554 }
2555 ]
2556
2557
2558 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2559
2560 (% class="box infomessage" %)
2561 (((
2562 **POST /api/v3/vehicles/getlastdata**
2563 )))
2564
2565 Метод запроса: **POST**
2566
2567 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2568
2569 В заголовках запроса: X-Auth: Токен авторизации
2570
2571
2572 В массиве указываем id объектов через запятую
2573
2574 Ответ:
2575
2576 [
2577 {
2578 "vehicleId": 55728, ~/~/ Идентификатор объекта 
2579 "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 
2580 "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 
2581 "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 
2582 "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 
2583 "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2584 "speed": 31, ~/~/ Скорость объекта 
2585 "course": 116, ~/~/ Курс движения [0;360]
2586 "latitude": 45.722128, ~/~/ Широта [-90°;90°].
2587 "longitude": 39.800432, ~/~/ Долгота [-180°;180°].
2588 "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 
2589 "geozones": [ ~/~/ Сведения по геозонам. 
2590 {
2591 "id": 10225647, ~/~/ ID Геозоны 
2592 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2593 },
2594 {
2595 "id": 10282875, ~/~/ ID Геозоны 
2596 "name": "Ё2" ~/~/ Наименование геозоны 
2597 },
2598 {
2599 "id": 10226240, ~/~/ ID Геозоны 
2600 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2601 },
2602 {
2603 "id": 9747869, ~/~/ ID Геозоны 
2604 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2605 },
2606 {
2607 "id": 10221123, ~/~/ ID Геозоны 
2608 "name": "53r" ~/~/ Наименование геозоны 
2609 },
2610 {
2611 "id": 10197638, ~/~/ ID Геозоны 
2612 "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 
2613 }
2614 ]
2615 }
2616
2617
2618 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2619
2620 == (% style="color: rgb(0, 0, 0); font-size: 16px" %)**Получение информации о геозоне по ID геозоны **(%%) ==
2621
2622 (% class="box infomessage" %)
2623 (((
2624 **GET /api/v3/gis/{geozoneId}**
2625 )))
2626
2627 Пример запроса: 
2628 \\geozoneId ~/~/ id геозоны
2629
2630
2631 (% style="text-align:left" %)
2632 Ответ:
2633
2634 (((
2635 {
2636 "id": 0, ~/~/ Идентификатор объекта геозоны
2637 "name": "string", ~/~/ Наименование объекта геозоны
2638 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
2639 "description": "string", ~/~/ Описание объекта геозоны
2640 "beginCalc": "2025-12-04T07:13:04.658Z", ~/~/ Дата начала расчетов для геозоны
2641 "endCalc": "2025-12-04T07:13:04.658Z", ~/~/ Дата окончания расчетов для геозоны
2642 "settingsData": "string", ~/~/ Параметры отображения в формате XML.
2643 "type": 0, ~/~/ Тип геозоны - линия,полигон
2644 "radius": 0, ~/~/ Радиус геозоны
2645 "shape": "string", ~/~/ Координаты геозоны
2646 "shape_format": "string" ~/~/ Формат xml,json 
2647 }
2648 )))
2649
2650 (((
2651
2652 )))
2653
2654 == **Удаление геообъекта ** ==
2655
2656 (((
2657
2658 )))
2659
2660 (% class="box errormessage" %)
2661 (((
2662 **DELETE /api/v3/gis/{geozoneId}**
2663 )))
2664
2665 (((
2666 Пример запроса:
2667 )))
2668
2669 (((
2670
2671 )))
2672
2673 (((
2674 geozoneId ~/~/ Id геообъекта
2675 )))
2676
2677 (((
2678
2679 )))
2680
2681 (((
2682 Пример ответа:
2683 )))
2684
2685 (((
2686
2687 )))
2688
2689 (((
2690 200 ~/~/ Success
2691 )))
2692
2693 (((
2694
2695 )))
2696
2697 == **Возвращение данных по пересечению объектами геозон ** ==
2698
2699 (((
2700
2701 )))
2702
2703 (% class="box successmessage" %)
2704 (((
2705 **POST /api/v3/gis/intersections/geozones**
2706 )))
2707
2708 (((
2709 Пример запроса:
2710 )))
2711
2712 (((
2713 (((
2714 {
2715 "startDate": "2025-12-04T07:19:27.628Z", ~/~/ Дата и время начала расчета 
2716 "endDate": "2025-12-04T07:19:27.628Z", ~/~/ Дата и время конца расчета 
2717 "ids": [ ~/~/ Идентификаторы объектов
2718 0
2719 ],
2720 "byTime": 0, ~/~/ объединение геообъектов по времени (секунды)
2721 "byDist": 0, ~/~/ объединение геообъектов по расстоянию(метры)
2722 "filterByTime": 0, ~/~/ Фильтрация посещений по времени, сек.
2723 "filterByHalfPerimeter": true, ~/~/ Фильтрация по половине периметра геообъекта
2724 "includeMotoHours": true ~/~/ Флаг, включать ли моточасы в отчет
2725 }
2726 )))
2727 )))
2728
2729 (((
2730
2731 )))
2732
2733 (((
2734 Пример ответа:
2735 )))
2736
2737 (((
2738 (((
2739 [
2740 {
2741 "geozoneId": 0, ~/~/ ID геозоны
2742 "geozoneName": "string", ~/~/ Наименование геозоны
2743 "startDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время входа из геозоны
2744 "endDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время выхода из геозоны
2745 "duration": 0, ~/~/ Продолжительность внутри геозоны
2746 "vehicleId": 0, ~/~/ ID объекта
2747 "vehicleName": "string", ~/~/ Имя объекта
2748 "motoHours": 0 ~/~/ Моточасы
2749 }
2750 ]
2751 )))
2752 )))
2753
2754 (((
2755
2756 )))
2757
2758 == **Возвращение данных по пересечению геозон для объектов с заданными ID ** ==
2759
2760 (((
2761
2762 )))
2763
2764 (% class="box successmessage" %)
2765 (((
2766 **POST /api/v3/gis/intersections/vehicles**
2767 )))
2768
2769 (((
2770 Пример запроса:
2771 )))
2772
2773 (((
2774
2775 )))
2776
2777 (((
2778 (((
2779 {
2780 "startDate": "2025-12-04T07:26:11.520Z", ~/~/ Дата и время начала расчета 
2781 "endDate": "2025-12-04T07:26:11.520Z", ~/~/ Дата и время конца расчета 
2782 "ids": [ ~/~/ Идентификаторы объектов
2783 0
2784 ],
2785 "byTime": 0, ~/~/ объединение геообъектов по времени (секунды)
2786 "byDist": 0, ~/~/ объединение геообъектов по расстоянию(метры)
2787 "filterByTime": 0, ~/~/ Фильтрация посещений по времени, сек.
2788 "filterByHalfPerimeter": true, ~/~/ Фильтрация по половине периметра геообъекта
2789 "includeMotoHours": true ~/~/ Флаг, включать ли моточасы в отчет
2790 }
2791 )))
2792 )))
2793
2794 (((
2795
2796 )))
2797
2798 (((
2799 Пример ответа:
2800 )))
2801
2802 (((
2803 [
2804 {
2805 "geozoneId": 0, ~/~/ ID геозоны
2806 "geozoneName": "string", ~/~/ Наименование геозоны
2807 "startDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время входа из геозоны
2808 "endDate": "2025-12-04T07:19:27.629Z", ~/~/ Дату и время выхода из геозоны
2809 "duration": 0, ~/~/ Продолжительность внутри геозоны
2810 "vehicleId": 0, ~/~/ ID объекта
2811 "vehicleName": "string", ~/~/ Имя объекта
2812 "motoHours": 0 ~/~/ Моточасы
2813 }
2814 ]
2815 )))
2816
2817 (((
2818
2819 )))
2820
2821 == **Получение списка геозон** ==
2822
2823 (((
2824
2825 )))
2826
2827 (% class="box successmessage" %)
2828 (((
2829 **POST /api/v3/gis/find**
2830 )))
2831
2832 (((
2833 (((
2834 Пример запроса:
2835 )))
2836
2837 (((
2838
2839 )))
2840
2841 (((
2842 {
2843 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента, для которого надо получить данные.
2844 }
2845 )))
2846 )))
2847
2848 (((
2849
2850 )))
2851
2852 (((
2853 Пример ответа:
2854 )))
2855
2856 (((
2857 (((
2858 [
2859 {
2860 "id": 0, ~/~/ Идентификатор объекта геозоны
2861 "name": "string", ~/~/ Название объекта геозоны
2862 "type": 0, ~/~/ Тип объекта геозоны
2863 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
2864 "fname": "string", ~/~/ Имя файла
2865 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента 
2866 "beginCalc": "2025-12-04T07:31:23.082Z", ~/~/ Дата начала расчетов для геозоны
2867 "endCalc": "2025-12-04T07:31:23.082Z", ~/~/ Дата окончания расчетов для геозоны
2868 "description": "string",  ~/~/ Описание объекта геозоны
2869 "area": 0, ~/~/ Площадь, м2
2870 "perimetr": 0, ~/~/ Периметр, м
2871 "createDate": "2025-12-04T07:31:23.082Z" ~/~/ Дата создания в бд
2872 }
2873 ]
2874 )))
2875 )))
2876
2877 (((
2878
2879 )))
2880
2881 == **Создание геообъекта** ==
2882
2883 (((
2884
2885 )))
2886
2887 (% class="box successmessage" %)
2888 (((
2889 **POST /api/v3/gis**
2890 )))
2891
2892 (((
2893 (((
2894 Пример запроса:
2895 \\{
2896 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента 
2897 "name": "string", ~/~/ Наименование объекта геозоны
2898 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
2899 "description": "string", ~/~/ Описание объекта геозоны
2900 "beginCalc": "2025-12-04T07:35:07.395Z", ~/~/ Дата начала расчетов для геозоны
2901 "endCalc": "2025-12-04T07:35:07.395Z",  ~/~/ Дата окончания расчетов для геозоны
2902 "settingsData": "string",  ~/~/ Параметры отображения в формате XML
2903 "type": 0, ~/~/ Тип геозоны - линия,полигон
2904 "radius": 0, ~/~/ Радиус геозоны
2905 "shape": "string", ~/~/ Координаты геозоны
2906 "shape_format": "string" ~/~/ Формат xml,json,
2907 }
2908 )))
2909 )))
2910
2911 (((
2912
2913 )))
2914
2915 (((
2916 Пример ответа:
2917 )))
2918
2919 (((
2920
2921 )))
2922
2923 (((
2924 200 ~/~/ Success
2925 )))
2926
2927 (((
2928
2929 )))
2930
2931 == **Редактирование геообъекта ** ==
2932
2933 (((
2934
2935 )))
2936
2937 (% class="box warningmessage" %)
2938 (((
2939 **PUT /api/v3/gis**
2940 )))
2941
2942 (((
2943 (((
2944 Пример запроса:
2945 {
2946 "id": 0, ~/~/ Идентификатор объекта геозоны
2947 "name": "string", ~/~/ Наименование объекта геозоны
2948 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
2949 "description": "string", ~/~/ Описание объекта геозоны
2950 "beginCalc": "2025-12-04T07:38:55.221Z", ~/~/ Дата начала расчетов для геозоны
2951 "endCalc": "2025-12-04T07:38:55.221Z", ~/~/ Дата окончания расчетов для геозоны
2952 "settingsData": "string", ~/~/ Параметры отображения в формате XML.
2953 "type": 0, ~/~/ Тип геозоны - линия,полигон
2954 "radius": 0, ~/~/ Радиус геозоны
2955 "shape": "string", ~/~/ Координаты геозоны
2956 "shape_format": "string" ~/~/Формат xml,json 
2957 }
2958 )))
2959 )))
2960
2961 (((
2962
2963 )))
2964
2965 (((
2966 Пример ответа:
2967 )))
2968
2969 (((
2970
2971 )))
2972
2973 (((
2974 200 ~/~/ Success
2975 )))
2976
2977 (((
2978
2979 )))
2980
2981 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2982
2983 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2984
2985 (% class="box infomessage" %)
2986 (((
2987 **POST /api/v3/notifications/find**
2988 )))
2989
2990 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2991
2992 (% style="text-align: left;" %)
2993 Метод запроса **POST**
2994
2995 (% style="text-align: left;" %)
2996 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2997
2998 (% style="text-align: left;" %)
2999 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
3000
3001 {
3002 "parentId": "" ~/~/ id клиента
3003 }
3004
3005 Ответ:
3006
3007 [
3008 {
3009 "id": 0, ~/~/ ID уведомления
3010 "name": "string", ~/~/ Название уведомления
3011 "active": true, ~/~/ Состояние true - активен, false - деактивирован
3012 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
3013 "userId": "", ~/~/ Пользователь, создавший уведомление
3014 "parentId": "", ~/~/ Идентификатор клиента
3015 "parentName": "string" ~/~/ Имя клиента
3016 }
3017 ]
3018
3019
3020 == (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
3021
3022 (% class="box infomessage" %)
3023 (((
3024 **POST /api/v3/notifications**
3025 )))
3026
3027 Метод запроса **POST**
3028
3029 (% style="text-align: left;" %)
3030 (% style="color:#000000" %)Пример запроса
3031
3032 (((
3033 {
3034 "id": 0, ~/~/ ID правила
3035 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
3036 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
3037 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
3038 "name": "string", ~/~/ Имя правила
3039 "active": true, ~/~/ Активность правила
3040 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
3041 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
3042 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
3043 ],
3044 "vehicleIds": [ ~/~/ Список объектов для анализа.
3045 0
3046 ],
3047 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
3048 0
3049 ],
3050 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
3051 0
3052 ],
3053 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
3054 "additionalProp1": "string",  
3055 "additionalProp2": "string",
3056 "additionalProp3": "string"
3057 },
3058 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3059 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3060 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3061 ],
3062 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3063 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
3064 "string"
3065 ],
3066 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
3067 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
3068 {
3069 "id": 0, ~/~/ Идентификатор участника чата.
3070 "info": "string" ~/~/ Дополнительные сведения.
3071 }
3072 ],
3073 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
3074 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
3075 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3076 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
3077 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
3078 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
3079 "timezone": 0, ~/~/ часовой пояс 
3080 "validity": 0, ~/~/ Срок действия в днях (1-90).
3081 "autoProlongation": true, ~/~/ Автопродление срока действия.
3082 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
3083 {
3084 "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 - Срок действия правила истек
3085 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
3086 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
3087 "additionalProp1": "string",
3088 "additionalProp2": "string",
3089 "additionalProp3": "string"
3090 }
3091 }
3092 ]
3093 }
3094 )))
3095
3096 (((
3097
3098 )))
3099
3100 Ответ:
3101
3102 {
3103 "id": 0, ~/~/ ID правила
3104 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
3105 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
3106 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
3107 "name": "string", ~/~/ Имя правила
3108 "active": true, ~/~/ Активность правила
3109 "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
3110 "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
3111 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
3112 ],
3113 "vehicleIds": [ ~/~/ Список объектов для анализа.
3114 0
3115 ],
3116 "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
3117 0
3118 ],
3119 "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
3120 0
3121 ],
3122 "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
3123 "additionalProp1": "string",  
3124 "additionalProp2": "string",
3125 "additionalProp3": "string"
3126 },
3127 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3128 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3129 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3130 ],
3131 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3132 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
3133 "string"
3134 ],
3135 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
3136 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
3137 {
3138 "id": 0, ~/~/ Идентификатор участника чата.
3139 "info": "string" ~/~/ Дополнительные сведения.
3140 }
3141 ],
3142 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
3143 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
3144 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3145 "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
3146 "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
3147 "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
3148 "timezone": 0, ~/~/ часовой пояс 
3149 "validity": 0, ~/~/ Срок действия в днях (1-90).
3150 "autoProlongation": true, ~/~/ Автопродление срока действия.
3151 "templates": [ ~/~/  Переопределения шаблонов уведомлений.
3152 {
3153 "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 - Срок действия правила истек
3154 "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
3155 "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
3156 "additionalProp1": "string",
3157 "additionalProp2": "string",
3158 "additionalProp3": "string"
3159 }
3160 }
3161 ]
3162 }
3163
3164 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
3165
3166 (% class="box infomessage" %)
3167 (((
3168 **GET /api/v3/notifications/{id}**
3169 )))
3170
3171 Метод возвращает данные правил формирования выбранного уведомления.
3172
3173 (% style="text-align: left;" %)
3174 Метод запроса **GET**
3175
3176 (% style="text-align: left;" %)
3177 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3178
3179 (% style="text-align: left;" %)
3180 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
3181
3182 (% style="text-align: left;" %)
3183 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
3184
3185 (% style="text-align: left;" %)
3186 (% style="color:#000000" %)Ответ:
3187
3188 (% style="text-align: left;" %)
3189 (% style="color:#000000" %){
3190 "id": 0, ~/~/ (%%)id уведомления
3191 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
3192 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
3193 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
3194 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
3195 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
3196 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
3197 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
3198 (% style="color:#000000" %) 0
3199 ],
3200 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
3201 (% style="color:#000000" %) 0
3202 ],
3203 "fieldids": [ ~/~/ (%%)Список id полей для анализа
3204 (% style="color:#000000" %) 0
3205 ],
3206 "settings": { ~/~/ Список параметров уведомления
3207 "additionalProp1": "string",
3208 "additionalProp2": "string",
3209 "additionalProp3": "string"
3210 },
3211 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3212 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3213 (% style="color:#000000" %) ""
3214 ],
3215 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3216 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
3217 (% style="color:#000000" %) "string"
3218 ],
3219 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
3220 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
3221 (% style="color:#000000" %) {
3222 "id": 0, ~/~/ (%%)Идентификатор участника чата
3223 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
3224 (% style="color:#000000" %) }
3225 ],
3226 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
3227 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
3228 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3229 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
3230 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3231 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
3232 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
3233 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
3234 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
3235 (% style="color:#000000" %)}
3236
3237 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
3238
3239 (% class="box warningmessage" %)
3240 (((
3241 **PUT /api/v3/notifications/**
3242 )))
3243
3244 Метод позволяет отредактировать уведомление.
3245
3246 Метод запроса **PUT**
3247
3248 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
3249
3250 В заголовках запроса: X-Auth: Токен авторизации
3251
3252 Тело запроса:
3253 {
3254 "id": 0, ~/~/ id уведомления
3255 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
3256 "userId": "", ~/~/ Пользователь, создавший уведомление
3257 "parentId": "", ~/~/ Идентификатор клиента
3258 "parentName": "string", ~/~/ Имя клиента
3259 "name": "string", ~/~/ Название уведомления
3260 "active": true, ~/~/ Состояние true - активен, false - деактивирован
3261 "vehicleIds": [ ~/~/ Список id объектов для анализа
3262 0
3263 ],
3264 "geoids": [ ~/~/ Список id геообъектов для анализа
3265 0
3266 ],
3267 "fieldids": [ ~/~/ Список id полей для анализа
3268 0
3269 ],
3270 "settings": { ~/~/ Список параметров уведомления
3271 "additionalProp1": "string",
3272 "additionalProp2": "string",
3273 "additionalProp3": "string"
3274 },
3275 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
3276 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
3277 ""
3278 ],
3279 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
3280 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
3281 "string"
3282 ],
3283 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
3284 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
3285 {
3286 "id": 0, ~/~/ Идентификатор участника чата
3287 "info": "string" ~/~/ Дополнительные сведения
3288 }
3289 ],
3290 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
3291 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
3292 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3293 "kind": 0, ~/~/ Определяет вид уведомления
3294 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3295 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
3296 "timezone": 0, ~/~/ Сдвиг часового пояса
3297 "validity": 0, ~/~/ Срок действия в днях (1-90)
3298 "autoProlongation": true ~/~/ Автопродление срока действия
3299 }
3300
3301 Ответ:
3302
3303 Success
3304
3305
3306 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
3307
3308 (% class="box warningmessage" %)
3309 (((
3310 **PUT** /api/v3/notifications/prolongation
3311 )))
3312
3313 Метод позволяет продлить уведомления.
3314
3315 Метод запроса **PUT**
3316
3317 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
3318
3319 В заголовках запроса: X-Auth: Токен авторизации.
3320
3321 Тело запроса:
3322
3323 [
3324
3325 0
3326
3327 ]
3328
3329 где 0 идентификатор ids.
3330
3331 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
3332
3333 (% class="box errormessage" %)
3334 (((
3335 **DELETE /api/v3/notifications/{id}**
3336 )))
3337
3338 Метод позволяет удалить выбранное уведомление.
3339
3340 Метод запроса **DELETE**
3341
3342 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3343
3344 Передаваемый параметр: {id} - id уведомления
3345
3346 В заголовках запроса: X-Auth: Токен авторизации
3347
3348 Ответ:
3349
3350 Success
3351
3352
3353 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3354
3355 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3356
3357 (% class="box infomessage" %)
3358 (((
3359 **POST /api/v3/Drivers/find**
3360 )))
3361
3362 Передается параметр: parentId - ID клиента-родителя
3363
3364 Ответ:
3365
3366 [
3367 {
3368 "name": "string", ~/~/ Определяет наименование
3369 "description": "string", ~/~/ Определяет описание
3370 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3371 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3372 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3373 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3374 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3375 "deleted": true ~/~/ Признак удаления
3376 }
3377 ]
3378
3379 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3380
3381 (% class="box infomessage" %)
3382 (((
3383 **GET /api/v3/Drivers/{driverGuid}**
3384 )))
3385
3386 Передается параметр: ID водителя
3387
3388 Ответ:
3389
3390 {
3391 "name": "string", ~/~/ Определяет наименование
3392 "description": "string", ~/~/ Определяет описание
3393 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3394 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3395 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3396 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3397 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3398 "deleted": true ~/~/ Признак удаления
3399 }
3400
3401 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3402
3403 (% class="box successmessage" %)
3404 (((
3405 **POST /api/v3/Drivers**
3406 )))
3407
3408 Запрос:
3409
3410 {
3411 "name": "string",
3412 "description": "string",
3413 "hiredate": "2023-06-30T12:50:54.020Z",
3414 "chopdate": "2023-06-30T12:50:54.020Z",
3415 "exclusive": true,
3416 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3417 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3418 "deleted": true
3419 }
3420
3421 Ответ:
3422
3423 {
3424 "name": "string",
3425 "description": "string",
3426 "hiredate": "2023-06-30T12:50:54.051Z",
3427 "chopdate": "2023-06-30T12:50:54.051Z",
3428 "exclusive": true,
3429 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3430 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3431 "deleted": true
3432 }
3433
3434
3435 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3436
3437 (% class="box warningmessage" %)
3438 (((
3439 **PUT /api/v3/Drivers**
3440 )))
3441
3442 Запрос:
3443
3444 {
3445 "name": "string",
3446 "description": "string",
3447 "hiredate": "2023-06-30T12:50:27.910Z",
3448 "chopdate": "2023-06-30T12:50:27.910Z",
3449 "exclusive": true,
3450 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3451 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3452 "deleted": true
3453 }
3454
3455 Ответ:
3456
3457 {
3458 "name": "string",
3459 "description": "string",
3460 "hiredate": "2023-06-30T12:50:27.929Z",
3461 "chopdate": "2023-06-30T12:50:27.929Z",
3462 "exclusive": true,
3463 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3464 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3465 "deleted": true
3466 }
3467
3468
3469 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3470
3471 (% class="box errormessage" %)
3472 (((
3473 **DELETE /api/v3/Drivers/{driverGuid}**
3474 )))
3475
3476 Передается параметр: ID водителя
3477
3478 Ответ:
3479
3480 Success
3481
3482
3483 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3484
3485 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3486
3487 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3488
3489 (% class="box infomessage" %)
3490 (((
3491 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3492 )))
3493
3494 Запрос:
3495
3496 {
3497 "Ids": [
3498 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3499 ],
3500 "BeginTime": "2023-06-30T12:49:04.365Z",
3501 "EndTime": "2023-06-30T12:49:04.365Z"
3502 }
3503
3504 Ответ:
3505
3506 [
3507 {
3508 "VehicleId": 0,
3509 "CreateTime": "2023-06-30T09:52:31.240Z",
3510 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3511 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3512 "BeginTime": "2023-06-30T09:52:31.240Z",
3513 "EndTime": "2023-06-30T09:52:31.240Z"
3514 }
3515 ]
3516
3517
3518 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3519
3520 (% class="box infomessage" %)
3521 (((
3522 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3523 )))
3524
3525 Запрос:
3526
3527 {
3528 "Ids": [
3529 0
3530 ],
3531 "BeginTime": "2023-06-30T12:48:39.419Z",
3532 "EndTime": "2023-06-30T12:48:39.419Z"
3533 }
3534
3535 Ответ:
3536
3537 [
3538 {
3539 "VehicleId": 0,
3540 "CreateTime": "2023-06-30T09:54:01.631Z",
3541 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3542 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3543 "BeginTime": "2023-06-30T09:54:01.631Z",
3544 "EndTime": "2023-06-30T09:54:01.631Z"
3545 }
3546 ]
3547
3548
3549 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3550
3551 (% class="box successmessage" %)
3552 (((
3553 **POST /api/v3/DriversVehiclesAssignments**
3554 )))
3555
3556 Передается массив назначений
3557
3558 Запрос:
3559
3560 [
3561 {
3562 "VehicleId": 0, ~/~/ Идентификатор объекта
3563 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3564 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3565 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3566 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3567 }
3568 ]
3569
3570 Ответ:
3571
3572 [
3573 {
3574 "VehicleId": 0,
3575 "CreateTime": "2023-06-30T11:04:46.903Z",
3576 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3577 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3578 "BeginTime": "2023-06-30T11:04:46.903Z",
3579 "EndTime": "2023-06-30T11:04:46.903Z"
3580 }
3581 ]
3582
3583
3584 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3585
3586 (% class="box warningmessage" %)
3587 (((
3588 **PUT /api/v3/DriversVehiclesAssignments**
3589 )))
3590
3591 Запрос:
3592
3593 [
3594 {
3595 "VehicleId": 0,
3596 "CreateTime": "2023-06-30T11:14:08.117Z",
3597 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3598 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3599 "BeginTime": "2023-06-30T11:14:08.117Z",
3600 "EndTime": "2023-06-30T11:14:08.117Z"
3601 }
3602 ]
3603
3604 Ответ:
3605
3606 [
3607 {
3608 "VehicleId": 0,
3609 "CreateTime": "2023-06-30T11:14:53.349Z",
3610 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3611 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3612 "BeginTime": "2023-06-30T11:14:53.349Z",
3613 "EndTime": "2023-06-30T11:14:53.349Z"
3614 }
3615 ]
3616
3617
3618 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3619
3620 (% class="box errormessage" %)
3621 (((
3622 **DELETE /api/v3/DriversVehiclesAssignments**
3623 )))
3624
3625 Запрос:
3626
3627 [
3628 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3629 ]
3630
3631 Ответ:
3632
3633 Success
3634
3635
3636 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3637
3638 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3639
3640 (% class="box infomessage" %)
3641 (((
3642 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3643 )))
3644
3645 Запрос:
3646
3647 {
3648 "Ids": [
3649 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3650 ],
3651 "BeginTime": "2023-06-30T12:47:12.162Z",
3652 "EndTime": "2023-06-30T12:47:12.162Z"
3653 }
3654
3655 Ответ:
3656
3657 [
3658 {
3659 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3660 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3661 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3662 "BeginTime": "2023-06-30T11:19:40.703Z",
3663 "EndTime": "2023-06-30T11:19:40.703Z"
3664 }
3665 ]
3666
3667
3668 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3669
3670 (% class="box infomessage" %)
3671 (((
3672 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3673 )))
3674
3675 Запрос:
3676
3677 {
3678 "Ids": [
3679 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3680 ],
3681 "BeginTime": "2023-06-30T12:47:12.162Z",
3682 "EndTime": "2023-06-30T12:47:12.162Z"
3683 }
3684
3685 Ответ:
3686
3687 [
3688 {
3689 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3690 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3691 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3692 "BeginTime": "2023-06-30T11:19:40.703Z",
3693 "EndTime": "2023-06-30T11:19:40.703Z"
3694 }
3695 ]
3696
3697
3698 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3699
3700 (% class="box successmessage" %)
3701 (((
3702 **POST /api/v3/DriversRfidsAssignments**
3703 )))
3704
3705 Запрос:
3706
3707 [
3708 {
3709 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3710 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3711 "BeginTime": "2023-06-30T11:27:08.635Z",
3712 "EndTime": "2023-06-30T11:27:08.635Z"
3713 }
3714 ]
3715
3716 Ответ:
3717
3718 [
3719 {
3720 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3721 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3722 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3723 "BeginTime": "2023-06-30T11:27:08.677Z",
3724 "EndTime": "2023-06-30T11:27:08.677Z"
3725 }
3726 ]
3727
3728
3729 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3730
3731 (% class="box warningmessage" %)
3732 (((
3733 **PUT /api/v3/DriversRfidsAssignments**
3734 )))
3735
3736 Запрос:
3737
3738 [
3739 {
3740 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3741 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3742 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3743 "BeginTime": "2023-06-30T11:28:43.330Z",
3744 "EndTime": "2023-06-30T11:28:43.330Z"
3745 }
3746 ]
3747
3748 Ответ:
3749
3750 [
3751 {
3752 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3753 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3754 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3755 "BeginTime": "2023-06-30T11:28:43.331Z",
3756 "EndTime": "2023-06-30T11:28:43.331Z"
3757 }
3758 ]
3759
3760
3761 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3762
3763 (% class="box errormessage" %)
3764 (((
3765 **DELETE /api/v3/DriversRfidsAssignments**
3766 )))
3767
3768 Запрос:
3769
3770 [
3771 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3772 ]
3773
3774 Ответ:
3775
3776 Success
3777
3778
3779 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3780
3781 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3782
3783 (% class="box infomessage" %)
3784 (((
3785 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3786 )))
3787
3788 Запрос:
3789
3790 {
3791 "Ids": [
3792 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3793 ],
3794 "BeginTime": "2023-06-30T12:45:10.852Z",
3795 "EndTime": "2023-06-30T12:45:10.852Z"
3796 }
3797
3798 Ответ:
3799
3800 [
3801 {
3802 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3803 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3804 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3805 "BeginTime": "2023-06-30T11:58:04.695Z",
3806 "EndTime": "2023-06-30T11:58:04.695Z"
3807 }
3808 ]
3809
3810
3811 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3812
3813 (% class="box infomessage" %)
3814 (((
3815 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3816 )))
3817
3818 Запрос:
3819
3820 {
3821 "Ids": [
3822 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3823 ],
3824 "BeginTime": "2023-06-30T12:45:10.852Z",
3825 "EndTime": "2023-06-30T12:45:10.852Z"
3826 }
3827
3828 Ответ:
3829
3830 [
3831 {
3832 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3833 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3834 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3835 "BeginTime": "2023-06-30T11:58:04.695Z",
3836 "EndTime": "2023-06-30T11:58:04.695Z"
3837 }
3838 ]
3839
3840
3841 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3842
3843 (% class="box successmessage" %)
3844 (((
3845 **POST /api/v3/DriversFuelCardsAssignments**
3846 )))
3847
3848 Запрос:
3849
3850 [
3851 {
3852 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3853 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3854 "BeginTime": "2023-06-30T12:09:53.175Z",
3855 "EndTime": "2023-06-30T12:09:53.175Z"
3856 }
3857 ]
3858
3859 Ответ:
3860
3861 [
3862 {
3863 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3864 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3865 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3866 "BeginTime": "2023-06-30T12:09:53.201Z",
3867 "EndTime": "2023-06-30T12:09:53.201Z"
3868 }
3869 ]
3870
3871
3872 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3873
3874 (% class="box warningmessage" %)
3875 (((
3876 **PUT /api/v3/DriversFuelCardsAssignments**
3877 )))
3878
3879 Запрос:
3880
3881 [
3882 {
3883 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3884 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3885 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3886 "BeginTime": "2023-06-30T12:09:53.201Z",
3887 "EndTime": "2023-06-30T12:09:53.201Z"
3888 }
3889 ]
3890
3891 Ответ:
3892
3893 [
3894 {
3895 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3896 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3897 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3898 "BeginTime": "2023-06-30T12:09:53.201Z",
3899 "EndTime": "2023-06-30T12:09:53.201Z"
3900 }
3901 ]
3902
3903
3904 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3905
3906 (% class="box errormessage" %)
3907 (((
3908 **DELETE /api/v3/DriversFuelCardsAssignments**
3909 )))
3910
3911 Запрос:
3912
3913 [
3914 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3915 ]
3916
3917 Ответ:
3918
3919 Success
3920
3921
3922 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3923
3924 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3925
3926 (% class="box infomessage" %)
3927 (((
3928 **POST /api/v3/Trailers**
3929 )))
3930
3931 Пример запроса:
3932
3933 {
3934 "startDate": "2023-11-14T10:48:03.671Z",
3935 "endDate": "2023-11-14T10:48:03.671Z",
3936 "ids": [ 0 ],
3937 "timezone": 0
3938 }
3939
3940 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3941 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3942 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3943 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3944 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3945
3946 Пример ответа:
3947
3948 [
3949 {
3950 "SD": "2023-11-14T10:48:03.717Z",
3951 "ED": "2023-11-14T10:48:03.717Z", 
3952 "id": 0,
3953 "SLat": 0,
3954 "SLon": 0,
3955 "ELat": 0,
3956 "ELon": 0,
3957 "mileage": 0
3958 "Duration": 0
3959 "Address": "string",
3960 "Address2": "string",
3961 "name": "string",
3962 "rid": "string",
3963 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3964 "trailer": {
3965 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3966 "Number": "string",
3967 "Description": "string",
3968 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3969 "ExternalID": "string",
3970 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3971 "CreateTime": "2023-11-14T10:48:03.717Z",
3972 "UpdateTime": "2023-11-14T10:48:03.717Z",
3973 "IsDeleted": true
3974 },
3975 "filesCount": 0,
3976 }
3977 ]
3978
3979 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3980 |SD|Дата и время начала события
3981 |ED|Дата и время окончания события
3982 |id|ID объекта
3983 |SLat|Широта начальной координаты
3984 |SLon|Долгота начальной координаты
3985 |ELat|Широта конечной координаты
3986 |ELon|Долгота конечной координаты
3987 |mileage|Пробег
3988 |Duration|Продолжительность
3989 |Address|Адрес начального местоположения
3990 |Address2|Адрес конечного местоположения
3991 |name|Имя радиометки
3992 |rid|Номер радиометки
3993 |rguid|ID радиометки
3994 |trailer|Информация об агрегате
3995 |ModelGuid|ID агрегата
3996 |Number|Название/номер агрегата
3997 |Description|Текст примечания агрегата
3998
3999 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
4000
4001 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
4002
4003 (% class="box infomessage" %)
4004 (((
4005 **POST /api/v3/Rfids/find**
4006 )))
4007
4008 Запрос:
4009
4010 {
4011 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4012 }
4013
4014 Ответ:
4015
4016 [
4017 {
4018 "name": "string",
4019 "number": 0,
4020 "period": 0,
4021 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4022 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4023 }
4024 ]
4025
4026 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4027 |parentId|ID клиента
4028 |name|Название карты-метки
4029 |number|Номер
4030 |period|Период запросов в секундах (работает только для агрегатов)
4031 |id|ID карты-метки
4032
4033 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
4034
4035 (% class="box infomessage" %)
4036 (((
4037 **GET /api/v3/Rfids/{rfidGuid}**
4038 )))
4039
4040 Передаем параметр rfidGuid - идентификатор карты-метки
4041
4042 Ответ:
4043
4044 [
4045 {
4046 "name": "string",
4047 "number": 0,
4048 "period": 0,
4049 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4050 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4051 }
4052 ]
4053
4054 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4055 |name|Название карты-метки
4056 |number|Номер
4057 |period|Период запросов в секундах (работает только для агрегатов)
4058 |id|ID карты-метки
4059 |parentId|ID клиента
4060
4061 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
4062
4063 (% class="box successmessage" %)
4064 (((
4065 **POST /api/v3/Rfids**
4066 )))
4067
4068 Запрос:
4069
4070 {
4071 "name": "string",
4072 "number": 0,
4073 "period": 0,
4074 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4075 }
4076
4077 Ответ:
4078
4079 {
4080 "name": "string",
4081 "number": 0,
4082 "period": 0,
4083 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4084 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4085 }
4086
4087 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4088 |name|Название карты-метки
4089 |number|Номер
4090 |period|Период запросов в секундах (работает только для агрегатов)
4091 |id|ID карты-метки
4092 |parentId|ID клиента
4093
4094 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
4095
4096 (% class="box warningmessage" %)
4097 (((
4098 **PUT /api/v3/Rfids**
4099 )))
4100
4101 Запрос:
4102
4103 {
4104 "name": "string",
4105 "number": 0,
4106 "period": 0,
4107 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4108 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4109 }
4110
4111 Ответ:
4112
4113 {
4114 "name": "string",
4115 "number": 0,
4116 "period": 0,
4117 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4118 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4119 }
4120
4121 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4122 |name|Название карты-метки
4123 |number|Номер
4124 |period|Период запросов в секундах (работает только для агрегатов)
4125 |id|ID карты-метки
4126 |parentId|ID клиента
4127
4128 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
4129
4130 (% class="box errormessage" %)
4131 (((
4132 **DELETE /api/v3/Rfids/{rfidGuid}**
4133 )))
4134
4135 Передаем параметр **rfidGuid** - идентификатор карты-метки
4136
4137 Ответ:
4138
4139 Success
4140
4141
4142 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
4143
4144 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
4145
4146 (% class="box infomessage" %)
4147 (((
4148 **GET /api/v3/Billing/client/balance/{clientId}**
4149 )))
4150
4151 Параметр запроса: **clientId **- идентификатор клиента.
4152
4153 Ответ:
4154
4155 {
4156 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4157 "Balance": 0
4158 }
4159
4160 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4161 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4162 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4163
4164 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
4165
4166 (% class="box infomessage" %)
4167 (((
4168 **GET /api/v3/Billing/client/constraint/{clientId}**
4169 )))
4170
4171 Параметр запроса: **clientId **- идентификатор клиента.
4172
4173 Ответ:
4174
4175 {
4176 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4177 "CalculationType": 0,
4178 "PermissibleBalance": 0,
4179 "DefermentDays": 0,
4180 "SendUiNotifications": true,
4181 "SendEmailNotifications": true,
4182 "IsPrivate": true,
4183 }
4184
4185 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4186 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4187 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
4188 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
4189 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
4190 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4191 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4192 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4193
4194 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
4195
4196 (% class="box infomessage" %)
4197 (((
4198 **GET /api/v3/Billing/client/plan/{clientId}**
4199 )))
4200
4201 Параметры запроса:
4202
4203 **clientId **- идентификатор клиента.
4204
4205 **planId **- идентификатор тарифного плана.
4206
4207 Ответ:
4208
4209 {
4210 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4211 "Plan": { **~/~/ Описание тарифного плана**
4212 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4213 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4214 "Name": "string",
4215 "IsArchived": true,
4216 "Constraint": {
4217 "CalculationType": 0,
4218 "PermissibleBalance": 0,
4219 "DefermentDays": 0
4220 },
4221 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
4222 {
4223 "Feature": "string",
4224 "IsFactual": true,
4225 "Limit": 0,
4226 "Price": 0,
4227 "PeriodValue": 0,
4228 "PeriodType": 0
4229 }
4230 ]
4231 },
4232 "DebitDate": "2023-10-18T12:46:24.213Z",
4233 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
4234 {
4235 "Feature": "string",
4236 "IsEnabled": true,
4237 "IsPrivate": true,
4238 "IsFactual": true,
4239 "Limit": 0,
4240 "Price": 0,
4241 "DebitDate": "2023-10-18T12:46:24.213Z",
4242 "PeriodValue": 0,
4243 "PeriodType": 0
4244 }
4245 ]
4246 }
4247
4248 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4249 |ClientId|Идентификатор клиента
4250 |Id|Идентификатор тарифного плана
4251 |OwnerId|Идентификатор клиента-владельца
4252 |Name|Наименование тарифного плана
4253 |IsArchived|Признак, определяющий архивный тарифный план
4254 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4255 |PermissibleBalance|Допустимый баланс
4256 |DefermentDays|Отсрочка, количество дней
4257 |Feature|Код услуги
4258 |IsEnabled|Признак, определяющий активирована ли услуга
4259 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4260 |IsFactual|Признак, определяющий расчёт по факту
4261 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4262 |Price|Цена за единицу.
4263 |DebitDate|Следующий момент времени списания с баланса за услугу.
4264 |PeriodValue|Значение периода.
4265 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4266
4267 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
4268
4269 (% class="box infomessage" %)
4270 (((
4271 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4272 )))
4273
4274 Параметр запроса: **clientId **- идентификатор клиента.
4275
4276 Ответ:
4277
4278 [
4279 {
4280 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4281 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4282 "Name": "string",
4283 "IsArchived": true,
4284 "Constraint": {
4285 "CalculationType": 0,
4286 "PermissibleBalance": 0,
4287 "DefermentDays": 0
4288 },
4289 "Features": [
4290 {
4291 "Feature": "string",
4292 "IsFactual": true,
4293 "Limit": 0,
4294 "Price": 0,
4295 "PeriodValue": 0,
4296 "PeriodType": 0
4297 }
4298 ]
4299 }
4300 ]
4301
4302 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4303 |ClientId|Идентификатор клиента
4304 |Id|Идентификатор тарифного плана
4305 |OwnerId|Идентификатор клиента-владельца
4306 |Name|Наименование тарифного плана
4307 |IsArchived|Признак, определяющий архивный тарифный план
4308 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4309 |PermissibleBalance|Допустимый баланс
4310 |DefermentDays|Отсрочка, количество дней
4311 |Feature|Код услуги
4312 |IsFactual|Признак, определяющий расчёт по факту
4313 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4314 |Price|Цена за единицу.
4315 |PeriodValue|Значение периода.
4316 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4317
4318 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
4319
4320 (% class="box infomessage" %)
4321 (((
4322 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4323 )))
4324
4325 Параметр запроса: **clientId **- идентификатор клиента.
4326
4327 Ответ:
4328
4329 [
4330 {
4331 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4332 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4333 "Name": "string",
4334 "IsArchived": true,
4335 "Constraint": {
4336 "CalculationType": 0,
4337 "PermissibleBalance": 0,
4338 "DefermentDays": 0
4339 },
4340 "Features": [
4341 {
4342 "Feature": "string",
4343 "IsFactual": true,
4344 "Limit": 0,
4345 "Price": 0,
4346 "PeriodValue": 0,
4347 "PeriodType": 0
4348 }
4349 ]
4350 }
4351 ]
4352
4353 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4354 |ClientId|Идентификатор клиента
4355 |Id|Идентификатор тарифного плана
4356 |OwnerId|Идентификатор клиента-владельца
4357 |Name|Наименование тарифного плана
4358 |IsArchived|Признак, определяющий архивный тарифный план
4359 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4360 |PermissibleBalance|Допустимый баланс
4361 |DefermentDays|Отсрочка, количество дней
4362 |Feature|Код услуги
4363 |IsFactual|Признак, определяющий расчёт по факту
4364 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4365 |Price|Цена за единицу.
4366 |PeriodValue|Значение периода.
4367 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4368
4369 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4370
4371 (% class="box warningmessage" %)
4372 (((
4373 **PUT /api/v3/Billing/client/balance**
4374 )))
4375
4376 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4377
4378 Тело запроса:
4379
4380 {
4381 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4382 "Balance": 0 ~/~/ Значение баланса.
4383 }
4384
4385 Ответ: Success
4386
4387 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4388
4389 (% class="box warningmessage" %)
4390 (((
4391 **PUT /api/v3/billing/client/balance/deposit**
4392 )))
4393
4394 Создает операцию **Пополнение **с указанной суммой
4395
4396 Тело запроса:
4397
4398 (((
4399 {
4400 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4401 "amount": 0 ~/~/ Сумма пополнения баланса 
4402 }
4403 )))
4404
4405 (((
4406
4407 )))
4408
4409 Ответ: Success
4410
4411 (((
4412 {
4413 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4414 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4415 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4416 "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки.
4417 "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4418 "Description": "string" ~/~/ Описание корректировки.
4419 }
4420 )))
4421
4422 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4423
4424 Создает операцию **Списание **с указанной суммой
4425
4426 (% class="box warningmessage" %)
4427 (((
4428 **PUT /api/v3/billing/client/balance/withdraw**
4429 )))
4430
4431 Тело запроса:
4432
4433 (((
4434 {
4435 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4436 "amount": 0 ~/~/ Сумма списания с баланса
4437 }
4438 )))
4439
4440 Ответ: Success
4441
4442 (((
4443 {
4444 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки.
4445 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4446 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя.
4447 "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки.
4448 "Amount": 0, ~/~/ Значение, на которое корректируется баланс.
4449 "Description": "string" ~/~/ Описание корректировки
4450 }
4451 )))
4452
4453 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4454
4455 (% class="box warningmessage" %)
4456 (((
4457 **PUT /api/v3/Billing/client/constraint**
4458 )))
4459
4460 Тело запроса:
4461
4462 (((
4463 {
4464 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4465 "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4466 "PermissibleBalance": 0, ~/~/ Допустимый баланс
4467 "DefermentDays": 0, ~/~/ Отсрочка (дни).
4468 "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4469 "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4470 }
4471 )))
4472
4473 (((
4474
4475 )))
4476
4477 Ответ: Success
4478
4479 (((
4480 {
4481 "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4482 "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент.
4483 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4484 "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни
4485 "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4486 "DefermentDays": 0, ~/~/ Отсрочка (дни)
4487 "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено
4488 "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено
4489 }
4490 )))
4491
4492 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4493
4494 (% class="box warningmessage" %)
4495 (((
4496 **PUT /api/v3/Billing/client/plan**
4497 )))
4498
4499 Тело запроса:
4500
4501 {
4502 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор клиента.
4503 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4504 "Features": [ ~/~/ Набор услуг по тарифу клиента.
4505 {
4506 "Feature": "string", ~/~/ Код услуги.
4507 "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4508 "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4509 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование
4510 "Price": 0, ~/~/ Цена за единицу.
4511 "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4512 "PeriodValue": 0, ~/~/ Значение периода.
4513 "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы)
4514 }
4515 ]
4516 }
4517
4518
4519 Ответ: Success
4520
4521 (((
4522 {
4523 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
4524 "Plan": { ~/~/ Определяет тарифный план (шаблон услуг)
4525 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана.
4526 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца.
4527 "Name": "string", ~/~/ Наименование.
4528 "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план.
4529 "Constraint": { ~/~/ Ограничения по тарифу 
4530 "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 
4531 "PermissibleBalance": 0, ~/~/ Допустимый баланс.
4532 "DefermentDays": 0 ~/~/ Отсрочка (дни)
4533 },
4534 "Features": [ ~/~/ Набор услуг по тарифному плану.
4535 {
4536 "Feature": "string", ~/~/Код услуги.
4537 "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту.
4538 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4539 "Price": 0, ~/~/ Цена за единицу.
4540 "PeriodValue": 0, ~/~/ Значение периода.
4541 "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 
4542 }
4543 ],
4544 "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план.
4545 "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана.
4546 "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана.
4547 },
4548 "Features": [ ~/~/ Набор услуг по тарифу клиента.
4549 {
4550 "Feature": "string", ~/~/ Код услуги.
4551 "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга.
4552 "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
4553 "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту.
4554 "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4555 "Price": 0, ~/~/ Цена за единицу.
4556 "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу.
4557 "PeriodValue": 0, ~/~/ Значение периода.
4558 "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане.
4559 "Quantity": 0 ~/~/ Количество использования услуги.
4560 }
4561 ]
4562 }
4563 )))
4564
4565 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4566
4567 (% class="box warningmessage" %)
4568 (((
4569 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4570 )))
4571
4572 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4573
4574 (% class="box infomessage" %)
4575 (((
4576 **POST /api/v3/vehicles/import/{agentId}**
4577 )))
4578
4579 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4580
4581 В пути указывается **agentId** - id клиента.
4582
4583 **Заголовок**
4584
4585 **X-Auth: [токен авторизации]**
4586
4587 **Параметры**
4588
4589 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4590 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4591 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4592
4593 В теле использовать тип **form-data,** тип значения** file**
4594
4595 **Ключи**
4596
4597 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4598 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4599 |csv|В значении передаем файл датчиков, формат **csv**
4600
4601 Ответ:
4602
4603 {
4604 "vehicleId": 0,
4605 "name": "string",
4606 "errors": ["string"]
4607 }
4608
4609 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4610 |vehicleId|ID созданного объекта
4611 |name|Имя созданного объекта
4612 |errors|Ошибки и их описание
4613
4614 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4615
4616 (% class="box infomessage" %)
4617 (((
4618 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4619 )))
4620
4621 (% class="wikigeneratedid" %)
4622 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4623
4624 (% class="wikigeneratedid" %)
4625 В пути указывается **vehicleId **- id объекта.
4626
4627 **Заголовок**
4628
4629 **X-Auth: [токен авторизации]**
4630
4631 В теле использовать тип **form-data.**
4632
4633 Ключи:
4634
4635 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4636 |**history**|В значении передавать файл с историей
4637
4638 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4639
4640 Ответ:
4641
4642 {
4643 "results": [
4644 {
4645 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4646 "vehicleId": 0,
4647 "errors": [
4648 "string"
4649 ],
4650 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4651 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4652 "producedCount": 0,
4653 "msgCount": 0
4654 }
4655 ]
4656 }
4657
4658 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4659 |results|Результаты импорта в разрезе ТС
4660 |vehicleGuid|Guid ТС
4661 |vehicleId|ID ТС
4662 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4663 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4664 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4665 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4666 |msgCount|Кол-во обработанных сообщений всего
4667
4668 == **Импортировать историю ТС (Асинхронный запрос)** ==
4669
4670 (% class="box successmessage" %)
4671 (((
4672 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4673 )))
4674
4675 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4676
4677 Метод запроса: **POST**
4678
4679 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4680
4681 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4682
4683
4684 Ответ:
4685
4686 {
4687
4688 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4689
4690 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4691
4692 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4693
4694 "Message": "string", ~/~/ Информация о выполнении запроса
4695
4696 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4697
4698 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4699
4700 "Data": "string" ~/~/ Данные
4701
4702 }
4703
4704
4705 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4706
4707 (% class="box infomessage" %)
4708 (((
4709 **GET /api/v3/vehicles/import/history/status**
4710 )))
4711
4712 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4713
4714 Ответ:
4715
4716 {
4717 "activity": true,
4718 "progress": 0,
4719 "message": "string"
4720 }
4721
4722 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4723 **Параметр**
4724 )))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4725 **Описание**
4726 )))
4727 |(((
4728 activity
4729 )))|(((
4730 Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4731 )))
4732 |(((
4733 progress
4734 )))|(((
4735 Guid ТС
4736 )))
4737
4738 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
4739
4740 (% class="box infomessage" %)
4741 (((
4742 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4743 )))
4744
4745 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4746
4747 Метод запроса: **GET**
4748
4749 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4750
4751 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4752
4753
4754 Ответ:
4755
4756 {
4757
4758 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4759
4760 "Status": 0, ~/~/ Перечисление состояний выполения запроса
4761 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4762
4763 "Message": "string", ~/~/ Информация о выполнении запроса
4764
4765 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4766
4767 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4768
4769 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4770
4771 "Data": "string" ~/~/ Данные
4772
4773 }
4774
4775 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4776
4777 (% class="box infomessage" %)
4778 (((
4779 **POST /api/v3/vehicles/export**
4780 )))
4781
4782 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4783
4784 Тело запроса:
4785
4786 [
4787 id
4788 ]
4789
4790 Ответ: Success 200, получаете файлы с настройками.
4791
4792 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4793
4794 (% class="box infomessage" %)
4795 (((
4796 **POST /api/v3/vehicles/export/history**
4797 )))
4798
4799 Метод возвращает список сообщений терминала объекта за выбранный период.
4800
4801 Тело запроса:
4802
4803 {
4804 "vehicleId": 0,
4805 "asArchive": true,
4806 "from": "2023-09-27T12:17:45.973Z",
4807 "to": "2023-09-27T12:17:45.973Z"
4808 }
4809
4810 Ответ:
4811
4812 Получаете файл. Сообщение: Code 200/Success
4813
4814 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4815 |vehicleId|ID объекта
4816 |asArchive|true - Архивировать файл, False - не архивировать
4817 |from|Дата и время начала запроса
4818 |to|Дата и время окончания запроса
4819
4820 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4821
4822 (% class="box infomessage" %)
4823 (((
4824 **GET /api/v3/vehicles/export/history/status**
4825 )))
4826
4827 Метод возвращает список сообщений терминала объекта за выбранный период.
4828
4829 Ответ:
4830
4831 {
4832 "activity": true,
4833 "progress": 0,
4834 "message": "string"
4835 }
4836
4837 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4838 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4839 |progress|Прогресс экспорта, от 0 до 100%
4840 |message|Текст описывающий статус
4841
4842 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4843
4844 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4845
4846 (% class="box infomessage" %)
4847 (((
4848 **POST /api/v3/EcoDriving/rating**
4849 )))
4850
4851 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4852
4853 Тело запроса:
4854
4855 {
4856 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4857 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4858 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4859 }
4860
4861 Ответ:
4862
4863 {
4864 "items": [  ~/~/ Список в разрезе ТС
4865 {
4866 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4867 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4868 "vehicleId": 0, ~/~/ ID ТС
4869 "vehicleName": "string", ~/~/ Название ТС
4870 "vehicleModel": "string", ~/~/ Модель ТС
4871 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4872 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4873 "totalViolations": 0, ~/~/ Нарушений всего
4874 "violationsByType": { ~/~/ Информация о нарушениях по типу
4875 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4876 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4877 "brakingViolations": 0, ~/~/ Нарушений торможения
4878 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4879 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4880 "sensorViolations": 0 ~/~/ Нарушений по датчику
4881 },
4882
4883 (((
4884
4885 )))
4886
4887 "moveTime": 0, ~/~/ Продолжительность движения, сек
4888 "mileage": 0, ~/~/ Пробег, м
4889 "tripsCount": 0, ~/~/ Кол-во рейсов
4890 "trips": [  ~/~/ Информация по рейсу
4891 {
4892 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4893 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4894 "violationsCount": 0, ~/~/ Всего нарушений
4895 "violationsByType": { ~/~/ Информация о нарушениях по типу
4896 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4897 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4898 "brakingViolations": 0, ~/~/ Нарушений торможения
4899 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4900 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4901 "sensorViolations": 0 ~/~/ Нарушений по датчику
4902 },
4903
4904 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4905 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4906 "moveTime": 0, ~/~/ Продолжительность движения, сек
4907 "mileage": 0, ~/~/ Пробег, м
4908 "motohours": 0, ~/~/ Моточасы, секунды
4909 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4910 "startAddress": "string", ~/~/ Адрес начала рейса
4911 "endAddress": "string", ~/~/ Адрес конца рейса
4912 "drivers": [  ~/~/ Список водителей
4913 {
4914 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4915 "driverName": "string", ~/~/ФИО водителя
4916 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4917 }
4918 ]
4919 }
4920 ]
4921 }
4922 ]
4923 }
4924
4925 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4926
4927 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4928
4929 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4930
4931 (% class="box infomessage" %)
4932 (((
4933 **POST /api/v3/fuelcards/transactions**
4934 )))
4935
4936 Метод запроса: POST
4937
4938 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4939 \\В заголовках запроса: X-Auth: Токен авторизации
4940
4941 Параметры в теле запроса (JSON):
4942
4943 {
4944 "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4945 "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4946 "ids": [ 
4947 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4948 ],
4949 "timezone": 0 ~/~/ Часовой пояс
4950 }
4951
4952
4953 Ответ:
4954 {
4955 "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4956 "driver": "string", ~/~/ Водители, привязанные к ТК
4957 "object": "string", ~/~/ Наименование ТС
4958 "amount": 0, ~/~/ Количество топлива
4959 "amountDut": 0, ~/~/ Количество по ДУТ
4960 "amountDiff": 0, ~/~/ Разница, л
4961 "amountDiffPerc": 0, ~/~/ Разница, %
4962 "summa": 0, ~/~/ Стоимость, руб
4963 "serviceName": "string", ~/~/ Тип топлива
4964 "price": 0, ~/~/ Цена за литр, руб
4965 "cardName": "string", ~/~/ Наименование ТК
4966 "cardNum": "string", ~/~/ Номер ТК
4967 "operator": "string", ~/~/ Оператор ТК
4968 "address": "string" ~/~/ Адрес АЗС
4969 }
4970
4971 == (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4972
4973 (% class="box infomessage" %)
4974 (((
4975 **GET /api/v3/fuelcards**
4976 )))
4977
4978 Метод запроса: GET
4979
4980 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4981
4982 Ответ:
4983
4984 [
4985 {
4986 "Name": "string", ~/~/ Определяет наименование карты.
4987 "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4988 "Number": "string", ~/~/ Определяет № карты.
4989 "Enabled": true, ~/~/ Определяет признак активности карты.
4990 "Description": "string", ~/~/ Определяет описание карты.
4991 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4992 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4993 "deleted": true ~/~/ Признак удаления
4994 }
4995 ]
4996
4997 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4998
4999
5000 == **Получение полных данных о ретрансляторе** ==
5001
5002 (% class="box infomessage" %)
5003 (((
5004 **GET ** **/api/v3/retranslations/{id}**
5005 )))
5006
5007 id - Идентификатор ретранслятора
5008
5009
5010 Пример ответа:
5011
5012 {  
5013 "description": "", ~/~/ Поле описания ретранслятора
5014 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
5015 "protocolType": 0, ~/~/ Тип протокола ретрансляции
5016 "isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
5017 "address": "string", ~/~/ Адрес и порт принимающего сервера
5018 "objects": [ ~/~/ Объекты для ретрансляции
5019 {      
5020 "id": "",  ~/~/ Идентификатор объекта ретрансляции
5021 "name": "", ~/~/ Наименование объекта ретрансляции
5022 "imei": "", ~/~/ IMEI объекта  ретрансляции
5023 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
5024 }
5025 ],  
5026 "id": "", ~/~/ Идентификатор ретранслятора 
5027 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
5028 "deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
5029 }
5030
5031
5032 == **Удаление данных ретранслятора** ==
5033
5034 (% class="box infomessage" %)
5035 (((
5036 **DELETE** **/api/v3/retranslations/{id}**
5037 )))
5038
5039 id - Идентификатор ретранслятора
5040
5041
5042 == **Создание ретранслятора** ==
5043
5044 (% class="box infomessage" %)
5045 (((
5046 **POST ** **/api/v3/retranslations/{id}**
5047 )))
5048
5049 Запрос:
5050
5051 {  
5052 "description": "", ~/~/ Поле описания ретранслятора
5053 "subscriberId": "", ~/~/ Идентификатор подписчика
5054 "protocolType": 0, ~/~/ Тип протокола ретрансляции
5055 "address": "", ~/~/ Адрес и порт принимающего сервера
5056 "isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
5057 "objects": [ ~/~/Объекты для ретрансляции
5058 {      
5059 "id": "", ~/~/ Идентификатор ретранслятора 
5060 "imei": "", ~/~/ IMEI объекта ретрансляции
5061 "isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
5062 }
5063 ]
5064 }
5065
5066
5067 Ответ:
5068
5069 {  
5070 "description": "", ~/~/ Поле описания ретранслятора
5071 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
5072 "protocolType": 0, ~/~/ Тип протокола ретрансляции
5073 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
5074 "address": "string", ~/~/ Адрес и порт принимающего сервера
5075 "objects": [ ~/~/ Объекты для ретрансляции
5076 {      
5077 "id": "", ~/~/ Идентификатор объекта ретрансляции     
5078 "name": "string", ~/~/ Наименование объекта ретрансляции    
5079 "imei": "", ~/~/ IMEI объекта ретрансляции
5080 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
5081 }
5082 ],
5083 "id": "", ~/~/ Идентификатор ретранслятора   
5084 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
5085 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
5086 }
5087
5088
5089 == **Редактирование ретранслятора** ==
5090
5091 (% class="box infomessage" %)
5092 (((
5093 **PUT** **/api/v3/retranslations**
5094 )))
5095
5096 Пример запроса:
5097
5098 {  
5099 "id": "", ~/~/ Идентификатор ретранслятора   
5100 "description": "string", ~/~/ Поле описания ретранслятора
5101 "subscriberId": "", ~/~/ Идентификатор подписчика
5102 "protocolType": 0, ~/~/ Тип протокола ретрансляции
5103 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
5104 "address": "string", ~/~/ Адрес и порт принимающего сервера
5105 "objects": ~/~/ Объекты для ретрансляции
5106 [    
5107 {      
5108 "id": "",  ~/~/ Идентификатор объекта ретрансляции 
5109 "imei": "", ~/~/ IMEI объекта ретрансляции
5110 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
5111 }
5112 ]
5113 }
5114
5115
5116 Пример ответа:
5117
5118 {  
5119 "description": "", ~/~/ Поле описания ретранслятора
5120 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
5121 "protocolType": 0, ~/~/ Тип протокола ретрансляции
5122 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
5123 "address": "string", ~/~/ Адрес и порт принимающего сервера
5124 "objects": [ ~/~/ Объекты для ретрансляции
5125 {      
5126 "id": "", ~/~/ Идентификатор объекта ретрансляции     
5127 "name": "string", ~/~/ Наименование объекта ретрансляции    
5128 "imei": "", ~/~/ IMEI объекта ретрансляции
5129 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
5130 }
5131 ],
5132 "id": "", ~/~/ Идентификатор ретранслятора   
5133 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
5134 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
5135 }
5136
5137
5138 == **Получение списка ретранслятора клиента** ==
5139
5140 (% class="box infomessage" %)
5141 (((
5142 **POST /api/v3/retranslations/find**
5143 )))
5144
5145 Пример запроса:
5146
5147 {  
5148 "id": "", ~/~/ Идентификатор ретранслятора   
5149 "search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
5150 "parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
5151 }
5152
5153 Ответ:
5154
5155 [ 
5156 {    
5157 "description": "", ~/~/ Поле описания ретранслятора
5158 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
5159 "protocolType": 0, ~/~/ Тип протокола ретрансляции
5160 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
5161 "address": "string", ~/~/ Адрес и порт принимающего сервера
5162 "id": "", ~/~/ Идентификатор ретранслятора   
5163 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
5164 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
5165 }
5166 ]
5167
5168
5169 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
5170
5171 == **API для отчета по выгрузке комбайнов** ==
5172
5173 (% class="box infomessage" %)
5174 (((
5175 **POST /api/v3/Reports/harvesterUnloading**
5176 )))
5177
5178 Пример запроса:
5179
5180 {
5181 "byTime": 0, ~/~/ Объединение событий по времени
5182 "byDist": 0, ~/~/ Объединение событий по расстоянию
5183 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5184 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5185 "showNearestObjects": true, ~/~/Показывать объекты рядом?
5186 "vehicleIds": [ ~/~/ Список id объектов для анализа
5187 0
5188 ],
5189 "from": "", ~/~/ Дата и время начало запроса
5190 "to": "", ~/~/ Дата и время окончания запроса
5191 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
5192 }
5193
5194 Пример ответа:
5195
5196 [ 
5197 {
5198 "harvesterName": "", ~/~/Комбайн, номер
5199 "harvesterId": 0, ~/~/Комбайн, id
5200 "harvesterModel": "", ~/~/ Модель комбайна
5201 "hopperCapacity": 0, ~/~/ Объем бункера м3
5202 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
5203 "events": [ ~/~/Список событий в разрезе комбайна
5204 {
5205 "driverId": "", ~/~/Идентификатор водителя
5206 "driverName": "", ~/~/Водитель комбайна, ФИО
5207 "RFID": "", ~/~/ идентификатор карты-метки
5208 "rfidName": "", ~/~/Водитель комбайна, имя метки
5209 "vehicleId": 0, ~/~/идентификатор объекта
5210 "vehicleName": "string", ~/~/ Имя объекта
5211 "modelName": "string", ~/~/ Имя модели объекта
5212 "nearestVehicles": [ ~/~/Объекты рядом
5213 {
5214 "vehicleId": 0, ~/~/идентификатор объекта
5215 "vehicleName": "string" ~/~/ Имя объекта
5216 }
5217 ],
5218 "fields": [ ~/~/Поля, где происходила выгрузка
5219 {
5220 "id": 0, ~/~/ идентификатор пользователя 
5221 "name": "string" ~/~/ имя пользователя 
5222 }
5223 ],
5224 "event": "string", ~/~/Событие
5225 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
5226 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
5227 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
5228 "cultureName": "string", ~/~/ название культуры
5229 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
5230 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
5231 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
5232 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
5233 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
5234 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
5235 "issued": 0, ~/~/Выдано, бункеров
5236 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
5237 "latitude": 0, ~/~/Широта
5238 "longitude": 0, ~/~/ Долгота
5239 "litresAway": 0, ~/~/Отдано, л
5240 "m3Away": 0 ~/~/Отдано, м3
5241 }
5242 ]
5243 }
5244 ]
5245
5246
5247 == **Отчет трек-датчики** ==
5248
5249 (% class="box infomessage" %)
5250 (((
5251 **POST /api/v3/Reports/sensorsWorks**
5252 )))
5253
5254 **Пример запроса:**
5255
5256 {
5257 "vehicleIds": [ ~/~/ Список ID объектов
5258 0
5259 ],
5260 "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
5261 "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
5262 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5263 }
5264
5265 **Пример ответа:**
5266
5267 (((
5268 {
5269 "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
5270 {
5271 "vehicleId": 0, ~/~/ Идентификатор ТС
5272 "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
5273 {
5274 "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
5275 "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
5276 "duration": 0, ~/~/  Продолжительность интервала в секундах.
5277 "name": "string", ~/~/ Наименование оборудования.
5278 "mileage": 0, ~/~/ Пробег за время работы оборудования.
5279 "totalMileage": 0, ~/~/ Общий пробег.
5280 "avgSpeed": 0 ~/~/ Средняя скорость.
5281 }
5282 ]
5283 }
5284 ]
5285 }
5286
5287
5288 == **Превышение скорости** ==
5289
5290 (% class="box infomessage" %)
5291 (((
5292 **POST /api/v3/Reports/overSpeedDuration**
5293 )))
5294
5295 Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
5296
5297 Пример запроса:
5298
5299 (((
5300 {
5301 "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
5302 "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
5303 "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
5304 "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5305 "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
5306 }
5307 )))
5308
5309 (((
5310
5311 )))
5312
5313 (((
5314 Пример ответа:
5315 )))
5316
5317 (((
5318 (((
5319 [
5320 {
5321 "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
5322 "duration": 0, ~/~/ Продолжительность события в секундах 
5323 "maxSpeed": 0, ~/~/ Максимальная скорость 
5324 "speedLimit": 0 ~/~/ Ограничение скорости 
5325 }
5326 ]
5327 )))
5328 )))
5329 )))
5330
5331 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
5332
5333
5334 == **Запрос списка полей** ==
5335
5336 (% class="box successmessage" %)
5337 (((
5338 **POST /api/v3/agroLands/find**
5339 )))
5340
5341 Пример запроса:
5342
5343 (((
5344 (((
5345 (((
5346 {
5347 "year": 0, ~/~/ Фильтр по году
5348 "name": "string", ~/~/ Фильтр по названию
5349 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
5350 }
5351 )))
5352 )))
5353
5354
5355 )))
5356
5357 Пример ответа:
5358
5359 (((
5360 [
5361 {
5362 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5363 "year": 0, ~/~/ Год поля
5364 "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
5365 "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
5366 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5367 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5368 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5369 "counts": { ~/~/ Счётчики с/х поля 
5370 "fieldOperations": 0, ~/~/ Количество операций на поле
5371 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5372 "facts": 0 ~/~/ Счётчик факта
5373 },
5374 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5375 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5376 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5377 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5378 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5379 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5380 "planComment": "string", ~/~/ Комментарий к полю
5381 "productivity": 0, ~/~/ Урожайность.
5382 "id": 0, ~/~/ Идентификатор объекта геозоны
5383 "name": "string", ~/~/ Название объекта геозоны
5384 "type": 0, ~/~/ Тип объекта геозоны
5385 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5386 "fname": "string", ~/~/ Имя файла
5387 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5388 "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
5389 "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
5390 "description": "string", ~/~/ Описание объекта геозоны
5391 "area": 0, ~/~/ Площадь, м2
5392 "perimetr": 0, ~/~/ Периметр, м
5393 "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
5394 }
5395 ]
5396
5397
5398 == **Создание нового поля ** ==
5399
5400 (% class="box successmessage" %)
5401 (((
5402 **POST /api/v3/agroLands**
5403 )))
5404
5405 Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
5406 X-agent  - ID клиента
5407
5408 Пример запроса:
5409
5410 (((
5411 {
5412 "extId": "string", 
5413 "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
5414 "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
5415 "display": "string", ~/~/ Настройки отображения
5416 "year": 0, ~/~/ Год поля
5417 "name": "string", ~/~/ Наименование
5418 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5419 "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
5420 "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
5421 "planComment": "string", ~/~/ Комментарий к полю
5422 "cropRotations": [ ~/~/ Данные по севообороту
5423 {
5424 "landId": 0, ~/~/ ID поля
5425 "landName": "string", ~/~/ Название поля
5426 "year": 0, ~/~/ Год урожая
5427 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5428 "cultureName": "string", ~/~/ Название культуры
5429 "productivity": 0, ~/~/ Урожайность
5430 "area": 0, ~/~/ Площадь поля, Га
5431 "total": 0, ~/~/ Валовый сбор
5432 "productivityFact": 0, ~/~/ Фактическая урожайность
5433 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5434 "totalFact": 0, ~/~/ Фактический валовый сбор
5435 "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5436 "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5437 "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5438 "isyearplan": true, ~/~/ Годовой план 
5439 "comment": "string" ~/~/ Комментарий
5440 }
5441 ]
5442 }
5443 )))
5444
5445 (((
5446
5447 )))
5448
5449 Пример ответа:
5450
5451 (((
5452 (((
5453 {
5454 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5455 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5456 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5457 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5458 "cropRotations": [ ~/~/ Данные по севообороту
5459 {
5460 "landId": 0, ~/~/ ID поля
5461 "landName": "string", ~/~/ Название поля
5462 "year": 0, ~/~/ Год урожая 
5463 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5464 "cultureName": "string", ~/~/ Название культуры
5465 "productivity": 0, ~/~/ Урожайность
5466 "area": 0, ~/~/ Площадь поля, Га.
5467 "total": 0, ~/~/ Валовый сбор
5468 "productivityFact": 0, ~/~/ Фактическая урожайность
5469 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5470 "totalFact": 0, ~/~/ Фактический валовый сбор
5471 "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5472 "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5473 "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5474 "isyearplan": true, ~/~/ годовой план 
5475 "comment": "string" ~/~/ Комментарий
5476 }
5477 ],
5478 "cropVegetation": [ ~/~/ История вегетации поля
5479 {
5480 "values": [  ~/~/ Данные вегетации и состояния посева
5481 {
5482 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5483 "ndvi": 0 ~/~/ Индекс вегетации
5484 }
5485 ],
5486 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5487 {
5488 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5489 "type": "string", ~/~/ Тип
5490 "pictureid": "string" ~/~/ Идентификатор ресурса
5491 }
5492 ],
5493 "states": [ ~/~/ Ключевые даты развития поля
5494 {
5495 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5496 "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5497 }
5498 ]
5499 }
5500 ],
5501 "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5502 "counts": {
5503 "fieldOperations": 0, ~/~/ Количество операций на поле
5504 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5505 "facts": 0 ~/~/ Счётчик факта
5506 },
5507 "planComment": "string", ~/~/ Комментарий к полю
5508 )))
5509
5510 (((
5511 "productivity": 0, ~/~/ Урожайность.
5512 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5513 "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5514 "year": 0, ~/~/ Год поля
5515 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5516 "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5517 "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5518 "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5519 "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5520 "id": 0, ~/~/ Идентификатор объекта геозоны
5521 "name": "string", ~/~/ Название объекта геозоны
5522 "type": 0, ~/~/ Тип объекта геозоны
5523 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5524 "fname": "string", ~/~/ Имя файла
5525 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5526 "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5527 "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5528 "description": "string", ~/~/ Описание объекта геозоны
5529 "area": 0, ~/~/ Площадь, м2
5530 "perimetr": 0, ~/~/ Периметр, м
5531 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5532 }
5533
5534
5535 )))
5536 )))
5537 )))
5538
5539 == **Получение поля по id** ==
5540
5541 (% class="box infomessage" %)
5542 (((
5543 **GET /api/v3/agroLands/{id}**
5544 )))
5545
5546 Пример запроса:
5547 id  ~/~/ Идентификатор поля
5548
5549 Пример ответа:
5550
5551 (((
5552 {
5553 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5554 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5555 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5556 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5557 "cropRotations": [ ~/~/ Данные по севообороту
5558 {
5559 "landId": 0, ~/~/ ID поля
5560 "landName": "string", ~/~/ Название поля
5561 "year": 0, ~/~/ Год урожая
5562 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5563 "cultureName": "string", ~/~/ Название культуры
5564 "productivity": 0, ~/~/ Урожайность
5565 "area": 0, ~/~/ Площадь поля, Га
5566 "total": 0, ~/~/ Валовый сбор
5567 "productivityFact": 0, ~/~/ Фактическая урожайность
5568 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5569 "totalFact": 0, ~/~/ Фактический валовый сбор
5570 "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5571 "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5572 "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5573 "isyearplan": true, ~/~/ План года 
5574 "comment": "string" ~/~/ Комментарий
5575 }
5576 ],
5577 "cropVegetation": [ ~/~/ История вегетации поля
5578 {
5579 "values": [ ~/~/ Данные вегетации и состояния посева
5580 {
5581 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5582 "ndvi": 0 ~/~/ Индекс вегетации
5583 }
5584 ],
5585 "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5586 {
5587 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5588 "type": "string", ~/~/ Тип 
5589 "pictureid": "string" ~/~/ Идентификатор ресурса
5590 }
5591 ],
5592 "states": [ ~/~/ Ключевые даты развития поля
5593 {
5594 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5595 "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5596 }
5597 ]
5598 }
5599 ],
5600 "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5601 "counts": {
5602 "fieldOperations": 0, ~/~/ Количество операций на поле
5603 "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5604 "facts": 0 ~/~/ Счётчик факта
5605 },
5606 "planComment": "string", ~/~/ Комментарий к полю
5607 "productivity": 0, ~/~/ Урожайность.
5608 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5609 )))
5610
5611 (((
5612 (((
5613 "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5614 "year": 0, ~/~/ Год поля
5615 "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5616 "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5617 "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5618 "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5619 "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5620 "id": 0, ~/~/ Идентификатор объекта геозоны
5621 "name": "string", ~/~/ Название объекта геозоны
5622 "type": 0, ~/~/ Тип объекта геозоны 
5623 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5624 "fname": "string", ~/~/ Имя файла
5625 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5626 "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5627 "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5628 "description": "string", ~/~/ Описание объекта геозоны
5629 "area": 0, ~/~/ Площадь, м2
5630 "perimetr": 0, ~/~/ Периметр, м
5631 "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5632 }
5633 )))
5634
5635
5636 (((
5637 (((
5638 (((
5639 == **Изменение поля** ==
5640
5641 (% class="box infomessage" %)
5642 (((
5643 **PUT /api/v3/agroLands**
5644 )))
5645
5646 Пример запроса:
5647
5648 (((
5649 (((
5650 {
5651 "id": 0, ~/~/ Идентификатор поля
5652 "extId": "string", ~/~/ ExtId
5653 "shape": "string", ~/~/ Форма поля
5654 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5655 "display": "string", ~/~/ Настройки отображения
5656 "year": 0, ~/~/ Год поля
5657 "name": "string", ~/~/ Наименование
5658 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5659 "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5660 "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5661 "planComment": "string", ~/~/Комментарий к полю
5662 "cropRotations": [  ~/~/ Данные по севообороту
5663 {
5664 "landId": 0, ~/~/ ID поля
5665 "landName": "string", ~/~/ Название поля
5666 "year": 0, ~/~/ Год урожая
5667 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5668 "cultureName": "string", ~/~/ Название культуры
5669 "productivity": 0, ~/~/ Урожайность
5670 "area": 0, ~/~/ Площадь поля, Га.
5671 "total": 0, ~/~/ Валовый сбор
5672 "productivityFact": 0, ~/~/ Фактическая урожайность
5673 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5674 "totalFact": 0, ~/~/ Фактический валовый сбор
5675 "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5676 "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5677 "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5678 "isyearplan": true, 
5679 "comment": "string" ~/~/ Комментарий
5680 }
5681 ],
5682 "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5683 }
5684 )))
5685 )))
5686
5687 (((
5688
5689 )))
5690
5691 Пример ответа:
5692
5693 (((
5694 (((
5695 (((
5696 {
5697 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5698 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5699 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5700 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5701 "cropRotations": [ ~/~/ Данные по севообороту
5702 {
5703 "landId": 0, ~/~/ ID поля
5704 "landName": "string", ~/~/ Название поля
5705 "year": 0, ~/~/  Год урожая
5706 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5707 "cultureName": "string", ~/~/ Название культуры
5708 "productivity": 0, ~/~/ Урожайность
5709 "area": 0, ~/~/ Площадь поля, Га
5710 "total": 0, ~/~/ Валовый сбор
5711 "productivityFact": 0, ~/~/ Фактическая урожайность
5712 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5713 "totalFact": 0, ~/~/ Фактический валовый сбор
5714 "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5715 "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5716 "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5717 "isyearplan": true, ~/~/ 
5718 "comment": "string" ~/~/ Комментарий
5719 }
5720 ],
5721 "cropVegetation": [ ~/~/ История вегетации поля
5722 {
5723 "values": [ ~/~/ Данные вегетации и состояния посева
5724 {
5725 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5726 "ndvi": 0 ~/~/ Индекс вегетации
5727 }
5728 ],
5729 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5730 {
5731 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5732 "type": "string", ~/~/ Тип
5733 "pictureid": "string" ~/~/ Идентификатор ресурса
5734 }
5735 ],
5736 "states": [ ~/~/ Ключевые даты развития поля 
5737 {
5738 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5739 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5740 }
5741 ]
5742 }
5743 ],
5744 "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5745 "counts": { 
5746 "fieldOperations": 0, ~/~/ Количество операций на поле
5747 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5748 "facts": 0 ~/~/ Счётчик факта
5749 },
5750 "planComment": "string", ~/~/ Комментарий к полю
5751 "productivity": 0, ~/~/ Урожайность.
5752 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5753 "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5754 "year": 0, ~/~/ Год поля
5755 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5756 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5757 "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5758 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5759 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5760 "id": 0, ~/~/ Идентификатор объекта геозоны
5761 "name": "string", ~/~/ Название объекта геозоны
5762 "type": 0, ~/~/ Тип объекта геозоны
5763 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5764 "fname": "string", ~/~/ Имя файла
5765 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5766 "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5767 "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5768 "description": "string", ~/~/ Описание объекта геозоны
5769 "area": 0, ~/~/ Площадь, м2
5770 "perimetr": 0, ~/~/ Периметр, м
5771 "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5772 }
5773 )))
5774 )))
5775 )))
5776 )))
5777 )))
5778
5779
5780 == **Редактирование года урожая ** ==
5781
5782 (% class="box successmessage" %)
5783 (((
5784 **POST /api/v3/agroLands/updateOpenCloseYear**
5785 )))
5786
5787 Пример запроса:
5788
5789 (((
5790 (((
5791 {
5792 "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5793 0
5794 ],
5795 "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5796 "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5797 }
5798 )))
5799
5800
5801 )))
5802
5803 Пример ответа:
5804
5805 (((
5806 (((
5807 {
5808 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5809 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5810 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5811 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5812 "cropRotations": [ ~/~/ Данные по севообороту
5813 {
5814 "landId": 0, ~/~/ ID поля
5815 "landName": "string", ~/~/ Название поля
5816 "year": 0, ~/~/ Год урожая
5817 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5818 "cultureName": "string", ~/~/ Название культуры
5819 "productivity": 0, ~/~/ Урожайность
5820 "area": 0, ~/~/ Площадь поля, Га.
5821 "total": 0, ~/~/ Валовый сбор
5822 "productivityFact": 0, ~/~/ Фактическая урожайность
5823 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5824 "totalFact": 0, ~/~/ Фактический валовый сбор
5825 "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5826 "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5827 "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5828 "isyearplan": true, ~/~/ 
5829 "comment": "string" ~/~/ Комментарий
5830 }
5831 ],
5832 "cropVegetation": [ ~/~/ История вегетации поля
5833 {
5834 "values": [ ~/~/ Данные вегетации и состояния посева
5835 {
5836 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5837 "ndvi": 0 ~/~/ Индекс вегетации
5838 }
5839 ],
5840 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5841 {
5842 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5843 "type": "string", ~/~/ Тип
5844 "pictureid": "string" ~/~/ Идентификатор ресурса
5845 }
5846 ],
5847 "states": [ ~/~/ Ключевые даты развития поля
5848 {
5849 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5850 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5851 }
5852 ]
5853 }
5854 ],
5855 "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5856 "counts": { 
5857 "fieldOperations": 0, ~/~/ Количество операций на поле
5858 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5859 "facts": 0 ~/~/ Счётчик факта
5860 },
5861 "planComment": "string", ~/~/ Комментарий к полю
5862 "productivity": 0, ~/~/ Урожайность.
5863 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5864 "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5865 "year": 0, ~/~/ Год поля
5866 "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5867 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5868 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5869 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5870 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5871 "id": 0, ~/~/ Идентификатор объекта геозоны
5872 "name": "string", ~/~/ Название объекта геозоны
5873 "type": 0, ~/~/ Тип объекта геозоны
5874 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5875 "fname": "string", ~/~/ Имя файла
5876 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5877 "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5878 "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5879 "description": "string", ~/~/ Описание объекта геозоны
5880 "area": 0, ~/~/ Площадь, м2
5881 "perimetr": 0, ~/~/ ериметр, м
5882 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5883 }
5884
5885
5886 == **Какие поля посещал объект** ==
5887
5888 (% class="box successmessage" %)
5889 (((
5890 **POST /api/v3/agroLands/visitingByVehicle**
5891 )))
5892
5893 Пример запроса:
5894
5895 {
5896 "vehicleId": 0, ~/~/ id объекта 
5897 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5898 "byTime": 0, ~/~/ Объединение событий по времени
5899 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5900 "byDist": 0, ~/~/ Объединение событий по расстоянию
5901 "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента)
5902 "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента)
5903 "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5904 }
5905
5906 Пример ответа:
5907
5908 [
5909 {
5910 "fieldId": 0, ~/~/ id объекта 
5911 "vehicleName": "string", ~/~/ Наименование объекта 
5912 "fieldName": "string", ~/~/ Наименование поля 
5913 "fuelUsage": 0, ~/~/ Расход топлива, л/га
5914 "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5915 "vehicleId": 0, ~/~/ Идентификатор ТС
5916 "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения
5917 "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения
5918 "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5919 "mileage": 0 ~/~/ Пробег 
5920 }
5921 ]
5922 )))
5923
5924
5925 == **Посещение поля объектами ** ==
5926
5927 (% class="box successmessage" %)
5928 (((
5929 **POST /api/v3/agroLands/visitingByField**
5930 )))
5931
5932 Пример запроса:
5933 {
5934 "fieldId": 0, ~/~/ ID поля
5935 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
5936 "byTime": 0, ~/~/ Объединение событий по времени
5937 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
5938 "byDist": 0, ~/~/ Объединение событий по расстоянию
5939 "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента)
5940 "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента)
5941 "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK
5942 }
5943
5944 Пример ответа:
5945
5946 [
5947 {
5948 "fieldId": 0, ~/~/ ID поля
5949 "vehicleName": "string", ~/~/ Наименование объекта 
5950 "fieldName": "string", ~/~/ Имя поля
5951 "fuelUsage": 0, ~/~/ Расход топлива, л/га
5952 "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата)
5953 "vehicleId": 0, ~/~/ Идентификатор ТС
5954 "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения
5955 "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения
5956 "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 
5957 "mileage": 0 ~/~/ Пробег
5958 }
5959 ]
5960
5961
5962 == **Удаление существующего поля** ==
5963
5964 (% class="box errormessage" %)
5965 (((
5966 **DELETE /api/v3/agroLands/{id}**
5967 )))
5968
5969 Пример запроса:
5970 id  ~/~/ Идентификатор поля
5971
5972 Пример ответа:
5973
5974 (((
5975 200 ~/~/ Успех
5976
5977
5978 )))
5979
5980 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5981 )))
5982 )))
5983 )))
5984
5985 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5986
5987
5988 (% class="box infomessage" %)
5989 (((
5990 **GET api/v3/Vehicles/recyclebin/all**
5991 )))
5992
5993 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5994
5995 Параметр запроса: {parentId} - идентификатор агента
5996
5997 В заголовках запроса: X-Auth: Токен авторизации
5998
5999 Ответ:
6000
6001 [ 
6002 {
6003 "recordTime": "", ~/~/Время записи
6004 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
6005 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
6006 "objectId": 0, ~/~/ID объекта, помещённого в корзину
6007 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
6008 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
6009 "details": { ~/~/Список деталей объекта, помещённого в корзину
6010 "items": [ ~/~/ 
6011 nullable: true ~/~/Детали
6012 {
6013 "name": "string", ~/~/наименование столбца
6014 "value": "string" ~/~/содержание столбца
6015 }
6016 ]
6017 },
6018 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
6019 "string"
6020 ]
6021 }
6022 ]
6023
6024
6025 == (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
6026
6027 (% class="box infomessage" %)
6028 (((
6029 **POST api/v3/Vehicles/recyclebin/erase**
6030 )))
6031
6032 В заголовках запроса: X-Auth: Токен авторизации
6033
6034 Пример запроса:
6035
6036 [
6037 0
6038 ]
6039
6040
6041 Пример ответа:
6042
6043 [ 
6044 {
6045 "recordTime": "", ~/~/Время записи
6046 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
6047 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
6048 "objectId": 0, ~/~/ID объекта, помещённого в корзин
6049 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
6050 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
6051 "details": { ~/~/Список деталей объекта, помещённого в корзину
6052 "items": [ ~/~/Детали
6053 {
6054 "name": "", ~/~/Имя свойства
6055 "value": "" ~/~/Значение свойства
6056 }
6057 ]
6058 },
6059 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
6060 ""
6061 ]
6062 }
6063 ]
6064
6065 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
6066
6067 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
6068
6069 (% class="box infomessage" %)
6070 (((
6071 **POST api/v3/Vehicles/recyclebin/restore**
6072 )))
6073
6074 В заголовках запроса: X-Auth: Токен авторизации
6075
6076 Параметры в теле запроса (JSON):
6077
6078 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
6079
6080 В заголовках запроса: X-Auth: Токен авторизации
6081
6082 Пример запроса:
6083
6084 (((
6085 [
6086 )))
6087
6088 (((
6089 0
6090 )))
6091
6092 (((
6093 ]
6094 )))
6095
6096
6097 Пример ответа:
6098
6099 [
6100 {
6101 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
6102 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
6103 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
6104 "objectId": 0, ~/~/ID объекта, помещённого в корзину
6105 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
6106 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
6107 "details": { ~/~/Список деталей объекта, помещённого в корзину
6108 "items": [ ~/~/Детали
6109 {
6110 "name": "string", ~/~/Имя свойства
6111 "value": "string" ~/~/Значение свойства
6112 }
6113 ]
6114 },
6115 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
6116 "string"
6117 ]
6118 }
6119 ]
6120
6121
6122 = **Раздел: Журнал заданий ** =
6123
6124
6125 == **Создание задания в Журнале заданий** ==
6126
6127 (% class="box infomessage" %)
6128 (((
6129 **POST /api/v3/vehicletasks**
6130 )))
6131
6132 Пример запроса:
6133
6134 (((
6135 {
6136 "vehicleId": 0, ~/~/ Идентификатор ТС
6137 "description": "string", ~/~/ Описание
6138 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6139 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6140 "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
6141 "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
6142 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6143 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6144 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6145 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6146 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6147 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6148 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6149 "cost": { 
6150 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6151 "Name": "string", ~/~/ Наименование
6152 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
6153 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6154 "Norm": 0 ~/~/ Норма внесения
6155 },
6156 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
6157 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6158 "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
6159 "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
6160 "deleted": true, ~/~/ Признак удаления
6161 "extId": "string", 
6162 "GeoIds": [ ~/~/ Cвязанные поля
6163 0
6164 ]
6165 }
6166 )))
6167
6168 Пример ответа:
6169
6170 {
6171 "vehicleId": 0, ~/~/ Идентификатор ТС
6172 "description": "string", ~/~/ Описание
6173 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6174 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6175 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6176 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6177 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6178 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6179 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6180 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6181 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6182 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6183 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6184 "cost": { 
6185 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6186 "Name": "string", ~/~/ Наименование
6187 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6188 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6189 "Norm": 0 ~/~/ Норма внесения
6190 },
6191 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6192 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6193 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6194 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6195 "deleted": true, ~/~/ Признак удаления
6196 "extId": "string", ~/~/ ExtId
6197 "GeoIds": [ ~/~/ Связанные поля
6198 0
6199 ]
6200 }
6201
6202
6203 == **Редактирование задания в Журнале заданий** ==
6204
6205 (% class="box successmessage" %)
6206 (((
6207 **PUT /api/v3/vehicletasks**
6208 )))
6209
6210 Пример запроса:
6211
6212 (((
6213 {
6214 "vehicleId": 0, ~/~/ Идентификатор ТС
6215 "description": "string", ~/~/ Описание
6216 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6217 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6218 "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
6219 "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
6220 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6221 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6222 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6223 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6224 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6225 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6226 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6227 "cost": { 
6228 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6229 "Name": "string", ~/~/ Наименование
6230 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6231 "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6232 "Norm": 0 ~/~/ Норма внесения
6233 },
6234 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6235 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6236 "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
6237 "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
6238 "deleted": true, ~/~/ Признак удаления
6239 "extId": "string", ~/~/ ExtId
6240 "GeoIds": [ ~/~/ Связанные поля
6241 0
6242 ]
6243 }
6244 )))
6245
6246
6247 Пример ответа:
6248
6249 {
6250 "vehicleId": 0, ~/~/ Идентификатор ТС
6251 "description": "string", ~/~/ Описание
6252 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6253 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6254 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6255 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6256 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6257 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6258 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6259 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6260 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6261 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6262 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6263 "cost": { 
6264 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6265 "Name": "string", ~/~/ Наименование
6266 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6267 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6268 "Norm": 0 ~/~/ Норма внесения
6269 },
6270 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6271 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6272 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6273 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6274 "deleted": true, ~/~/ Признак удаления
6275 "extId": "string", ~/~/ ExtId
6276 "GeoIds": [ ~/~/ Связанные поля
6277 0
6278 ]
6279 }
6280
6281
6282 == **Удаление задания в Журнале заданий** ==
6283
6284 (% class="box warningmessage" %)
6285 (((
6286 **DELETE /api/v3/vehicletasks**
6287 )))
6288
6289 Пример запроса:
6290
6291 (((
6292 [
6293 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
6294 ]
6295 )))
6296
6297 (((
6298 Пример ответа:
6299 )))
6300
6301 {
6302 "vehicleId": 0, ~/~/ Идентификатор ТС
6303 "description": "string", ~/~/ Описание
6304 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
6305 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
6306 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
6307 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
6308 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
6309 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
6310 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
6311 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
6312 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
6313 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
6314 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
6315 "cost": { 
6316 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
6317 "Name": "string", ~/~/ Наименование
6318 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
6319 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
6320 "Norm": 0 ~/~/ Норма внесения
6321 },
6322 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6323 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
6324 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
6325 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
6326 "deleted": true, ~/~/ Признак удаления
6327 "extId": "string", ~/~/ ExtId
6328 "GeoIds": [ ~/~/ Связанные поля
6329 0
6330 ]
6331 }
6332
6333
6334 == **Получение списка Журнала заданий** ==
6335
6336 (% class="box infomessage" %)
6337 (((
6338 **POST /api/v3/vehicletasks/getbyperiod**
6339 )))
6340
6341 Пример запроса:
6342
6343 (((
6344 {
6345 "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
6346 "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
6347 "TimeZone": 0, ~/~/ Часовой пояс.
6348 "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
6349 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
6350 ],
6351 "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
6352 0
6353 ],
6354 "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
6355 0
6356 ],
6357 "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
6358 "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
6359 }
6360 )))
6361
6362
6363 Пример ответа:
6364
6365 (((
6366 {
6367 "total": 0,  ~/~/ Общее количество записей
6368 "pages": 0,  ~/~/ Общее количество страниц
6369 "currentPage": 0, ~/~/ Текущая страница
6370 "items": [  ~/~/ Записи 
6371 {
6372 "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6373 "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
6374 "name": "string", ~/~/ Название задания.
6375 "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
6376 "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
6377 "workKind": "string", ~/~/ Вид работ
6378 "techOp": "string", ~/~/ Тех. операция
6379 "trailerModel": "string", ~/~/ Модель агрегата
6380 "width": "string", ~/~/ Ширина, м
6381 "speed": "string", ~/~/ Тех. скорость
6382 "fields": "string", ~/~/ Поля
6383 "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
6384 "vehicles": "string", ~/~/ Объект-модель
6385 "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
6386 "drivers": "string", ~/~/ Водители
6387 "tmc": "string", ~/~/ ТМЦ
6388 "client": "string", ~/~/  Клиент
6389 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
6390 "dep": "string", ~/~/ Подразделение
6391 "geoIds": [ ~/~/  Связанные поля
6392 0
6393 ]
6394 }
6395 ]
6396 }
6397 )))
6398
6399
6400 = **Раздел: Роли** =
6401
6402 == **Получение списка клиентских и системных ролей пользователя ** ==
6403
6404 (% class="box successmessage" %)
6405 (((
6406 **POST /api/v3/groups/find**
6407 )))
6408
6409 Пример запроса:
6410
6411 (((
6412 {
6413 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6414 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6415 }
6416 )))
6417
6418 (((
6419
6420 )))
6421
6422 (((
6423 Пример ответа:
6424 )))
6425
6426 (((
6427 (((
6428 {
6429 "groups": [  ~/~/ Системные роли пользователя
6430 {
6431 "code": "string", ~/~/ Код роли.
6432 "name": "string", ~/~/ Имя  
6433 "shortName": "string" ~/~/ Короткое имя 
6434 }
6435 ],
6436 "customGroups": [ ~/~/ Системные роли пользователя
6437 {
6438 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6439 "name": "string", ~/~/ Наименование 
6440 "shortName": "string", ~/~/ Короткое наименование 
6441 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6442 }
6443 ]
6444 }
6445 )))
6446 )))
6447
6448 (((
6449
6450 )))
6451
6452 = **Раздел: Локатор ** =
6453
6454
6455 == **Получение данных по локатору** ==
6456
6457 (% class="box infomessage" %)
6458 (((
6459 **GET /api/v3/locators/{locatorId}**
6460 )))
6461
6462 В запросе указывается locatorid - идентификатор локатора
6463
6464 Пример ответа:
6465
6466 (((
6467 (((
6468 {
6469 "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6470 0
6471 ],
6472 "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6473 0
6474 ],
6475 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6476 0
6477 ],
6478 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6479 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6480 "agentName": "string", ~/~/ Наименование агента.
6481 "isEnabled": true, ~/~/ Активность 
6482 "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6483 "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6484 "name": "string", ~/~/ Наименование.
6485 "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6486 "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6487 "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6488 "validity": 0, ~/~/ Значение срока действия
6489 "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6490 "autoProlongation": true, ~/~/ Автопродление срока действия.
6491 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6492 "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6493 "url": "string", ~/~/ Ссылка
6494 "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6495
6496 "showVehicleName": true, ~/~/ Наименование объекта
6497 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6498 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6499 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6500 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6501 "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ГИС)
6502
6503 1
6504
6505 ]
6506 }
6507 )))
6508 )))
6509
6510
6511 == **Создание локатора** ==
6512
6513 (% class="box successmessage" %)
6514 (((
6515 **POST /api/v3/locators**
6516 )))
6517
6518 Пример запроса:
6519
6520 (((
6521 {
6522 "isEnabled": true, ~/~/ Активность
6523 "name": "string", ~/~/ Наименование локатора
6524 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
6525 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
6526 "validity": 0, ~/~/ Срок действия в днях (1-90)
6527 "autoProlongation": true, ~/~/ Автопродление срока действия.
6528 "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6529 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6530 "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6531 0
6532 ],
6533 "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6534 0
6535 ],
6536 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6537 0
6538 ],
6539
6540 "showVehicleName": true, ~/~/ Наименование объекта
6541 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6542 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6543 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6544 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6545 "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ГИС)
6546
6547 1
6548
6549 ]
6550 }
6551 )))
6552
6553 Пример ответа:
6554
6555 (((
6556 3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
6557 )))
6558
6559
6560 == **Выводит список локаторов ** ==
6561
6562 (% class="box successmessage" %)
6563 (((
6564 **POST /api/v3/locators/find**
6565 )))
6566
6567 Пример запроса:
6568
6569 (((
6570 {
6571 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента
6572 }
6573 )))
6574
6575 (((
6576
6577 )))
6578
6579 Пример ответа:
6580
6581 (((
6582 [
6583 {
6584 "vehiclesCount": 0, ~/~/ Количество объектов.
6585 "geozonesCount": 0, ~/~/ Количество геозон.
6586 "fieldsCount": 0, ~/~/ Количество полей.
6587 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6588 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
6589 "agentName": "string", ~/~/ Наименование агента.
6590 "isEnabled": true, ~/~/ Активность локатора
6591 "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания
6592 "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 
6593 "name": "string", ~/~/ Наименование локатора 
6594 "status": 0,  ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6595 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6596 "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC)
6597 "validity": 0, ~/~/ Срок действия в днях (1-90)
6598 "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6599 "autoProlongation": true, ~/~/ Автоматическая пролонгация 
6600 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6601 "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 
6602 "url": "string", ~/~/ ссылка на локатор 
6603 "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6604 "showVehicleName": true, ~/~/ Наименование объекта
6605 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6606 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6607 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6608 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6609 "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ГИС)
6610
6611 0
6612 ]
6613 }
6614 ]
6615 )))
6616
6617
6618 == **Изменение локатора** ==
6619
6620 (% class="box infomessage" %)
6621 (((
6622 **PUT /api/v3/locators**
6623 )))
6624
6625 Пример запроса:
6626
6627 (((
6628 {
6629 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6630 "isEnabled": true, ~/~/ Активность 
6631 "name": "string", ~/~/ Наименование
6632 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
6633 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
6634 "validity": 0, ~/~/ Срок действия в днях (1-90)
6635 "autoProlongation": true, ~/~/ Автопродление срока действия
6636 "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский)
6637 "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 
6638 0
6639 ],
6640 "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 
6641 0
6642 ],
6643 "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 
6644 0
6645 ],
6646 "showVehicleName": true, ~/~/ Наименование объекта
6647 "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте
6648 "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки**
6649 "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке.
6650 "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах
6651 "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ГИС)
6652
6653 0
6654
6655 ]
6656 }
6657
6658
6659 )))
6660
6661 Пример ответа:
6662
6663 200 ~/~/ Success
6664
6665
6666 == **Удалить локатор** ==
6667
6668 (% class="box warningmessage" %)
6669 (((
6670 **DELETE /api/v3/locators**
6671 )))
6672
6673 Пример запроса:
6674
6675 (((
6676 [
6677 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6678 ]
6679 )))
6680
6681
6682 = =
6683
6684 (((
6685 (((
6686
6687 )))
6688 )))
6689
6690
6691 (% class="box" lang="en-US" style="text-align: center;" %)
6692 (((
6693 (% 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]] **
6694 )))

Меню

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