Version 225.2 by Андрей Калиновский on 2025/05/06 11:25
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="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
291 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
292 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
293 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
294 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
295 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
296 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
297 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
298 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
299 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
300 |(% style="width:215px" %)city|(% style="width:861px" %)Город
301 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
302 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
303 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
304 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
305 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
306 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
307 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
308 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
309 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
310 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
311
312 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
313
314 (% class="box warningmessage" %)
315 (((
316 **PUT /api/v3/agents**
317 )))
318
319 Метод позволяет отредактировать клиента, указанного в запросе.
320
321 Метод запроса: **PUT**
322
323 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
324
325 В заголовках запроса: X-Auth: Токен авторизации
326
327 Параметры в теле запроса (JSON):
328
329 {
330 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
331 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
332 "name": "string", ~/~/ имя
333 "fullName": "string", ~/~/ полное наименование
334 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
335 "isForeign": true, ~/~/ иностранный контрагент
336 "district": "string", ~/~/ округ
337 "region": "string", ~/~/ регион
338 "city": "string", ~/~/ город
339 "inn": "string", ~/~/ ИНН
340 "kpp": "string", ~/~/ КПП
341 "address": "string", ~/~/ юридический адрес
342 "addressFact": "string", ~/~/ фактический адрес
343 "email": "string", ~/~/ email
344 "director": "string", ~/~/ ФИО руководителя
345 "bankName": "string", ~/~/ банк
346 "bankBIK": "string", ~/~/ БИК
347 "bankRS": "string", ~/~/ номер счёта
348 "bankKS": "string" ~/~/ корр. счёт
349 }
350
351 Ответ:
352
353 {
354 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
355 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
356 "name": "string", ~/~/ имя
357 "fullName": "string", ~/~/ полное наименование
358 "isForeign": true, ~/~/ иностранный контрагент
359 "district": "string", ~/~/ округ
360 "region": "string", ~/~/ регион
361 "city": "string", ~/~/ город
362 "inn": "string", ~/~/ ИНН
363 "kpp": "string", ~/~/ КПП
364 "address": "string", ~/~/ юридический адрес
365 "addressFact": "string", ~/~/ фактический адрес
366 "email": "string", ~/~/ email
367 "director": "string", ~/~/ ФИО руководителя
368 "bankName": "string", ~/~/ банк
369 "bankBIK": "string", ~/~/ БИК
370 "bankRS": "string", ~/~/ номер счёта
371 "bankKS": "string" ~/~/ корр. счёт
372 }
373
374 == (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
375
376 (% class="box errormessage" %)
377 (((
378 **DELETE /api/v3/agents/{clientId}**
379 )))
380
381 Метод позволяет удалить клиента, указанного в строке запроса.
382
383 Метод запроса: **DELETE**
384
385 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
386
387 Параметр запроса: **{clientId}** - Guid пользователя
388
389 В заголовках запроса: X-Auth: Токен авторизации
390
391 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
392
393 == (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
394
395 (% class="box warningmessage" %)
396 (((
397 **PUT /api/v3/agents/{id}/changeStatus/{status}**
398 )))
399
400 Метод позволяет изменить статус клиента, указанного в запросе.
401
402 В пути указывается GUID клиента и статус клиента.
403
404 **status **- значение 0 - заблокирован, 1 - активен.
405
406 Ответ: Code 204
407
408 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
409
410 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
411
412 (% class="box successmessage" %)
413 (((
414 (% lang="en-US" %)**POST /api/v3/users**
415 )))
416
417 (% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
418
419 (% style="color:#000000" %)Метод запроса: **POST**
420
421 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
422
423 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
424
425 (% style="color:#000000" %)Параметры в теле запроса (JSON):
426
427 (% style="color:#000000" %)
428 { 
429 "lastName": "", ~/~/ фамилия
430 "firstName": "", ~/~/ имя
431 "position": "", ~/~/ должность
432 "phone": "", ~/~/ телефон
433 "organization": "", ~/~/ организация
434 "login": "", ~/~/ логин (обязателен)
435 "password": "", ~/~/ пароль (обязателен)
436 "email": "", ~/~/ email (обязателен)
437 "description": "string", ~/~/ Описание
438 "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
439 "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
440 "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
441 "parentId": "", ~/~/ Guid родительского агента
442 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
443 "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
444 "doubleAuth":
445 {
446 "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
447 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
448 },
449 "groups":
450 [
451 "string" ~/~/ группы пользователя, перечисление названия системных ролей
452 ],
453 "customGroups":
454 [
455 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
456 ],
457 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
458 }
459 {
460 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
461 "lastName": "string",
462 "firstName": "string",
463 "position": "string",
464 "phone": "string",
465 "organization": "string",
466 "login": "string",
467 "password": "string",
468 "email": "string",
469
470 (% style="text-align:left" %)
471 (% style="color:#000000; font-weight:normal" %)Ответ:
472 {     
473 "id": "" , ~/~/ ID пользователя
474 "lastName": "" , ~/~/ Фамилия ,
475 "firstName": "" , ~/~/ Имя
476 "position": "" , ~/~/ Должность
477 "phone": "" , ~/~/ Телефон
478 "organization": "" , ~/~/ Организация
479 "login": "" , ~/~/ Логин
480 "password": "" , ~/~/ Пароль
481 "email": "" , ~/~/ Email
482 "description": "" , ~/~/ Описание
483 "isEnabled": "" , ~/~/ Признак включения
484 "parentId": "" , ~/~/ Guid родительского агента
485 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
486 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
487 "kind": "" , ~/~/ тип аутентификации
488 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
489 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
490 }
491
492
493 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
494
495 (% class="box infomessage" %)
496 (((
497 (% lang="en-US" %)**POST /api/v3/users/find**
498 )))
499
500 (% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
501
502 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
503
504 (% style="color:#000000" %)Метод запроса: **POST**
505
506 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
507
508 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
509
510 (% style="color:#000000" %)Параметры в теле запроса (JSON):
511
512 (% style="color:#000000" %){(%%)
513 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
514 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
515 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
516 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
517 (% style="color:#000000" %)}
518
519 (% style="color:#000000" %)Ответ:
520
521 (% style="color:#000000" %){         (%%)
522 "id": "" , ~/~/ идентификатор пользователя
523 "lastName": "" , ~/~/ фамилия
524 "firstName": "" , ~/~/ имя
525 "position": "" , ~/~/ должность
526 "phone": "" , ~/~/ телефон
527 "parentId": "" , ~/~/ идентификатор клиента-родителя
528 "parentName": "" , ~/~/ наименование клиента-родителя
529 "organization": "" , ~/~/ организация
530 "login": "" , ~/~/ логин
531 "email": "" , ~/~/ E-mail
532 "sessionDuration":"", ~/~/ длительность сессии в минутах
533 "status": "1",  ~/~/ статус пользователя
534 "lastLogged": "", ~/~/ дата/время последней авторизации
535 (% style="color:#000000" %)}
536
537 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
538
539 (% class="box infomessage" %)
540 (((
541 (% lang="en-US" %)**GET /api/v3/users/{GUID}**
542 )))
543
544 (% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
545
546 (% style="color:#000000" %)Метод запроса: **GET**
547
548 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
549
550 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
551
552 (% style="color:#000000" %)Ответ:
553
554 (((
555 (((
556 {
557 "id": "", ~/~/ GUID пользователя
558 "lastName": "", ~/~/ Фамилия 
559 "firstName": "", ~/~/ Имя
560 "position": "", ~/~/ Должность
561 "phone": "", ~/~/ Номер телефона
562 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
563 "parentName": "", Наименование клиента, которому принадлежит пользователь
564 "organization": "", ~/~/ Организация
565 "login": "", ~/~/ Логин пользователя
566 "email": "", ~/~/ Адрес электронной почты
567 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
568 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
569 "description": "", ~/~/ Описание
570 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
571 "doubleAuth":
572 {
573 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
574 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
575 },
576 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
577 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
578 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
579 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
580 "groups": [], ~/~/ Список ролей пользователя
581 "customGroups": [], ~/~/ Список клиентских ролей пользователя
582 "authDevices": [ ], ~/~/ Список авторизованных устройств
583 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
584 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
585 }
586 )))
587 )))
588
589 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
590
591 (% class="box warningmessage" %)
592 (((
593 (% lang="en-US" %)**PUT /api/v3/users**
594 )))
595
596 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
597
598 (% style="color:#000000" %)Метод запроса: **PUT**
599
600 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
601
602 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
603
604 (% lang="en-US" style="text-align:left" %)
605 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
606
607 (% lang="en-US" style="text-align:left" %)
608 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
609 "id": "" , ~/~/ ID пользователя 
610 "lastName": "" , ~/~/ фамилия
611 "firstName": "" , ~/~/ имя
612 "position": "" , ~/~/ должность
613 "phone": "" , ~/~/ телефон
614 "organization": "" , ~/~/ организация
615 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
616 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
617 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
618 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
619 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
620 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
621 "isEnabled": "" , ~/~/ признак включения
622 "parentId": "" , ~/~/ Guid родительского агента
623 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
624 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
625 "doubleAuth":
626 {
627 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
628 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
629 },
630 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
631 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
632 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
633
634 (% lang="en-US" style="text-align:left" %)
635 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
636
637 (% lang="en-US" style="text-align:left" %)
638 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
639 "id": "" , ~/~/ идентификатор пользователя
640 "lastName": "" , ~/~/ фамилия
641 "firstName": "" , ~/~/ имя
642 "position": "" , ~/~/ должность
643 "phone": "" , ~/~/ телефон
644 "organization": "" , ~/~/ организация
645 "login": "" , ~/~/ логин
646 "password": "" , ~/~/ пароль 
647 "email": "" , ~/~/ email
648 "description": "" , ~/~/ описание
649 "isEnabled": "" , ~/~/ признак включения
650 "parentId": "" , ~/~/ Guid родительского агента
651 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
652 "doubleAuth":
653 {
654 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
655 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
656 },
657 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
658 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
659 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
660 }
661
662 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
663
664 (% class="box warningmessage" %)
665 (((
666 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
667 )))
668
669 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
670
671 (% style="color:#000000" %)Метод запроса: **PUT**
672
673 (% 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}
674
675 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
676
677 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
678
679 (% style="color:#000000" %)Параметры в теле запроса (JSON):
680
681 (% style="color:#000000" %){(%%)
682 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
683 "description": "" , ~/~/ описание
684 "data": "" , ~/~/ данные, связанные со сменой статуса
685 (% style="color:#000000" %)}
686
687 (% style="text-align:left" %)
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/disable**
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/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
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
712 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
713
714 (% class="box warningmessage" %)
715 (((
716 **POST /api/v3/users/enable**
717 )))
718
719 Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
720
721 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
722
723 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
724
725 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
726
727 [ 
728 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
729 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
730 ]
731
732 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
733 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
734
735 (((
736 В теле ответа:
737 {
738 "errorMessages": [
739 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
740 ],
741 "users": [
742 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
743 ]
744 }
745 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
746 "users" - массив id пользователей, которых не удалось включить или отключить.
747 )))
748
749 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
750
751 (% class="box errormessage" %)
752 (((
753 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
754 )))
755
756 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
757
758 (% style="color:#000000" %)Метод запроса: **DELETE**
759
760 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
761
762 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
763
764 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
765
766 (% style="text-align:left" %)
767 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
768
769 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
770
771 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
772
773 (% class="box infomessage" %)
774 (((
775 (% lang="en-US" %)**GET /api/v3/models/{Id}**
776 )))
777
778 Метод возвращает полную информацию о модели объекта.
779
780 (% style="color:#000000" %)Метод запроса: **GET**
781
782 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
783
784 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
785
786 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
787
788 (% style="color:#000000" %)Ответ:
789
790 (% style="color:#000000" %){
791 "parentName": "string",
792 "name": "string",
793 "picture": "string",
794 "minspeed": 0,
795 "maxspeed": 0,
796 "width": 0,
797 "imbeddedtrailer": true,
798 "hoppercapacity": 0,
799 "hopperdischargespeed": 0,
800 "modelType": 0,
801 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
802 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
803 "deleted": true
804 }
805
806 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
807 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
808 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
809 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
810 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
811 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
812 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
813 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
814 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
815 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
816 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
817 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
818 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
819 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
820
821 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
822
823 (% class="box successmessage" %)
824 (((
825 (% lang="en-US" %)**POST /api/v3/models/find**
826 )))
827
828 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
829
830 (% style="color:#000000" %)Метод запроса: **POST**
831
832 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
833
834 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
835
836 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
837
838 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
839 }
840
841 (% style="color:#000000" %)Ответ:
842
843 (% style="color:#000000" %)[
844 {
845 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
846 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
847 "parentName": "string",
848 "name": "string",
849 "modelType": 0
850 }
851 ]
852
853 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
854 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
855 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
856 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
857 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
858 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
859
860 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
861
862 (% class="box successmessage" %)
863 (((
864 (% lang="en-US" %)**POST /api/v3/models**
865 )))
866
867 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
868
869 (% style="color:#000000" %)Метод запроса: **POST**
870
871 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
872
873 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
874
875 (% style="color:#000000" %)Параметры в теле запроса (JSON):
876
877 {
878 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
879 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
880 "deleted": true,
881 "extId": "string",
882 "name": "string",
883 "picture": "string",
884 "minspeed": 0,
885 "maxspeed": 0,
886 "width": 0,
887 "imbeddedtrailer": true,
888 "fueloutlay": 0,
889 "hoppercapacity": 0,
890 "hopperdischargespeed": 0,
891 "modelType": 0
892 }
893
894 Ответ:
895
896 {
897 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
898 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
899 "deleted": true,
900 "extId": "string",
901 "name": "string",
902 "picture": "string",
903 "minspeed": 0,
904 "maxspeed": 0,
905 "width": 0,
906 "imbeddedtrailer": true,
907 "hoppercapacity": 0,
908 "hopperdischargespeed": 0,
909 "modelType": 0
910 }
911
912 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
913 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
914 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
915 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
916 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
917 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
918 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
919 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
920 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
921 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
922 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
923 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
924 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
925
926 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
927
928 (% class="box warningmessage" %)
929 (((
930 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
931 )))
932
933 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
934
935 (% style="color:#000000" %)Метод запроса: **PUT**
936
937 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
938
939 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
940
941 (% style="color:#000000" %)Параметры в теле запроса (JSON):
942
943 {
944 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
945 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
946 "deleted": true,
947 "extId": "string",
948 "name": "string",
949 "picture": "string",
950 "minspeed": 0,
951 "maxspeed": 0,
952 "width": 0,
953 "imbeddedtrailer": true,
954 "fueloutlay": 0,
955 "hoppercapacity": 0,
956 "hopperdischargespeed": 0,
957 "modelType": 0
958 }
959
960 Ответ:
961
962 {
963 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
964 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
965 "deleted": true,
966 "extId": "string",
967 "name": "string",
968 "picture": "string",
969 "minspeed": 0,
970 "maxspeed": 0,
971 "width": 0,
972 "imbeddedtrailer": true,
973 "fueloutlay": 0,
974 "hoppercapacity": 0,
975 "hopperdischargespeed": 0,
976 "modelType": 0
977 }
978
979 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
980 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
981 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
982 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
983 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
984 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
985 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
986 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
987 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
988 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
989 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
990 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
991 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
992
993 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
994
995 (% class="box errormessage" %)
996 (((
997 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
998 )))
999
1000 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
1001
1002 (% style="color:#000000" %)Метод запроса: **DELETE**
1003
1004 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
1005
1006 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
1007
1008 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1009
1010 Ответ: В случае успеха **Success 200**
1011
1012 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
1013
1014 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
1015
1016 (% class="box infomessage" %)
1017 (((
1018 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1019 )))
1020
1021 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1022
1023 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1024
1025 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1026
1027 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1028
1029 (% style="color:#000000" %)Метод запроса: **GET**
1030
1031 (% 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}
1032
1033 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1034
1035 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1036
1037 (% style="color:#000000" %)Ответ:
1038
1039 (((
1040 {
1041
1042 (((
1043 "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1044 "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1045 )))
1046
1047 (((
1048 ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1049 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1050 )))
1051
1052 "vehicleId": "", ~/~/ ID объекта
1053 "name": "", ~/~/ Имя объекта
1054 "imei": "", ~/~/ IMEI объекта
1055 "deviceTypeId": , ~/~/ ID типа устройства
1056 "deviceTypeName": "", ~/~/ Название типа устройства
1057 "sim1": "", ~/~/ Номер SIM1
1058 "sim2": "", ~/~/ Номер SIM2
1059 "parentId": "", ~/~/ ID клиента-родителя
1060 "parentName": "", ~/~/ Наименование клиента-родителя
1061 "modelId": "", ~/~/ ID модели объекта
1062 "modelName": "", ~/~/ Имя модели объекта
1063 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1064 "unitName": "string", ~/~/ Наименование подразделения
1065 "status": 0, ~/~/ Статус объекта
1066 "createdAt": "", ~/~/ Дата создания объекта
1067 },
1068 "customFields": [ ~/~/ Произвольные поля
1069 {
1070 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1071 "name": "string", ~/~/ Имя поля
1072 "value": "string", ~/~/ Значение поля
1073 "forClient": true, ~/~/ Не используемая функция
1074 "forTooltip": true, ~/~/ Отображать в подсказке
1075 "forReport": true ~/~/ Отображать в отчете
1076 }
1077
1078 ], ~/~/ Данные с вкладки нормы
1079 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1080 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1081 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1082 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1083 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1084 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1085 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1086 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1087 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1088 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1089 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1090 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1091 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1092 "mileageCoeff": 0, ~/~/ коэффициент пробега
1093 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1094 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1095 "counters": { ~/~/ Счетчики
1096 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1097 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1098 "mileage": 0, ~/~/ Текущий пробег
1099 "motohours": 0, ~/~/ Текущие моточасы
1100 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1101 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1102 },
1103
1104 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1105 "id": "string", ~/~/ ID объекта
1106 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1107 "host": "string", ~/~/ CMSV6 Web Host
1108 "login": "string", ~/~/ CMSV6 Account
1109 "password": "string" ~/~/ CMSV6 Password
1110 },
1111
1112 "commandTemplates": [ ~/~/ Шаблоны команд
1113 {
1114 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1115 "name": "string", ~/~/ Наименование команды
1116 "command": "string", ~/~/ Текст команды
1117 "retries": 0 ~/~/ Количество попыток
1118 }
1119 ],
1120 "sensors": [ ~/~/ Датчики
1121 {
1122 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1123 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1124 "type": 0, ~/~/ Тип датчика
1125 "name": "string", ~/~/ Имя датчика
1126 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1127 "inputNumber": 0, ~/~/ Номер входа
1128 "pseudonym": "string", ~/~/ Псевдоним
1129 "medianDegree": 0, ~/~/ Медианная фильтрация
1130 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1131 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1132 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1133 "gradesTables": [ ~/~/ Массив таблиц тарировки
1134 {
1135 "grades": [ ~/~/ Таблица тарировки 1
1136 {
1137 "input": 0, ~/~/ Входящее значение
1138 "output": 0 ~/~/ Выходящее значение
1139 }
1140 ],
1141 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1142 }
1143 ],
1144 "showInTooltip": true, ~/~/ Отображать в подсказке
1145 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1146 "color": "string", ~/~/ Код цвета датчиков
1147 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1148 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1149 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1150 "expr": "string", ~/~/ Формула
1151 "children": [ ~/~/ массив дочерних датчиков
1152 "string"
1153 ],
1154 "customParams": { ~/~/ прочие произвольные параметры
1155 "additionalProp1": "string",
1156 "additionalProp2": "string",
1157 "additionalProp3": "string"
1158 },
1159
1160 ~/~/ Характерные для произвольного:
1161 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1162 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1163 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1164 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1165 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1166 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1167 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1168 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1169 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1170 ~/~/ "ValueOn": "Вкл.",
1171 ~/~/ "ValueOff": "Выкл."
1172 "summaryMaxValue": 0 ~/~/ Макс. значение
1173 }
1174 "drivers": [ ~/~/ Водители
1175 {
1176 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1177 "name": "string", ~/~/ Наименование
1178 "description": "string",
1179 "isDefault": true ~/~/ По умолчанию
1180 }
1181 ],
1182 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1183 {
1184 "id": "", ~/~/ ID  задания
1185 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1186 "name": "", ~/~/ Наименование задания
1187 "description": "", ~/~/ Описание задания
1188 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1189 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1190 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1191 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1192 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1193 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1194 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1195 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1196 }
1197 ],
1198 "statusHistory": [ ~/~/ История статусов
1199 {
1200 "status": 0,
1201 "date": "2023-05-22T09:57:39.562Z",
1202 "description": "string",
1203 "additionalInfo": "string"
1204
1205 (((
1206 }
1207 ],
1208 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1209 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1210 )))
1211
1212 (((
1213 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1214 }
1215
1216 )))
1217 )))
1218
1219 (% style="text-align:left" %)
1220 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1221
1222 (% style="text-align:left" %)
1223 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1224
1225
1226 == **Отправить команду на терминал** ==
1227
1228 (% class="box successmessage" %)
1229 (((
1230 (% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1231 )))
1232
1233 Команда для отправки на тс.
1234
1235 {  
1236 "id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1237 "command": "", ~/~/ Текст отправляемой команды
1238 "retries": "", ~/~/ Количество попыток отправки на терминал
1239 "idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1240 }
1241
1242 В ответ получаем cmdid
1243
1244
1245 == **Получить ответ на отправленную на ТС команду** ==
1246
1247 (% class="box infomessage" %)
1248 (((
1249 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1250 )))
1251
1252 Идентификатор команды: cmdId
1253
1254 Запрос от терминала на ответ команды
1255
1256 Пример ответ от терминала:
1257
1258 ID= "" ~/~/ идентификатор объекта
1259 Soft="" ~/~/ версия софта
1260 GPS=4 ~/~/ тип трекера
1261 Time=11:05:43 28.06.24 ~/~/ время запроса
1262 Lat=45.056221 ~/~/ широта
1263 Lon=39.035938 ~/~/ долгота
1264 Speed=0.0 ~/~/ скорость
1265 Course=181.4 ~/~/направление
1266
1267 (((
1268 == **Список отправленных объекту команд с ответами** ==
1269
1270 (% class="box infomessage" %)
1271 (((
1272 (% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1273 )))
1274
1275 Идентификатор ТС: vehicleId
1276
1277 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1278
1279 Пример ответа терминала
1280
1281 [ 
1282 {    
1283 "id": "", ~/~/ идентификатор пользователя
1284 "commandText": "", ~/~/Текст команды.
1285 "templateId": "", ~/~/Идентификатор шаблона
1286 "updated": "", ~/~/ Время отправки  
1287 "tryCount": 0, ~/~/ Количество попыток отправки команды
1288 "answer": "", ~/~/ Ответ терминала.
1289 "status": "" ~/~/ Статус отправки
1290 }
1291 ]
1292 )))
1293
1294 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1295
1296 (% class="box successmessage" %)
1297 (((
1298 (% lang="en-US" %)**POST /api/v3/vehicles**
1299 )))
1300
1301 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1302
1303 (% style="color:#000000" %)Метод запроса: **POST**
1304
1305 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1306
1307 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1308
1309 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1310
1311 (% style="color:#000000" %){
1312
1313
1314 (((
1315 "vehicleId": 0, ~/~/ ID ТС
1316 )))
1317
1318 "parentId": "" , ~/~/ ID клиента
1319 "name": "" , ~/~/ имя ТС
1320 "imei": "" , ~/~/ IMEI
1321 "deviceTypeId": "" , ~/~/ ID типа устройства
1322 "modelId": "" , ~/~/ ID модели
1323 "unitId": "" , ~/~/ ID подразделения
1324 "sim1": "" , ~/~/ Номер SIM 1
1325 "sim2": "" , ~/~/ Номер SIM2
1326 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1327 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1328 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1329 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1330 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1331 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1332 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1333 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1334 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1335 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1336 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1337 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1338 "mileageCalcMethod": 0,
1339 "mileageCoeff": 0,
1340 "locationByCellId": true,
1341 "dottedLineTrackWhenNoCoords": true,
1342 "counters": ~/~/ счетчики
1343 {
1344 "mileage": "" , ~/~/ пробег
1345 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1346 "motohours": "" , ~/~/ моточасы
1347 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1348 },
1349 "cmsv6Parameters": { ~/~/ параметры CMSv6
1350 "enabled": true, ~/~/ флаг включения
1351 "id": "" , ~/~/ идентификатор
1352 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1353 "login": "" , ~/~/ имя учетной записи
1354 "password": "" ~/~/ пароль учетной записи
1355 },
1356 "inspectionTasks": ~/~/ задания на ТО
1357 {
1358 "enabled": "" , ~/~/ Признак включения
1359 "name": "" , ~/~/ Имя задания
1360 "description": "" , ~/~/ Описание задания
1361 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1362 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1363 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1364 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1365 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1366 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1367 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1368 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1369 }
1370 "drivers": [ ~/~/ Водители
1371 {
1372 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1373 "isDefault": true
1374 }
1375 ],
1376 "commandTemplates": [ ~/~/ Шаблон команды
1377 {
1378 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1379 "name": "string",
1380 "command": "string",
1381 "retries": 0
1382 }
1383 ],
1384 "sensors": [ ~/~/ Датчики
1385 {
1386 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1387 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1388 "type": 0, ~/~/ Тип датчика
1389 "name": "string", ~/~/ Имя датчика
1390 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1391 "inputNumber": 0, ~/~/ Номер входа
1392 "pseudonym": "string", ~/~/ Псевдоним
1393 "medianDegree": 0, ~/~/ Медианная фильтрация
1394 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1395 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1396 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1397 "gradesTables": [ ~/~/ Массив таблиц тарировки
1398 {
1399 "grades": [ ~/~/ Таблица тарировки 1
1400 {
1401 "input": 0, ~/~/ Входящее значение
1402 "output": 0 ~/~/ Выходящее значение
1403 }
1404 ],
1405 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1406 }
1407 ],
1408 "showInTooltip": true, ~/~/ Отображать в подсказке
1409 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1410 "color": "string", ~/~/ код цвета датчиков
1411 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1412 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1413 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1414 "expr": "string", ~/~/ Формула
1415 "children": [ ~/~/ массив дочерних датчиков
1416 "string"
1417 ],
1418 "customParams": { ~/~/ прочие произвольные параметры
1419 "additionalProp1": "string",
1420 "additionalProp2": "string",
1421 "additionalProp3": "string"
1422 },
1423 ~/~/ Характерные для произвольного:
1424 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1425 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1426 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1427 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1428 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1429 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1430 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1431 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1432 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1433 ~/~/ "ValueOn": "Вкл.",
1434 ~/~/ "ValueOff": "Выкл."
1435 "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1436
1437 (((
1438 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1439 {
1440 "from": 0, ~/~/ С какого значения
1441 "color": "string", ~/~/ Каким цветом
1442 "text": "string" ~/~/ Текст подписи к этому интервалу
1443 }
1444 ]
1445 }
1446 ],
1447 )))
1448
1449 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1450
1451
1452 "customFields": [ ~/~/ Произвольные поля
1453 {
1454 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1455 "name": "string", ~/~/ Наименование произвольного поля
1456 "value": "string", ~/~/ Значение произвольного поля
1457 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1458 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1459 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1460
1461 (((
1462 }
1463 ],
1464 "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1465 )))
1466
1467 (((
1468 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1469 }
1470 )))
1471
1472
1473 (% style="color:#000000" %)Ответ:
1474
1475
1476 (((
1477 (((
1478 (((
1479 {
1480 "vehicleId": 0,  ~/~/ ID ТС
1481 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1482 "name": "string", ~/~/ Имя объекта
1483 "imei": "string", ~/~/ IMEI
1484 "deviceTypeId": 0, ~/~/ ID типа устройства
1485 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1486 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1487 "sim1": "string", ~/~/ SIM1
1488 "sim2": "string", ~/~/ SIM2
1489 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1490 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1491 "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1492 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1493 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1494 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1495 "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1496 "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1497 "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1498 "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1499 "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1500 "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1501 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1502 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1503 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1504 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1505 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1506 "counters": {  ~/~/ Dto для состояний счётчиков
1507 "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1508 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1509 "mileage": 0, ~/~/ Пробег
1510 "motohours": 0 ~/~/ Моточасы
1511 },
1512 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1513 "id": "string", ~/~/ CMSV6 Идентификатор
1514 "enabled": true, ~/~/ Признак включения
1515 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1516 "login": "string", ~/~/ CMSV6 имя учетной записи
1517 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1518 },
1519 "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1520 {
1521 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1522 "enabled": true, ~/~/ Признак включения
1523 "name": "string", ~/~/ Имя задания
1524 "description": "string", ~/~/ Описание задания
1525 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1526 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1527 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1528 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1529 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1530 "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1531 "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1532 "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1533 }
1534 ],
1535 "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1536 {
1537 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1538 "inputNumber": 0, ~/~/ № входа.
1539 "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1540 "comment": "string", ~/~/ Комментарий
1541 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1542 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1543 "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1544 "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1545 }
1546 ],
1547 "commandTemplates": [  ~/~/ Список шаблонов команд
1548 {
1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1550 "name": "string", ~/~/ Название шаблона команд
1551 "command": "string", ~/~/ Команда на выполнение
1552 "retries": 0 ~/~/ Лимит попыток отправки
1553 }
1554 ],
1555 "sensors": [ ~/~/ Список датчиков
1556 {
1557 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1558 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1559 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1560 "name": "string",  ~/~/ Имя датчика
1561 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1562 "inputNumber": 0, ~/~/ Номер входа
1563 "pseudonym": "string", ~/~/ Псевдоним
1564 "medianDegree": 0, ~/~/ Степень медианной фильтрации
1565 "isInverted": true, ~/~/  Признак инверсии
1566 "disabled": true, ~/~/ Датчик не участвует в обработке
1567 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1568 "gradesTables": [ ~/~/ Тарировка
1569 {
1570 "grades": [ ~/~/ Таблицы тарировки
1571 {
1572 "input": 0, ~/~/ Вход
1573 "output": 0 ~/~/ Выход
1574 }
1575 ],
1576 "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1577 }
1578 ],
1579 "showInTooltip": true, ~/~/ Отображение в подсказке
1580 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1581 "color": "string", ~/~/ код цвета датчиков
1582 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1583 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1584 "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1585 "expr": "string", ~/~/ Выражение
1586 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1587 "string"
1588 ],
1589 "customParams": {
1590 "additionalProp1": "string",
1591 "additionalProp2": "string",
1592 "additionalProp3": "string"
1593 },
1594 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1595 "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1596 {
1597 "from": 0, ~/~/ С какого значения
1598 "color": "string", ~/~/ Каким цветом
1599 )))
1600
1601 (((
1602 "text": "string" ~/~/ Текст подписи к этому интервалу
1603 }
1604 ]
1605 }
1606 ],
1607 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1608 "customFields": [ ~/~/ Список произвольных полей
1609 {
1610 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1611 "name": "string", ~/~/ Наименование произвольного поля
1612 "value": "string", ~/~/ Значение произвольного поля
1613 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1614 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1615 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1616 }
1617 ],
1618 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1619 }
1620 )))
1621 )))
1622 )))
1623
1624
1625 **Валидация:**
1626 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1627 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1629
1630
1631 == **Импортировать историю ТС (Асинхронный запрос)** ==
1632
1633 (% class="box successmessage" %)
1634 (((
1635 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1636 )))
1637
1638 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
1639
1640 Метод запроса: **POST**
1641
1642 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1643
1644 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1645
1646
1647 Ответ:
1648
1649 {
1650
1651 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1652
1653 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1654
1655 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1656
1657 "Message": "string", ~/~/ Информация о выполнении запроса
1658
1659 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1660
1661 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1662
1663 "Data": "string" ~/~/ Данные
1664
1665 }
1666
1667
1668 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
1669
1670 (% class="box infomessage" %)
1671 (((
1672 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1673 )))
1674
1675 При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
1676
1677 Метод запроса: **GET**
1678
1679 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1680
1681 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1682
1683
1684 Ответ:
1685
1686 {
1687
1688 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1689
1690 "Status": 0, ~/~/ Перечисление состояний выполения запроса
1691 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1692
1693 "Message": "string", ~/~/ Информация о выполнении запроса
1694
1695 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1696
1697 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1698
1699 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1700
1701 "Data": "string" ~/~/ Данные
1702
1703 }
1704
1705
1706 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1707
1708 (% class="box infomessage" %)
1709 (((
1710 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1711 )))
1712
1713 (% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1714
1715 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1716
1717 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1718
1719 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1720
1721 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1722
1723 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1724
1725 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1726
1727 (% style="color:#000000" %)Метод запроса: **POST**
1728
1729 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1730
1731 (% style="color:#000000" %)В заголовках запроса:
1732
1733 (% style="color:#000000" %)− Content-Type: __**application/json**__
1734
1735 (% style="color:#000000" %)− X-Auth: Токен авторизации
1736
1737 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1738
1739 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1740
1741 {
1742 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1743 "name": null, ~/~/ Имя ТС (string, опционально)
1744 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1745 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1746 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1747 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1748 "unitName": "string",  ~/~/ Название подразделения (опционально)
1749 "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1750 "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1751 "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1752 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1753 }
1754
1755 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1756
1757 (% style="color:#000000" %)Ответ:
1758
1759 (% style="color:#000000" %)[
1760 {
1761
1762 (((
1763 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1764 )))
1765
1766 (((
1767 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1768 "name": "" ~/~/ наименование объекта
1769 "imei": "" ~/~/ IMEI объекта
1770 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1771 "deviceTypeName": "" ~/~/ наименование типа устройства
1772 "sim1": "" ~/~/ первый номер телефона
1773 "sim2": "" ~/~/ второй номер телефона
1774 "parentId": "" ~/~/ идентификатор клиента-родителя
1775 "parentName": "" ~/~/ наименование клиента-родителя
1776 "modelId": "" ~/~/ идентификатор модели объекта
1777 "modelName": "" ~/~/ наименование модели объекта
1778 "unitId": "" ~/~/ идентификатор подразделения
1779 "unitName": "" ~/~/ наименование подразделения
1780 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1781 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1782 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1783 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1784 "customFields": [ 
1785 {
1786 "id": "", ~/~/ идентификатор произвольного поля
1787 "name": "", ~/~/ имя произвольного поля
1788 "value": "", ~/~/ значение произвольного поля
1789 "forClient": true, ~/~/ право на отображение у клиента
1790 "forTooltip": false, ~/~/ право на отображение в подсказке
1791 "forReport": false ~/~/ право на отображение в отчетах
1792 )))
1793
1794 (((
1795 }
1796 ],
1797 "vehicleGroups": [  ~/~/ Группы ТС
1798 {
1799 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1800 "name": "string" ~/~/ Наименование группы ТС
1801 }
1802 ]
1803 }
1804 ]
1805 )))
1806
1807 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1808
1809 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1810
1811 (% class="box successmessage" %)
1812 (((
1813 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1814 )))
1815
1816 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1817
1818 (% style="color:#000000" %)Метод запроса: **POST**
1819
1820 (% 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}
1821
1822 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1823
1824 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1825
1826 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1827
1828 (% style="color:#000000" %){
1829
1830 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1831 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1832 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1833 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1834 "description": "", ~/~/ Описание
1835 "data": "", ~/~/ Данные
1836 "overwrite": false, ~/~/ Флаг перезаписи
1837 "stage": "", ~/~/ Состояние, может быть null
1838 (% style="color:#000000" %)}
1839
1840 (% style="color:#000000" %)Ответ:
1841
1842 (% style="color:#000000" %){(%%)
1843 "status": "", ~/~/ значение статуса
1844 "date": "", ~/~/ Дата смены статуса 
1845 "description": "", ~/~/ Описание
1846 "data": "", ~/~/ Данные
1847 "overwrite": false, ~/~/ Флаг перезаписи
1848 "stage": "", ~/~/ Состояние
1849 (% style="color:#000000" %) }
1850
1851 == ==
1852
1853 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1854
1855 (% class="box warningmessage" %)
1856 (((
1857 (% lang="en-US" %)**PUT /api/v3/vehicles**
1858 )))
1859
1860 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1861
1862 (% style="color:#000000" %)Метод запроса: **PUT**
1863
1864 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1865
1866 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1867
1868 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1869
1870 (% style="color:#000000" %){
1871 "vehicleId": , ~/~/ ID объекта
1872 "parentId": "" , ~/~/ ID клиента
1873 "name": "" , ~/~/ имя ТС
1874 "imei": "" , ~/~/ IMEI
1875 "deviceTypeId": "" , ~/~/ ID типа устройства
1876 "modelId": "" , ~/~/ ID модели
1877 "unitId": "" , ~/~/ ID подразделения
1878 "sim1": "" , ~/~/ Номер SIM 1
1879 "sim2": "" , ~/~/ Номер SIM2
1880 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1881 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1882 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1883 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1884 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1885 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1886 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1887 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1888 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1889 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1890 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1891 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1892
1893 "mileageCalcMethod": 0,
1894 "mileageCoeff": 0,
1895 "locationByCellId": true,
1896 "dottedLineTrackWhenNoCoords": true,
1897 "counters": ~/~/ счетчики
1898 {
1899 "mileage": "" , ~/~/ пробег
1900 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1901 "motohours": "" , ~/~/ моточасы
1902 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1903 },
1904 "cmsv6Parameters": { ~/~/ параметры CMSv6
1905 "enabled": true, ~/~/ флаг включения
1906 "id": "" , ~/~/ идентификатор
1907 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1908 "login": "" , ~/~/ имя учетной записи
1909 "password": "" ~/~/ пароль учетной записи
1910 },
1911 "inspectionTasks": ~/~/ задания на ТО
1912 {
1913 "enabled": "" , ~/~/ Признак включения
1914 "name": "" , ~/~/ Имя задания
1915 "description": "" , ~/~/ Описание задания
1916 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1917 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1918 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1919 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1920 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1921 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1922 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1923 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1924 }
1925
1926 "drivers": [ ~/~/ Водители
1927 {
1928
1929 (((
1930 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1931 "inputNumber": 0, ~/~/ № входа.
1932 "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1933 "comment": "string", ~/~/ Комментарий.
1934 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1935 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1936 "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1937 "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1938 )))
1939
1940 } 
1941 ],
1942 "commandTemplates": [ ~/~/ Шаблон команды
1943 {
1944 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1945 "name": "string",
1946 "command": "string",
1947 "retries": 0
1948 }
1949 ],
1950 "sensors": [ ~/~/ Датчики
1951 {
1952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1953 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1954 "type": 0, ~/~/ Тип датчика
1955 "name": "string", ~/~/ Имя датчика
1956 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1957 "inputNumber": 0, ~/~/ Номер входа
1958 "pseudonym": "string", ~/~/ Псевдоним
1959 "medianDegree": 0, ~/~/ Медианная фильтрация
1960 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1961 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1962 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1963 "gradesTables": [ ~/~/ Массив таблиц тарировки
1964 {
1965 "grades": [ ~/~/ Таблица тарировки 1
1966 {
1967 "input": 0, ~/~/ Входящее значение
1968 "output": 0 ~/~/ Выходящее значение
1969 }
1970 ],
1971 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1972 }
1973 ],
1974 "showInTooltip": true, ~/~/ Отображать в подсказке
1975 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1976
1977 (((
1978 "color": "string",** ~/~/ **Цвет датчика
1979 )))
1980
1981 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1982 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1983 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1984 "expr": "string", ~/~/ Формула
1985 "children": [ ~/~/ массив дочерних датчиков
1986 "string"
1987 ],
1988 "customParams": { ~/~/ прочие произвольные параметры
1989 "additionalProp1": "string",
1990 "additionalProp2": "string",
1991 "additionalProp3": "string"
1992 },
1993 ~/~/ Характерные для произвольного:
1994 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1995 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1996 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1997 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1998 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1999 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
2000 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
2001 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
2002 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
2003 ~/~/ "ValueOn": "Вкл.",
2004 ~/~/ "ValueOff": "Выкл."
2005 "summaryMaxValue": 0 ~/~/ Макс. значение
2006
2007 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2008 {
2009 "from": 0, ~/~/ С какого значения
2010 "color": "string", ~/~/ Каким цветом
2011 "text": "string" ~/~/ Текст подписи к этому интервалу
2012 }
2013 ]
2014 }
2015 ],
2016 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2017
2018 "customFields": [ ~/~/ Произвольные поля
2019 {     
2020 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
2021 "name": "string", ~/~/ Наименование произвольного поля
2022 "value": "string", ~/~/ Значение произвольного поля
2023 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2024 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2025 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2026 }
2027
2028 (((
2029 ],
2030 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
2031 )))
2032
2033 }
2034
2035
2036 (% style="color:#000000" %)Ответ:
2037
2038 (((
2039 {
2040 "vehicleId": 0, ~/~/ ID ТС
2041 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
2042 "name": "string", ~/~/ Имя объекта
2043 "imei": "string", ~/~/ IMEI
2044 "deviceTypeId": 0, ~/~/ ID типа устройства
2045 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
2046 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
2047 "sim1": "string", ~/~/ SIM1
2048 "sim2": "string", ~/~/ SIM2
2049 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
2050 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
2051 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
2052 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
2053 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
2054 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
2055 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
2056 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
2057 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
2058 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
2059 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
2060 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
2061 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
2062 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
2063 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
2064 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
2065 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
2066 "counters": { ~/~/ состояний счётчиков
2067 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
2068 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
2069 "mileage": 0, ~/~/ Пробег
2070 "motohours": 0 ~/~/ Моточасы 
2071 },
2072 "cmsv6Parameters": { ~/~/ Dto для CMSv6
2073 "id": "string", ~/~/ CMSV6 Идентификатор
2074 "enabled": true, ~/~/ Признак включения
2075 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2076 )))
2077
2078
2079 (((
2080 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2081 "login": "string", ~/~/ CMSV6 имя учетной записи
2082 "password": "string" ~/~/ CMSV6 — пароль учетной записи
2083 },
2084 "inspectionTasks": [ ~/~/ Задания на ТО
2085 {
2086 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2087 "enabled": true, ~/~/ Признак включения
2088 "name": "string", ~/~/ Имя задания
2089 "description": "string", ~/~/ Описание задания
2090 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2091 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2092 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2093 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2094 "periodicCondition": 0, ~/~/ Условие периодичности по времени
2095 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2096 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2097 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2098 }
2099 ],
2100 "drivers": [  ~/~/ Список водителей
2101 {
2102 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2103 "inputNumber": 0, ~/~/ № входа.
2104 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2105 "comment": "string", ~/~/ Комментарий.
2106 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2107 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2108 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2109 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2110 }
2111 ],
2112 "commandTemplates": [ ~/~/ Список шаблонов команд
2113 {
2114 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2115 "name": "string", ~/~/ Название шаблона команд
2116 "command": "string", ~/~/ Команда на выполнение
2117 "retries": 0 ~/~/ Лимит попыток отправки
2118 }
2119 ],
2120 "sensors": [  ~/~/ Список датчиков 
2121 {
2122 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2123 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2124 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2125 )))
2126
2127 (((
2128 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2129 )))
2130
2131 (((
2132 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2133 )))
2134
2135 (((
2136 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2137 )))
2138
2139 (((
2140 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2141 )))
2142
2143 (((
2144 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2145 "name": "string", ~/~/ Имя датчика
2146 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2147 )))
2148
2149 (((
2150 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2151 "inputNumber": 0, ~/~/ Номер входа
2152 "pseudonym": "string", ~/~/ Псевдоним
2153 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2154 "isInverted": true, ~/~/ Признак инверсии
2155 "disabled": true, ~/~/ Датчик не участвует в обработке
2156 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2157 "gradesTables": [ ~/~/ Тарировка
2158 {
2159 "grades": [ ~/~/ Таблицы тарировки
2160 {
2161 "input": 0, ~/~/ Вход
2162 "output": 0 ~/~/ Выход
2163 }
2164 ],
2165 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2166 }
2167 ],
2168 "showInTooltip": true, ~/~/ Отображение в подсказке
2169 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2170
2171 (((
2172 "color": "string", ~/~/ цвет уведомлений
2173 )))
2174
2175 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2176 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2177 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2178 "expr": "string", ~/~/ Выражение
2179 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2180 "string" 
2181 ],
2182 "customParams": { ~/~/ Дополнительные настройки
2183 "additionalProp1": "string",
2184 "additionalProp2": "string",
2185 "additionalProp3": "string"
2186 },
2187 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2188 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2189 {
2190 "from": 0, ~/~/ С какого значения
2191 "color": "string", ~/~/ Каким цветом
2192 "text": "string" ~/~/ Текст подписи к этому интервалу
2193 }
2194 ]
2195 }
2196 ],
2197 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2198 "customFields": [ ~/~/ Список произвольных полей
2199 {
2200 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2201 "name": "string", ~/~/ Наименование произвольного поля
2202 "value": "string", ~/~/ Значение произвольного поля
2203 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2204 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2205 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2206 }
2207 ],
2208 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2209 }
2210 )))
2211
2212 **Валидация:**
2213 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2214 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2215 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2216
2217 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2218
2219 (% class="box errormessage" %)
2220 (((
2221 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2222 )))
2223
2224 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2225
2226 (% style="color:#000000" %)Метод запроса: **DELETE**
2227
2228 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2229
2230 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2231
2232 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2233
2234 (% style="text-align:left" %)
2235 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2236
2237 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2238
2239 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2240
2241 (% class="box infomessage" %)
2242 (((
2243 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2244 )))
2245
2246 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2247
2248 (% style="color:#000000" %)Метод запроса: **GET**
2249
2250 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2251
2252 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2253
2254 (% style="color:#000000" %)Ответ:
2255
2256 (% style="color:#000000" %){(%%)
2257 "deviceTypeId" : "", ~/~/ ID типа устройства
2258 "deviceTypeName" : "" ~/~/ Название типа устройства
2259 (% style="color:#000000" %)}
2260
2261 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2262
2263 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2264
2265 (% class="box infomessage" %)
2266 (((
2267 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2268 )))
2269
2270 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2271
2272 (% style="color:#000000" %)Метод запроса: **GET**
2273
2274 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2275
2276 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2277
2278 (% style="color:#000000" %)Ответ:
2279
2280 (% style="color:#000000" %){(%%)
2281 "id": "", ~/~/ ID типа датчика 
2282 "name": "", ~/~/ Название
2283 "description": "", ~/~/ Описание
2284 (% style="color:#000000" %)}
2285
2286 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2287
2288 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2289
2290 (% class="box infomessage" style="text-align: left;" %)
2291 (((
2292 **POST /api/v3/terminalMessages/count**
2293 )))
2294
2295 (% style="text-align: left;" %)
2296 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2297
2298 (% style="text-align: left;" %)
2299 Метод запроса **POST**
2300
2301 (% style="text-align: left;" %)
2302 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2303
2304 (% style="text-align: left;" %)
2305 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2306
2307 (% style="text-align: left;" %)
2308 {
2309 "vehicleIds": [
2310 id ~/~/ здесь передается список идентификаторов объектов
2311 ],
2312 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2313 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2314 }
2315
2316 (% style="text-align: left;" %)
2317 Ответ:
2318
2319 (% style="text-align: left;" %)
2320 [
2321 {
2322 "vehicleId": 0, ~/~/ идентификатор объекта
2323 "count": 0 ~/~/ количество сообщений за период
2324 }
2325 ]
2326
2327 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2328
2329 (% class="box infomessage" style="text-align: left;" %)
2330 (((
2331 **POST /api/v3/terminalMessages/mapping**
2332 )))
2333
2334 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2335
2336 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2337
2338 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2339
2340 {
2341 "protocolType": 0,
2342 "params": ["string"]
2343 }
2344
2345 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2346 |protocolType|ID типа протокола
2347 |params|(((
2348 Массив наименований параметров в сообщении
2349 )))
2350
2351 Ответ:
2352
2353 {
2354 "protocolType": 0,
2355 "mapping": {
2356 "additionalProp1": {
2357 "inputType": 0,
2358 "inputNumber": 0
2359 },
2360 "additionalProp2": {
2361 "inputType": 0,
2362 "inputNumber": 0
2363 }
2364 }
2365 }
2366
2367 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2368 |protocolType|Тип протокола
2369 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2370 |inputNumber|(((
2371 Номер входа
2372 )))
2373
2374 (% class="wikigeneratedid" %)
2375 Перечень 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/]]
2376
2377 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2378
2379 (% class="box infomessage" %)
2380 (((
2381 **POST /api/v3/terminalMessages**
2382 )))
2383
2384 Метод возвращает список сообщений терминала объекта за выбранный период.
2385
2386 (% style="text-align: left;" %)
2387 Метод запроса **POST**
2388
2389 (% style="text-align: left;" %)
2390 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2391
2392 (% style="text-align: left;" %)
2393 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2394
2395 {
2396 "vehicleId": 0, ~/~/ id объекта
2397 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2398 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2399 }
2400
2401 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2402 |vehicleId|ID объекта
2403 |from|Дата и время начала периода запроса
2404 |to|Дата и время окончания периода запроса
2405
2406 Ответ:
2407
2408 [
2409 {
2410 "messages": [
2411 {
2412 "deviceTime": "2023-11-29T07:40:44.052Z",
2413 "serverTime": "2023-11-29T07:40:44.052Z",
2414 "speed": 0,
2415 "altitude": 0,
2416 "latitude": 0,
2417 "longitude": 0,
2418 "satellites": 0,
2419 "course": 0,
2420 "voltage": 0,
2421 "parameters": {
2422 "additionalProp1": "string",
2423 "additionalProp2": "string",
2424 "additionalProp3": "string"
2425 },
2426 "photoCount": 0,
2427 "lbsCorrectedCoords": true,
2428 "protocolType": 0
2429 }
2430 ]
2431 }
2432 ]
2433
2434 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2435 |deviceTime|Время сообщения терминала
2436 |serverTime|Время когда сообщение поступило на сервер
2437 |speed|Скорость
2438 |altitude|Высота над уровнем моря
2439 |latitude|Широта
2440 |longitude|Долгота
2441 |satellites|Кол-во спутников
2442 |course|Курс
2443 |voltage|Бортовое напряжение
2444 |parameters|Список параметров и их значений
2445 |photoCount|Количество фото
2446 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2447 |protocolType|ID типа протокола
2448
2449 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2450
2451 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2452
2453 (% class="box infomessage" %)
2454 (((
2455 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2456 )))
2457
2458 (% style="color:#000000" %)Метод запроса: **POST**
2459
2460 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2461
2462 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2463
2464 (% style="text-align:left" %)
2465 Тело запроса:
2466
2467 {
2468 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2469 "vehicleIds": [0], ~/~/ Список ID объектов
2470 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2471 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2472 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2473 }
2474
2475 Ответ:
2476
2477 [
2478 {
2479 "vehicleId": 0, ~/~/ ID объекта
2480 "name": "string", ~/~/ Имя ТС
2481 "periods": [ ~/~/ Периоды
2482 {
2483 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2484 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2485 "mileage": 0, ~/~/ Пробег за период, километры
2486 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2487 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2488 "motohours": 0, ~/~/ Моточасы за период, секунды
2489 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2490 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2491 "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2492
2493 }
2494 ]
2495 }
2496 ]
2497
2498 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2499
2500 (% class="box infomessage" %)
2501 (((
2502 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2503 )))
2504
2505 (% style="color:#000000" %)Метод запроса: **POST**
2506
2507 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2508
2509 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2510
2511 (% style="text-align:left" %)
2512 Тело запроса:
2513
2514 {
2515 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2516 "vehicleIds": [0], ~/~/ Список ID объектов
2517 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2518 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2519 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2520 }
2521
2522 Ответ:
2523
2524 [
2525 {
2526 "vehicleId": 0, ~/~/ ID объекта
2527 "name": "string", ~/~/ Имя ТС
2528 "periods": [ ~/~/ Периоды
2529 {
2530 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2531 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2532 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2533 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2534 "fuelConsumption": 0, ~/~/ Расход топлива
2535 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2536 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2537
2538 }
2539 ]
2540 }
2541 ]
2542
2543 (% class="box warningmessage" %)
2544 (((
2545 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2546 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2547 )))
2548
2549 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2550
2551 (% class="box infomessage" %)
2552 (((
2553 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2554 )))
2555
2556 (% style="color:#000000" %)Метод запроса: **POST**
2557
2558 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2559
2560 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2561
2562 (% style="text-align:left" %)
2563 Тело запроса:
2564
2565 {
2566 "vehicleIds": [0], ~/~/ Список ID объектов
2567 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2568 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2569 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2570 }
2571
2572 Ответ:
2573
2574 [
2575 {
2576 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2577 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2578 "vehicleId": 0, ~/~/ ID объекта
2579 "name": "string", ~/~/ Имя объекта
2580 "model": "string", ~/~/ Модель объекта
2581 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2582 {
2583 "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
2584
2585 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2586 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2587 "valueFuel": 0, ~/~/ Количество
2588 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2589 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2590 }
2591 ]
2592 }
2593 ]
2594
2595
2596 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2597
2598 (% class="box infomessage" %)
2599 (((
2600 **POST /api/v3/vehicles/moveStop**
2601 )))
2602
2603 Метод запроса: **POST**
2604
2605 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2606
2607 В заголовках запроса: X-Auth: Токен авторизации
2608
2609
2610 Тело запроса:
2611
2612 {
2613 "vehicleIds": [ ], ~/~/ Список ID объектов
2614 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2615 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2616 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2617 }
2618
2619 Ответ:
2620
2621 [ 
2622 {
2623 "vehicleId": 0, ~/~/ ID объекта
2624 "vehicleName": "string", ~/~/ Имя объекта
2625 "moves": [ ~/~/ Событие движения
2626 {
2627 "mileage": 0, ~/~/ Пробег, км
2628 "eventId": 0, ~/~/ Идентификатор события
2629 "eventName": "string", ~/~/ Название события
2630 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2631 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2632 "duration": 0 ~/~/ Продолжительность события, секунд
2633 }
2634 ],
2635 "stops": [ ~/~/ События стоянок
2636 {
2637 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2638 "eventId": 0, ~/~/ Идентификатор события
2639 "eventName": "string", ~/~/ Название события
2640 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2641 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2642 "duration": 0 ~/~/ Продолжительность события, секунд
2643 }
2644 ]
2645 }
2646 ]
2647
2648
2649 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2650
2651 (% class="box infomessage" %)
2652 (((
2653 **POST /api/v3/vehicles/getlastdata**
2654 )))
2655
2656 Метод запроса: **POST**
2657
2658 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2659
2660 В заголовках запроса: X-Auth: Токен авторизации
2661
2662
2663 В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2664
2665 Ответ:
2666 {
2667 "vehicleId": 0, ~/~/Идентификатор объекта.
2668 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2669 "vehicleNumber": "string",~/~/Номер объекта.
2670 "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2671 "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2672 "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2673 "speed": 0,~/~/Скорость объекта.
2674 "course": 0,~/~/Курс движения [0;360]
2675 "latitude": 0,~/~/Широта [-90°;90°].
2676 "longitude": 0,~/~/Долгота [-180°;180°].
2677 "address": "string",~/~/Адрес.
2678 "geozones": [ ~/~/Сведения по геозонам.
2679 {
2680 "id": 0,
2681 "name": "string"
2682 }
2683
2684
2685 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2686
2687 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2688
2689 (% class="box infomessage" %)
2690 (((
2691 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2692 )))
2693
2694 (% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2695
2696 (% style="color:#000000" %)Метод запроса: **POST**
2697
2698 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2699
2700 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2701
2702 (% style="text-align:left" %)
2703 Тело запроса:
2704
2705 (% style="text-align:left" %)
2706 {
2707 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2708 }
2709
2710 (% style="text-align:left" %)
2711 Ответ:
2712
2713 [
2714 {
2715 "id": 0, ~/~/ Идентификатор объекта геозоны
2716 "name": "string", ~/~/ Название объекта геозоны
2717 "type": 0, ~/~/ Тип объекта геозоны
2718 "fname": "string", ~/~/ Имя файла
2719 "parentId": "string", ~/~/ Идентификатор клиента
2720 "radius": 0, ~/~/ Радиус геообъекта
2721 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2722 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2723 "description": "string", ~/~/ Описание
2724 "area": 0, ~/~/ Площадь, м^^2^^
2725 "perimetr": 0, ~/~/ Периметр, м
2726 "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2727 }
2728 ]
2729
2730 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2731
2732 (% class="box infomessage" %)
2733 (((
2734 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2735 )))
2736
2737 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2738
2739 (% style="color:#000000" %)Метод запроса: **POST**
2740
2741 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2742
2743 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2744
2745 (% style="text-align:left" %)
2746 Тело запроса:
2747
2748 {
2749 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2750 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2751 "ids": [ ], ~/~/ Массив id объектов
2752 "byTime": 0, ~/~/ Объединение событий по времени 
2753 "byDist": 0, ~/~/ Объединение событий по расстоянию
2754 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2755 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2756 }
2757
2758 Ответ:
2759 [
2760 {
2761 "geozoneId": 0, ~/~/ ID геообъекта
2762 "geozoneName": "string", ~/~/ Название геообъекта
2763 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2764 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2765 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2766 "vehicleId": 0, ~/~/ ID объекта
2767 "vehicleName": "string" ~/~/ Имя объекта
2768 }
2769 ]
2770
2771 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2772
2773 (% class="box infomessage" %)
2774 (((
2775 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2776 )))
2777
2778 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2779
2780 (% style="color:#000000" %)Метод запроса: **POST**
2781
2782 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2783
2784 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2785
2786 (% style="text-align:left" %)
2787 Тело запроса:
2788
2789 {
2790 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2791 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2792 "ids": [ ], ~/~/ Массив id геообъектов
2793 "byTime": 0, ~/~/ Объединение событий по времени 
2794 "byDist": 0, ~/~/ Объединение событий по расстоянию
2795 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2796 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2797 }
2798
2799 Ответ:
2800
2801 [
2802 {
2803 "geozoneId": 0, ~/~/ ID геообъекта
2804 "geozoneName": "string", ~/~/ Название геообъекта
2805 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2806 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2807 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2808 "vehicleId": 0, ~/~/ ID объекта
2809 "vehicleName": "string" ~/~/ Имя объекта
2810 }
2811 ]
2812
2813
2814 == (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2815
2816 (% class="box successmessage" %)
2817 (((
2818 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2819 )))
2820
2821 (% style="color:#000000" %)Метод запроса: **PUT**
2822
2823 Пример запроса:
2824
2825 (((
2826 {
2827 "id": 0,  ~/~/ Идентификатор объекта геозоны
2828 "name": "string",  ~/~/ Наименование объекта геозоны
2829 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2830 "description": "string", ~/~/ Описание объекта геозоны
2831 "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2832 "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2833 "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2834 }
2835 )))
2836
2837
2838 Пример ответа:
2839
2840 200 ~/~/ Success
2841
2842 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2843
2844 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2845
2846 (% class="box infomessage" %)
2847 (((
2848 **POST /api/v3/notifications/find**
2849 )))
2850
2851 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2852
2853 (% style="text-align: left;" %)
2854 Метод запроса **POST**
2855
2856 (% style="text-align: left;" %)
2857 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2858
2859 (% style="text-align: left;" %)
2860 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2861
2862 {
2863 "parentId": "" ~/~/ id клиента
2864 }
2865
2866 Ответ:
2867
2868 [
2869 {
2870 "id": 0, ~/~/ ID уведомления
2871 "name": "string", ~/~/ Название уведомления
2872 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2873 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2874 "userId": "", ~/~/ Пользователь, создавший уведомление
2875 "parentId": "", ~/~/ Идентификатор клиента
2876 "parentName": "string" ~/~/ Имя клиента
2877 }
2878 ]
2879
2880 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2881
2882 (% class="box infomessage" %)
2883 (((
2884 **GET /api/v3/notifications/{id}**
2885 )))
2886
2887 Метод возвращает данные правил формирования выбранного уведомления.
2888
2889 (% style="text-align: left;" %)
2890 Метод запроса **GET**
2891
2892 (% style="text-align: left;" %)
2893 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2894
2895 (% style="text-align: left;" %)
2896 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2897
2898 (% style="text-align: left;" %)
2899 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2900
2901 (% style="text-align: left;" %)
2902 (% style="color:#000000" %)Ответ:
2903
2904 (% style="text-align: left;" %)
2905 (% style="color:#000000" %){
2906 "id": 0, ~/~/ (%%)id уведомления
2907 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2908 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2909 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2910 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2911 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2912 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2913 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2914 (% style="color:#000000" %) 0
2915 ],
2916 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2917 (% style="color:#000000" %) 0
2918 ],
2919 "fieldids": [ ~/~/ (%%)Список id полей для анализа
2920 (% style="color:#000000" %) 0
2921 ],
2922 "settings": { ~/~/ Список параметров уведомления
2923 "additionalProp1": "string",
2924 "additionalProp2": "string",
2925 "additionalProp3": "string"
2926 },
2927 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2928 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2929 (% style="color:#000000" %) ""
2930 ],
2931 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2932 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2933 (% style="color:#000000" %) "string"
2934 ],
2935 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2936 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2937 (% style="color:#000000" %) {
2938 "id": 0, ~/~/ (%%)Идентификатор участника чата
2939 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2940 (% style="color:#000000" %) }
2941 ],
2942 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2943 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2944 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2945 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2946 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2947 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2948 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2949 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2950 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2951 (% style="color:#000000" %)}
2952
2953 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2954
2955 (% class="box warningmessage" %)
2956 (((
2957 **PUT /api/v3/notifications/**
2958 )))
2959
2960 Метод позволяет отредактировать уведомление.
2961
2962 Метод запроса **PUT**
2963
2964 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2965
2966 В заголовках запроса: X-Auth: Токен авторизации
2967
2968 Тело запроса:
2969 {
2970 "id": 0, ~/~/ id уведомления
2971 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2972 "userId": "", ~/~/ Пользователь, создавший уведомление
2973 "parentId": "", ~/~/ Идентификатор клиента
2974 "parentName": "string", ~/~/ Имя клиента
2975 "name": "string", ~/~/ Название уведомления
2976 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2977 "vehicleIds": [ ~/~/ Список id объектов для анализа
2978 0
2979 ],
2980 "geoids": [ ~/~/ Список id геообъектов для анализа
2981 0
2982 ],
2983 "fieldids": [ ~/~/ Список id полей для анализа
2984 0
2985 ],
2986 "settings": { ~/~/ Список параметров уведомления
2987 "additionalProp1": "string",
2988 "additionalProp2": "string",
2989 "additionalProp3": "string"
2990 },
2991 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2992 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2993 ""
2994 ],
2995 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2996 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2997 "string"
2998 ],
2999 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
3000 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
3001 {
3002 "id": 0, ~/~/ Идентификатор участника чата
3003 "info": "string" ~/~/ Дополнительные сведения
3004 }
3005 ],
3006 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
3007 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
3008 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
3009 "kind": 0, ~/~/ Определяет вид уведомления
3010 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
3011 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
3012 "timezone": 0, ~/~/ Сдвиг часового пояса
3013 "validity": 0, ~/~/ Срок действия в днях (1-90)
3014 "autoProlongation": true ~/~/ Автопродление срока действия
3015 }
3016
3017 Ответ:
3018
3019 Success
3020
3021
3022 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
3023
3024 (% class="box warningmessage" %)
3025 (((
3026 **PUT** /api/v3/notifications/prolongation
3027 )))
3028
3029 Метод позволяет продлить уведомления.
3030
3031 Метод запроса **PUT**
3032
3033 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
3034
3035 В заголовках запроса: X-Auth: Токен авторизации.
3036
3037 Тело запроса:
3038
3039 [
3040
3041 0
3042
3043 ]
3044
3045 где 0 идентификатор ids.
3046
3047 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
3048
3049 (% class="box errormessage" %)
3050 (((
3051 **DELETE /api/v3/notifications/{id}**
3052 )))
3053
3054 Метод позволяет удалить выбранное уведомление.
3055
3056 Метод запроса **DELETE**
3057
3058 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3059
3060 Передаваемый параметр: {id} - id уведомления
3061
3062 В заголовках запроса: X-Auth: Токен авторизации
3063
3064 Ответ:
3065
3066 Success
3067
3068
3069 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3070
3071 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3072
3073 (% class="box infomessage" %)
3074 (((
3075 **POST /api/v3/Drivers/find**
3076 )))
3077
3078 Передается параметр: parentId - ID клиента-родителя
3079
3080 Ответ:
3081
3082 [
3083 {
3084 "name": "string", ~/~/ Определяет наименование
3085 "description": "string", ~/~/ Определяет описание
3086 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3087 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3088 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3089 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3090 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3091 "deleted": true ~/~/ Признак удаления
3092 }
3093 ]
3094
3095 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3096
3097 (% class="box infomessage" %)
3098 (((
3099 **GET /api/v3/Drivers/{driverGuid}**
3100 )))
3101
3102 Передается параметр: ID водителя
3103
3104 Ответ:
3105
3106 {
3107 "name": "string", ~/~/ Определяет наименование
3108 "description": "string", ~/~/ Определяет описание
3109 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3110 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3111 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3112 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3113 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3114 "deleted": true ~/~/ Признак удаления
3115 }
3116
3117 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3118
3119 (% class="box successmessage" %)
3120 (((
3121 **POST /api/v3/Drivers**
3122 )))
3123
3124 Запрос:
3125
3126 {
3127 "name": "string",
3128 "description": "string",
3129 "hiredate": "2023-06-30T12:50:54.020Z",
3130 "chopdate": "2023-06-30T12:50:54.020Z",
3131 "exclusive": true,
3132 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3133 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3134 "deleted": true
3135 }
3136
3137 Ответ:
3138
3139 {
3140 "name": "string",
3141 "description": "string",
3142 "hiredate": "2023-06-30T12:50:54.051Z",
3143 "chopdate": "2023-06-30T12:50:54.051Z",
3144 "exclusive": true,
3145 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3146 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3147 "deleted": true
3148 }
3149
3150
3151 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3152
3153 (% class="box warningmessage" %)
3154 (((
3155 **PUT /api/v3/Drivers**
3156 )))
3157
3158 Запрос:
3159
3160 {
3161 "name": "string",
3162 "description": "string",
3163 "hiredate": "2023-06-30T12:50:27.910Z",
3164 "chopdate": "2023-06-30T12:50:27.910Z",
3165 "exclusive": true,
3166 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3167 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3168 "deleted": true
3169 }
3170
3171 Ответ:
3172
3173 {
3174 "name": "string",
3175 "description": "string",
3176 "hiredate": "2023-06-30T12:50:27.929Z",
3177 "chopdate": "2023-06-30T12:50:27.929Z",
3178 "exclusive": true,
3179 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3180 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3181 "deleted": true
3182 }
3183
3184
3185 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3186
3187 (% class="box errormessage" %)
3188 (((
3189 **DELETE /api/v3/Drivers/{driverGuid}**
3190 )))
3191
3192 Передается параметр: ID водителя
3193
3194 Ответ:
3195
3196 Success
3197
3198
3199 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3200
3201 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3202
3203 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3204
3205 (% class="box infomessage" %)
3206 (((
3207 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3208 )))
3209
3210 Запрос:
3211
3212 {
3213 "Ids": [
3214 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3215 ],
3216 "BeginTime": "2023-06-30T12:49:04.365Z",
3217 "EndTime": "2023-06-30T12:49:04.365Z"
3218 }
3219
3220 Ответ:
3221
3222 [
3223 {
3224 "VehicleId": 0,
3225 "CreateTime": "2023-06-30T09:52:31.240Z",
3226 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3227 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3228 "BeginTime": "2023-06-30T09:52:31.240Z",
3229 "EndTime": "2023-06-30T09:52:31.240Z"
3230 }
3231 ]
3232
3233
3234 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3235
3236 (% class="box infomessage" %)
3237 (((
3238 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3239 )))
3240
3241 Запрос:
3242
3243 {
3244 "Ids": [
3245 0
3246 ],
3247 "BeginTime": "2023-06-30T12:48:39.419Z",
3248 "EndTime": "2023-06-30T12:48:39.419Z"
3249 }
3250
3251 Ответ:
3252
3253 [
3254 {
3255 "VehicleId": 0,
3256 "CreateTime": "2023-06-30T09:54:01.631Z",
3257 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3258 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3259 "BeginTime": "2023-06-30T09:54:01.631Z",
3260 "EndTime": "2023-06-30T09:54:01.631Z"
3261 }
3262 ]
3263
3264
3265 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3266
3267 (% class="box successmessage" %)
3268 (((
3269 **POST /api/v3/DriversVehiclesAssignments**
3270 )))
3271
3272 Передается массив назначений
3273
3274 Запрос:
3275
3276 [
3277 {
3278 "VehicleId": 0, ~/~/ Идентификатор объекта
3279 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3280 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3281 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3282 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3283 }
3284 ]
3285
3286 Ответ:
3287
3288 [
3289 {
3290 "VehicleId": 0,
3291 "CreateTime": "2023-06-30T11:04:46.903Z",
3292 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3293 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3294 "BeginTime": "2023-06-30T11:04:46.903Z",
3295 "EndTime": "2023-06-30T11:04:46.903Z"
3296 }
3297 ]
3298
3299
3300 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3301
3302 (% class="box warningmessage" %)
3303 (((
3304 **PUT /api/v3/DriversVehiclesAssignments**
3305 )))
3306
3307 Запрос:
3308
3309 [
3310 {
3311 "VehicleId": 0,
3312 "CreateTime": "2023-06-30T11:14:08.117Z",
3313 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3314 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3315 "BeginTime": "2023-06-30T11:14:08.117Z",
3316 "EndTime": "2023-06-30T11:14:08.117Z"
3317 }
3318 ]
3319
3320 Ответ:
3321
3322 [
3323 {
3324 "VehicleId": 0,
3325 "CreateTime": "2023-06-30T11:14:53.349Z",
3326 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3327 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3328 "BeginTime": "2023-06-30T11:14:53.349Z",
3329 "EndTime": "2023-06-30T11:14:53.349Z"
3330 }
3331 ]
3332
3333
3334 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3335
3336 (% class="box errormessage" %)
3337 (((
3338 **DELETE /api/v3/DriversVehiclesAssignments**
3339 )))
3340
3341 Запрос:
3342
3343 [
3344 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3345 ]
3346
3347 Ответ:
3348
3349 Success
3350
3351
3352 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3353
3354 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3355
3356 (% class="box infomessage" %)
3357 (((
3358 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3359 )))
3360
3361 Запрос:
3362
3363 {
3364 "Ids": [
3365 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3366 ],
3367 "BeginTime": "2023-06-30T12:47:12.162Z",
3368 "EndTime": "2023-06-30T12:47:12.162Z"
3369 }
3370
3371 Ответ:
3372
3373 [
3374 {
3375 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3376 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3377 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3378 "BeginTime": "2023-06-30T11:19:40.703Z",
3379 "EndTime": "2023-06-30T11:19:40.703Z"
3380 }
3381 ]
3382
3383
3384 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3385
3386 (% class="box infomessage" %)
3387 (((
3388 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3389 )))
3390
3391 Запрос:
3392
3393 {
3394 "Ids": [
3395 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3396 ],
3397 "BeginTime": "2023-06-30T12:47:12.162Z",
3398 "EndTime": "2023-06-30T12:47:12.162Z"
3399 }
3400
3401 Ответ:
3402
3403 [
3404 {
3405 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3406 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3407 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3408 "BeginTime": "2023-06-30T11:19:40.703Z",
3409 "EndTime": "2023-06-30T11:19:40.703Z"
3410 }
3411 ]
3412
3413
3414 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3415
3416 (% class="box successmessage" %)
3417 (((
3418 **POST /api/v3/DriversRfidsAssignments**
3419 )))
3420
3421 Запрос:
3422
3423 [
3424 {
3425 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3426 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3427 "BeginTime": "2023-06-30T11:27:08.635Z",
3428 "EndTime": "2023-06-30T11:27:08.635Z"
3429 }
3430 ]
3431
3432 Ответ:
3433
3434 [
3435 {
3436 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3437 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3438 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3439 "BeginTime": "2023-06-30T11:27:08.677Z",
3440 "EndTime": "2023-06-30T11:27:08.677Z"
3441 }
3442 ]
3443
3444
3445 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3446
3447 (% class="box warningmessage" %)
3448 (((
3449 **PUT /api/v3/DriversRfidsAssignments**
3450 )))
3451
3452 Запрос:
3453
3454 [
3455 {
3456 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3457 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3458 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3459 "BeginTime": "2023-06-30T11:28:43.330Z",
3460 "EndTime": "2023-06-30T11:28:43.330Z"
3461 }
3462 ]
3463
3464 Ответ:
3465
3466 [
3467 {
3468 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3469 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3470 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3471 "BeginTime": "2023-06-30T11:28:43.331Z",
3472 "EndTime": "2023-06-30T11:28:43.331Z"
3473 }
3474 ]
3475
3476
3477 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3478
3479 (% class="box errormessage" %)
3480 (((
3481 **DELETE /api/v3/DriversRfidsAssignments**
3482 )))
3483
3484 Запрос:
3485
3486 [
3487 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3488 ]
3489
3490 Ответ:
3491
3492 Success
3493
3494
3495 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3496
3497 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3498
3499 (% class="box infomessage" %)
3500 (((
3501 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3502 )))
3503
3504 Запрос:
3505
3506 {
3507 "Ids": [
3508 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3509 ],
3510 "BeginTime": "2023-06-30T12:45:10.852Z",
3511 "EndTime": "2023-06-30T12:45:10.852Z"
3512 }
3513
3514 Ответ:
3515
3516 [
3517 {
3518 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3520 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3521 "BeginTime": "2023-06-30T11:58:04.695Z",
3522 "EndTime": "2023-06-30T11:58:04.695Z"
3523 }
3524 ]
3525
3526
3527 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3528
3529 (% class="box infomessage" %)
3530 (((
3531 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3532 )))
3533
3534 Запрос:
3535
3536 {
3537 "Ids": [
3538 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3539 ],
3540 "BeginTime": "2023-06-30T12:45:10.852Z",
3541 "EndTime": "2023-06-30T12:45:10.852Z"
3542 }
3543
3544 Ответ:
3545
3546 [
3547 {
3548 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3549 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3550 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3551 "BeginTime": "2023-06-30T11:58:04.695Z",
3552 "EndTime": "2023-06-30T11:58:04.695Z"
3553 }
3554 ]
3555
3556
3557 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3558
3559 (% class="box successmessage" %)
3560 (((
3561 **POST /api/v3/DriversFuelCardsAssignments**
3562 )))
3563
3564 Запрос:
3565
3566 [
3567 {
3568 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3569 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3570 "BeginTime": "2023-06-30T12:09:53.175Z",
3571 "EndTime": "2023-06-30T12:09:53.175Z"
3572 }
3573 ]
3574
3575 Ответ:
3576
3577 [
3578 {
3579 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3580 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3581 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3582 "BeginTime": "2023-06-30T12:09:53.201Z",
3583 "EndTime": "2023-06-30T12:09:53.201Z"
3584 }
3585 ]
3586
3587
3588 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3589
3590 (% class="box warningmessage" %)
3591 (((
3592 **PUT /api/v3/DriversFuelCardsAssignments**
3593 )))
3594
3595 Запрос:
3596
3597 [
3598 {
3599 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3600 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3601 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3602 "BeginTime": "2023-06-30T12:09:53.201Z",
3603 "EndTime": "2023-06-30T12:09:53.201Z"
3604 }
3605 ]
3606
3607 Ответ:
3608
3609 [
3610 {
3611 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3612 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3613 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3614 "BeginTime": "2023-06-30T12:09:53.201Z",
3615 "EndTime": "2023-06-30T12:09:53.201Z"
3616 }
3617 ]
3618
3619
3620 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3621
3622 (% class="box errormessage" %)
3623 (((
3624 **DELETE /api/v3/DriversFuelCardsAssignments**
3625 )))
3626
3627 Запрос:
3628
3629 [
3630 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3631 ]
3632
3633 Ответ:
3634
3635 Success
3636
3637
3638 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3639
3640 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3641
3642 (% class="box infomessage" %)
3643 (((
3644 **POST /api/v3/Trailers**
3645 )))
3646
3647 Пример запроса:
3648
3649 {
3650 "startDate": "2023-11-14T10:48:03.671Z",
3651 "endDate": "2023-11-14T10:48:03.671Z",
3652 "ids": [ 0 ],
3653 "timezone": 0
3654 }
3655
3656 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3657 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3658 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3659 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3660 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3661
3662 Пример ответа:
3663
3664 [
3665 {
3666 "SD": "2023-11-14T10:48:03.717Z",
3667 "ED": "2023-11-14T10:48:03.717Z", 
3668 "id": 0,
3669 "SLat": 0,
3670 "SLon": 0,
3671 "ELat": 0,
3672 "ELon": 0,
3673 "mileage": 0
3674 "Duration": 0
3675 "Address": "string",
3676 "Address2": "string",
3677 "name": "string",
3678 "rid": "string",
3679 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3680 "trailer": {
3681 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3682 "Number": "string",
3683 "Description": "string",
3684 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3685 "ExternalID": "string",
3686 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3687 "CreateTime": "2023-11-14T10:48:03.717Z",
3688 "UpdateTime": "2023-11-14T10:48:03.717Z",
3689 "IsDeleted": true
3690 },
3691 "filesCount": 0,
3692 }
3693 ]
3694
3695 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3696 |SD|Дата и время начала события
3697 |ED|Дата и время окончания события
3698 |id|ID объекта
3699 |SLat|Широта начальной координаты
3700 |SLon|Долгота начальной координаты
3701 |ELat|Широта конечной координаты
3702 |ELon|Долгота конечной координаты
3703 |mileage|Пробег
3704 |Duration|Продолжительность
3705 |Address|Адрес начального местоположения
3706 |Address2|Адрес конечного местоположения
3707 |name|Имя радиометки
3708 |rid|Номер радиометки
3709 |rguid|ID радиометки
3710 |trailer|Информация об агрегате
3711 |ModelGuid|ID агрегата
3712 |Number|Название/номер агрегата
3713 |Description|Текст примечания агрегата
3714
3715 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3716
3717 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3718
3719 (% class="box infomessage" %)
3720 (((
3721 **POST /api/v3/Rfids/find**
3722 )))
3723
3724 Запрос:
3725
3726 {
3727 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3728 }
3729
3730 Ответ:
3731
3732 [
3733 {
3734 "name": "string",
3735 "number": 0,
3736 "period": 0,
3737 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3738 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3739 }
3740 ]
3741
3742 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3743 |parentId|ID клиента
3744 |name|Название карты-метки
3745 |number|Номер
3746 |period|Период запросов в секундах (работает только для агрегатов)
3747 |id|ID карты-метки
3748
3749 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3750
3751 (% class="box infomessage" %)
3752 (((
3753 **GET /api/v3/Rfids/{rfidGuid}**
3754 )))
3755
3756 Передаем параметр rfidGuid - идентификатор карты-метки
3757
3758 Ответ:
3759
3760 [
3761 {
3762 "name": "string",
3763 "number": 0,
3764 "period": 0,
3765 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3766 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3767 }
3768 ]
3769
3770 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3771 |name|Название карты-метки
3772 |number|Номер
3773 |period|Период запросов в секундах (работает только для агрегатов)
3774 |id|ID карты-метки
3775 |parentId|ID клиента
3776
3777 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3778
3779 (% class="box successmessage" %)
3780 (((
3781 **POST /api/v3/Rfids**
3782 )))
3783
3784 Запрос:
3785
3786 {
3787 "name": "string",
3788 "number": 0,
3789 "period": 0,
3790 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3791 }
3792
3793 Ответ:
3794
3795 {
3796 "name": "string",
3797 "number": 0,
3798 "period": 0,
3799 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3800 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3801 }
3802
3803 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3804 |name|Название карты-метки
3805 |number|Номер
3806 |period|Период запросов в секундах (работает только для агрегатов)
3807 |id|ID карты-метки
3808 |parentId|ID клиента
3809
3810 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3811
3812 (% class="box warningmessage" %)
3813 (((
3814 **PUT /api/v3/Rfids**
3815 )))
3816
3817 Запрос:
3818
3819 {
3820 "name": "string",
3821 "number": 0,
3822 "period": 0,
3823 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3824 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3825 }
3826
3827 Ответ:
3828
3829 {
3830 "name": "string",
3831 "number": 0,
3832 "period": 0,
3833 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3834 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3835 }
3836
3837 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3838 |name|Название карты-метки
3839 |number|Номер
3840 |period|Период запросов в секундах (работает только для агрегатов)
3841 |id|ID карты-метки
3842 |parentId|ID клиента
3843
3844 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3845
3846 (% class="box errormessage" %)
3847 (((
3848 **DELETE /api/v3/Rfids/{rfidGuid}**
3849 )))
3850
3851 Передаем параметр **rfidGuid** - идентификатор карты-метки
3852
3853 Ответ:
3854
3855 Success
3856
3857
3858 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3859
3860 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3861
3862 (% class="box infomessage" %)
3863 (((
3864 **GET /api/v3/Billing/client/balance/{clientId}**
3865 )))
3866
3867 Параметр запроса: **clientId **- идентификатор клиента.
3868
3869 Ответ:
3870
3871 {
3872 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3873 "Balance": 0
3874 }
3875
3876 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3877 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3878 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3879
3880 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3881
3882 (% class="box infomessage" %)
3883 (((
3884 **GET /api/v3/Billing/client/constraint/{clientId}**
3885 )))
3886
3887 Параметр запроса: **clientId **- идентификатор клиента.
3888
3889 Ответ:
3890
3891 {
3892 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3893 "CalculationType": 0,
3894 "PermissibleBalance": 0,
3895 "DefermentDays": 0,
3896 "SendUiNotifications": true,
3897 "SendEmailNotifications": true,
3898 "IsPrivate": true,
3899 }
3900
3901 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3902 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3903 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3904 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3905 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3906 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3907 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3908 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3909
3910 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3911
3912 (% class="box infomessage" %)
3913 (((
3914 **GET /api/v3/Billing/client/plan/{clientId}**
3915 )))
3916
3917 Параметры запроса:
3918
3919 **clientId **- идентификатор клиента.
3920
3921 **planId **- идентификатор тарифного плана.
3922
3923 Ответ:
3924
3925 {
3926 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3927 "Plan": { **~/~/ Описание тарифного плана**
3928 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3929 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3930 "Name": "string",
3931 "IsArchived": true,
3932 "Constraint": {
3933 "CalculationType": 0,
3934 "PermissibleBalance": 0,
3935 "DefermentDays": 0
3936 },
3937 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3938 {
3939 "Feature": "string",
3940 "IsFactual": true,
3941 "Limit": 0,
3942 "Price": 0,
3943 "PeriodValue": 0,
3944 "PeriodType": 0
3945 }
3946 ]
3947 },
3948 "DebitDate": "2023-10-18T12:46:24.213Z",
3949 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3950 {
3951 "Feature": "string",
3952 "IsEnabled": true,
3953 "IsPrivate": true,
3954 "IsFactual": true,
3955 "Limit": 0,
3956 "Price": 0,
3957 "DebitDate": "2023-10-18T12:46:24.213Z",
3958 "PeriodValue": 0,
3959 "PeriodType": 0
3960 }
3961 ]
3962 }
3963
3964 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3965 |ClientId|Идентификатор клиента
3966 |Id|Идентификатор тарифного плана
3967 |OwnerId|Идентификатор клиента-владельца
3968 |Name|Наименование тарифного плана
3969 |IsArchived|Признак, определяющий архивный тарифный план
3970 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3971 |PermissibleBalance|Допустимый баланс
3972 |DefermentDays|Отсрочка, количество дней
3973 |Feature|Код услуги
3974 |IsEnabled|Признак, определяющий активирована ли услуга
3975 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3976 |IsFactual|Признак, определяющий расчёт по факту
3977 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3978 |Price|Цена за единицу.
3979 |DebitDate|Следующий момент времени списания с баланса за услугу.
3980 |PeriodValue|Значение периода.
3981 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3982
3983 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3984
3985 (% class="box infomessage" %)
3986 (((
3987 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3988 )))
3989
3990 Параметр запроса: **clientId **- идентификатор клиента.
3991
3992 Ответ:
3993
3994 [
3995 {
3996 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3997 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3998 "Name": "string",
3999 "IsArchived": true,
4000 "Constraint": {
4001 "CalculationType": 0,
4002 "PermissibleBalance": 0,
4003 "DefermentDays": 0
4004 },
4005 "Features": [
4006 {
4007 "Feature": "string",
4008 "IsFactual": true,
4009 "Limit": 0,
4010 "Price": 0,
4011 "PeriodValue": 0,
4012 "PeriodType": 0
4013 }
4014 ]
4015 }
4016 ]
4017
4018 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4019 |ClientId|Идентификатор клиента
4020 |Id|Идентификатор тарифного плана
4021 |OwnerId|Идентификатор клиента-владельца
4022 |Name|Наименование тарифного плана
4023 |IsArchived|Признак, определяющий архивный тарифный план
4024 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4025 |PermissibleBalance|Допустимый баланс
4026 |DefermentDays|Отсрочка, количество дней
4027 |Feature|Код услуги
4028 |IsFactual|Признак, определяющий расчёт по факту
4029 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4030 |Price|Цена за единицу.
4031 |PeriodValue|Значение периода.
4032 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4033
4034 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
4035
4036 (% class="box infomessage" %)
4037 (((
4038 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
4039 )))
4040
4041 Параметр запроса: **clientId **- идентификатор клиента.
4042
4043 Ответ:
4044
4045 [
4046 {
4047 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4048 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4049 "Name": "string",
4050 "IsArchived": true,
4051 "Constraint": {
4052 "CalculationType": 0,
4053 "PermissibleBalance": 0,
4054 "DefermentDays": 0
4055 },
4056 "Features": [
4057 {
4058 "Feature": "string",
4059 "IsFactual": true,
4060 "Limit": 0,
4061 "Price": 0,
4062 "PeriodValue": 0,
4063 "PeriodType": 0
4064 }
4065 ]
4066 }
4067 ]
4068
4069 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4070 |ClientId|Идентификатор клиента
4071 |Id|Идентификатор тарифного плана
4072 |OwnerId|Идентификатор клиента-владельца
4073 |Name|Наименование тарифного плана
4074 |IsArchived|Признак, определяющий архивный тарифный план
4075 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4076 |PermissibleBalance|Допустимый баланс
4077 |DefermentDays|Отсрочка, количество дней
4078 |Feature|Код услуги
4079 |IsFactual|Признак, определяющий расчёт по факту
4080 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4081 |Price|Цена за единицу.
4082 |PeriodValue|Значение периода.
4083 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4084
4085 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4086
4087 (% class="box warningmessage" %)
4088 (((
4089 **PUT /api/v3/Billing/client/balance**
4090 )))
4091
4092 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4093
4094 Тело запроса:
4095
4096 {
4097 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4098 "Balance": 0
4099 }
4100
4101 Ответ: Success
4102
4103 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4104 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4105 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4106
4107 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4108
4109 (% class="box warningmessage" %)
4110 (((
4111 **PUT /api/v3/billing/client/balance/deposit**
4112 )))
4113
4114 Создает операцию **Пополнение **с указанной суммой
4115
4116 Тело запроса:
4117
4118 {
4119 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4120 "Balance": 0
4121 }
4122
4123 Ответ: Success
4124
4125 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4126 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4127 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4128
4129 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4130
4131 Создает операцию **Списание **с указанной суммой
4132
4133 (% class="box warningmessage" %)
4134 (((
4135 **PUT /api/v3/billing/client/balance/withdraw**
4136 )))
4137
4138 Тело запроса:
4139
4140 {
4141 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4142 "Balance": 0
4143 }
4144
4145 Ответ: Success
4146
4147 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4148 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4149 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4150
4151 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4152
4153 (% class="box warningmessage" %)
4154 (((
4155 **PUT /api/v3/Billing/client/constraint**
4156 )))
4157
4158 Тело запроса:
4159
4160 {
4161 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4162 "CalculationType": 0,
4163 "PermissibleBalance": 0,
4164 "DefermentDays": 0,
4165 "SendUiNotifications": true,
4166 "SendEmailNotifications": true,
4167 "IsPrivate": true,
4168 }
4169
4170 Ответ: Success
4171
4172 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4173 |ClientId|Идентификатор клиента
4174 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4175 |PermissibleBalance|Допустимый баланс
4176 |DefermentDays|(((
4177 Отсрочка, количество дней
4178 )))
4179 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4180 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4181 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4182
4183 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4184
4185 (% class="box warningmessage" %)
4186 (((
4187 **PUT /api/v3/Billing/client/plan**
4188 )))
4189
4190 Тело запроса:
4191
4192 {
4193 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4194 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4195 "Features": [
4196 {
4197 "Feature": "string",
4198 "IsEnabled": true,
4199 "IsFactual": true,
4200 "Limit": 0,
4201 "Price": 0,
4202 "DebitDate": "2023-10-18T13:26:58.987Z",
4203 "PeriodValue": 0,
4204 "PeriodType": 0
4205 }
4206 ]
4207 }
4208
4209 Ответ: Success
4210
4211 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4212 |ClientId|Идентификатор клиента
4213 |PlanId|Идентификатор тарифного плана
4214 |Feature|Код услуги
4215 |IsEnabled|Признак, определяющий активирована ли услуга
4216 |IsFactual|Признак, определяющий расчёт по факту
4217 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4218 |Price|Цена за единицу.
4219 |DebitDate|Следующий момент времени списания с баланса за услугу.
4220 |PeriodValue|Значение периода.
4221 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4222
4223 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4224
4225 (% class="box warningmessage" %)
4226 (((
4227 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4228 )))
4229
4230 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4231
4232 (% class="box infomessage" %)
4233 (((
4234 **POST /api/v3/vehicles/import/{agentId}**
4235 )))
4236
4237 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4238
4239 В пути указывается **agentId** - id клиента.
4240
4241 **Заголовок**
4242
4243 **X-Auth: [токен авторизации]**
4244
4245 **Параметры**
4246
4247 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4248 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4249 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4250
4251 В теле использовать тип **form-data,** тип значения** file**
4252
4253 **Ключи**
4254
4255 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4256 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4257 |csv|В значении передаем файл датчиков, формат **csv**
4258
4259 Ответ:
4260
4261 {
4262 "vehicleId": 0,
4263 "name": "string",
4264 "errors": ["string"]
4265 }
4266
4267 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4268 |vehicleId|ID созданного объекта
4269 |name|Имя созданного объекта
4270 |errors|Ошибки и их описание
4271
4272 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4273
4274 (% class="box infomessage" %)
4275 (((
4276 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4277 )))
4278
4279 (% class="wikigeneratedid" %)
4280 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4281
4282 (% class="wikigeneratedid" %)
4283 В пути указывается **vehicleId **- id объекта.
4284
4285 **Заголовок**
4286
4287 **X-Auth: [токен авторизации]**
4288
4289 В теле использовать тип **form-data.**
4290
4291 Ключи:
4292
4293 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4294 |**history**|В значении передавать файл с историей
4295
4296 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4297
4298 Ответ:
4299
4300 {
4301 "results": [
4302 {
4303 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4304 "vehicleId": 0,
4305 "errors": [
4306 "string"
4307 ],
4308 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4309 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4310 "producedCount": 0,
4311 "msgCount": 0
4312 }
4313 ]
4314 }
4315
4316 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4317 |results|Результаты импорта в разрезе ТС
4318 |vehicleGuid|Guid ТС
4319 |vehicleId|ID ТС
4320 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4321 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4322 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4323 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4324 |msgCount|Кол-во обработанных сообщений всего
4325
4326 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4327
4328 (% class="box infomessage" %)
4329 (((
4330 **GET /api/v3/vehicles/import/history/status**
4331 )))
4332
4333 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4334
4335 Ответ:
4336
4337 {
4338 "activity": true,
4339 "progress": 0,
4340 "message": "string"
4341 }
4342
4343 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4344 |activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4345 |progress|Guid ТС
4346
4347 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4348
4349 (% class="box infomessage" %)
4350 (((
4351 **POST /api/v3/vehicles/export**
4352 )))
4353
4354 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4355
4356 Тело запроса:
4357
4358 [
4359 id
4360 ]
4361
4362 Ответ: Success 200, получаете файлы с настройками.
4363
4364 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4365
4366 (% class="box infomessage" %)
4367 (((
4368 **POST /api/v3/vehicles/export/history**
4369 )))
4370
4371 Метод возвращает список сообщений терминала объекта за выбранный период.
4372
4373 Тело запроса:
4374
4375 {
4376 "vehicleId": 0,
4377 "asArchive": true,
4378 "from": "2023-09-27T12:17:45.973Z",
4379 "to": "2023-09-27T12:17:45.973Z"
4380 }
4381
4382 Ответ:
4383
4384 Получаете файл. Сообщение: Code 200/Success
4385
4386 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4387 |vehicleId|ID объекта
4388 |asArchive|true - Архивировать файл, False - не архивировать
4389 |from|Дата и время начала запроса
4390 |to|Дата и время окончания запроса
4391
4392 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4393
4394 (% class="box infomessage" %)
4395 (((
4396 **GET /api/v3/vehicles/export/history/status**
4397 )))
4398
4399 Метод возвращает список сообщений терминала объекта за выбранный период.
4400
4401 Ответ:
4402
4403 {
4404 "activity": true,
4405 "progress": 0,
4406 "message": "string"
4407 }
4408
4409 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4410 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4411 |progress|Прогресс экспорта, от 0 до 100%
4412 |message|Текст описывающий статус
4413
4414 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4415
4416 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4417
4418 (% class="box infomessage" %)
4419 (((
4420 **POST /api/v3/EcoDriving/rating**
4421 )))
4422
4423 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4424
4425 Тело запроса:
4426
4427 {
4428 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4429 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4430 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4431 }
4432
4433 Ответ:
4434
4435 {
4436 "items": [  ~/~/ Список в разрезе ТС
4437 {
4438 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4439 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4440 "vehicleId": 0, ~/~/ ID ТС
4441 "vehicleName": "string", ~/~/ Название ТС
4442 "vehicleModel": "string", ~/~/ Модель ТС
4443 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4444 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4445 "totalViolations": 0, ~/~/ Нарушений всего
4446 "violationsByType": { ~/~/ Информация о нарушениях по типу
4447 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4448 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4449 "brakingViolations": 0, ~/~/ Нарушений торможения
4450 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4451 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4452 "sensorViolations": 0 ~/~/ Нарушений по датчику
4453 },
4454
4455 (((
4456
4457 )))
4458
4459 "moveTime": 0, ~/~/ Продолжительность движения, сек
4460 "mileage": 0, ~/~/ Пробег, м
4461 "tripsCount": 0, ~/~/ Кол-во рейсов
4462 "trips": [  ~/~/ Информация по рейсу
4463 {
4464 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4465 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4466 "violationsCount": 0, ~/~/ Всего нарушений
4467 "violationsByType": { ~/~/ Информация о нарушениях по типу
4468 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4469 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4470 "brakingViolations": 0, ~/~/ Нарушений торможения
4471 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4472 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4473 "sensorViolations": 0 ~/~/ Нарушений по датчику
4474 },
4475
4476 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4477 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4478 "moveTime": 0, ~/~/ Продолжительность движения, сек
4479 "mileage": 0, ~/~/ Пробег, м
4480 "motohours": 0, ~/~/ Моточасы, секунды
4481 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4482 "startAddress": "string", ~/~/ Адрес начала рейса
4483 "endAddress": "string", ~/~/ Адрес конца рейса
4484 "drivers": [  ~/~/ Список водителей
4485 {
4486 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4487 "driverName": "string", ~/~/ФИО водителя
4488 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4489 }
4490 ]
4491 }
4492 ]
4493 }
4494 ]
4495 }
4496
4497 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4498
4499 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4500
4501 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4502
4503 (% class="box infomessage" %)
4504 (((
4505 **POST /api/v3/fuelcards/transactions**
4506 )))
4507
4508 Метод запроса: POST
4509
4510 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4511 \\В заголовках запроса: X-Auth: Токен авторизации
4512
4513 Параметры в теле запроса (JSON):
4514
4515 {
4516 "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4517 "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4518 "ids": [ 
4519 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4520 ],
4521 "timezone": 0 ~/~/ Часовой пояс
4522 }
4523
4524
4525 Ответ:
4526 {
4527 "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4528 "driver": "string", ~/~/ Водители, привязанные к ТК
4529 "object": "string", ~/~/ Наименование ТС
4530 "amount": 0, ~/~/ Количество топлива
4531 "amountDut": 0, ~/~/ Количество по ДУТ
4532 "amountDiff": 0, ~/~/ Разница, л
4533 "amountDiffPerc": 0, ~/~/ Разница, %
4534 "summa": 0, ~/~/ Стоимость, руб
4535 "serviceName": "string", ~/~/ Тип топлива
4536 "price": 0, ~/~/ Цена за литр, руб
4537 "cardName": "string", ~/~/ Наименование ТК
4538 "cardNum": "string", ~/~/ Номер ТК
4539 "operator": "string", ~/~/ Оператор ТК
4540 "address": "string" ~/~/ Адрес АЗС
4541 }
4542
4543 == (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4544
4545 (% class="box infomessage" %)
4546 (((
4547 **GET /api/v3/fuelcards**
4548 )))
4549
4550 Метод запроса: GET
4551
4552 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4553
4554 Ответ:
4555
4556 [
4557 {
4558 "Name": "string", ~/~/ Определяет наименование карты.
4559 "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4560 "Number": "string", ~/~/ Определяет № карты.
4561 "Enabled": true, ~/~/ Определяет признак активности карты.
4562 "Description": "string", ~/~/ Определяет описание карты.
4563 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4564 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4565 "deleted": true ~/~/ Признак удаления
4566 }
4567 ]
4568
4569 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4570
4571
4572 == **Получение полных данных о ретрансляторе** ==
4573
4574 (% class="box infomessage" %)
4575 (((
4576 **GET ** **/api/v3/retranslations/{id}**
4577 )))
4578
4579 id - Идентификатор ретранслятора
4580
4581
4582 Пример ответа:
4583
4584 {  
4585 "description": "", ~/~/ Поле описания ретранслятора
4586 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4587 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4588 "isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4589 "address": "string", ~/~/ Адрес и порт принимающего сервера
4590 "objects": [ ~/~/ Объекты для ретрансляции
4591 {      
4592 "id": "",  ~/~/ Идентификатор объекта ретрансляции
4593 "name": "", ~/~/ Наименование объекта ретрансляции
4594 "imei": "", ~/~/ IMEI объекта  ретрансляции
4595 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4596 }
4597 ],  
4598 "id": "", ~/~/ Идентификатор ретранслятора 
4599 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4600 "deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4601 }
4602
4603
4604 == **Удаление данных ретранслятора** ==
4605
4606 (% class="box infomessage" %)
4607 (((
4608 **DELETE** **/api/v3/retranslations/{id}**
4609 )))
4610
4611 id - Идентификатор ретранслятора
4612
4613
4614 == **Создание ретранслятора** ==
4615
4616 (% class="box infomessage" %)
4617 (((
4618 **POST ** **/api/v3/retranslations/{id}**
4619 )))
4620
4621 Запрос:
4622
4623 {  
4624 "description": "", ~/~/ Поле описания ретранслятора
4625 "subscriberId": "", ~/~/ Идентификатор подписчика
4626 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4627 "address": "", ~/~/ Адрес и порт принимающего сервера
4628 "isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4629 "objects": [ ~/~/Объекты для ретрансляции
4630 {      
4631 "id": "", ~/~/ Идентификатор ретранслятора 
4632 "imei": "", ~/~/ IMEI объекта ретрансляции
4633 "isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4634 }
4635 ]
4636 }
4637
4638
4639 Ответ:
4640
4641 {  
4642 "description": "", ~/~/ Поле описания ретранслятора
4643 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4644 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4645 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4646 "address": "string", ~/~/ Адрес и порт принимающего сервера
4647 "objects": [ ~/~/ Объекты для ретрансляции
4648 {      
4649 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4650 "name": "string", ~/~/ Наименование объекта ретрансляции    
4651 "imei": "", ~/~/ IMEI объекта ретрансляции
4652 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4653 }
4654 ],
4655 "id": "", ~/~/ Идентификатор ретранслятора   
4656 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4657 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4658 }
4659
4660
4661 == **Редактирование ретранслятора** ==
4662
4663 (% class="box infomessage" %)
4664 (((
4665 **PUT** **/api/v3/retranslations**
4666 )))
4667
4668 Пример запроса:
4669
4670 {  
4671 "id": "", ~/~/ Идентификатор ретранслятора   
4672 "description": "string", ~/~/ Поле описания ретранслятора
4673 "subscriberId": "", ~/~/ Идентификатор подписчика
4674 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4675 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4676 "address": "string", ~/~/ Адрес и порт принимающего сервера
4677 "objects": ~/~/ Объекты для ретрансляции
4678 [    
4679 {      
4680 "id": "",  ~/~/ Идентификатор объекта ретрансляции 
4681 "imei": "", ~/~/ IMEI объекта ретрансляции
4682 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4683 }
4684 ]
4685 }
4686
4687
4688 Пример ответа:
4689
4690 {  
4691 "description": "", ~/~/ Поле описания ретранслятора
4692 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4693 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4694 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4695 "address": "string", ~/~/ Адрес и порт принимающего сервера
4696 "objects": [ ~/~/ Объекты для ретрансляции
4697 {      
4698 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4699 "name": "string", ~/~/ Наименование объекта ретрансляции    
4700 "imei": "", ~/~/ IMEI объекта ретрансляции
4701 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4702 }
4703 ],
4704 "id": "", ~/~/ Идентификатор ретранслятора   
4705 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4706 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4707 }
4708
4709
4710 == **Получение списка ретранслятора клиента** ==
4711
4712 (% class="box infomessage" %)
4713 (((
4714 **POST /api/v3/retranslations/find**
4715 )))
4716
4717 Пример запроса:
4718
4719 {  
4720 "id": "", ~/~/ Идентификатор ретранслятора   
4721 "search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4722 "parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4723 }
4724
4725 Ответ:
4726
4727 [ 
4728 {    
4729 "description": "", ~/~/ Поле описания ретранслятора
4730 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4731 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4732 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4733 "address": "string", ~/~/ Адрес и порт принимающего сервера
4734 "id": "", ~/~/ Идентификатор ретранслятора   
4735 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4736 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4737 }
4738 ]
4739
4740
4741 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4742
4743 == **API для отчета по выгрузке комбайнов** ==
4744
4745 (% class="box infomessage" %)
4746 (((
4747 **POST /api/v3/Reports/harvesterUnloading**
4748 )))
4749
4750 Пример запроса:
4751
4752 {
4753 "byTime": 0, ~/~/ Объединение событий по времени
4754 "byDist": 0, ~/~/ Объединение событий по расстоянию
4755 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4756 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4757 "showNearestObjects": true, ~/~/Показывать объекты рядом?
4758 "vehicleIds": [ ~/~/ Список id объектов для анализа
4759 0
4760 ],
4761 "from": "", ~/~/ Дата и время начало запроса
4762 "to": "", ~/~/ Дата и время окончания запроса
4763 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4764 }
4765
4766 Пример ответа:
4767
4768 [ 
4769 {
4770 "harvesterName": "", ~/~/Комбайн, номер
4771 "harvesterId": 0, ~/~/Комбайн, id
4772 "harvesterModel": "", ~/~/ Модель комбайна
4773 "hopperCapacity": 0, ~/~/ Объем бункера м3
4774 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4775 "events": [ ~/~/Список событий в разрезе комбайна
4776 {
4777 "driverId": "", ~/~/Идентификатор водителя
4778 "driverName": "", ~/~/Водитель комбайна, ФИО
4779 "RFID": "", ~/~/ идентификатор карты-метки
4780 "rfidName": "", ~/~/Водитель комбайна, имя метки
4781 "vehicleId": 0, ~/~/идентификатор объекта
4782 "vehicleName": "string", ~/~/ Имя объекта
4783 "modelName": "string", ~/~/ Имя модели объекта
4784 "nearestVehicles": [ ~/~/Объекты рядом
4785 {
4786 "vehicleId": 0, ~/~/идентификатор объекта
4787 "vehicleName": "string" ~/~/ Имя объекта
4788 }
4789 ],
4790 "fields": [ ~/~/Поля, где происходила выгрузка
4791 {
4792 "id": 0, ~/~/ идентификатор пользователя 
4793 "name": "string" ~/~/ имя пользователя 
4794 }
4795 ],
4796 "event": "string", ~/~/Событие
4797 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4798 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4799 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4800 "cultureName": "string", ~/~/ название культуры
4801 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4802 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4803 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4804 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4805 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4806 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4807 "issued": 0, ~/~/Выдано, бункеров
4808 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4809 "latitude": 0, ~/~/Широта
4810 "longitude": 0, ~/~/ Долгота
4811 "litresAway": 0, ~/~/Отдано, л
4812 "m3Away": 0 ~/~/Отдано, м3
4813 }
4814 ]
4815 }
4816 ]
4817
4818
4819 == **Отчет трек-датчики** ==
4820
4821 (% class="box infomessage" %)
4822 (((
4823 **POST /api/v3/Reports/sensorsWorks**
4824 )))
4825
4826 **Пример запроса:**
4827
4828 {
4829 "vehicleIds": [ ~/~/ Список ID объектов
4830 0
4831 ],
4832 "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4833 "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4834 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4835 }
4836
4837 **Пример ответа:**
4838
4839 (((
4840 {
4841 "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4842 {
4843 "vehicleId": 0, ~/~/ Идентификатор ТС
4844 "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4845 {
4846 "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4847 "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4848 "duration": 0, ~/~/  Продолжительность интервала в секундах.
4849 "name": "string", ~/~/ Наименование оборудования.
4850 "mileage": 0, ~/~/ Пробег за время работы оборудования.
4851 "totalMileage": 0, ~/~/ Общий пробег.
4852 "avgSpeed": 0 ~/~/ Средняя скорость.
4853 }
4854 ]
4855 }
4856 ]
4857 }
4858
4859
4860 == **Превышение скорости** ==
4861
4862 (% class="box infomessage" %)
4863 (((
4864 **POST /api/v3/Reports/overSpeedDuration**
4865 )))
4866
4867 Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4868
4869 Пример запроса:
4870
4871 (((
4872 {
4873 "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4874 "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4875 "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4876 "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4877 "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4878 }
4879 )))
4880
4881 (((
4882
4883 )))
4884
4885 (((
4886 Пример ответа:
4887 )))
4888
4889 (((
4890 (((
4891 [
4892 {
4893 "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4894 "duration": 0, ~/~/ Продолжительность события в секундах 
4895 "maxSpeed": 0, ~/~/ Максимальная скорость 
4896 "speedLimit": 0 ~/~/ Ограничение скорости 
4897 }
4898 ]
4899 )))
4900 )))
4901 )))
4902
4903 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4904
4905
4906 == **Запрос списка полей** ==
4907
4908 (% class="box successmessage" %)
4909 (((
4910 **POST /api/v3/agroLands/find**
4911 )))
4912
4913 Пример запроса:
4914
4915 (((
4916 (((
4917 (((
4918 {
4919 "year": 0, ~/~/ Фильтр по году
4920 "name": "string", ~/~/ Фильтр по названию
4921 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4922 }
4923 )))
4924 )))
4925
4926
4927 )))
4928
4929 Пример ответа:
4930
4931 (((
4932 [
4933 {
4934 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4935 "year": 0, ~/~/ Год поля
4936 "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4937 "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4938 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4939 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4940 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4941 "counts": { ~/~/ Счётчики с/х поля 
4942 "fieldOperations": 0, ~/~/ Количество операций на поле
4943 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4944 "facts": 0 ~/~/ Счётчик факта
4945 },
4946 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4947 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4948 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4949 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4950 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4951 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4952 "planComment": "string", ~/~/ Комментарий к полю
4953 "productivity": 0, ~/~/ Урожайность.
4954 "id": 0, ~/~/ Идентификатор объекта геозоны
4955 "name": "string", ~/~/ Название объекта геозоны
4956 "type": 0, ~/~/ Тип объекта геозоны
4957 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4958 "fname": "string", ~/~/ Имя файла
4959 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4960 "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4961 "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4962 "description": "string", ~/~/ Описание объекта геозоны
4963 "area": 0, ~/~/ Площадь, м2
4964 "perimetr": 0, ~/~/ Периметр, м
4965 "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4966 }
4967 ]
4968
4969
4970 == **Создание нового поля ** ==
4971
4972 (% class="box successmessage" %)
4973 (((
4974 **POST /api/v3/agroLands**
4975 )))
4976
4977 Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
4978 X-agent  - ID клиента
4979
4980 Пример запроса:
4981
4982 (((
4983 {
4984 "extId": "string", 
4985 "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
4986 "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
4987 "display": "string", ~/~/ Настройки отображения
4988 "year": 0, ~/~/ Год поля
4989 "name": "string", ~/~/ Наименование
4990 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4991 "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4992 "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4993 "planComment": "string", ~/~/ Комментарий к полю
4994 "cropRotations": [ ~/~/ Данные по севообороту
4995 {
4996 "landId": 0, ~/~/ ID поля
4997 "landName": "string", ~/~/ Название поля
4998 "year": 0, ~/~/ Год урожая
4999 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5000 "cultureName": "string", ~/~/ Название культуры
5001 "productivity": 0, ~/~/ Урожайность
5002 "area": 0, ~/~/ Площадь поля, Га
5003 "total": 0, ~/~/ Валовый сбор
5004 "productivityFact": 0, ~/~/ Фактическая урожайность
5005 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5006 "totalFact": 0, ~/~/ Фактический валовый сбор
5007 "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
5008 "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
5009 "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
5010 "isyearplan": true, ~/~/ Годовой план 
5011 "comment": "string" ~/~/ Комментарий
5012 }
5013 ]
5014 }
5015 )))
5016
5017 (((
5018
5019 )))
5020
5021 Пример ответа:
5022
5023 (((
5024 (((
5025 {
5026 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5027 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5028 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5029 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5030 "cropRotations": [ ~/~/ Данные по севообороту
5031 {
5032 "landId": 0, ~/~/ ID поля
5033 "landName": "string", ~/~/ Название поля
5034 "year": 0, ~/~/ Год урожая 
5035 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5036 "cultureName": "string", ~/~/ Название культуры
5037 "productivity": 0, ~/~/ Урожайность
5038 "area": 0, ~/~/ Площадь поля, Га.
5039 "total": 0, ~/~/ Валовый сбор
5040 "productivityFact": 0, ~/~/ Фактическая урожайность
5041 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5042 "totalFact": 0, ~/~/ Фактический валовый сбор
5043 "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
5044 "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
5045 "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
5046 "isyearplan": true, ~/~/ годовой план 
5047 "comment": "string" ~/~/ Комментарий
5048 }
5049 ],
5050 "cropVegetation": [ ~/~/ История вегетации поля
5051 {
5052 "values": [  ~/~/ Данные вегетации и состояния посева
5053 {
5054 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5055 "ndvi": 0 ~/~/ Индекс вегетации
5056 }
5057 ],
5058 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5059 {
5060 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5061 "type": "string", ~/~/ Тип
5062 "pictureid": "string" ~/~/ Идентификатор ресурса
5063 }
5064 ],
5065 "states": [ ~/~/ Ключевые даты развития поля
5066 {
5067 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
5068 "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5069 }
5070 ]
5071 }
5072 ],
5073 "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
5074 "counts": {
5075 "fieldOperations": 0, ~/~/ Количество операций на поле
5076 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5077 "facts": 0 ~/~/ Счётчик факта
5078 },
5079 "planComment": "string", ~/~/ Комментарий к полю
5080 )))
5081
5082 (((
5083 "productivity": 0, ~/~/ Урожайность.
5084 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5085 "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
5086 "year": 0, ~/~/ Год поля
5087 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5088 "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5089 "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5090 "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5091 "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
5092 "id": 0, ~/~/ Идентификатор объекта геозоны
5093 "name": "string", ~/~/ Название объекта геозоны
5094 "type": 0, ~/~/ Тип объекта геозоны
5095 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5096 "fname": "string", ~/~/ Имя файла
5097 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5098 "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5099 "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5100 "description": "string", ~/~/ Описание объекта геозоны
5101 "area": 0, ~/~/ Площадь, м2
5102 "perimetr": 0, ~/~/ Периметр, м
5103 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5104 }
5105
5106
5107 )))
5108 )))
5109 )))
5110
5111 == **Получение поля по id** ==
5112
5113 (% class="box infomessage" %)
5114 (((
5115 **GET /api/v3/agroLands/{id}**
5116 )))
5117
5118 Пример запроса:
5119 id  ~/~/ Идентификатор поля
5120
5121 Пример ответа:
5122
5123 (((
5124 {
5125 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
5126 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5127 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5128 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5129 "cropRotations": [ ~/~/ Данные по севообороту
5130 {
5131 "landId": 0, ~/~/ ID поля
5132 "landName": "string", ~/~/ Название поля
5133 "year": 0, ~/~/ Год урожая
5134 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5135 "cultureName": "string", ~/~/ Название культуры
5136 "productivity": 0, ~/~/ Урожайность
5137 "area": 0, ~/~/ Площадь поля, Га
5138 "total": 0, ~/~/ Валовый сбор
5139 "productivityFact": 0, ~/~/ Фактическая урожайность
5140 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5141 "totalFact": 0, ~/~/ Фактический валовый сбор
5142 "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ
5143 "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5144 "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5145 "isyearplan": true, ~/~/ План года 
5146 "comment": "string" ~/~/ Комментарий
5147 }
5148 ],
5149 "cropVegetation": [ ~/~/ История вегетации поля
5150 {
5151 "values": [ ~/~/ Данные вегетации и состояния посева
5152 {
5153 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5154 "ndvi": 0 ~/~/ Индекс вегетации
5155 }
5156 ],
5157 "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5158 {
5159 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5160 "type": "string", ~/~/ Тип 
5161 "pictureid": "string" ~/~/ Идентификатор ресурса
5162 }
5163 ],
5164 "states": [ ~/~/ Ключевые даты развития поля
5165 {
5166 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5167 "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5168 }
5169 ]
5170 }
5171 ],
5172 "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5173 "counts": {
5174 "fieldOperations": 0, ~/~/ Количество операций на поле
5175 "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5176 "facts": 0 ~/~/ Счётчик факта
5177 },
5178 "planComment": "string", ~/~/ Комментарий к полю
5179 "productivity": 0, ~/~/ Урожайность.
5180 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5181 )))
5182
5183 (((
5184 (((
5185 "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5186 "year": 0, ~/~/ Год поля
5187 "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5188 "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5189 "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5190 "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5191 "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5192 "id": 0, ~/~/ Идентификатор объекта геозоны
5193 "name": "string", ~/~/ Название объекта геозоны
5194 "type": 0, ~/~/ Тип объекта геозоны 
5195 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5196 "fname": "string", ~/~/ Имя файла
5197 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5198 "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5199 "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5200 "description": "string", ~/~/ Описание объекта геозоны
5201 "area": 0, ~/~/ Площадь, м2
5202 "perimetr": 0, ~/~/ Периметр, м
5203 "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5204 }
5205 )))
5206
5207
5208 == **Удаление существующего поля** ==
5209
5210 (% class="box errormessage" %)
5211 (((
5212 **DELETE /api/v3/agroLands/{id}**
5213 )))
5214
5215 Пример запроса:
5216 id  ~/~/ Идентификатор поля
5217
5218 Пример ответа:
5219
5220 (((
5221 200 ~/~/ Успех
5222 )))
5223
5224 (((
5225
5226 )))
5227
5228 (((
5229 (((
5230 (((
5231
5232 )))
5233
5234 (((
5235 == **Изменение поля** ==
5236
5237 (% class="box infomessage" %)
5238 (((
5239 **PUT /api/v3/agroLands**
5240 )))
5241
5242 Пример запроса:
5243
5244 (((
5245 (((
5246 {
5247 "id": 0, ~/~/ Идентификатор поля
5248 "extId": "string", ~/~/ ExtId
5249 "shape": "string", ~/~/ Форма поля
5250 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5251 "display": "string", ~/~/ Настройки отображения
5252 "year": 0, ~/~/ Год поля
5253 "name": "string", ~/~/ Наименование
5254 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5255 "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5256 "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5257 "planComment": "string", ~/~/Комментарий к полю
5258 "cropRotations": [  ~/~/ Данные по севообороту
5259 {
5260 "landId": 0, ~/~/ ID поля
5261 "landName": "string", ~/~/ Название поля
5262 "year": 0, ~/~/ Год урожая
5263 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5264 "cultureName": "string", ~/~/ Название культуры
5265 "productivity": 0, ~/~/ Урожайность
5266 "area": 0, ~/~/ Площадь поля, Га.
5267 "total": 0, ~/~/ Валовый сбор
5268 "productivityFact": 0, ~/~/ Фактическая урожайность
5269 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5270 "totalFact": 0, ~/~/ Фактический валовый сбор
5271 "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5272 "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5273 "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5274 "isyearplan": true, 
5275 "comment": "string" ~/~/ Комментарий
5276 }
5277 ],
5278 "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5279 }
5280 )))
5281 )))
5282
5283 (((
5284
5285 )))
5286
5287 Пример ответа:
5288
5289 (((
5290 (((
5291 (((
5292 {
5293 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5294 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5295 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5296 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5297 "cropRotations": [ ~/~/ Данные по севообороту
5298 {
5299 "landId": 0, ~/~/ ID поля
5300 "landName": "string", ~/~/ Название поля
5301 "year": 0, ~/~/  Год урожая
5302 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5303 "cultureName": "string", ~/~/ Название культуры
5304 "productivity": 0, ~/~/ Урожайность
5305 "area": 0, ~/~/ Площадь поля, Га
5306 "total": 0, ~/~/ Валовый сбор
5307 "productivityFact": 0, ~/~/ Фактическая урожайность
5308 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5309 "totalFact": 0, ~/~/ Фактический валовый сбор
5310 "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5311 "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5312 "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5313 "isyearplan": true, ~/~/ 
5314 "comment": "string" ~/~/ Комментарий
5315 }
5316 ],
5317 "cropVegetation": [ ~/~/ История вегетации поля
5318 {
5319 "values": [ ~/~/ Данные вегетации и состояния посева
5320 {
5321 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5322 "ndvi": 0 ~/~/ Индекс вегетации
5323 }
5324 ],
5325 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5326 {
5327 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5328 "type": "string", ~/~/ Тип
5329 "pictureid": "string" ~/~/ Идентификатор ресурса
5330 }
5331 ],
5332 "states": [ ~/~/ Ключевые даты развития поля 
5333 {
5334 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5335 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5336 }
5337 ]
5338 }
5339 ],
5340 "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5341 "counts": { 
5342 "fieldOperations": 0, ~/~/ Количество операций на поле
5343 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5344 "facts": 0 ~/~/ Счётчик факта
5345 },
5346 "planComment": "string", ~/~/ Комментарий к полю
5347 "productivity": 0, ~/~/ Урожайность.
5348 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5349 "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5350 "year": 0, ~/~/ Год поля
5351 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5352 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5353 "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5354 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5355 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5356 "id": 0, ~/~/ Идентификатор объекта геозоны
5357 "name": "string", ~/~/ Название объекта геозоны
5358 "type": 0, ~/~/ Тип объекта геозоны
5359 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5360 "fname": "string", ~/~/ Имя файла
5361 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5362 "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5363 "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5364 "description": "string", ~/~/ Описание объекта геозоны
5365 "area": 0, ~/~/ Площадь, м2
5366 "perimetr": 0, ~/~/ Периметр, м
5367 "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5368 }
5369 )))
5370 )))
5371 )))
5372 )))
5373 )))
5374
5375
5376 == **Редактирование года урожая ** ==
5377
5378 (% class="box successmessage" %)
5379 (((
5380 **POST /api/v3/agroLands/updateOpenCloseYear**
5381 )))
5382
5383 Пример запроса:
5384
5385 (((
5386 (((
5387 {
5388 "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5389 0
5390 ],
5391 "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5392 "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5393 }
5394 )))
5395
5396
5397 )))
5398
5399 Пример ответа:
5400
5401 (((
5402 (((
5403 {
5404 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5405 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5406 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5407 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5408 "cropRotations": [ ~/~/ Данные по севообороту
5409 {
5410 "landId": 0, ~/~/ ID поля
5411 "landName": "string", ~/~/ Название поля
5412 "year": 0, ~/~/ Год урожая
5413 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5414 "cultureName": "string", ~/~/ Название культуры
5415 "productivity": 0, ~/~/ Урожайность
5416 "area": 0, ~/~/ Площадь поля, Га.
5417 "total": 0, ~/~/ Валовый сбор
5418 "productivityFact": 0, ~/~/ Фактическая урожайность
5419 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5420 "totalFact": 0, ~/~/ Фактический валовый сбор
5421 "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5422 "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5423 "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5424 "isyearplan": true, ~/~/ 
5425 "comment": "string" ~/~/ Комментарий
5426 }
5427 ],
5428 "cropVegetation": [ ~/~/ История вегетации поля
5429 {
5430 "values": [ ~/~/ Данные вегетации и состояния посева
5431 {
5432 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5433 "ndvi": 0 ~/~/ Индекс вегетации
5434 }
5435 ],
5436 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5437 {
5438 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5439 "type": "string", ~/~/ Тип
5440 "pictureid": "string" ~/~/ Идентификатор ресурса
5441 }
5442 ],
5443 "states": [ ~/~/ Ключевые даты развития поля
5444 {
5445 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5446 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5447 }
5448 ]
5449 }
5450 ],
5451 "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5452 "counts": { 
5453 "fieldOperations": 0, ~/~/ Количество операций на поле
5454 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5455 "facts": 0 ~/~/ Счётчик факта
5456 },
5457 "planComment": "string", ~/~/ Комментарий к полю
5458 "productivity": 0, ~/~/ Урожайность.
5459 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5460 "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5461 "year": 0, ~/~/ Год поля
5462 "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5463 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5464 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5465 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5466 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5467 "id": 0, ~/~/ Идентификатор объекта геозоны
5468 "name": "string", ~/~/ Название объекта геозоны
5469 "type": 0, ~/~/ Тип объекта геозоны
5470 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5471 "fname": "string", ~/~/ Имя файла
5472 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5473 "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5474 "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5475 "description": "string", ~/~/ Описание объекта геозоны
5476 "area": 0, ~/~/ Площадь, м2
5477 "perimetr": 0, ~/~/ ериметр, м
5478 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5479 }
5480 )))
5481
5482
5483 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5484 )))
5485 )))
5486 )))
5487
5488 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5489
5490
5491 (% class="box infomessage" %)
5492 (((
5493 **GET api/v3/Vehicles/recyclebin/all**
5494 )))
5495
5496 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5497
5498 Параметр запроса: {parentId} - идентификатор агента
5499
5500 В заголовках запроса: X-Auth: Токен авторизации
5501
5502 Ответ:
5503
5504 [ 
5505 {
5506 "recordTime": "", ~/~/Время записи
5507 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5508 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5509 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5510 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5511 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5512 "details": { ~/~/Список деталей объекта, помещённого в корзину
5513 "items": [ ~/~/ 
5514 nullable: true ~/~/Детали
5515 {
5516 "name": "string", ~/~/наименование столбца
5517 "value": "string" ~/~/содержание столбца
5518 }
5519 ]
5520 },
5521 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5522 "string"
5523 ]
5524 }
5525 ]
5526
5527
5528 == (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5529
5530 (% class="box infomessage" %)
5531 (((
5532 **POST api/v3/Vehicles/recyclebin/erase**
5533 )))
5534
5535 В заголовках запроса: X-Auth: Токен авторизации
5536
5537 Пример запроса:
5538
5539 [
5540 0
5541 ]
5542
5543
5544 Пример ответа:
5545
5546 [ 
5547 {
5548 "recordTime": "", ~/~/Время записи
5549 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5550 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5551 "objectId": 0, ~/~/ID объекта, помещённого в корзин
5552 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5553 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5554 "details": { ~/~/Список деталей объекта, помещённого в корзину
5555 "items": [ ~/~/Детали
5556 {
5557 "name": "", ~/~/Имя свойства
5558 "value": "" ~/~/Значение свойства
5559 }
5560 ]
5561 },
5562 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5563 ""
5564 ]
5565 }
5566 ]
5567
5568 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5569
5570 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5571
5572 (% class="box infomessage" %)
5573 (((
5574 **POST api/v3/Vehicles/recyclebin/restore**
5575 )))
5576
5577 В заголовках запроса: X-Auth: Токен авторизации
5578
5579 Параметры в теле запроса (JSON):
5580
5581 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5582
5583 В заголовках запроса: X-Auth: Токен авторизации
5584
5585
5586 Пример запроса:
5587
5588 (((
5589 [
5590 )))
5591
5592 (((
5593 0
5594 )))
5595
5596 (((
5597 ]
5598 )))
5599
5600
5601 Пример ответа:
5602
5603 [
5604 {
5605 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5606 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5607 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5608 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5609 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5610 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5611 "details": { ~/~/Список деталей объекта, помещённого в корзину
5612 "items": [ ~/~/Детали
5613 {
5614 "name": "string", ~/~/Имя свойства
5615 "value": "string" ~/~/Значение свойства
5616 }
5617 ]
5618 },
5619 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5620 "string"
5621 ]
5622 }
5623 ]
5624
5625
5626 = **Раздел: Журнал заданий ** =
5627
5628
5629 == **Создание задания в Журнале заданий** ==
5630
5631 (% class="box infomessage" %)
5632 (((
5633 **POST /api/v3/vehicletasks**
5634 )))
5635
5636 Пример запроса:
5637
5638 (((
5639 {
5640 "vehicleId": 0, ~/~/ Идентификатор ТС
5641 "description": "string", ~/~/ Описание
5642 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5643 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5644 "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5645 "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5646 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5647 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5648 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5649 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5650 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5651 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5652 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5653 "cost": { 
5654 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5655 "Name": "string", ~/~/ Наименование
5656 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5657 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5658 "Norm": 0 ~/~/ Норма внесения
5659 },
5660 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5661 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5662 "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5663 "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5664 "deleted": true, ~/~/ Признак удаления
5665 "extId": "string", 
5666 "GeoIds": [ ~/~/ Cвязанные поля
5667 0
5668 ]
5669 }
5670 )))
5671
5672
5673 Пример ответа:
5674
5675 {
5676 "vehicleId": 0, ~/~/ Идентификатор ТС
5677 "description": "string", ~/~/ Описание
5678 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5679 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5680 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5681 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5682 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5683 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5684 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5685 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5686 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5687 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5688 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5689 "cost": { 
5690 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5691 "Name": "string", ~/~/ Наименование
5692 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5693 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5694 "Norm": 0 ~/~/ Норма внесения
5695 },
5696 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5697 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5698 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5699 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5700 "deleted": true, ~/~/ Признак удаления
5701 "extId": "string", ~/~/ ExtId
5702 "GeoIds": [ ~/~/ Связанные поля
5703 0
5704 ]
5705 }
5706
5707
5708 == **Редактирование задания в Журнале заданий** ==
5709
5710 (% class="box successmessage" %)
5711 (((
5712 **PUT /api/v3/vehicletasks**
5713 )))
5714
5715 Пример запроса:
5716
5717 (((
5718 {
5719 "vehicleId": 0, ~/~/ Идентификатор ТС
5720 "description": "string", ~/~/ Описание
5721 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5722 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5723 "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5724 "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5725 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5726 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5727 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5728 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5729 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5730 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5731 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5732 "cost": { 
5733 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5734 "Name": "string", ~/~/ Наименование
5735 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5736 "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5737 "Norm": 0 ~/~/ Норма внесения
5738 },
5739 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5740 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5741 "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5742 "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5743 "deleted": true, ~/~/ Признак удаления
5744 "extId": "string", ~/~/ ExtId
5745 "GeoIds": [ ~/~/ Связанные поля
5746 0
5747 ]
5748 }
5749 )))
5750
5751
5752 Пример ответа:
5753
5754 {
5755 "vehicleId": 0, ~/~/ Идентификатор ТС
5756 "description": "string", ~/~/ Описание
5757 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5758 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5759 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5760 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5761 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5762 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5763 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5764 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5765 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5766 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5767 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5768 "cost": { 
5769 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5770 "Name": "string", ~/~/ Наименование
5771 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5772 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5773 "Norm": 0 ~/~/ Норма внесения
5774 },
5775 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5776 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5777 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5778 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5779 "deleted": true, ~/~/ Признак удаления
5780 "extId": "string", ~/~/ ExtId
5781 "GeoIds": [ ~/~/ Связанные поля
5782 0
5783 ]
5784 }
5785
5786
5787 == **Удаление задания в Журнале заданий** ==
5788
5789 (% class="box warningmessage" %)
5790 (((
5791 **DELETE /api/v3/vehicletasks**
5792 )))
5793
5794 Пример запроса:
5795
5796 (((
5797 [
5798 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5799 ]
5800 )))
5801
5802 (((
5803
5804 )))
5805
5806 Пример ответа:
5807
5808 {
5809 "vehicleId": 0, ~/~/ Идентификатор ТС
5810 "description": "string", ~/~/ Описание
5811 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5812 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5813 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5814 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5815 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5816 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5817 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5818 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5819 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5820 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5821 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5822 "cost": { 
5823 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5824 "Name": "string", ~/~/ Наименование
5825 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5826 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5827 "Norm": 0 ~/~/ Норма внесения
5828 },
5829 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5830 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5831 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5832 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5833 "deleted": true, ~/~/ Признак удаления
5834 "extId": "string", ~/~/ ExtId
5835 "GeoIds": [ ~/~/ Связанные поля
5836 0
5837 ]
5838 }
5839
5840
5841 == **Получение списка Журнала заданий** ==
5842
5843 (% class="box infomessage" %)
5844 (((
5845 **POST /api/v3/vehicletasks/getbyperiod**
5846 )))
5847
5848 Пример запроса:
5849
5850 (((
5851 {
5852 "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
5853 "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
5854 "TimeZone": 0, ~/~/ Часовой пояс.
5855 "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
5856 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
5857 ],
5858 "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
5859 0
5860 ],
5861 "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
5862 0
5863 ],
5864 "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
5865 "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
5866 }
5867 )))
5868
5869
5870 Пример ответа:
5871
5872 (((
5873 {
5874 "total": 0,  ~/~/ Общее количество записей
5875 "pages": 0,  ~/~/ Общее количество страниц
5876 "currentPage": 0, ~/~/ Текущая страница
5877 "items": [  ~/~/ Записи 
5878 {
5879 "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5880 "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
5881 "name": "string", ~/~/ Название задания.
5882 "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
5883 "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
5884 "workKind": "string", ~/~/ Вид работ
5885 "techOp": "string", ~/~/ Тех. операция
5886 "trailerModel": "string", ~/~/ Модель агрегата
5887 "width": "string", ~/~/ Ширина, м
5888 "speed": "string", ~/~/ Тех. скорость
5889 "fields": "string", ~/~/ Поля
5890 "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
5891 "vehicles": "string", ~/~/ Объект-модель
5892 "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
5893 "drivers": "string", ~/~/ Водители
5894 "tmc": "string", ~/~/ ТМЦ
5895 "client": "string", ~/~/  Клиент
5896 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5897 "dep": "string", ~/~/ Подразделение
5898 "geoIds": [ ~/~/  Связанные поля
5899 0
5900 ]
5901 }
5902 ]
5903 }
5904 )))
5905
5906
5907 = **Раздел: Локатор ** =
5908
5909
5910 == **Получение списка локаторов, доступных пользователю ** ==
5911
5912 (% class="box infomessage" %)
5913 (((
5914 **GET /api/v3/locators**
5915 )))
5916
5917 В заголовках запроса: X-Auth: Токен авторизации
5918
5919
5920 Пример ответа:
5921
5922 (((
5923 [
5924 {
5925 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5926 "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5927 "agentName": "string", ~/~/ Наименование агента.
5928 "isEnabled": true, ~/~/ Активен 
5929 "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5930 "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5931 "name": "string", ~/~/ Наименование
5932 "status": 0, ~/~/ 
5933 "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5934 "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5935 "validity": 0, ~/~/ Срок действия в днях (1-90).
5936 "autoProlongation": true, ~/~/ Автопродление срока действия.
5937 "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5938 "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5939 "url": "string", ~/~/ Ссылка
5940 "language": 0, ~/~/ Язык.
5941 "vehiclesCount": 0, ~/~/ Количество объектов.
5942 "geozonesCount": 0, ~/~/ Количество геозон.
5943 "fieldsCount": 0 ~/~/ Количество полей.
5944 }
5945 ]
5946 )))
5947
5948
5949
5950 == **Создание локатора** ==
5951
5952 (% class="box successmessage" %)
5953 (((
5954 **POST /api/v3/locators**
5955 )))
5956
5957 Пример запроса:
5958
5959 (((
5960 {
5961 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5962 "isEnabled": true, ~/~/ Активность
5963 "name": "string", ~/~/ Наименование локатора
5964 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени)
5965 "activationTime": "2025-03-12T07:00:08.272Z", ~/~/  Время активации
5966 "validity": 0, ~/~/ Срок действия в днях (1-90)
5967 "autoProlongation": true, ~/~/ Автопродление срока действия.
5968 "url": "string", ~/~/ Ссылка
5969 "language": 0 ~/~/ Язык
5970 }
5971 )))
5972
5973
5974 Пример ответа:
5975
5976 (((
5977 3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора
5978 )))
5979
5980
5981
5982 == **Изменение локатора** ==
5983
5984 (% class="box infomessage" %)
5985 (((
5986 **PUT /api/v3/locators**
5987 )))
5988
5989 Пример запроса:
5990
5991 (((
5992 {
5993 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
5994 "isEnabled": true, ~/~/ Активность 
5995 "name": "string", ~/~/ Наименование
5996 "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 
5997 "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации
5998 "validity": 0, ~/~/ Срок действия в днях (1-90)
5999 "autoProlongation": true, ~/~/ Автопродление срока действия
6000 "url": "string", ~/~/ Ссылка
6001 "language": 0 ~/~/ Язык
6002 }
6003 )))
6004
6005
6006 Пример ответа:
6007
6008 200 ~/~/ Success
6009
6010
6011 == **Удалить локатор** ==
6012
6013 (% class="box warningmessage" %)
6014 (((
6015 **DELETE /api/v3/locators**
6016 )))
6017
6018 Пример запроса:
6019
6020 (((
6021 [
6022 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора
6023 ]
6024 )))
6025
6026
6027
6028 = **Раздел: Яндекс Маршруты** =
6029
6030
6031 == **Возвращение списка маршрутов** ==
6032
6033 (% class="box infomessage" %)
6034 (((
6035 **GET /api/v3/TransportRoutes**
6036 )))
6037
6038 Пример запроса:
6039 Id  ~/~/ Идентификатор поля
6040
6041
6042 Пример ответа:
6043
6044 (((
6045 [
6046 {
6047 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6048 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6049 "name": "string", ~/~/ Наименование маршрута.
6050 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6051 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6052 0
6053 ]
6054 }
6055 ]
6056 )))
6057
6058
6059
6060 == **Добавить маршрут** ==
6061
6062 (% class="box infomessage" %)
6063 (((
6064 **POST /api/v3/TransportRoutes**
6065 )))
6066
6067 Пример запроса: 
6068 {
6069 "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6070 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6071 "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6072 "vehicles": [  ~/~/ Определяет список ТС для маршрута
6073 0
6074 ]
6075 }
6076
6077
6078 Пример ответа:
6079
6080 (((
6081 {
6082 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6083 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6084 "name": "string", ~/~/ Определяет наименование маршрута 
6085 "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6086 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6087 0
6088 ]
6089 }
6090 )))
6091
6092
6093 == **Обновление маршрута** ==
6094
6095 (% class="box successmessage" %)
6096 (((
6097 **PUT /api/v3/TransportRoutes**
6098 )))
6099
6100 Пример запроса:
6101
6102 (((
6103 {
6104 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6105 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6106 "name": "string", ~/~/ Опредлеляет наименование маршрута.
6107 "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6108 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6109 0
6110 ]
6111 }
6112 )))
6113
6114
6115 Пример ответа:
6116
6117 (((
6118 {
6119 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6120 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6121 "name": "string", ~/~/ Определяет наименование маршрута 
6122 "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6123 "vehicles": [ ~/~/ Определяет список ТС для маршрута
6124 0
6125 ]
6126 }
6127 )))
6128
6129
6130 == **Получить связки маршрутов ТС** ==
6131
6132 (% class="box infomessage" %)
6133 (((
6134 **POST /api/v3/TransportRoutes/getroutesvehicles**
6135 )))
6136
6137 Пример запроса:
6138
6139 (((
6140 [
6141 "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6142 ]
6143 )))
6144
6145
6146 Пример ответа:
6147
6148 (((
6149 [
6150 {
6151 "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6152 "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6153 }
6154 ]
6155 )))
6156
6157
6158 == **Удалить маршрут** ==
6159
6160 (% class="box warningmessage" %)
6161 (((
6162 **DELETE /api/v3/TransportRoutes/{id}**
6163 )))
6164
6165 Пример запроса:
6166 Id  ~/~/ Идентификатор поля
6167
6168
6169 ==== ====
6170
6171 = **Раздел: Управление доступа к машинам** =
6172
6173
6174 == Получение списка транспортных средств видимых пользователю ==
6175
6176 (% class="box infomessage" %)
6177 (((
6178 **GET /api/v3/UserVisibleVehicles/{userId}**
6179 )))
6180
6181 Пример ответа:
6182
6183 (((
6184 {
6185 "vehicleIds": [  ~/~/ Идентификаторы ТС
6186 0
6187 ]
6188 }
6189 )))
6190
6191
6192
6193 == Задает видимость транспортных средств пользователю ==
6194
6195 (% class="box infomessage" %)
6196 (((
6197 **POST /api/v3/UserVisibleVehicles**
6198 )))
6199
6200 Пример запроса:
6201
6202 (((
6203 (((
6204 {
6205 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6206 "vehicleIds": [ ~/~/ Идентификаторы ТС
6207 0
6208 ]
6209 }
6210 )))
6211
6212 (((
6213
6214 )))
6215
6216 (((
6217
6218 )))
6219
6220 (((
6221 Пример ответа :
6222 )))
6223
6224 (((
6225
6226 )))
6227
6228 (((
6229 200 ~/~/ Success
6230 )))
6231 )))
6232
6233
6234
6235
6236
6237
6238 (% class="box" lang="en-US" style="text-align: center;" %)
6239 (((
6240 (% 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]] **
6241 )))
ГЛОНАССSoft wiki - 2024 г.