Редактировал(а) Андрей Калиновский 2025/02/25 16:35
Последние авторы
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
15 **Содержание страницы:**
16 )))
17
18 {{toc/}}
19
20
21 = (% style="color:#000000; font-size:16px" %)**Действующие ограничения**(%%) =
22
23 (% style="color:#000000" %)−(%%) **Между запросами должна быть пауза в 1 секунду** (превышение отвергается системой с уведомлением о превышении частоты запросов).
24
25 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
26
27 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
28
29 (% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!
30
31
32 (% style="color:#000000; font-size:16px" %)**Рекомендации**
33
34 - Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период).
35
36 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) =
37
38 (% class="box warningmessage" id="H41043244243E44043843743044643844F" %)
39 (((
40 (% style="color:#000000; font-size:16px" %)**Авторизация**(%%)
41 (% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие)
42 )))
43
44 (% class="box successmessage" %)
45 (((
46 (% lang="en-US" %)**POST /api/v3/auth/login**
47 )))
48
49 (% style="color:#000000" %)Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
50
51 (% style="color:#000000" %)Метод запроса: **POST**
52
53 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
54
55 (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
56
57 (% style="color:#000000" %)Параметры в теле запроса (JSON):
58
59 (% style="color:#000000" %){
60 "login": "testuser",
61 "password": "testuser"
62 }
63
64 (% style="color:#000000" %)**Ответ:**
65
66 (% lang="en-US" %)
67 (% style="color:#000000" %){
68 "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
69 "User": "testuser" , ~/~/ имя пользователя(%%)
70 }
71
72 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
73
74 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
75 |(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя
76 |(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя
77 |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
78 |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
79
80 (% class="wikigeneratedid" %)
81 Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]])
82
83 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
84
85 (% class="box infomessage" %)
86 (((
87 (% lang="en-US" %)**GET /api/v3/auth/check**
88 )))
89
90 (% style="color:#000000" %)Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет.
91
92 (% style="color:#000000" %)Метод запроса: **GET**
93
94 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
95
96 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
97
98 (% lang="en-US" %)
99 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
100
101 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Клиенты**(%%) =
102
103 == (% style="color:#000000; font-size:16px" %)**Получение информации о клиенте**(%%) ==
104
105 (% class="box infomessage" %)
106 (((
107 **GET api/v3/agents/{id}**
108 )))
109
110 Метод позволяет получить параметры выбранного клиента(% style="color:#000000" %): наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
111
112 (% style="color:#000000" %)− информация о клиенте предоставляется при наличии права «Просмотр клиентов»;
113
114 (% style="color:#000000" %)Метод запроса: **GET**
115
116 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/{id}
117
118 Запрос должен содержать данные параметра "**agentId**"
119
120 (% style="color:#000000" %)Ответ:
121 {
122 "agentId": "",  (%%)
123 "parentId": "",
124 "parentName": "string",
125 "name": "string",
126 "fullName": "string",
127 "agentInfoType": 0,
128 "isForeign": true/false,
129 "district": "string", 
130 "region": "string",
131 "city": "string",
132 "inn": "string",
133 "kpp": "string",
134 "address": "string",
135 "addressFact": "string",
136 "email": "string",
137 "director": "string",
138 "bankName": "string",
139 "bankBIK": "string",
140 "bankRS": "string",
141 "bankKS": "string"
142 }
143
144 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
145 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
146 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
147 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
148 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
149 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
150 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
151 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
152 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
153 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
154 |(% style="width:215px" %)city|(% style="width:861px" %)Город
155 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
156 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
157 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
158 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
159 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
160 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
161 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
162 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
163 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
164 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
165
166 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) ==
167
168 (% class="box infomessage" %)
169 (((
170 (% lang="en-US" %)**POST **(%%)**/(% lang="en-US" %)api/v3/agents/find(%%)**
171 )))
172
173 (% style="color:#000000" %)Метод позволяет получить параметры всех дочерних клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя и т.д. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе:
174
175 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
176
177 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
178
179 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
180
181 (% style="color:#000000" %)Метод запроса: **POST**
182
183 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/agents/find
184
185 (% style="color:#000000" %)Параметр запроса:
186
187 (% style="color:#000000" %){
188 "parentId": "string"
189 }
190
191 (% style="color:#000000" %)Ответ:
192
193 {
194 "agentId": "",(% style="color:#000000" %)   (%%)
195 "parentId": "",
196 "name": "string",
197 "fullName": "string",
198 "agentInfoType": 0,
199 (% style="color:#000000" %) "status": "",
200 }
201
202
203 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
204 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
205 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
206 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
207 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
208 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
209 |(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен
210
211 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) ==
212
213 (% class="box successmessage" %)
214 (((
215 **POST /api/v3/agents **
216 )))
217
218 Метод позволяет добавить клиента, указанного в запросе.
219
220 Метод запроса: **POST**
221
222 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
223
224 В заголовках запроса: X-Auth: Токен авторизации
225
226 Параметры в теле запроса (JSON):
227
228 {
229 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
230 "name": "string", ~/~/ имя
231 "fullName": "string", ~/~/ полное наименование
232 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
233 "isForeign": true, ~/~/ иностранный контрагент
234 "district": "string", ~/~/ округ
235 "region": "string", ~/~/ регион
236 "city": "string", ~/~/ город
237 "inn": "string", ~/~/ ИНН
238 "kpp": "string", ~/~/ КПП
239 "address": "string", ~/~/ юридический адрес
240 "addressFact": "string", ~/~/ фактический адрес
241 "email": "string", ~/~/ email
242 "director": "string", ~/~/ ФИО руководителя
243 "bankName": "string", ~/~/ банк
244 "bankBIK": "string", ~/~/ БИК
245 "bankRS": "string", ~/~/ номер счёта
246 "bankKS": "string" ~/~/ корр. счёт
247 }
248
249 Ответ:
250
251 {
252 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
253 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
254 "name": "string", ~/~/ имя
255 "fullName": "string", ~/~/ полное наименование
256 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
257 "isForeign": true, ~/~/ иностранный контрагент
258 "district": "string", ~/~/ округ
259 "region": "string", ~/~/ регион
260 "city": "string", ~/~/ город
261 "inn": "string", ~/~/ ИНН
262 "kpp": "string", ~/~/ КПП
263 "address": "string", ~/~/ юридический адрес
264 "addressFact": "string", ~/~/ фактический адрес
265 "email": "string", ~/~/ email
266 "director": "string", ~/~/ ФИО руководителя
267 "bankName": "string", ~/~/ банк
268 "bankBIK": "string", ~/~/ БИК
269 "bankRS": "string", ~/~/ номер счёта
270 "bankKS": "string" ~/~/ корр. счёт
271 }
272
273 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
274 |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
275 |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
276 |(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
277 |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
278 |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
279 |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
280 |(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент
281 |(% style="width:215px" %)district|(% style="width:861px" %)Округ
282 |(% style="width:215px" %)region|(% style="width:861px" %)Регион
283 |(% style="width:215px" %)city|(% style="width:861px" %)Город
284 |(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента
285 |(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента
286 |(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес
287 |(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес
288 |(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта
289 |(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя
290 |(% style="width:215px" %)bankName|(% style="width:861px" %)Банк
291 |(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК
292 |(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета
293 |(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет
294
295 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) ==
296
297 (% class="box warningmessage" %)
298 (((
299 **PUT /api/v3/agents**
300 )))
301
302 Метод позволяет отредактировать клиента, указанного в запросе.
303
304 Метод запроса: **PUT**
305
306 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents>>https://hosting.glonasssoft.ru/api/v3/agents]]
307
308 В заголовках запроса: X-Auth: Токен авторизации
309
310 Параметры в теле запроса (JSON):
311
312 {
313 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
314 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
315 "name": "string", ~/~/ имя
316 "fullName": "string", ~/~/ полное наименование
317 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%)
318 "isForeign": true, ~/~/ иностранный контрагент
319 "district": "string", ~/~/ округ
320 "region": "string", ~/~/ регион
321 "city": "string", ~/~/ город
322 "inn": "string", ~/~/ ИНН
323 "kpp": "string", ~/~/ КПП
324 "address": "string", ~/~/ юридический адрес
325 "addressFact": "string", ~/~/ фактический адрес
326 "email": "string", ~/~/ email
327 "director": "string", ~/~/ ФИО руководителя
328 "bankName": "string", ~/~/ банк
329 "bankBIK": "string", ~/~/ БИК
330 "bankRS": "string", ~/~/ номер счёта
331 "bankKS": "string" ~/~/ корр. счёт
332 }
333
334 Ответ:
335
336 {
337 "agentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента
338 "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 
339 "name": "string", ~/~/ имя
340 "fullName": "string", ~/~/ полное наименование
341 "isForeign": true, ~/~/ иностранный контрагент
342 "district": "string", ~/~/ округ
343 "region": "string", ~/~/ регион
344 "city": "string", ~/~/ город
345 "inn": "string", ~/~/ ИНН
346 "kpp": "string", ~/~/ КПП
347 "address": "string", ~/~/ юридический адрес
348 "addressFact": "string", ~/~/ фактический адрес
349 "email": "string", ~/~/ email
350 "director": "string", ~/~/ ФИО руководителя
351 "bankName": "string", ~/~/ банк
352 "bankBIK": "string", ~/~/ БИК
353 "bankRS": "string", ~/~/ номер счёта
354 "bankKS": "string" ~/~/ корр. счёт
355 }
356
357 == (% style="color:#000000; font-size:16px" %)**Удаление клиента**(%%) ==
358
359 (% class="box errormessage" %)
360 (((
361 **DELETE /api/v3/agents/{clientId}**
362 )))
363
364 Метод позволяет удалить клиента, указанного в строке запроса.
365
366 Метод запроса: **DELETE**
367
368 URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents/>>https://hosting.glonasssoft.ru/api/v3/agents/]]**{clientId}**
369
370 Параметр запроса: **{clientId}** - Guid пользователя
371
372 В заголовках запроса: X-Auth: Токен авторизации
373
374 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
375
376 == (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
377
378 (% class="box warningmessage" %)
379 (((
380 **PUT /api/v3/agents/{id}/changeStatus/{status}**
381 )))
382
383 Метод позволяет изменить статус клиента, указанного в запросе.
384
385 В пути указывается GUID клиента и статус клиента.
386
387 **status **- значение 0 - заблокирован, 1 - активен.
388
389 Ответ: Code 204
390
391 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
392
393 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
394
395 (% class="box successmessage" %)
396 (((
397 (% lang="en-US" %)**POST /api/v3/users**
398 )))
399
400 (% style="color:#000000" %)Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе.
401
402 (% style="color:#000000" %)Метод запроса: **POST**
403
404 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
405
406 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
407
408 (% style="color:#000000" %)Параметры в теле запроса (JSON):
409
410 (% style="color:#000000" %)
411 { 
412 "lastName": "", ~/~/ фамилия
413 "firstName": "", ~/~/ имя
414 "position": "", ~/~/ должность
415 "phone": "", ~/~/ телефон
416 "organization": "", ~/~/ организация
417 "login": "", ~/~/ логин (обязателен)
418 "password": "", ~/~/ пароль (обязателен)
419 "email": "", ~/~/ email (обязателен)
420 "description": "string", ~/~/ Описание
421 "isReadOnly": true, ~/~/ Право только на чтение, true - включено, false - отключено
422 "isDisabledMobile": true, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
423 "isEnabled": true, ~/~/ Включен, true - включен, false - отключен
424 "parentId": "", ~/~/ Guid родительского агента
425 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
426 "sessionDuration": 0, ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
427 "doubleAuth":
428 {
429 "kind": 0, ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
430 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
431 },
432 "groups":
433 [
434 "string" ~/~/ группы пользователя, перечисление названия системных ролей
435 ],
436 "customGroups":
437 [
438 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей
439 ],
440 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
441 }
442 {
443 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
444 "lastName": "string",
445 "firstName": "string",
446 "position": "string",
447 "phone": "string",
448 "organization": "string",
449 "login": "string",
450 "password": "string",
451 "email": "string",
452
453 (% style="text-align:left" %)
454 (% style="color:#000000; font-weight:normal" %)Ответ:
455 {     
456 "id": "" , ~/~/ ID пользователя
457 "lastName": "" , ~/~/ Фамилия ,
458 "firstName": "" , ~/~/ Имя
459 "position": "" , ~/~/ Должность
460 "phone": "" , ~/~/ Телефон
461 "organization": "" , ~/~/ Организация
462 "login": "" , ~/~/ Логин
463 "password": "" , ~/~/ Пароль
464 "email": "" , ~/~/ Email
465 "description": "" , ~/~/ Описание
466 "isEnabled": "" , ~/~/ Признак включения
467 "parentId": "" , ~/~/ Guid родительского агента
468 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
469 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
470 "kind": "" , ~/~/ тип аутентификации
471 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
472 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
473 }
474
475
476 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) ==
477
478 (% class="box infomessage" %)
479 (((
480 (% lang="en-US" %)**POST /api/v3/users/find**
481 )))
482
483 (% style="color:#000000" %)Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
484
485 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
486
487 (% style="color:#000000" %)Метод запроса: **POST**
488
489 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
490
491 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
492
493 (% style="color:#000000" %)Параметры в теле запроса (JSON):
494
495 (% style="color:#000000" %){(%%)
496 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
497 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
498 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
499 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
500 (% style="color:#000000" %)}
501
502 (% style="color:#000000" %)Ответ:
503
504 (% style="color:#000000" %){         (%%)
505 "id": "" , ~/~/ идентификатор пользователя
506 "lastName": "" , ~/~/ фамилия
507 "firstName": "" , ~/~/ имя
508 "position": "" , ~/~/ должность
509 "phone": "" , ~/~/ телефон
510 "parentId": "" , ~/~/ идентификатор клиента-родителя
511 "parentName": "" , ~/~/ наименование клиента-родителя
512 "organization": "" , ~/~/ организация
513 "login": "" , ~/~/ логин
514 "email": "" , ~/~/ E-mail
515 "sessionDuration":"", ~/~/ длительность сессии в минутах
516 "status": "1",  ~/~/ статус пользователя
517 "lastLogged": "", ~/~/ дата/время последней авторизации
518 (% style="color:#000000" %)}
519
520 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) ==
521
522 (% class="box infomessage" %)
523 (((
524 (% lang="en-US" %)**GET /api/v3/users/{GUID}**
525 )))
526
527 (% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
528
529 (% style="color:#000000" %)Метод запроса: **GET**
530
531 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
532
533 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
534
535 (% style="color:#000000" %)Ответ:
536
537 (((
538 (((
539 {
540 "id": "", ~/~/ GUID пользователя
541 "lastName": "", ~/~/ Фамилия 
542 "firstName": "", ~/~/ Имя
543 "position": "", ~/~/ Должность
544 "phone": "", ~/~/ Номер телефона
545 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
546 "parentName": "", Наименование клиента, которому принадлежит пользователь
547 "organization": "", ~/~/ Организация
548 "login": "", ~/~/ Логин пользователя
549 "email": "", ~/~/ Адрес электронной почты
550 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
551 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
552 "description": "", ~/~/ Описание
553 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
554 "doubleAuth":
555 {
556 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
557 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
558 },
559 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
560 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
561 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
562 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
563 "groups": [], ~/~/ Список ролей пользователя
564 "customGroups": [], ~/~/ Список клиентских ролей пользователя
565 "authDevices": [ ], ~/~/ Список авторизованных устройств
566 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
567 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
568 }
569 )))
570 )))
571
572 == (% style="color:#000000; font-size:16px" %)**Редактирование пользователя**(%%) ==
573
574 (% class="box warningmessage" %)
575 (((
576 (% lang="en-US" %)**PUT /api/v3/users**
577 )))
578
579 (% style="color:#000000" %)Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе.
580
581 (% style="color:#000000" %)Метод запроса: **PUT**
582
583 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
584
585 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
586
587 (% lang="en-US" style="text-align:left" %)
588 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
589
590 (% lang="en-US" style="text-align:left" %)
591 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){   
592 "id": "" , ~/~/ ID пользователя 
593 "lastName": "" , ~/~/ фамилия
594 "firstName": "" , ~/~/ имя
595 "position": "" , ~/~/ должность
596 "phone": "" , ~/~/ телефон
597 "organization": "" , ~/~/ организация
598 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
599 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
600 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
601 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
602 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
603 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
604 "isEnabled": "" , ~/~/ признак включения
605 "parentId": "" , ~/~/ Guid родительского агента
606 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
607 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
608 "doubleAuth":
609 {
610 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
611 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
612 },
613 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
614 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%)
615 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
616
617 (% lang="en-US" style="text-align:left" %)
618 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
619
620 (% lang="en-US" style="text-align:left" %)
621 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){     
622 "id": "" , ~/~/ идентификатор пользователя
623 "lastName": "" , ~/~/ фамилия
624 "firstName": "" , ~/~/ имя
625 "position": "" , ~/~/ должность
626 "phone": "" , ~/~/ телефон
627 "organization": "" , ~/~/ организация
628 "login": "" , ~/~/ логин
629 "password": "" , ~/~/ пароль 
630 "email": "" , ~/~/ email
631 "description": "" , ~/~/ описание
632 "isEnabled": "" , ~/~/ признак включения
633 "parentId": "" , ~/~/ Guid родительского агента
634 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
635 "doubleAuth":
636 {
637 "kind": "None", ~/~/ Состояние двухэтапной аутентификации, email - включен, None - отключен
638 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации
639 },
640 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
641 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
642 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
643 }
644
645 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) ==
646
647 (% class="box warningmessage" %)
648 (((
649 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
650 )))
651
652 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
653
654 (% style="color:#000000" %)Метод запроса: **PUT**
655
656 (% 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}
657
658 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
659
660 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
661
662 (% style="color:#000000" %)Параметры в теле запроса (JSON):
663
664 (% style="color:#000000" %){(%%)
665 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
666 "description": "" , ~/~/ описание
667 "data": "" , ~/~/ данные, связанные со сменой статуса
668 (% style="color:#000000" %)}
669
670 (% style="text-align:left" %)
671 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
672
673 == (% style="color:#000000; font-size:16px" %)**Блокировка пользователей**(%%) ==
674
675 (% class="box warningmessage" %)
676 (((
677 **POST /api/v3/users/disable**
678 )))
679
680 Метода позволяет выполнить массовую блокировку пользователей(% style="color:#000000" %).
681
682 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
683
684 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
685
686 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
687
688 [ 
689 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
690 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
691 ]
692
693 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
694
695 == (% style="color:#000000; font-size:16px" %)**Разблокировка пользователей**(%%) ==
696
697 (% class="box warningmessage" %)
698 (((
699 **POST /api/v3/users/enable**
700 )))
701
702 Метода позволяет выполнить массовую разблокировку пользователей(% style="color:#000000" %).
703
704 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
705
706 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
707
708 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
709
710 [ 
711 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
712 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
713 ]
714
715 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
716 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
717
718 (((
719 В теле ответа:
720 {
721 "errorMessages": [
722 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
723 ],
724 "users": [
725 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
726 ]
727 }
728 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
729 "users" - массив id пользователей, которых не удалось включить или отключить.
730 )))
731
732 == (% style="color:#000000; font-size:16px" %)**Удаление пользователя**(%%) ==
733
734 (% class="box errormessage" %)
735 (((
736 (% lang="en-US" %)**DELETE /api/v3/users/{id}**
737 )))
738
739 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
740
741 (% style="color:#000000" %)Метод запроса: **DELETE**
742
743 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
744
745 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
746
747 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
748
749 (% style="text-align:left" %)
750 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
751
752 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) =
753
754 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) ==
755
756 (% class="box infomessage" %)
757 (((
758 (% lang="en-US" %)**GET /api/v3/models/{Id}**
759 )))
760
761 Метод возвращает полную информацию о модели объекта.
762
763 (% style="color:#000000" %)Метод запроса: **GET**
764
765 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID}
766
767 (% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта
768
769 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
770
771 (% style="color:#000000" %)Ответ:
772
773 (% style="color:#000000" %){
774 "parentName": "string",
775 "name": "string",
776 "picture": "string",
777 "minspeed": 0,
778 "maxspeed": 0,
779 "width": 0,
780 "imbeddedtrailer": true,
781 "hoppercapacity": 0,
782 "hopperdischargespeed": 0,
783 "modelType": 0,
784 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
785 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
786 "deleted": true
787 }
788
789 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
790 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
791 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
792 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
793 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
794 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
795 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
796 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
797 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
798 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек
799 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
800 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
801 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
802 |(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean
803
804 == (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) ==
805
806 (% class="box successmessage" %)
807 (((
808 (% lang="en-US" %)**POST /api/v3/models/find**
809 )))
810
811 (% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе.
812
813 (% style="color:#000000" %)Метод запроса: **POST**
814
815 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find
816
817 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
818
819 (% style="color:#000000" %)Параметры в теле запроса (JSON):{
820
821 (% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
822 }
823
824 (% style="color:#000000" %)Ответ:
825
826 (% style="color:#000000" %)[
827 {
828 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
829 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
830 "parentName": "string",
831 "name": "string",
832 "modelType": 0
833 }
834 ]
835
836 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
837 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
838 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
839 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
840 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
841 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
842
843 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) ==
844
845 (% class="box successmessage" %)
846 (((
847 (% lang="en-US" %)**POST /api/v3/models**
848 )))
849
850 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
851
852 (% style="color:#000000" %)Метод запроса: **POST**
853
854 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models
855
856 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
857
858 (% style="color:#000000" %)Параметры в теле запроса (JSON):
859
860 {
861 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
862 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
863 "deleted": true,
864 "extId": "string",
865 "name": "string",
866 "picture": "string",
867 "minspeed": 0,
868 "maxspeed": 0,
869 "width": 0,
870 "imbeddedtrailer": true,
871 "fueloutlay": 0,
872 "hoppercapacity": 0,
873 "hopperdischargespeed": 0,
874 "modelType": 0
875 }
876
877 Ответ:
878
879 {
880 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
881 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
882 "deleted": true,
883 "extId": "string",
884 "name": "string",
885 "picture": "string",
886 "minspeed": 0,
887 "maxspeed": 0,
888 "width": 0,
889 "imbeddedtrailer": true,
890 "hoppercapacity": 0,
891 "hopperdischargespeed": 0,
892 "modelType": 0
893 }
894
895 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
896 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
897 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
898 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
899 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
900 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
901 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
902 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
903 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
904 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
905 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
906 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
907 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
908
909 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) ==
910
911 (% class="box warningmessage" %)
912 (((
913 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
914 )))
915
916 (% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
917
918 (% style="color:#000000" %)Метод запроса: **PUT**
919
920 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models
921
922 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
923
924 (% style="color:#000000" %)Параметры в теле запроса (JSON):
925
926 {
927 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
928 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
929 "deleted": true,
930 "extId": "string",
931 "name": "string",
932 "picture": "string",
933 "minspeed": 0,
934 "maxspeed": 0,
935 "width": 0,
936 "imbeddedtrailer": true,
937 "fueloutlay": 0,
938 "hoppercapacity": 0,
939 "hopperdischargespeed": 0,
940 "modelType": 0
941 }
942
943 Ответ:
944
945 {
946 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
947 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
948 "deleted": true,
949 "extId": "string",
950 "name": "string",
951 "picture": "string",
952 "minspeed": 0,
953 "maxspeed": 0,
954 "width": 0,
955 "imbeddedtrailer": true,
956 "fueloutlay": 0,
957 "hoppercapacity": 0,
958 "hopperdischargespeed": 0,
959 "modelType": 0
960 }
961
962 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
963 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта
964 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта
965 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта
966 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта
967 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта
968 |(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч
969 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч
970 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах
971 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат
972 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера
973 |(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек
974 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car
975
976 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) ==
977
978 (% class="box errormessage" %)
979 (((
980 (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
981 )))
982
983 (% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
984
985 (% style="color:#000000" %)Метод запроса: **DELETE**
986
987 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id}
988
989 (% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели
990
991 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
992
993 Ответ: В случае успеха **Success 200**
994
995 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) =
996
997 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) ==
998
999 (% class="box infomessage" %)
1000 (((
1001 (% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
1002 )))
1003
1004 (% style="color:#000000" %)Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
1005
1006 (% style="color:#000000" %)Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе:
1007
1008 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
1009
1010 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
1011
1012 (% style="color:#000000" %)Метод запроса: **GET**
1013
1014 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
1015
1016 (% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
1017
1018 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1019
1020 (% style="color:#000000" %)Ответ:
1021
1022 (((
1023 {
1024
1025 (((
1026 "showLineTrackWhenNoCoords": true,  ~/~/ Обозначать трек при отсутствии координат.
1027 "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства
1028 )))
1029
1030 (((
1031 ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink
1032 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1033 )))
1034
1035 "vehicleId": "", ~/~/ ID объекта
1036 "name": "", ~/~/ Имя объекта
1037 "imei": "", ~/~/ IMEI объекта
1038 "deviceTypeId": , ~/~/ ID типа устройства
1039 "deviceTypeName": "", ~/~/ Название типа устройства
1040 "sim1": "", ~/~/ Номер SIM1
1041 "sim2": "", ~/~/ Номер SIM2
1042 "parentId": "", ~/~/ ID клиента-родителя
1043 "parentName": "", ~/~/ Наименование клиента-родителя
1044 "modelId": "", ~/~/ ID модели объекта
1045 "modelName": "", ~/~/ Имя модели объекта
1046 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1047 "unitName": "string", ~/~/ Наименование подразделения
1048 "status": 0, ~/~/ Статус объекта
1049 "createdAt": "", ~/~/ Дата создания объекта
1050 },
1051 "customFields": [ ~/~/ Произвольные поля
1052 {
1053 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
1054 "name": "string", ~/~/ Имя поля
1055 "value": "string", ~/~/ Значение поля
1056 "forClient": true, ~/~/ Не используемая функция
1057 "forTooltip": true, ~/~/ Отображать в подсказке
1058 "forReport": true ~/~/ Отображать в отчете
1059 }
1060
1061 ], ~/~/ Данные с вкладки нормы
1062 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1063 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1064 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1065 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1066 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1067 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1068 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1069 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1070 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1071 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
1072 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1073 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х  
1074 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
1075 "mileageCoeff": 0, ~/~/ коэффициент пробега
1076 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
1077 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
1078 "counters": { ~/~/ Счетчики
1079 "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
1080 "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
1081 "mileage": 0, ~/~/ Текущий пробег
1082 "motohours": 0, ~/~/ Текущие моточасы
1083 "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
1084 "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
1085 },
1086
1087 "cmsv6Parameters": { ~/~/ Настройки видеомониторинга
1088 "id": "string", ~/~/ ID объекта
1089 "enabled": true, ~/~/ Включить, true - активна, false - не активна
1090 "host": "string", ~/~/ CMSV6 Web Host
1091 "login": "string", ~/~/ CMSV6 Account
1092 "password": "string" ~/~/ CMSV6 Password
1093 },
1094
1095 "commandTemplates": [ ~/~/ Шаблоны команд
1096 {
1097 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
1098 "name": "string", ~/~/ Наименование команды
1099 "command": "string", ~/~/ Текст команды
1100 "retries": 0 ~/~/ Количество попыток
1101 }
1102 ],
1103 "sensors": [ ~/~/ Датчики
1104 {
1105 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1106 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1107 "type": 0, ~/~/ Тип датчика
1108 "name": "string", ~/~/ Имя датчика
1109 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1110 "inputNumber": 0, ~/~/ Номер входа
1111 "pseudonym": "string", ~/~/ Псевдоним
1112 "medianDegree": 0, ~/~/ Медианная фильтрация
1113 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1114 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1115 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1116 "gradesTables": [ ~/~/ Массив таблиц тарировки
1117 {
1118 "grades": [ ~/~/ Таблица тарировки 1
1119 {
1120 "input": 0, ~/~/ Входящее значение
1121 "output": 0 ~/~/ Выходящее значение
1122 }
1123 ],
1124 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1125 }
1126 ],
1127 "showInTooltip": true, ~/~/ Отображать в подсказке
1128 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1129 "color": "string", ~/~/ Код цвета датчиков
1130 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1131 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1132 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1133 "expr": "string", ~/~/ Формула
1134 "children": [ ~/~/ массив дочерних датчиков
1135 "string"
1136 ],
1137 "customParams": { ~/~/ прочие произвольные параметры
1138 "additionalProp1": "string",
1139 "additionalProp2": "string",
1140 "additionalProp3": "string"
1141 },
1142
1143 ~/~/ Характерные для произвольного:
1144 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1145 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1146 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1147 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1148 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1149 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1150 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1151 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1152 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1153 ~/~/ "ValueOn": "Вкл.",
1154 ~/~/ "ValueOff": "Выкл."
1155 "summaryMaxValue": 0 ~/~/ Макс. значение
1156 }
1157 "drivers": [ ~/~/ Водители
1158 {
1159 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1160 "name": "string", ~/~/ Наименование
1161 "description": "string",
1162 "isDefault": true ~/~/ По умолчанию
1163 }
1164 ],
1165 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
1166 {
1167 "id": "", ~/~/ ID  задания
1168 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
1169 "name": "", ~/~/ Наименование задания
1170 "description": "", ~/~/ Описание задания
1171 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1172 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1173 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1174 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1175 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1176 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1177 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
1178 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1179 }
1180 ],
1181 "statusHistory": [ ~/~/ История статусов
1182 {
1183 "status": 0,
1184 "date": "2023-05-22T09:57:39.562Z",
1185 "description": "string",
1186 "additionalInfo": "string"
1187
1188 (((
1189 }
1190 ],
1191 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1192 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов.
1193 )))
1194
1195 (((
1196 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1197 }
1198
1199 )))
1200 )))
1201
1202 (% style="text-align:left" %)
1203 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
1204
1205 (% style="text-align:left" %)
1206 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1207
1208
1209 == **Отправить команду на терминал** ==
1210
1211 (% class="box successmessage" %)
1212 (((
1213 (% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1214 )))
1215
1216 Команда для отправки на тс.
1217
1218 {  
1219 "id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId)
1220 "command": "", ~/~/ Текст отправляемой команды
1221 "retries": "", ~/~/ Количество попыток отправки на терминал
1222 "idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 
1223 }
1224
1225 В ответ получаем cmdid
1226
1227
1228 == **Получить ответ на отправленную на ТС команду** ==
1229
1230 (% class="box infomessage" %)
1231 (((
1232 (% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1233 )))
1234
1235 Идентификатор команды: cmdId
1236
1237 Запрос от терминала на ответ команды
1238
1239 Пример ответ от терминала:
1240
1241 ID= "" ~/~/ идентификатор объекта
1242 Soft="" ~/~/ версия софта
1243 GPS=4 ~/~/ тип трекера
1244 Time=11:05:43 28.06.24 ~/~/ время запроса
1245 Lat=45.056221 ~/~/ широта
1246 Lon=39.035938 ~/~/ долгота
1247 Speed=0.0 ~/~/ скорость
1248 Course=181.4 ~/~/направление
1249
1250 (((
1251 == **Список отправленных объекту команд с ответами** ==
1252
1253 (% class="box infomessage" %)
1254 (((
1255 (% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1256 )))
1257
1258 Идентификатор ТС: vehicleId
1259
1260 В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1261
1262 Пример ответа терминала
1263
1264 [ 
1265 {    
1266 "id": "", ~/~/ идентификатор пользователя
1267 "commandText": "", ~/~/Текст команды.
1268 "templateId": "", ~/~/Идентификатор шаблона
1269 "updated": "", ~/~/ Время отправки  
1270 "tryCount": 0, ~/~/ Количество попыток отправки команды
1271 "answer": "", ~/~/ Ответ терминала.
1272 "status": "" ~/~/ Статус отправки
1273 }
1274 ]
1275 )))
1276
1277 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1278
1279 (% class="box successmessage" %)
1280 (((
1281 (% lang="en-US" %)**POST /api/v3/vehicles**
1282 )))
1283
1284 (% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
1285
1286 (% style="color:#000000" %)Метод запроса: **POST**
1287
1288 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1289
1290 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1291
1292 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
1293
1294 (% style="color:#000000" %){
1295
1296
1297 (((
1298 "vehicleId": 0, ~/~/ ID ТС
1299 )))
1300
1301 "parentId": "" , ~/~/ ID клиента
1302 "name": "" , ~/~/ имя ТС
1303 "imei": "" , ~/~/ IMEI
1304 "deviceTypeId": "" , ~/~/ ID типа устройства
1305 "modelId": "" , ~/~/ ID модели
1306 "unitId": "" , ~/~/ ID подразделения
1307 "sim1": "" , ~/~/ Номер SIM 1
1308 "sim2": "" , ~/~/ Номер SIM2
1309 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1310 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1311 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1312 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1313 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1314 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1315 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1316 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1317 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1318 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1319 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1320 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1321 "mileageCalcMethod": 0,
1322 "mileageCoeff": 0,
1323 "locationByCellId": true,
1324 "dottedLineTrackWhenNoCoords": true,
1325 "counters": ~/~/ счетчики
1326 {
1327 "mileage": "" , ~/~/ пробег
1328 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1329 "motohours": "" , ~/~/ моточасы
1330 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1331 },
1332 "cmsv6Parameters": { ~/~/ параметры CMSv6
1333 "enabled": true, ~/~/ флаг включения
1334 "id": "" , ~/~/ идентификатор
1335 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1336 "login": "" , ~/~/ имя учетной записи
1337 "password": "" ~/~/ пароль учетной записи
1338 },
1339 "inspectionTasks": ~/~/ задания на ТО
1340 {
1341 "enabled": "" , ~/~/ Признак включения
1342 "name": "" , ~/~/ Имя задания
1343 "description": "" , ~/~/ Описание задания
1344 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1345 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1346 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1347 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1348 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1349 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1350 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1351 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1352 }
1353 "drivers": [ ~/~/ Водители
1354 {
1355 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1356 "isDefault": true
1357 }
1358 ],
1359 "commandTemplates": [ ~/~/ Шаблон команды
1360 {
1361 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1362 "name": "string",
1363 "command": "string",
1364 "retries": 0
1365 }
1366 ],
1367 "sensors": [ ~/~/ Датчики
1368 {
1369 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1370 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1371 "type": 0, ~/~/ Тип датчика
1372 "name": "string", ~/~/ Имя датчика
1373 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1374 "inputNumber": 0, ~/~/ Номер входа
1375 "pseudonym": "string", ~/~/ Псевдоним
1376 "medianDegree": 0, ~/~/ Медианная фильтрация
1377 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1378 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1379 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1380 "gradesTables": [ ~/~/ Массив таблиц тарировки
1381 {
1382 "grades": [ ~/~/ Таблица тарировки 1
1383 {
1384 "input": 0, ~/~/ Входящее значение
1385 "output": 0 ~/~/ Выходящее значение
1386 }
1387 ],
1388 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1389 }
1390 ],
1391 "showInTooltip": true, ~/~/ Отображать в подсказке
1392 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1393 "color": "string", ~/~/ код цвета датчиков
1394 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1395 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1396 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1397 "expr": "string", ~/~/ Формула
1398 "children": [ ~/~/ массив дочерних датчиков
1399 "string"
1400 ],
1401 "customParams": { ~/~/ прочие произвольные параметры
1402 "additionalProp1": "string",
1403 "additionalProp2": "string",
1404 "additionalProp3": "string"
1405 },
1406 ~/~/ Характерные для произвольного:
1407 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1408 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1409 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1410 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1411 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1412 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1413 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1414 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1415 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1416 ~/~/ "ValueOn": "Вкл.",
1417 ~/~/ "ValueOff": "Выкл."
1418 "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления.
1419
1420 (((
1421 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1422 {
1423 "from": 0, ~/~/ С какого значения
1424 "color": "string", ~/~/ Каким цветом
1425 "text": "string" ~/~/ Текст подписи к этому интервалу
1426 }
1427 ]
1428 }
1429 ],
1430 )))
1431
1432 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1433
1434
1435 "customFields": [ ~/~/ Произвольные поля
1436 {
1437 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
1438 "name": "string", ~/~/ Наименование произвольного поля
1439 "value": "string", ~/~/ Значение произвольного поля
1440 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1441 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1442 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1443
1444 (((
1445 }
1446 ],
1447 "motohoursCalcMethod": 0 ~/~/  Вид расчета моточасов.
1448 )))
1449
1450 (((
1451 ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1452 }
1453 )))
1454
1455
1456 (% style="color:#000000" %)Ответ:
1457
1458
1459 (((
1460 (((
1461 (((
1462 {
1463 "vehicleId": 0,  ~/~/ ID ТС
1464 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС
1465 "name": "string", ~/~/ Имя объекта
1466 "imei": "string", ~/~/ IMEI
1467 "deviceTypeId": 0, ~/~/ ID типа устройства
1468 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ ID модели
1469 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
1470 "sim1": "string", ~/~/ SIM1
1471 "sim2": "string", ~/~/ SIM2
1472 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
1473 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
1474 "consumptionIdle": 0,  ~/~/ Расход топлива на холостом ходу
1475 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
1476 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1477 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
1478 "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1479 "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1480 "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1481 "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1482 "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1483 "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1484 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor)
1485 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
1486 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
1487 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
1488 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
1489 "counters": {  ~/~/ Dto для состояний счётчиков
1490 "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег"
1491 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
1492 "mileage": 0, ~/~/ Пробег
1493 "motohours": 0 ~/~/ Моточасы
1494 },
1495 "cmsv6Parameters": { ~/~/ Dto для CMSv6
1496 "id": "string", ~/~/ CMSV6 Идентификатор
1497 "enabled": true, ~/~/ Признак включения
1498 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
1499 "login": "string", ~/~/ CMSV6 имя учетной записи
1500 "password": "string" ~/~/ CMSV6 — пароль учетной записи
1501 },
1502 "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО
1503 {
1504 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
1505 "enabled": true, ~/~/ Признак включения
1506 "name": "string", ~/~/ Имя задания
1507 "description": "string", ~/~/ Описание задания
1508 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
1509 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
1510 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
1511 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
1512 "periodicCondition": 0, ~/~/ Условие периодичности по времени
1513 "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы)
1514 "lastInspectionDate": "2024-10-30T08:11:35.622Z",  ~/~/  Дата последнего ТО
1515 "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации
1516 }
1517 ],
1518 "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект.
1519 {
1520 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
1521 "inputNumber": 0, ~/~/ № входа.
1522 "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения.
1523 "comment": "string", ~/~/ Комментарий
1524 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1525 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1526 "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения.
1527 "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения.
1528 }
1529 ],
1530 "commandTemplates": [  ~/~/ Список шаблонов команд
1531 {
1532 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
1533 "name": "string", ~/~/ Название шаблона команд
1534 "command": "string", ~/~/ Команда на выполнение
1535 "retries": 0 ~/~/ Лимит попыток отправки
1536 }
1537 ],
1538 "sensors": [ ~/~/ Список датчиков
1539 {
1540 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1541 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
1542 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
1543 "name": "string",  ~/~/ Имя датчика
1544 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
1545 "inputNumber": 0, ~/~/ Номер входа
1546 "pseudonym": "string", ~/~/ Псевдоним
1547 "medianDegree": 0, ~/~/ Степень медианной фильтрации
1548 "isInverted": true, ~/~/  Признак инверсии
1549 "disabled": true, ~/~/ Датчик не участвует в обработке
1550 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1551 "gradesTables": [ ~/~/ Тарировка
1552 {
1553 "grades": [ ~/~/ Таблицы тарировки
1554 {
1555 "input": 0, ~/~/ Вход
1556 "output": 0 ~/~/ Выход
1557 }
1558 ],
1559 "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки
1560 }
1561 ],
1562 "showInTooltip": true, ~/~/ Отображение в подсказке
1563 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1564 "color": "string", ~/~/ код цвета датчиков
1565 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1566 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
1567 "agrFunction": 0,  ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION
1568 "expr": "string", ~/~/ Выражение
1569 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
1570 "string"
1571 ],
1572 "customParams": {
1573 "additionalProp1": "string",
1574 "additionalProp2": "string",
1575 "additionalProp3": "string"
1576 },
1577 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
1578 "valueIntervals": [  ~/~/ Интервалы значений для подсветки в мониторинге
1579 {
1580 "from": 0, ~/~/ С какого значения
1581 "color": "string", ~/~/ Каким цветом
1582 )))
1583
1584 (((
1585 "text": "string" ~/~/ Текст подписи к этому интервалу
1586 }
1587 ]
1588 }
1589 ],
1590 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1591 "customFields": [ ~/~/ Список произвольных полей
1592 {
1593 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1594 "name": "string", ~/~/ Наименование произвольного поля
1595 "value": "string", ~/~/ Значение произвольного поля
1596 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
1597 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
1598 "forReport": true ~/~/ Отобразить произвольное поле в отчете
1599 }
1600 ],
1601 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
1602 }
1603 )))
1604 )))
1605 )))
1606
1607
1608 **Валидация:**
1609 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1610 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1611 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1612
1613
1614 == **Импортировать историю ТС (Асинхронный запрос)** ==
1615
1616 (% class="box successmessage" %)
1617 (((
1618 **POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1619 )))
1620
1621 Метод запроса: **POST**
1622
1623 URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1624
1625 Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1626
1627
1628 Ответ:
1629
1630 {
1631
1632 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1633
1634 "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1635
1636 ~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1637
1638 "Message": "string", ~/~/ Информация о выполнении запроса
1639
1640 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1641
1642 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1643
1644 "Data": "string" ~/~/ Данные
1645
1646 }
1647
1648
1649 == **Возвращает статус асинхронного запроса импорта истории ТС** ==
1650
1651 (% class="box infomessage" %)
1652 (((
1653 **GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1654 )))
1655
1656 Метод запроса: **GET**
1657
1658 URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1659
1660 Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1661
1662
1663 Ответ:
1664
1665 {
1666
1667 "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1668
1669 "Status": 0, ~/~/ Перечисление состояний выполения запроса
1670 ~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1671
1672 "Message": "string", ~/~/ Информация о выполнении запроса
1673
1674 "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1675
1676 ~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1677
1678 "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1679
1680 "Data": "string" ~/~/ Данные
1681
1682 }
1683
1684
1685 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1686
1687 (% class="box infomessage" %)
1688 (((
1689 (% lang="en-US" %)**POST /api/v3/vehicles/find**
1690 )))
1691
1692 (% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1693
1694 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1695
1696 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
1697
1698 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
1699
1700 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
1701
1702 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
1703
1704 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
1705
1706 (% style="color:#000000" %)Метод запроса: **POST**
1707
1708 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
1709
1710 (% style="color:#000000" %)В заголовках запроса:
1711
1712 (% style="color:#000000" %)− Content-Type: __**application/json**__
1713
1714 (% style="color:#000000" %)− X-Auth: Токен авторизации
1715
1716 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
1717
1718 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1719
1720 {
1721 "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
1722 "name": null, ~/~/ Имя ТС (string, опционально)
1723 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
1724 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
1725 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
1726 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально)
1727 "unitName": "string",  ~/~/ Название подразделения (опционально)
1728 "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально)
1729 "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально)
1730 "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально)
1731 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные
1732 }
1733
1734 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
1735
1736 (% style="color:#000000" %)Ответ:
1737
1738 (% style="color:#000000" %)[
1739 {
1740
1741 (((
1742 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC
1743 )))
1744
1745 (((
1746 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
1747 "name": "" ~/~/ наименование объекта
1748 "imei": "" ~/~/ IMEI объекта
1749 "deviceTypeId": "" ~/~/ идентификатор типа устройства
1750 "deviceTypeName": "" ~/~/ наименование типа устройства
1751 "sim1": "" ~/~/ первый номер телефона
1752 "sim2": "" ~/~/ второй номер телефона
1753 "parentId": "" ~/~/ идентификатор клиента-родителя
1754 "parentName": "" ~/~/ наименование клиента-родителя
1755 "modelId": "" ~/~/ идентификатор модели объекта
1756 "modelName": "" ~/~/ наименование модели объекта
1757 "unitId": "" ~/~/ идентификатор подразделения
1758 "unitName": "" ~/~/ наименование подразделения
1759 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1760 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1761 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1762 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
1763 "customFields": [ 
1764 {
1765 "id": "", ~/~/ идентификатор произвольного поля
1766 "name": "", ~/~/ имя произвольного поля
1767 "value": "", ~/~/ значение произвольного поля
1768 "forClient": true, ~/~/ право на отображение у клиента
1769 "forTooltip": false, ~/~/ право на отображение в подсказке
1770 "forReport": false ~/~/ право на отображение в отчетах
1771 )))
1772
1773 (((
1774 }
1775 ],
1776 "vehicleGroups": [  ~/~/ Группы ТС
1777 {
1778 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
1779 "name": "string" ~/~/ Наименование группы ТС
1780 }
1781 ]
1782 }
1783 ]
1784 )))
1785
1786 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
1787
1788 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) ==
1789
1790 (% class="box successmessage" %)
1791 (((
1792 (% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
1793 )))
1794
1795 (% style="color:#000000" %)Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе.
1796
1797 (% style="color:#000000" %)Метод запроса: **POST**
1798
1799 (% 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}
1800
1801 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
1802
1803 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1804
1805 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1806
1807 (% style="color:#000000" %){
1808
1809 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
1810 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
1811 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
1812 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
1813 "description": "", ~/~/ Описание
1814 "data": "", ~/~/ Данные
1815 "overwrite": false, ~/~/ Флаг перезаписи
1816 "stage": "", ~/~/ Состояние, может быть null
1817 (% style="color:#000000" %)}
1818
1819 (% style="color:#000000" %)Ответ:
1820
1821 (% style="color:#000000" %){(%%)
1822 "status": "", ~/~/ значение статуса
1823 "date": "", ~/~/ Дата смены статуса 
1824 "description": "", ~/~/ Описание
1825 "data": "", ~/~/ Данные
1826 "overwrite": false, ~/~/ Флаг перезаписи
1827 "stage": "", ~/~/ Состояние
1828 (% style="color:#000000" %) }
1829
1830 == ==
1831
1832 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1833
1834 (% class="box warningmessage" %)
1835 (((
1836 (% lang="en-US" %)**PUT /api/v3/vehicles**
1837 )))
1838
1839 (% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1840
1841 (% style="color:#000000" %)Метод запроса: **PUT**
1842
1843 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1844
1845 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1846
1847 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1848
1849 (% style="color:#000000" %){
1850 "vehicleId": , ~/~/ ID объекта
1851 "parentId": "" , ~/~/ ID клиента
1852 "name": "" , ~/~/ имя ТС
1853 "imei": "" , ~/~/ IMEI
1854 "deviceTypeId": "" , ~/~/ ID типа устройства
1855 "modelId": "" , ~/~/ ID модели
1856 "unitId": "" , ~/~/ ID подразделения
1857 "sim1": "" , ~/~/ Номер SIM 1
1858 "sim2": "" , ~/~/ Номер SIM2
1859 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1860 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1861 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1862 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1863 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1864 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1865 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1866 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1867 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1868 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1869 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1870 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1871
1872 "mileageCalcMethod": 0,
1873 "mileageCoeff": 0,
1874 "locationByCellId": true,
1875 "dottedLineTrackWhenNoCoords": true,
1876 "counters": ~/~/ счетчики
1877 {
1878 "mileage": "" , ~/~/ пробег
1879 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
1880 "motohours": "" , ~/~/ моточасы
1881 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
1882 },
1883 "cmsv6Parameters": { ~/~/ параметры CMSv6
1884 "enabled": true, ~/~/ флаг включения
1885 "id": "" , ~/~/ идентификатор
1886 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1887 "login": "" , ~/~/ имя учетной записи
1888 "password": "" ~/~/ пароль учетной записи
1889 },
1890 "inspectionTasks": ~/~/ задания на ТО
1891 {
1892 "enabled": "" , ~/~/ Признак включения
1893 "name": "" , ~/~/ Имя задания
1894 "description": "" , ~/~/ Описание задания
1895 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1896 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1897 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1898 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1899 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
1900 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
1901 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
1902 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
1903 }
1904
1905 "drivers": [ ~/~/ Водители
1906 {
1907
1908 (((
1909 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор объекта.
1910 "inputNumber": 0, ~/~/ № входа.
1911 "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения.
1912 "comment": "string", ~/~/ Комментарий.
1913 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
1914 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
1915 "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения.
1916 "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения.
1917 )))
1918
1919 } 
1920 ],
1921 "commandTemplates": [ ~/~/ Шаблон команды
1922 {
1923 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1924 "name": "string",
1925 "command": "string",
1926 "retries": 0
1927 }
1928 ],
1929 "sensors": [ ~/~/ Датчики
1930 {
1931 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
1932 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный
1933 "type": 0, ~/~/ Тип датчика
1934 "name": "string", ~/~/ Имя датчика
1935 "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE
1936 "inputNumber": 0, ~/~/ Номер входа
1937 "pseudonym": "string", ~/~/ Псевдоним
1938 "medianDegree": 0, ~/~/ Медианная фильтрация
1939 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
1940 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
1941 "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
1942 "gradesTables": [ ~/~/ Массив таблиц тарировки
1943 {
1944 "grades": [ ~/~/ Таблица тарировки 1
1945 {
1946 "input": 0, ~/~/ Входящее значение
1947 "output": 0 ~/~/ Выходящее значение
1948 }
1949 ],
1950 "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы
1951 }
1952 ],
1953 "showInTooltip": true, ~/~/ Отображать в подсказке
1954 "showLastValid": true, ~/~/ Отображать последнее валидное значение
1955
1956 (((
1957 "color": "string",** ~/~/ **Цвет датчика
1958 )))
1959
1960 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
1961 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
1962 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION
1963 "expr": "string", ~/~/ Формула
1964 "children": [ ~/~/ массив дочерних датчиков
1965 "string"
1966 ],
1967 "customParams": { ~/~/ прочие произвольные параметры
1968 "additionalProp1": "string",
1969 "additionalProp2": "string",
1970 "additionalProp3": "string"
1971 },
1972 ~/~/ Характерные для произвольного:
1973 ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1974 ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1975 ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1976 ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1977 ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1978 ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1979 ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1980 ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1981 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1982 ~/~/ "ValueOn": "Вкл.",
1983 ~/~/ "ValueOff": "Выкл."
1984 "summaryMaxValue": 0 ~/~/ Макс. значение
1985
1986 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
1987 {
1988 "from": 0, ~/~/ С какого значения
1989 "color": "string", ~/~/ Каким цветом
1990 "text": "string" ~/~/ Текст подписи к этому интервалу
1991 }
1992 ]
1993 }
1994 ],
1995 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
1996
1997 "customFields": [ ~/~/ Произвольные поля
1998 {     
1999 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ System.Guid идентификатор элемента сущности
2000 "name": "string", ~/~/ Наименование произвольного поля
2001 "value": "string", ~/~/ Значение произвольного поля
2002 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2003 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2004 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2005 }
2006
2007 (((
2008 ],
2009 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов
2010 )))
2011
2012 }
2013
2014
2015 (% style="color:#000000" %)Ответ:
2016
2017 (((
2018 {
2019 "vehicleId": 0, ~/~/ ID ТС
2020 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 
2021 "name": "string", ~/~/ Имя объекта
2022 "imei": "string", ~/~/ IMEI
2023 "deviceTypeId": 0, ~/~/ ID типа устройства
2024 "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
2025 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
2026 "sim1": "string", ~/~/ SIM1
2027 "sim2": "string", ~/~/ SIM2
2028 "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км
2029 "consumptionPerHour": 0, ~/~/ Расход топлива на моточас
2030 "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу
2031 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км
2032 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
2033 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу
2034 "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
2035 "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
2036 "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
2037 "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
2038 "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
2039 "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
2040 "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor
2041 "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1)
2042 "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны?
2043 "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат.
2044 "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат.
2045 "counters": { ~/~/ состояний счётчиков
2046 "mileageEnabled": true,  ~/~/ Флаг включения счётчика "Пробег"
2047 "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы"
2048 "mileage": 0, ~/~/ Пробег
2049 "motohours": 0 ~/~/ Моточасы 
2050 },
2051 "cmsv6Parameters": { ~/~/ Dto для CMSv6
2052 "id": "string", ~/~/ CMSV6 Идентификатор
2053 "enabled": true, ~/~/ Признак включения
2054 "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 
2055 )))
2056
2057
2058 (((
2059 ~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол.
2060 "login": "string", ~/~/ CMSV6 имя учетной записи
2061 "password": "string" ~/~/ CMSV6 — пароль учетной записи
2062 },
2063 "inspectionTasks": [ ~/~/ Задания на ТО
2064 {
2065 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи
2066 "enabled": true, ~/~/ Признак включения
2067 "name": "string", ~/~/ Имя задания
2068 "description": "string", ~/~/ Описание задания
2069 "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах)
2070 "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО
2071 "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах)
2072 "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО
2073 "periodicCondition": 0, ~/~/ Условие периодичности по времени
2074 "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы
2075 "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО
2076 "maxQuantity": 0  ~/~/ Условие по количеству записей для деактивации
2077 }
2078 ],
2079 "drivers": [  ~/~/ Список водителей
2080 {
2081 "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта.
2082 "inputNumber": 0, ~/~/ № входа.
2083 "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения.
2084 "comment": "string", ~/~/ Комментарий.
2085 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения.
2086 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя.
2087 "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения.
2088 "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения.
2089 }
2090 ],
2091 "commandTemplates": [ ~/~/ Список шаблонов команд
2092 {
2093 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона
2094 "name": "string", ~/~/ Название шаблона команд
2095 "command": "string", ~/~/ Команда на выполнение
2096 "retries": 0 ~/~/ Лимит попыток отправки
2097 }
2098 ],
2099 "sensors": [  ~/~/ Список датчиков 
2100 {
2101 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
2102 "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite
2103 "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition,
2104 )))
2105
2106 (((
2107 ~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature,
2108 )))
2109
2110 (((
2111 ~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp,
2112 )))
2113
2114 (((
2115 ~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal,
2116 )))
2117
2118 (((
2119 ~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel,
2120 )))
2121
2122 (((
2123 ~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed
2124 "name": "string", ~/~/ Имя датчика
2125 "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse,
2126 )))
2127
2128 (((
2129 ~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual
2130 "inputNumber": 0, ~/~/ Номер входа
2131 "pseudonym": "string", ~/~/ Псевдоним
2132 "medianDegree": 0, ~/~/ Степень медианной фильтрации
2133 "isInverted": true, ~/~/ Признак инверсии
2134 "disabled": true, ~/~/ Датчик не участвует в обработке
2135 "gradeType": 0, ~/~/ Способ тарировки показаний датчика.  0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs
2136 "gradesTables": [ ~/~/ Тарировка
2137 {
2138 "grades": [ ~/~/ Таблицы тарировки
2139 {
2140 "input": 0, ~/~/ Вход
2141 "output": 0 ~/~/ Выход
2142 }
2143 ],
2144 "relevanceTime": "2024-10-30T10:31:17.196Z"  ~/~/ Время, с которого наступает актуальность таблицы тарировки
2145 }
2146 ],
2147 "showInTooltip": true, ~/~/ Отображение в подсказке
2148 "showLastValid": true, ~/~/ Отображать последнее валидное значение
2149
2150 (((
2151 "color": "string", ~/~/ цвет уведомлений
2152 )))
2153
2154 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
2155 "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания
2156 "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 
2157 "expr": "string", ~/~/ Выражение
2158 "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков
2159 "string" 
2160 ],
2161 "customParams": { ~/~/ Дополнительные настройки
2162 "additionalProp1": "string",
2163 "additionalProp2": "string",
2164 "additionalProp3": "string"
2165 },
2166 "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления.
2167 "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге
2168 {
2169 "from": 0, ~/~/ С какого значения
2170 "color": "string", ~/~/ Каким цветом
2171 "text": "string" ~/~/ Текст подписи к этому интервалу
2172 }
2173 ]
2174 }
2175 ],
2176 "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах
2177 "customFields": [ ~/~/ Список произвольных полей
2178 {
2179 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности
2180 "name": "string", ~/~/ Наименование произвольного поля
2181 "value": "string", ~/~/ Значение произвольного поля
2182 "forClient": true, ~/~/ Отобразить произвольное поле у клиента
2183 "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте)
2184 "forReport": true ~/~/ Отобразить произвольное поле в отчете
2185 }
2186 ],
2187 "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor
2188 }
2189 )))
2190
2191 **Валидация:**
2192 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
2193 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
2194 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
2195
2196 == (% style="color:#000000; font-size:16px" %)**Удаление объекта**(%%) ==
2197
2198 (% class="box errormessage" %)
2199 (((
2200 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
2201 )))
2202
2203 (% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
2204
2205 (% style="color:#000000" %)Метод запроса: **DELETE**
2206
2207 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
2208
2209 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
2210
2211 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2212
2213 (% style="text-align:left" %)
2214 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
2215
2216 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Устройства**(%%) =
2217
2218 == (% style="color:#000000; font-size:16px" %)**Получение списка типов устройств**(%%) ==
2219
2220 (% class="box infomessage" %)
2221 (((
2222 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/devices/types**
2223 )))
2224
2225 (% style="color:#000000" %)Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе.
2226
2227 (% style="color:#000000" %)Метод запроса: **GET**
2228
2229 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
2230
2231 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2232
2233 (% style="color:#000000" %)Ответ:
2234
2235 (% style="color:#000000" %){(%%)
2236 "deviceTypeId" : "", ~/~/ ID типа устройства
2237 "deviceTypeName" : "" ~/~/ Название типа устройства
2238 (% style="color:#000000" %)}
2239
2240 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) =
2241
2242 == (% style="color:#000000; font-size:16px" %)**Получение списка типов датчиков**(%%) ==
2243
2244 (% class="box infomessage" %)
2245 (((
2246 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**GET /api/v3/sensors/types**
2247 )))
2248
2249 (% style="color:#000000" %)Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе.
2250
2251 (% style="color:#000000" %)Метод запроса: **GET**
2252
2253 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
2254
2255 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2256
2257 (% style="color:#000000" %)Ответ:
2258
2259 (% style="color:#000000" %){(%%)
2260 "id": "", ~/~/ ID типа датчика 
2261 "name": "", ~/~/ Название
2262 "description": "", ~/~/ Описание
2263 (% style="color:#000000" %)}
2264
2265 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
2266
2267 == (% style="color:#000000; font-size:16px" %)**Данные об активности объекта**(%%) ==
2268
2269 (% class="box infomessage" style="text-align: left;" %)
2270 (((
2271 **POST /api/v3/terminalMessages/count**
2272 )))
2273
2274 (% style="text-align: left;" %)
2275 Метод возвращает количество сообщений отправленных терминалом на сервер за указанный период.
2276
2277 (% style="text-align: left;" %)
2278 Метод запроса **POST**
2279
2280 (% style="text-align: left;" %)
2281 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/count
2282
2283 (% style="text-align: left;" %)
2284 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2285
2286 (% style="text-align: left;" %)
2287 {
2288 "vehicleIds": [
2289 id ~/~/ здесь передается список идентификаторов объектов
2290 ],
2291 "from": "2023-03-12T07:09:02.364Z", ~/~/ от какой даты выполнять запрос
2292 "to": "2023-03-14T07:09:02.364Z" ~/~/ до какой даты выполнять запрос
2293 }
2294
2295 (% style="text-align: left;" %)
2296 Ответ:
2297
2298 (% style="text-align: left;" %)
2299 [
2300 {
2301 "vehicleId": 0, ~/~/ идентификатор объекта
2302 "count": 0 ~/~/ количество сообщений за период
2303 }
2304 ]
2305
2306 == (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
2307
2308 (% class="box infomessage" style="text-align: left;" %)
2309 (((
2310 **POST /api/v3/terminalMessages/mapping**
2311 )))
2312
2313 Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
2314
2315 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
2316
2317 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2318
2319 {
2320 "protocolType": 0,
2321 "params": ["string"]
2322 }
2323
2324 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2325 |protocolType|ID типа протокола
2326 |params|(((
2327 Массив наименований параметров в сообщении
2328 )))
2329
2330 Ответ:
2331
2332 {
2333 "protocolType": 0,
2334 "mapping": {
2335 "additionalProp1": {
2336 "inputType": 0,
2337 "inputNumber": 0
2338 },
2339 "additionalProp2": {
2340 "inputType": 0,
2341 "inputNumber": 0
2342 }
2343 }
2344 }
2345
2346 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2347 |protocolType|Тип протокола
2348 |inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
2349 |inputNumber|(((
2350 Номер входа
2351 )))
2352
2353 (% class="wikigeneratedid" %)
2354 Перечень 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/]]
2355
2356 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
2357
2358 (% class="box infomessage" %)
2359 (((
2360 **POST /api/v3/terminalMessages**
2361 )))
2362
2363 Метод возвращает список сообщений терминала объекта за выбранный период.
2364
2365 (% style="text-align: left;" %)
2366 Метод запроса **POST**
2367
2368 (% style="text-align: left;" %)
2369 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages
2370
2371 (% style="text-align: left;" %)
2372 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2373
2374 {
2375 "vehicleId": 0, ~/~/ id объекта
2376 "from": "2023-03-29T09:14:46.107Z", ~/~/ начало периода запроса
2377 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
2378 }
2379
2380 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2381 |vehicleId|ID объекта
2382 |from|Дата и время начала периода запроса
2383 |to|Дата и время окончания периода запроса
2384
2385 Ответ:
2386
2387 [
2388 {
2389 "messages": [
2390 {
2391 "deviceTime": "2023-11-29T07:40:44.052Z",
2392 "serverTime": "2023-11-29T07:40:44.052Z",
2393 "speed": 0,
2394 "altitude": 0,
2395 "latitude": 0,
2396 "longitude": 0,
2397 "satellites": 0,
2398 "course": 0,
2399 "voltage": 0,
2400 "parameters": {
2401 "additionalProp1": "string",
2402 "additionalProp2": "string",
2403 "additionalProp3": "string"
2404 },
2405 "photoCount": 0,
2406 "lbsCorrectedCoords": true,
2407 "protocolType": 0
2408 }
2409 ]
2410 }
2411 ]
2412
2413 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2414 |deviceTime|Время сообщения терминала
2415 |serverTime|Время когда сообщение поступило на сервер
2416 |speed|Скорость
2417 |altitude|Высота над уровнем моря
2418 |latitude|Широта
2419 |longitude|Долгота
2420 |satellites|Кол-во спутников
2421 |course|Курс
2422 |voltage|Бортовое напряжение
2423 |parameters|Список параметров и их значений
2424 |photoCount|Количество фото
2425 |lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2426 |protocolType|ID типа протокола
2427
2428 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2429
2430 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
2431
2432 (% class="box infomessage" %)
2433 (((
2434 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours**
2435 )))
2436
2437 (% style="color:#000000" %)Метод запроса: **POST**
2438
2439 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours
2440
2441 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2442
2443 (% style="text-align:left" %)
2444 Тело запроса:
2445
2446 {
2447 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2448 "vehicleIds": [0], ~/~/ Список ID объектов
2449 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2450 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2451 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2452 }
2453
2454 Ответ:
2455
2456 [
2457 {
2458 "vehicleId": 0, ~/~/ ID объекта
2459 "name": "string", ~/~/ Имя ТС
2460 "periods": [ ~/~/ Периоды
2461 {
2462 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2463 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2464 "mileage": 0, ~/~/ Пробег за период, километры
2465 "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 
2466 "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры
2467 "motohours": 0, ~/~/ Моточасы за период, секунды
2468 "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды
2469 "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды
2470 "idlingTime": 0 ~/~/  Холостой ход за период, секунд
2471
2472 }
2473 ]
2474 }
2475 ]
2476
2477 == (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) ==
2478
2479 (% class="box infomessage" %)
2480 (((
2481 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption**
2482 )))
2483
2484 (% style="color:#000000" %)Метод запроса: **POST**
2485
2486 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption
2487
2488 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2489
2490 (% style="text-align:left" %)
2491 Тело запроса:
2492
2493 {
2494 "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой.
2495 "vehicleIds": [0], ~/~/ Список ID объектов
2496 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода
2497 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода
2498 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2499 }
2500
2501 Ответ:
2502
2503 [
2504 {
2505 "vehicleId": 0, ~/~/ ID объекта
2506 "name": "string", ~/~/ Имя ТС
2507 "periods": [ ~/~/ Периоды
2508 {
2509 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 
2510 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2511 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2512 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2513 "fuelConsumption": 0, ~/~/ Расход топлива
2514 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2515 }
2516 ]
2517 }
2518 ]
2519
2520 (% class="box warningmessage" %)
2521 (((
2522 Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"".
2523 \\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling".
2524 )))
2525
2526 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) ==
2527
2528 (% class="box infomessage" %)
2529 (((
2530 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut**
2531 )))
2532
2533 (% style="color:#000000" %)Метод запроса: **POST**
2534
2535 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut
2536
2537 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2538
2539 (% style="text-align:left" %)
2540 Тело запроса:
2541
2542 {
2543 "vehicleIds": [0], ~/~/ Список ID объектов
2544 "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса
2545 "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса
2546 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2547 }
2548
2549 Ответ:
2550
2551 [
2552 {
2553 "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода
2554 "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода
2555 "vehicleId": 0, ~/~/ ID объекта
2556 "name": "string", ~/~/ Имя объекта
2557 "model": "string", ~/~/ Модель объекта
2558 "fuels": [ ~/~/ Массив данным по заправкам и сливам
2559 {
2560 "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2561 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2562 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2563 "valueFuel": 0, ~/~/ Количество
2564 "fuelStart": 0, ~/~/ Уровень топлива на начало события
2565 "fuelEnd": 0 ~/~/ Уровень топливо на конец события
2566 }
2567 ]
2568 }
2569 ]
2570
2571
2572 == (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2573
2574 (% class="box infomessage" %)
2575 (((
2576 **POST /api/v3/vehicles/moveStop**
2577 )))
2578
2579 Метод запроса: **POST**
2580
2581 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2582
2583 В заголовках запроса: X-Auth: Токен авторизации
2584
2585
2586 Тело запроса:
2587
2588 {
2589 "vehicleIds": [ ], ~/~/ Список ID объектов
2590 "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2591 "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2592 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2593 }
2594
2595 Ответ:
2596
2597 [ 
2598 {
2599 "vehicleId": 0, ~/~/ ID объекта
2600 "vehicleName": "string", ~/~/ Имя объекта
2601 "moves": [ ~/~/ Событие движения
2602 {
2603 "mileage": 0, ~/~/ Пробег, км
2604 "eventId": 0, ~/~/ Идентификатор события
2605 "eventName": "string", ~/~/ Название события
2606 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2607 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2608 "duration": 0 ~/~/ Продолжительность события, секунд
2609 }
2610 ],
2611 "stops": [ ~/~/ События стоянок
2612 {
2613 "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты
2614 "eventId": 0, ~/~/ Идентификатор события
2615 "eventName": "string", ~/~/ Название события
2616 "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2617 "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2618 "duration": 0 ~/~/ Продолжительность события, секунд
2619 }
2620 ]
2621 }
2622 ]
2623
2624
2625 == (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2626
2627 (% class="box infomessage" %)
2628 (((
2629 **POST /api/v3/vehicles/getlastdata**
2630 )))
2631
2632 Метод запроса: **POST**
2633
2634 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2635
2636 В заголовках запроса: X-Auth: Токен авторизации
2637
2638
2639 В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2640
2641 Ответ:
2642 {
2643 "vehicleId": 0, ~/~/Идентификатор объекта.
2644 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2645 "vehicleNumber": "string",~/~/Номер объекта.
2646 "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2647 "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2648 "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2649 "speed": 0,~/~/Скорость объекта.
2650 "course": 0,~/~/Курс движения [0;360]
2651 "latitude": 0,~/~/Широта [-90°;90°].
2652 "longitude": 0,~/~/Долгота [-180°;180°].
2653 "address": "string",~/~/Адрес.
2654 "geozones": [ ~/~/Сведения по геозонам.
2655 {
2656 "id": 0,
2657 "name": "string"
2658 }
2659
2660
2661 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2662
2663 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
2664
2665 (% class="box infomessage" %)
2666 (((
2667 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find**
2668 )))
2669
2670 (% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
2671
2672 (% style="color:#000000" %)Метод запроса: **POST**
2673
2674 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
2675
2676 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2677
2678 (% style="text-align:left" %)
2679 Тело запроса:
2680
2681 (% style="text-align:left" %)
2682 {
2683 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2684 }
2685
2686 (% style="text-align:left" %)
2687 Ответ:
2688
2689 [
2690 {
2691 "id": 0, ~/~/ Идентификатор объекта геозоны
2692 "name": "string", ~/~/ Название объекта геозоны
2693 "type": 0, ~/~/ Тип объекта геозоны
2694 "fname": "string", ~/~/ Имя файла
2695 "parentId": "string", ~/~/ Идентификатор клиента
2696 "radius": 0, ~/~/ Радиус геообъекта
2697 "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
2698 "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
2699 "description": "string", ~/~/ Описание
2700 "area": 0, ~/~/ Площадь, м^^2^^
2701 "perimetr": 0, ~/~/ Периметр, м
2702 "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
2703 }
2704 ]
2705
2706 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) ==
2707
2708 (% class="box infomessage" %)
2709 (((
2710 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles**
2711 )))
2712
2713 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
2714
2715 (% style="color:#000000" %)Метод запроса: **POST**
2716
2717 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
2718
2719 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2720
2721 (% style="text-align:left" %)
2722 Тело запроса:
2723
2724 {
2725 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2726 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2727 "ids": [ ], ~/~/ Массив id объектов
2728 "byTime": 0, ~/~/ Объединение событий по времени 
2729 "byDist": 0, ~/~/ Объединение событий по расстоянию
2730 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2731 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2732 }
2733
2734 Ответ:
2735 [
2736 {
2737 "geozoneId": 0, ~/~/ ID геообъекта
2738 "geozoneName": "string", ~/~/ Название геообъекта
2739 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2740 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2741 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2742 "vehicleId": 0, ~/~/ ID объекта
2743 "vehicleName": "string" ~/~/ Имя объекта
2744 }
2745 ]
2746
2747 == (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) ==
2748
2749 (% class="box infomessage" %)
2750 (((
2751 (% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones**
2752 )))
2753
2754 (% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
2755
2756 (% style="color:#000000" %)Метод запроса: **POST**
2757
2758 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
2759
2760 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2761
2762 (% style="text-align:left" %)
2763 Тело запроса:
2764
2765 {
2766 "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
2767 "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
2768 "ids": [ ], ~/~/ Массив id геообъектов
2769 "byTime": 0, ~/~/ Объединение событий по времени 
2770 "byDist": 0, ~/~/ Объединение событий по расстоянию
2771 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
2772 "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
2773 }
2774
2775 Ответ:
2776
2777 [
2778 {
2779 "geozoneId": 0, ~/~/ ID геообъекта
2780 "geozoneName": "string", ~/~/ Название геообъекта
2781 "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
2782 "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
2783 "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
2784 "vehicleId": 0, ~/~/ ID объекта
2785 "vehicleName": "string" ~/~/ Имя объекта
2786 }
2787 ]
2788
2789 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2790
2791 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
2792
2793 (% class="box infomessage" %)
2794 (((
2795 **POST /api/v3/notifications/find**
2796 )))
2797
2798 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии.
2799
2800 (% style="text-align: left;" %)
2801 Метод запроса **POST**
2802
2803 (% style="text-align: left;" %)
2804 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/find
2805
2806 (% style="text-align: left;" %)
2807 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2808
2809 {
2810 "parentId": "" ~/~/ id клиента
2811 }
2812
2813 Ответ:
2814
2815 [
2816 {
2817 "id": 0, ~/~/ ID уведомления
2818 "name": "string", ~/~/ Название уведомления
2819 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2820 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2821 "userId": "", ~/~/ Пользователь, создавший уведомление
2822 "parentId": "", ~/~/ Идентификатор клиента
2823 "parentName": "string" ~/~/ Имя клиента
2824 }
2825 ]
2826
2827 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2828
2829 (% class="box infomessage" %)
2830 (((
2831 **GET /api/v3/notifications/{id}**
2832 )))
2833
2834 Метод возвращает данные правил формирования выбранного уведомления.
2835
2836 (% style="text-align: left;" %)
2837 Метод запроса **GET**
2838
2839 (% style="text-align: left;" %)
2840 (% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
2841
2842 (% style="text-align: left;" %)
2843 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
2844
2845 (% style="text-align: left;" %)
2846 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
2847
2848 (% style="text-align: left;" %)
2849 (% style="color:#000000" %)Ответ:
2850
2851 (% style="text-align: left;" %)
2852 (% style="color:#000000" %){
2853 "id": 0, ~/~/ (%%)id уведомления
2854 (% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2855 (% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление
2856 (% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента
2857 (% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента
2858 (% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления
2859 (% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован
2860 (% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа
2861 (% style="color:#000000" %) 0
2862 ],
2863 "geoids": [ ~/~/ (%%)Список id геообъектов для анализа
2864 (% style="color:#000000" %) 0
2865 ],
2866 "fieldids": [ ~/~/ (%%)Список id полей для анализа
2867 (% style="color:#000000" %) 0
2868 ],
2869 "settings": { ~/~/ Список параметров уведомления
2870 "additionalProp1": "string",
2871 "additionalProp2": "string",
2872 "additionalProp3": "string"
2873 },
2874 "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2875 (% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2876 (% style="color:#000000" %) ""
2877 ],
2878 "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2879 (% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений
2880 (% style="color:#000000" %) "string"
2881 ],
2882 "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram
2883 (% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram.
2884 (% style="color:#000000" %) {
2885 "id": 0, ~/~/ (%%)Идентификатор участника чата
2886 (% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения
2887 (% style="color:#000000" %) }
2888 ],
2889 "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение
2890 (% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы
2891 (% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2892 (% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления
2893 (% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2894 (% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC)
2895 (% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса
2896 (% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90)
2897 (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
2898 (% style="color:#000000" %)}
2899
2900 == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
2901
2902 (% class="box warningmessage" %)
2903 (((
2904 **PUT /api/v3/notifications/**
2905 )))
2906
2907 Метод позволяет отредактировать уведомление.
2908
2909 Метод запроса **PUT**
2910
2911 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
2912
2913 В заголовках запроса: X-Auth: Токен авторизации
2914
2915 Тело запроса:
2916 {
2917 "id": 0, ~/~/ id уведомления
2918 "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2919 "userId": "", ~/~/ Пользователь, создавший уведомление
2920 "parentId": "", ~/~/ Идентификатор клиента
2921 "parentName": "string", ~/~/ Имя клиента
2922 "name": "string", ~/~/ Название уведомления
2923 "active": true, ~/~/ Состояние true - активен, false - деактивирован
2924 "vehicleIds": [ ~/~/ Список id объектов для анализа
2925 0
2926 ],
2927 "geoids": [ ~/~/ Список id геообъектов для анализа
2928 0
2929 ],
2930 "fieldids": [ ~/~/ Список id полей для анализа
2931 0
2932 ],
2933 "settings": { ~/~/ Список параметров уведомления
2934 "additionalProp1": "string",
2935 "additionalProp2": "string",
2936 "additionalProp3": "string"
2937 },
2938 "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2939 "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2940 ""
2941 ],
2942 "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2943 "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2944 "string"
2945 ],
2946 "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2947 "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2948 {
2949 "id": 0, ~/~/ Идентификатор участника чата
2950 "info": "string" ~/~/ Дополнительные сведения
2951 }
2952 ],
2953 "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2954 "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2955 "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2956 "kind": 0, ~/~/ Определяет вид уведомления
2957 "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
2958 "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
2959 "timezone": 0, ~/~/ Сдвиг часового пояса
2960 "validity": 0, ~/~/ Срок действия в днях (1-90)
2961 "autoProlongation": true ~/~/ Автопродление срока действия
2962 }
2963
2964 Ответ:
2965
2966 Success
2967
2968
2969 == (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) ==
2970
2971 (% class="box warningmessage" %)
2972 (((
2973 **PUT** /api/v3/notifications/prolongation
2974 )))
2975
2976 Метод позволяет продлить уведомления.
2977
2978 Метод запроса **PUT**
2979
2980 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation
2981
2982 В заголовках запроса: X-Auth: Токен авторизации.
2983
2984 Тело запроса:
2985
2986 [
2987
2988 0
2989
2990 ]
2991
2992 где 0 идентификатор ids.
2993
2994 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
2995
2996 (% class="box errormessage" %)
2997 (((
2998 **DELETE /api/v3/notifications/{id}**
2999 )))
3000
3001 Метод позволяет удалить выбранное уведомление.
3002
3003 Метод запроса **DELETE**
3004
3005 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
3006
3007 Передаваемый параметр: {id} - id уведомления
3008
3009 В заголовках запроса: X-Auth: Токен авторизации
3010
3011 Ответ:
3012
3013 Success
3014
3015
3016 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) =
3017
3018 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) ==
3019
3020 (% class="box infomessage" %)
3021 (((
3022 **POST /api/v3/Drivers/find**
3023 )))
3024
3025 Передается параметр: parentId - ID клиента-родителя
3026
3027 Ответ:
3028
3029 [
3030 {
3031 "name": "string", ~/~/ Определяет наименование
3032 "description": "string", ~/~/ Определяет описание
3033 "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма
3034 "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения
3035 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3036 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3037 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3038 "deleted": true ~/~/ Признак удаления
3039 }
3040 ]
3041
3042 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) ==
3043
3044 (% class="box infomessage" %)
3045 (((
3046 **GET /api/v3/Drivers/{driverGuid}**
3047 )))
3048
3049 Передается параметр: ID водителя
3050
3051 Ответ:
3052
3053 {
3054 "name": "string", ~/~/ Определяет наименование
3055 "description": "string", ~/~/ Определяет описание
3056 "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма
3057 "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения
3058 "exclusive": true, ~/~/ Определяет признак "Исключительный"
3059 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя
3060 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
3061 "deleted": true ~/~/ Признак удаления
3062 }
3063
3064 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) ==
3065
3066 (% class="box successmessage" %)
3067 (((
3068 **POST /api/v3/Drivers**
3069 )))
3070
3071 Запрос:
3072
3073 {
3074 "name": "string",
3075 "description": "string",
3076 "hiredate": "2023-06-30T12:50:54.020Z",
3077 "chopdate": "2023-06-30T12:50:54.020Z",
3078 "exclusive": true,
3079 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3080 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3081 "deleted": true
3082 }
3083
3084 Ответ:
3085
3086 {
3087 "name": "string",
3088 "description": "string",
3089 "hiredate": "2023-06-30T12:50:54.051Z",
3090 "chopdate": "2023-06-30T12:50:54.051Z",
3091 "exclusive": true,
3092 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3093 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3094 "deleted": true
3095 }
3096
3097
3098 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) ==
3099
3100 (% class="box warningmessage" %)
3101 (((
3102 **PUT /api/v3/Drivers**
3103 )))
3104
3105 Запрос:
3106
3107 {
3108 "name": "string",
3109 "description": "string",
3110 "hiredate": "2023-06-30T12:50:27.910Z",
3111 "chopdate": "2023-06-30T12:50:27.910Z",
3112 "exclusive": true,
3113 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3114 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3115 "deleted": true
3116 }
3117
3118 Ответ:
3119
3120 {
3121 "name": "string",
3122 "description": "string",
3123 "hiredate": "2023-06-30T12:50:27.929Z",
3124 "chopdate": "2023-06-30T12:50:27.929Z",
3125 "exclusive": true,
3126 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3127 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3128 "deleted": true
3129 }
3130
3131
3132 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) ==
3133
3134 (% class="box errormessage" %)
3135 (((
3136 **DELETE /api/v3/Drivers/{driverGuid}**
3137 )))
3138
3139 Передается параметр: ID водителя
3140
3141 Ответ:
3142
3143 Success
3144
3145
3146 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) =
3147
3148 == (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) ==
3149
3150 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) ===
3151
3152 (% class="box infomessage" %)
3153 (((
3154 **POST /api/v3/DriversVehiclesAssignments/GetByDrivers**
3155 )))
3156
3157 Запрос:
3158
3159 {
3160 "Ids": [
3161 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3162 ],
3163 "BeginTime": "2023-06-30T12:49:04.365Z",
3164 "EndTime": "2023-06-30T12:49:04.365Z"
3165 }
3166
3167 Ответ:
3168
3169 [
3170 {
3171 "VehicleId": 0,
3172 "CreateTime": "2023-06-30T09:52:31.240Z",
3173 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3174 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3175 "BeginTime": "2023-06-30T09:52:31.240Z",
3176 "EndTime": "2023-06-30T09:52:31.240Z"
3177 }
3178 ]
3179
3180
3181 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) ===
3182
3183 (% class="box infomessage" %)
3184 (((
3185 **POST /api/v3/DriversVehiclesAssignments/GetByVehicles**
3186 )))
3187
3188 Запрос:
3189
3190 {
3191 "Ids": [
3192 0
3193 ],
3194 "BeginTime": "2023-06-30T12:48:39.419Z",
3195 "EndTime": "2023-06-30T12:48:39.419Z"
3196 }
3197
3198 Ответ:
3199
3200 [
3201 {
3202 "VehicleId": 0,
3203 "CreateTime": "2023-06-30T09:54:01.631Z",
3204 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3205 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3206 "BeginTime": "2023-06-30T09:54:01.631Z",
3207 "EndTime": "2023-06-30T09:54:01.631Z"
3208 }
3209 ]
3210
3211
3212 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) ===
3213
3214 (% class="box successmessage" %)
3215 (((
3216 **POST /api/v3/DriversVehiclesAssignments**
3217 )))
3218
3219 Передается массив назначений
3220
3221 Запрос:
3222
3223 [
3224 {
3225 "VehicleId": 0, ~/~/ Идентификатор объекта
3226 "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения
3227 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3228 "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения
3229 "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно.
3230 }
3231 ]
3232
3233 Ответ:
3234
3235 [
3236 {
3237 "VehicleId": 0,
3238 "CreateTime": "2023-06-30T11:04:46.903Z",
3239 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3240 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3241 "BeginTime": "2023-06-30T11:04:46.903Z",
3242 "EndTime": "2023-06-30T11:04:46.903Z"
3243 }
3244 ]
3245
3246
3247 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) ===
3248
3249 (% class="box warningmessage" %)
3250 (((
3251 **PUT /api/v3/DriversVehiclesAssignments**
3252 )))
3253
3254 Запрос:
3255
3256 [
3257 {
3258 "VehicleId": 0,
3259 "CreateTime": "2023-06-30T11:14:08.117Z",
3260 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3261 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3262 "BeginTime": "2023-06-30T11:14:08.117Z",
3263 "EndTime": "2023-06-30T11:14:08.117Z"
3264 }
3265 ]
3266
3267 Ответ:
3268
3269 [
3270 {
3271 "VehicleId": 0,
3272 "CreateTime": "2023-06-30T11:14:53.349Z",
3273 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3274 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3275 "BeginTime": "2023-06-30T11:14:53.349Z",
3276 "EndTime": "2023-06-30T11:14:53.349Z"
3277 }
3278 ]
3279
3280
3281 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) ===
3282
3283 (% class="box errormessage" %)
3284 (((
3285 **DELETE /api/v3/DriversVehiclesAssignments**
3286 )))
3287
3288 Запрос:
3289
3290 [
3291 "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3292 ]
3293
3294 Ответ:
3295
3296 Success
3297
3298
3299 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) ==
3300
3301 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) ===
3302
3303 (% class="box infomessage" %)
3304 (((
3305 **POST /api/v3/DriversRfidsAssignments/GetByDrivers**
3306 )))
3307
3308 Запрос:
3309
3310 {
3311 "Ids": [
3312 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3313 ],
3314 "BeginTime": "2023-06-30T12:47:12.162Z",
3315 "EndTime": "2023-06-30T12:47:12.162Z"
3316 }
3317
3318 Ответ:
3319
3320 [
3321 {
3322 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3323 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3324 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3325 "BeginTime": "2023-06-30T11:19:40.703Z",
3326 "EndTime": "2023-06-30T11:19:40.703Z"
3327 }
3328 ]
3329
3330
3331 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) ===
3332
3333 (% class="box infomessage" %)
3334 (((
3335 **POST /api/v3/DriversRfidsAssignments/GetByRfids**
3336 )))
3337
3338 Запрос:
3339
3340 {
3341 "Ids": [
3342 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3343 ],
3344 "BeginTime": "2023-06-30T12:47:12.162Z",
3345 "EndTime": "2023-06-30T12:47:12.162Z"
3346 }
3347
3348 Ответ:
3349
3350 [
3351 {
3352 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки
3353 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения
3354 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
3355 "BeginTime": "2023-06-30T11:19:40.703Z",
3356 "EndTime": "2023-06-30T11:19:40.703Z"
3357 }
3358 ]
3359
3360
3361 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) ===
3362
3363 (% class="box successmessage" %)
3364 (((
3365 **POST /api/v3/DriversRfidsAssignments**
3366 )))
3367
3368 Запрос:
3369
3370 [
3371 {
3372 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3373 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3374 "BeginTime": "2023-06-30T11:27:08.635Z",
3375 "EndTime": "2023-06-30T11:27:08.635Z"
3376 }
3377 ]
3378
3379 Ответ:
3380
3381 [
3382 {
3383 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3384 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3385 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3386 "BeginTime": "2023-06-30T11:27:08.677Z",
3387 "EndTime": "2023-06-30T11:27:08.677Z"
3388 }
3389 ]
3390
3391
3392 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) ===
3393
3394 (% class="box warningmessage" %)
3395 (((
3396 **PUT /api/v3/DriversRfidsAssignments**
3397 )))
3398
3399 Запрос:
3400
3401 [
3402 {
3403 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3404 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3405 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3406 "BeginTime": "2023-06-30T11:28:43.330Z",
3407 "EndTime": "2023-06-30T11:28:43.330Z"
3408 }
3409 ]
3410
3411 Ответ:
3412
3413 [
3414 {
3415 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3416 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3417 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3418 "BeginTime": "2023-06-30T11:28:43.331Z",
3419 "EndTime": "2023-06-30T11:28:43.331Z"
3420 }
3421 ]
3422
3423
3424 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) ===
3425
3426 (% class="box errormessage" %)
3427 (((
3428 **DELETE /api/v3/DriversRfidsAssignments**
3429 )))
3430
3431 Запрос:
3432
3433 [
3434 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3435 ]
3436
3437 Ответ:
3438
3439 Success
3440
3441
3442 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) ==
3443
3444 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) ===
3445
3446 (% class="box infomessage" %)
3447 (((
3448 **POST /api/v3/DriversFuelCardsAssignments/GetByDrivers**
3449 )))
3450
3451 Запрос:
3452
3453 {
3454 "Ids": [
3455 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3456 ],
3457 "BeginTime": "2023-06-30T12:45:10.852Z",
3458 "EndTime": "2023-06-30T12:45:10.852Z"
3459 }
3460
3461 Ответ:
3462
3463 [
3464 {
3465 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3466 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3467 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3468 "BeginTime": "2023-06-30T11:58:04.695Z",
3469 "EndTime": "2023-06-30T11:58:04.695Z"
3470 }
3471 ]
3472
3473
3474 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) ===
3475
3476 (% class="box infomessage" %)
3477 (((
3478 **POST /api/v3/DriversFuelCardsAssignments/GetByCards**
3479 )))
3480
3481 Запрос:
3482
3483 {
3484 "Ids": [
3485 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3486 ],
3487 "BeginTime": "2023-06-30T12:45:10.852Z",
3488 "EndTime": "2023-06-30T12:45:10.852Z"
3489 }
3490
3491 Ответ:
3492
3493 [
3494 {
3495 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3496 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3497 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3498 "BeginTime": "2023-06-30T11:58:04.695Z",
3499 "EndTime": "2023-06-30T11:58:04.695Z"
3500 }
3501 ]
3502
3503
3504 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) ===
3505
3506 (% class="box successmessage" %)
3507 (((
3508 **POST /api/v3/DriversFuelCardsAssignments**
3509 )))
3510
3511 Запрос:
3512
3513 [
3514 {
3515 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3516 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3517 "BeginTime": "2023-06-30T12:09:53.175Z",
3518 "EndTime": "2023-06-30T12:09:53.175Z"
3519 }
3520 ]
3521
3522 Ответ:
3523
3524 [
3525 {
3526 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3527 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3528 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3529 "BeginTime": "2023-06-30T12:09:53.201Z",
3530 "EndTime": "2023-06-30T12:09:53.201Z"
3531 }
3532 ]
3533
3534
3535 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) ===
3536
3537 (% class="box warningmessage" %)
3538 (((
3539 **PUT /api/v3/DriversFuelCardsAssignments**
3540 )))
3541
3542 Запрос:
3543
3544 [
3545 {
3546 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3547 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3548 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3549 "BeginTime": "2023-06-30T12:09:53.201Z",
3550 "EndTime": "2023-06-30T12:09:53.201Z"
3551 }
3552 ]
3553
3554 Ответ:
3555
3556 [
3557 {
3558 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3559 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3560 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3561 "BeginTime": "2023-06-30T12:09:53.201Z",
3562 "EndTime": "2023-06-30T12:09:53.201Z"
3563 }
3564 ]
3565
3566
3567 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) ===
3568
3569 (% class="box errormessage" %)
3570 (((
3571 **DELETE /api/v3/DriversFuelCardsAssignments**
3572 )))
3573
3574 Запрос:
3575
3576 [
3577 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3578 ]
3579
3580 Ответ:
3581
3582 Success
3583
3584
3585 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3586
3587 == (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3588
3589 (% class="box infomessage" %)
3590 (((
3591 **POST /api/v3/Trailers**
3592 )))
3593
3594 Пример запроса:
3595
3596 {
3597 "startDate": "2023-11-14T10:48:03.671Z",
3598 "endDate": "2023-11-14T10:48:03.671Z",
3599 "ids": [ 0 ],
3600 "timezone": 0
3601 }
3602
3603 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3604 |(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3605 |(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3606 |(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3607 |(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3608
3609 Пример ответа:
3610
3611 [
3612 {
3613 "SD": "2023-11-14T10:48:03.717Z",
3614 "ED": "2023-11-14T10:48:03.717Z", 
3615 "id": 0,
3616 "SLat": 0,
3617 "SLon": 0,
3618 "ELat": 0,
3619 "ELon": 0,
3620 "mileage": 0
3621 "Duration": 0
3622 "Address": "string",
3623 "Address2": "string",
3624 "name": "string",
3625 "rid": "string",
3626 "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3627 "trailer": {
3628 "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3629 "Number": "string",
3630 "Description": "string",
3631 "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3632 "ExternalID": "string",
3633 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3634 "CreateTime": "2023-11-14T10:48:03.717Z",
3635 "UpdateTime": "2023-11-14T10:48:03.717Z",
3636 "IsDeleted": true
3637 },
3638 "filesCount": 0,
3639 }
3640 ]
3641
3642 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3643 |SD|Дата и время начала события
3644 |ED|Дата и время окончания события
3645 |id|ID объекта
3646 |SLat|Широта начальной координаты
3647 |SLon|Долгота начальной координаты
3648 |ELat|Широта конечной координаты
3649 |ELon|Долгота конечной координаты
3650 |mileage|Пробег
3651 |Duration|Продолжительность
3652 |Address|Адрес начального местоположения
3653 |Address2|Адрес конечного местоположения
3654 |name|Имя радиометки
3655 |rid|Номер радиометки
3656 |rguid|ID радиометки
3657 |trailer|Информация об агрегате
3658 |ModelGuid|ID агрегата
3659 |Number|Название/номер агрегата
3660 |Description|Текст примечания агрегата
3661
3662 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3663
3664 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
3665
3666 (% class="box infomessage" %)
3667 (((
3668 **POST /api/v3/Rfids/find**
3669 )))
3670
3671 Запрос:
3672
3673 {
3674 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3675 }
3676
3677 Ответ:
3678
3679 [
3680 {
3681 "name": "string",
3682 "number": 0,
3683 "period": 0,
3684 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3685 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3686 }
3687 ]
3688
3689 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3690 |parentId|ID клиента
3691 |name|Название карты-метки
3692 |number|Номер
3693 |period|Период запросов в секундах (работает только для агрегатов)
3694 |id|ID карты-метки
3695
3696 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3697
3698 (% class="box infomessage" %)
3699 (((
3700 **GET /api/v3/Rfids/{rfidGuid}**
3701 )))
3702
3703 Передаем параметр rfidGuid - идентификатор карты-метки
3704
3705 Ответ:
3706
3707 [
3708 {
3709 "name": "string",
3710 "number": 0,
3711 "period": 0,
3712 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3713 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3714 }
3715 ]
3716
3717 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3718 |name|Название карты-метки
3719 |number|Номер
3720 |period|Период запросов в секундах (работает только для агрегатов)
3721 |id|ID карты-метки
3722 |parentId|ID клиента
3723
3724 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3725
3726 (% class="box successmessage" %)
3727 (((
3728 **POST /api/v3/Rfids**
3729 )))
3730
3731 Запрос:
3732
3733 {
3734 "name": "string",
3735 "number": 0,
3736 "period": 0,
3737 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3738 }
3739
3740 Ответ:
3741
3742 {
3743 "name": "string",
3744 "number": 0,
3745 "period": 0,
3746 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3747 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3748 }
3749
3750 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3751 |name|Название карты-метки
3752 |number|Номер
3753 |period|Период запросов в секундах (работает только для агрегатов)
3754 |id|ID карты-метки
3755 |parentId|ID клиента
3756
3757 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3758
3759 (% class="box warningmessage" %)
3760 (((
3761 **PUT /api/v3/Rfids**
3762 )))
3763
3764 Запрос:
3765
3766 {
3767 "name": "string",
3768 "number": 0,
3769 "period": 0,
3770 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3771 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3772 }
3773
3774 Ответ:
3775
3776 {
3777 "name": "string",
3778 "number": 0,
3779 "period": 0,
3780 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3781 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3782 }
3783
3784 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3785 |name|Название карты-метки
3786 |number|Номер
3787 |period|Период запросов в секундах (работает только для агрегатов)
3788 |id|ID карты-метки
3789 |parentId|ID клиента
3790
3791 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3792
3793 (% class="box errormessage" %)
3794 (((
3795 **DELETE /api/v3/Rfids/{rfidGuid}**
3796 )))
3797
3798 Передаем параметр **rfidGuid** - идентификатор карты-метки
3799
3800 Ответ:
3801
3802 Success
3803
3804
3805 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) =
3806
3807 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) ==
3808
3809 (% class="box infomessage" %)
3810 (((
3811 **GET /api/v3/Billing/client/balance/{clientId}**
3812 )))
3813
3814 Параметр запроса: **clientId **- идентификатор клиента.
3815
3816 Ответ:
3817
3818 {
3819 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3820 "Balance": 0
3821 }
3822
3823 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3824 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3825 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3826
3827 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) ==
3828
3829 (% class="box infomessage" %)
3830 (((
3831 **GET /api/v3/Billing/client/constraint/{clientId}**
3832 )))
3833
3834 Параметр запроса: **clientId **- идентификатор клиента.
3835
3836 Ответ:
3837
3838 {
3839 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3840 "CalculationType": 0,
3841 "PermissibleBalance": 0,
3842 "DefermentDays": 0,
3843 "SendUiNotifications": true,
3844 "SendEmailNotifications": true,
3845 "IsPrivate": true,
3846 }
3847
3848 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3849 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3850 |(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни
3851 |(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс
3852 |(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней.
3853 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
3854 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
3855 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
3856
3857 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) ==
3858
3859 (% class="box infomessage" %)
3860 (((
3861 **GET /api/v3/Billing/client/plan/{clientId}**
3862 )))
3863
3864 Параметры запроса:
3865
3866 **clientId **- идентификатор клиента.
3867
3868 **planId **- идентификатор тарифного плана.
3869
3870 Ответ:
3871
3872 {
3873 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3874 "Plan": { **~/~/ Описание тарифного плана**
3875 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3876 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3877 "Name": "string",
3878 "IsArchived": true,
3879 "Constraint": {
3880 "CalculationType": 0,
3881 "PermissibleBalance": 0,
3882 "DefermentDays": 0
3883 },
3884 "Features": [ **~/~/ Описание шаблона услуг тарифного плана**
3885 {
3886 "Feature": "string",
3887 "IsFactual": true,
3888 "Limit": 0,
3889 "Price": 0,
3890 "PeriodValue": 0,
3891 "PeriodType": 0
3892 }
3893 ]
3894 },
3895 "DebitDate": "2023-10-18T12:46:24.213Z",
3896 "Features": [ **~/~/ Описание услуг тарифного плана как есть**
3897 {
3898 "Feature": "string",
3899 "IsEnabled": true,
3900 "IsPrivate": true,
3901 "IsFactual": true,
3902 "Limit": 0,
3903 "Price": 0,
3904 "DebitDate": "2023-10-18T12:46:24.213Z",
3905 "PeriodValue": 0,
3906 "PeriodType": 0
3907 }
3908 ]
3909 }
3910
3911 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3912 |ClientId|Идентификатор клиента
3913 |Id|Идентификатор тарифного плана
3914 |OwnerId|Идентификатор клиента-владельца
3915 |Name|Наименование тарифного плана
3916 |IsArchived|Признак, определяющий архивный тарифный план
3917 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3918 |PermissibleBalance|Допустимый баланс
3919 |DefermentDays|Отсрочка, количество дней
3920 |Feature|Код услуги
3921 |IsEnabled|Признак, определяющий активирована ли услуга
3922 |IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом.
3923 |IsFactual|Признак, определяющий расчёт по факту
3924 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3925 |Price|Цена за единицу.
3926 |DebitDate|Следующий момент времени списания с баланса за услугу.
3927 |PeriodValue|Значение периода.
3928 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3929
3930 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) ==
3931
3932 (% class="box infomessage" %)
3933 (((
3934 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3935 )))
3936
3937 Параметр запроса: **clientId **- идентификатор клиента.
3938
3939 Ответ:
3940
3941 [
3942 {
3943 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3944 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3945 "Name": "string",
3946 "IsArchived": true,
3947 "Constraint": {
3948 "CalculationType": 0,
3949 "PermissibleBalance": 0,
3950 "DefermentDays": 0
3951 },
3952 "Features": [
3953 {
3954 "Feature": "string",
3955 "IsFactual": true,
3956 "Limit": 0,
3957 "Price": 0,
3958 "PeriodValue": 0,
3959 "PeriodType": 0
3960 }
3961 ]
3962 }
3963 ]
3964
3965 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3966 |ClientId|Идентификатор клиента
3967 |Id|Идентификатор тарифного плана
3968 |OwnerId|Идентификатор клиента-владельца
3969 |Name|Наименование тарифного плана
3970 |IsArchived|Признак, определяющий архивный тарифный план
3971 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
3972 |PermissibleBalance|Допустимый баланс
3973 |DefermentDays|Отсрочка, количество дней
3974 |Feature|Код услуги
3975 |IsFactual|Признак, определяющий расчёт по факту
3976 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
3977 |Price|Цена за единицу.
3978 |PeriodValue|Значение периода.
3979 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3980
3981 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) ==
3982
3983 (% class="box infomessage" %)
3984 (((
3985 **GET /api/v3/Billing/client/constraint/getowned/{clientId}**
3986 )))
3987
3988 Параметр запроса: **clientId **- идентификатор клиента.
3989
3990 Ответ:
3991
3992 [
3993 {
3994 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3995 "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3996 "Name": "string",
3997 "IsArchived": true,
3998 "Constraint": {
3999 "CalculationType": 0,
4000 "PermissibleBalance": 0,
4001 "DefermentDays": 0
4002 },
4003 "Features": [
4004 {
4005 "Feature": "string",
4006 "IsFactual": true,
4007 "Limit": 0,
4008 "Price": 0,
4009 "PeriodValue": 0,
4010 "PeriodType": 0
4011 }
4012 ]
4013 }
4014 ]
4015
4016 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4017 |ClientId|Идентификатор клиента
4018 |Id|Идентификатор тарифного плана
4019 |OwnerId|Идентификатор клиента-владельца
4020 |Name|Наименование тарифного плана
4021 |IsArchived|Признак, определяющий архивный тарифный план
4022 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4023 |PermissibleBalance|Допустимый баланс
4024 |DefermentDays|Отсрочка, количество дней
4025 |Feature|Код услуги
4026 |IsFactual|Признак, определяющий расчёт по факту
4027 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4028 |Price|Цена за единицу.
4029 |PeriodValue|Значение периода.
4030 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4031
4032 == (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) ==
4033
4034 (% class="box warningmessage" %)
4035 (((
4036 **PUT /api/v3/Billing/client/balance**
4037 )))
4038
4039 Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
4040
4041 Тело запроса:
4042
4043 {
4044 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4045 "Balance": 0
4046 }
4047
4048 Ответ: Success
4049
4050 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4051 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4052 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4053
4054 == (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
4055
4056 (% class="box warningmessage" %)
4057 (((
4058 **PUT /api/v3/billing/client/balance/deposit**
4059 )))
4060
4061 Создает операцию **Пополнение **с указанной суммой
4062
4063 Тело запроса:
4064
4065 {
4066 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4067 "Balance": 0
4068 }
4069
4070 Ответ: Success
4071
4072 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4073 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4074 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4075
4076 == (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
4077
4078 Создает операцию **Списание **с указанной суммой
4079
4080 (% class="box warningmessage" %)
4081 (((
4082 **PUT /api/v3/billing/client/balance/withdraw**
4083 )))
4084
4085 Тело запроса:
4086
4087 {
4088 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4089 "Balance": 0
4090 }
4091
4092 Ответ: Success
4093
4094 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4095 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
4096 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
4097
4098 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
4099
4100 (% class="box warningmessage" %)
4101 (((
4102 **PUT /api/v3/Billing/client/constraint**
4103 )))
4104
4105 Тело запроса:
4106
4107 {
4108 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4109 "CalculationType": 0,
4110 "PermissibleBalance": 0,
4111 "DefermentDays": 0,
4112 "SendUiNotifications": true,
4113 "SendEmailNotifications": true,
4114 "IsPrivate": true,
4115 }
4116
4117 Ответ: Success
4118
4119 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4120 |ClientId|Идентификатор клиента
4121 |CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни
4122 |PermissibleBalance|Допустимый баланс
4123 |DefermentDays|(((
4124 Отсрочка, количество дней
4125 )))
4126 |(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено
4127 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено
4128 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом
4129
4130 == (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) ==
4131
4132 (% class="box warningmessage" %)
4133 (((
4134 **PUT /api/v3/Billing/client/plan**
4135 )))
4136
4137 Тело запроса:
4138
4139 {
4140 "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4141 "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4142 "Features": [
4143 {
4144 "Feature": "string",
4145 "IsEnabled": true,
4146 "IsFactual": true,
4147 "Limit": 0,
4148 "Price": 0,
4149 "DebitDate": "2023-10-18T13:26:58.987Z",
4150 "PeriodValue": 0,
4151 "PeriodType": 0
4152 }
4153 ]
4154 }
4155
4156 Ответ: Success
4157
4158 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4159 |ClientId|Идентификатор клиента
4160 |PlanId|Идентификатор тарифного плана
4161 |Feature|Код услуги
4162 |IsEnabled|Признак, определяющий активирована ли услуга
4163 |IsFactual|Признак, определяющий расчёт по факту
4164 |Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование.
4165 |Price|Цена за единицу.
4166 |DebitDate|Следующий момент времени списания с баланса за услугу.
4167 |PeriodValue|Значение периода.
4168 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
4169
4170 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
4171
4172 (% class="box warningmessage" %)
4173 (((
4174 Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
4175 )))
4176
4177 == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
4178
4179 (% class="box infomessage" %)
4180 (((
4181 **POST /api/v3/vehicles/import/{agentId}**
4182 )))
4183
4184 Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).**
4185
4186 В пути указывается **agentId** - id клиента.
4187
4188 **Заголовок**
4189
4190 **X-Auth: [токен авторизации]**
4191
4192 **Параметры**
4193
4194 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4195 |withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
4196 |importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление
4197
4198 В теле использовать тип **form-data,** тип значения** file**
4199
4200 **Ключи**
4201
4202 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4203 |data|В значении передаем файл объекта, формат **xml** или **wlp **
4204 |csv|В значении передаем файл датчиков, формат **csv**
4205
4206 Ответ:
4207
4208 {
4209 "vehicleId": 0,
4210 "name": "string",
4211 "errors": ["string"]
4212 }
4213
4214 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4215 |vehicleId|ID созданного объекта
4216 |name|Имя созданного объекта
4217 |errors|Ошибки и их описание
4218
4219 == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
4220
4221 (% class="box infomessage" %)
4222 (((
4223 **POST** **/api/v3/vehicles/import/history/{vehicleId}**
4224 )))
4225
4226 (% class="wikigeneratedid" %)
4227 Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
4228
4229 (% class="wikigeneratedid" %)
4230 В пути указывается **vehicleId **- id объекта.
4231
4232 **Заголовок**
4233
4234 **X-Auth: [токен авторизации]**
4235
4236 В теле использовать тип **form-data.**
4237
4238 Ключи:
4239
4240 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4241 |**history**|В значении передавать файл с историей
4242
4243 В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
4244
4245 Ответ:
4246
4247 {
4248 "results": [
4249 {
4250 "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4251 "vehicleId": 0,
4252 "errors": [
4253 "string"
4254 ],
4255 "firstMessageDate": "2023-11-28T09:27:58.949Z",
4256 "lastMessageDate": "2023-11-28T09:27:58.949Z",
4257 "producedCount": 0,
4258 "msgCount": 0
4259 }
4260 ]
4261 }
4262
4263 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4264 |results|Результаты импорта в разрезе ТС
4265 |vehicleGuid|Guid ТС
4266 |vehicleId|ID ТС
4267 |errors|Список ошибок импорта истории (если пустой - нет ошибок)
4268 |firstMessageDate|Дата первого импортированного сообщения (UTC)
4269 |lastMessageDate|Дата последнего импортированного сообщения (UTC)
4270 |producedCount|Кол-во успешно отправленных в шину данных сообщений
4271 |msgCount|Кол-во обработанных сообщений всего
4272
4273 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4274
4275 (% class="box infomessage" %)
4276 (((
4277 **GET /api/v3/vehicles/import/history/status**
4278 )))
4279
4280 Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
4281
4282 Ответ:
4283
4284 {
4285 "activity": true,
4286 "progress": 0,
4287 "message": "string"
4288 }
4289
4290 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4291 |activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4292 |progress|Guid ТС
4293
4294 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4295
4296 (% class="box infomessage" %)
4297 (((
4298 **POST /api/v3/vehicles/export**
4299 )))
4300
4301 Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
4302
4303 Тело запроса:
4304
4305 [
4306 id
4307 ]
4308
4309 Ответ: Success 200, получаете файлы с настройками.
4310
4311 == (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
4312
4313 (% class="box infomessage" %)
4314 (((
4315 **POST /api/v3/vehicles/export/history**
4316 )))
4317
4318 Метод возвращает список сообщений терминала объекта за выбранный период.
4319
4320 Тело запроса:
4321
4322 {
4323 "vehicleId": 0,
4324 "asArchive": true,
4325 "from": "2023-09-27T12:17:45.973Z",
4326 "to": "2023-09-27T12:17:45.973Z"
4327 }
4328
4329 Ответ:
4330
4331 Получаете файл. Сообщение: Code 200/Success
4332
4333 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4334 |vehicleId|ID объекта
4335 |asArchive|true - Архивировать файл, False - не архивировать
4336 |from|Дата и время начала запроса
4337 |to|Дата и время окончания запроса
4338
4339 == (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
4340
4341 (% class="box infomessage" %)
4342 (((
4343 **GET /api/v3/vehicles/export/history/status**
4344 )))
4345
4346 Метод возвращает список сообщений терминала объекта за выбранный период.
4347
4348 Ответ:
4349
4350 {
4351 "activity": true,
4352 "progress": 0,
4353 "message": "string"
4354 }
4355
4356 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4357 |activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
4358 |progress|Прогресс экспорта, от 0 до 100%
4359 |message|Текст описывающий статус
4360
4361 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
4362
4363 == (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
4364
4365 (% class="box infomessage" %)
4366 (((
4367 **POST /api/v3/EcoDriving/rating**
4368 )))
4369
4370 Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
4371
4372 Тело запроса:
4373
4374 {
4375 "vehicleIds": [vehicleId], ~/~/Массив ID объектов
4376 "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса
4377 "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса
4378 }
4379
4380 Ответ:
4381
4382 {
4383 "items": [  ~/~/ Список в разрезе ТС
4384 {
4385 "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода
4386 "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода
4387 "vehicleId": 0, ~/~/ ID ТС
4388 "vehicleName": "string", ~/~/ Название ТС
4389 "vehicleModel": "string", ~/~/ Модель ТС
4390 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС
4391 "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС
4392 "totalViolations": 0, ~/~/ Нарушений всего
4393 "violationsByType": { ~/~/ Информация о нарушениях по типу
4394 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4395 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4396 "brakingViolations": 0, ~/~/ Нарушений торможения
4397 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4398 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4399 "sensorViolations": 0 ~/~/ Нарушений по датчику
4400 },
4401
4402 (((
4403
4404 )))
4405
4406 "moveTime": 0, ~/~/ Продолжительность движения, сек
4407 "mileage": 0, ~/~/ Пробег, м
4408 "tripsCount": 0, ~/~/ Кол-во рейсов
4409 "trips": [  ~/~/ Информация по рейсу
4410 {
4411 "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс
4412 "score": 0, ~/~/ Рассчитанная оценка вождения за рейс
4413 "violationsCount": 0, ~/~/ Всего нарушений
4414 "violationsByType": { ~/~/ Информация о нарушениях по типу
4415 "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости
4416 "accelerationViolations": 0, ~/~/ Нарушений ускорения
4417 "brakingViolations": 0, ~/~/ Нарушений торможения
4418 "turningViolations": 0, ~/~/ Нарушений опасного поворота
4419 "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения
4420 "sensorViolations": 0 ~/~/ Нарушений по датчику
4421 },
4422
4423 "startDate": "2024-11-18T13:23:38.516Z",  ~/~/ Дата начала поездки
4424 "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки
4425 "moveTime": 0, ~/~/ Продолжительность движения, сек
4426 "mileage": 0, ~/~/ Пробег, м
4427 "motohours": 0, ~/~/ Моточасы, секунды
4428 "maxSpeed": 0, ~/~/ Максимальная скорость за рейс
4429 "startAddress": "string", ~/~/ Адрес начала рейса
4430 "endAddress": "string", ~/~/ Адрес конца рейса
4431 "drivers": [  ~/~/ Список водителей
4432 {
4433 "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя
4434 "driverName": "string", ~/~/ФИО водителя
4435 "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки
4436 }
4437 ]
4438 }
4439 ]
4440 }
4441 ]
4442 }
4443
4444 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4445
4446 == (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4447
4448 Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4449
4450 (% class="box infomessage" %)
4451 (((
4452 **POST /api/v3/fuelcards/transactions**
4453 )))
4454
4455 Метод запроса: POST
4456
4457 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4458 \\В заголовках запроса: X-Auth: Токен авторизации
4459
4460 Параметры в теле запроса (JSON):
4461
4462 {
4463 "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода
4464 "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода
4465 "ids": [ 
4466 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт
4467 ],
4468 "timezone": 0 ~/~/ Часовой пояс
4469 }
4470
4471
4472 Ответ:
4473 {
4474 "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции
4475 "driver": "string", ~/~/ Водители, привязанные к ТК
4476 "object": "string", ~/~/ Наименование ТС
4477 "amount": 0, ~/~/ Количество топлива
4478 "amountDut": 0, ~/~/ Количество по ДУТ
4479 "amountDiff": 0, ~/~/ Разница, л
4480 "amountDiffPerc": 0, ~/~/ Разница, %
4481 "summa": 0, ~/~/ Стоимость, руб
4482 "serviceName": "string", ~/~/ Тип топлива
4483 "price": 0, ~/~/ Цена за литр, руб
4484 "cardName": "string", ~/~/ Наименование ТК
4485 "cardNum": "string", ~/~/ Номер ТК
4486 "operator": "string", ~/~/ Оператор ТК
4487 "address": "string" ~/~/ Адрес АЗС
4488 }
4489
4490 == (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) ==
4491
4492 (% class="box infomessage" %)
4493 (((
4494 **GET /api/v3/fuelcards**
4495 )))
4496
4497 Метод запроса: GET
4498
4499 URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список
4500
4501 Ответ:
4502
4503 [
4504 {
4505 "Name": "string", ~/~/ Определяет наименование карты.
4506 "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора.
4507 "Number": "string", ~/~/ Определяет № карты.
4508 "Enabled": true, ~/~/ Определяет признак активности карты.
4509 "Description": "string", ~/~/ Определяет описание карты.
4510 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты
4511 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
4512 "deleted": true ~/~/ Признак удаления
4513 }
4514 ]
4515
4516 = (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4517
4518
4519 == **Получение полных данных о ретрансляторе** ==
4520
4521 (% class="box infomessage" %)
4522 (((
4523 **GET ** **/api/v3/retranslations/{id}**
4524 )))
4525
4526 id - Идентификатор ретранслятора
4527
4528
4529 Пример ответа:
4530
4531 {  
4532 "description": "", ~/~/ Поле описания ретранслятора
4533 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4534 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4535 "isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен
4536 "address": "string", ~/~/ Адрес и порт принимающего сервера
4537 "objects": [ ~/~/ Объекты для ретрансляции
4538 {      
4539 "id": "",  ~/~/ Идентификатор объекта ретрансляции
4540 "name": "", ~/~/ Наименование объекта ретрансляции
4541 "imei": "", ~/~/ IMEI объекта  ретрансляции
4542 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4543 }
4544 ],  
4545 "id": "", ~/~/ Идентификатор ретранслятора 
4546 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4547 "deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен
4548 }
4549
4550
4551 == **Удаление данных ретранслятора** ==
4552
4553 (% class="box infomessage" %)
4554 (((
4555 **DELETE** **/api/v3/retranslations/{id}**
4556 )))
4557
4558 id - Идентификатор ретранслятора
4559
4560
4561 == **Создание ретранслятора** ==
4562
4563 (% class="box infomessage" %)
4564 (((
4565 **POST ** **/api/v3/retranslations/{id}**
4566 )))
4567
4568 Запрос:
4569
4570 {  
4571 "description": "", ~/~/ Поле описания ретранслятора
4572 "subscriberId": "", ~/~/ Идентификатор подписчика
4573 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4574 "address": "", ~/~/ Адрес и порт принимающего сервера
4575 "isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен
4576 "objects": [ ~/~/Объекты для ретрансляции
4577 {      
4578 "id": "", ~/~/ Идентификатор ретранслятора 
4579 "imei": "", ~/~/ IMEI объекта ретрансляции
4580 "isEnabled": ""  ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4581 }
4582 ]
4583 }
4584
4585
4586 Ответ:
4587
4588 {  
4589 "description": "", ~/~/ Поле описания ретранслятора
4590 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4591 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4592 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4593 "address": "string", ~/~/ Адрес и порт принимающего сервера
4594 "objects": [ ~/~/ Объекты для ретрансляции
4595 {      
4596 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4597 "name": "string", ~/~/ Наименование объекта ретрансляции    
4598 "imei": "", ~/~/ IMEI объекта ретрансляции
4599 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4600 }
4601 ],
4602 "id": "", ~/~/ Идентификатор ретранслятора   
4603 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4604 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4605 }
4606
4607
4608 == **Редактирование ретранслятора** ==
4609
4610 (% class="box infomessage" %)
4611 (((
4612 **PUT** **/api/v3/retranslations**
4613 )))
4614
4615 Пример запроса:
4616
4617 {  
4618 "id": "", ~/~/ Идентификатор ретранслятора   
4619 "description": "string", ~/~/ Поле описания ретранслятора
4620 "subscriberId": "", ~/~/ Идентификатор подписчика
4621 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4622 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4623 "address": "string", ~/~/ Адрес и порт принимающего сервера
4624 "objects": ~/~/ Объекты для ретрансляции
4625 [    
4626 {      
4627 "id": "",  ~/~/ Идентификатор объекта ретрансляции 
4628 "imei": "", ~/~/ IMEI объекта ретрансляции
4629 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен
4630 }
4631 ]
4632 }
4633
4634
4635 Пример ответа:
4636
4637 {  
4638 "description": "", ~/~/ Поле описания ретранслятора
4639 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4640 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4641 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4642 "address": "string", ~/~/ Адрес и порт принимающего сервера
4643 "objects": [ ~/~/ Объекты для ретрансляции
4644 {      
4645 "id": "", ~/~/ Идентификатор объекта ретрансляции     
4646 "name": "string", ~/~/ Наименование объекта ретрансляции    
4647 "imei": "", ~/~/ IMEI объекта ретрансляции
4648 "isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен  
4649 }
4650 ],
4651 "id": "", ~/~/ Идентификатор ретранслятора   
4652 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4653 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4654 }
4655
4656
4657 == **Получение списка ретранслятора клиента** ==
4658
4659 (% class="box infomessage" %)
4660 (((
4661 **POST /api/v3/retranslations/find**
4662 )))
4663
4664 Пример запроса:
4665
4666 {  
4667 "id": "", ~/~/ Идентификатор ретранслятора   
4668 "search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4669 "parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр).
4670 }
4671
4672 Ответ:
4673
4674 [ 
4675 {    
4676 "description": "", ~/~/ Поле описания ретранслятора
4677 "subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться)
4678 "protocolType": 0, ~/~/ Тип протокола ретрансляции
4679 "isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен
4680 "address": "string", ~/~/ Адрес и порт принимающего сервера
4681 "id": "", ~/~/ Идентификатор ретранслятора   
4682 "parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента)
4683 "deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален
4684 }
4685 ]
4686
4687
4688 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) =
4689
4690 == **API для отчета по выгрузке комбайнов** ==
4691
4692 (% class="box infomessage" %)
4693 (((
4694 **POST /api/v3/Reports/harvesterUnloading**
4695 )))
4696
4697 Пример запроса:
4698
4699 {
4700 "byTime": 0, ~/~/ Объединение событий по времени
4701 "byDist": 0, ~/~/ Объединение событий по расстоянию
4702 "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4703 "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4704 "showNearestObjects": true, ~/~/Показывать объекты рядом?
4705 "vehicleIds": [ ~/~/ Список id объектов для анализа
4706 0
4707 ],
4708 "from": "", ~/~/ Дата и время начало запроса
4709 "to": "", ~/~/ Дата и время окончания запроса
4710 "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4711 }
4712
4713 Пример ответа:
4714
4715 [ 
4716 {
4717 "harvesterName": "", ~/~/Комбайн, номер
4718 "harvesterId": 0, ~/~/Комбайн, id
4719 "harvesterModel": "", ~/~/ Модель комбайна
4720 "hopperCapacity": 0, ~/~/ Объем бункера м3
4721 "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4722 "events": [ ~/~/Список событий в разрезе комбайна
4723 {
4724 "driverId": "", ~/~/Идентификатор водителя
4725 "driverName": "", ~/~/Водитель комбайна, ФИО
4726 "RFID": "", ~/~/ идентификатор карты-метки
4727 "rfidName": "", ~/~/Водитель комбайна, имя метки
4728 "vehicleId": 0, ~/~/идентификатор объекта
4729 "vehicleName": "string", ~/~/ Имя объекта
4730 "modelName": "string", ~/~/ Имя модели объекта
4731 "nearestVehicles": [ ~/~/Объекты рядом
4732 {
4733 "vehicleId": 0, ~/~/идентификатор объекта
4734 "vehicleName": "string" ~/~/ Имя объекта
4735 }
4736 ],
4737 "fields": [ ~/~/Поля, где происходила выгрузка
4738 {
4739 "id": 0, ~/~/ идентификатор пользователя 
4740 "name": "string" ~/~/ имя пользователя 
4741 }
4742 ],
4743 "event": "string", ~/~/Событие
4744 "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4745 "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4746 "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4747 "cultureName": "string", ~/~/ название культуры
4748 "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4749 "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4750 "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4751 "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4752 "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4753 "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4754 "issued": 0, ~/~/Выдано, бункеров
4755 "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4756 "latitude": 0, ~/~/Широта
4757 "longitude": 0, ~/~/ Долгота
4758 "litresAway": 0, ~/~/Отдано, л
4759 "m3Away": 0 ~/~/Отдано, м3
4760 }
4761 ]
4762 }
4763 ]
4764
4765
4766 == **Отчет трек-датчики** ==
4767
4768 (% class="box infomessage" %)
4769 (((
4770 **POST /api/v3/Reports/sensorsWorks**
4771 )))
4772
4773 **Пример запроса:**
4774
4775 {
4776 "vehicleIds": [ ~/~/ Список ID объектов
4777 0
4778 ],
4779 "from": "2025-02-20T06:39:23.888Z",  ~/~/ Начало периода (локальное время клиента)
4780 "to": "2025-02-20T06:39:23.888Z", ~/~/  Конец периода (локальное время клиента)
4781 "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4782 }
4783
4784 **Пример ответа:**
4785
4786 (((
4787 {
4788 "vehicleSensorWorks": [  ~/~/ Интервалы работы оборудования для конкретного ТС
4789 {
4790 "vehicleId": 0, ~/~/ Идентификатор ТС
4791 "sensorWorks": [ ~/~/ Интервалы работы оборудования. 
4792 {
4793 "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования.
4794 "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования.
4795 "duration": 0, ~/~/  Продолжительность интервала в секундах.
4796 "name": "string", ~/~/ Наименование оборудования.
4797 "mileage": 0, ~/~/ Пробег за время работы оборудования.
4798 "totalMileage": 0, ~/~/ Общий пробег.
4799 "avgSpeed": 0 ~/~/ Средняя скорость.
4800 }
4801 ]
4802 }
4803 ]
4804 }
4805 )))
4806
4807 = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4808
4809
4810 == **Запрос списка полей** ==
4811
4812 (% class="box successmessage" %)
4813 (((
4814 **POST /api/v3/agroLands/find**
4815 )))
4816
4817 Пример запроса:
4818
4819 (((
4820 (((
4821 (((
4822 {
4823 "year": 0, ~/~/ Фильтр по году
4824 "name": "string", ~/~/ Фильтр по названию
4825 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению
4826 }
4827 )))
4828 )))
4829
4830
4831 )))
4832
4833 Пример ответа:
4834
4835 (((
4836 [
4837 {
4838 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4839 "year": 0, ~/~/ Год поля
4840 "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая
4841 "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая
4842 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
4843 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
4844 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4845 "counts": { ~/~/ Счётчики с/х поля 
4846 "fieldOperations": 0, ~/~/ Количество операций на поле
4847 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4848 "facts": 0 ~/~/ Счётчик факта
4849 },
4850 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4851 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4852 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4853 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
4854 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4855 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4856 "planComment": "string", ~/~/ Комментарий к полю
4857 "productivity": 0, ~/~/ Урожайность.
4858 "id": 0, ~/~/ Идентификатор объекта геозоны
4859 "name": "string", ~/~/ Название объекта геозоны
4860 "type": 0, ~/~/ Тип объекта геозоны
4861 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4862 "fname": "string", ~/~/ Имя файла
4863 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4864 "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны
4865 "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны
4866 "description": "string", ~/~/ Описание объекта геозоны
4867 "area": 0, ~/~/ Площадь, м2
4868 "perimetr": 0, ~/~/ Периметр, м
4869 "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд
4870 }
4871 ]
4872
4873
4874 == **Создание нового поля ** ==
4875
4876 (% class="box successmessage" %)
4877 (((
4878 **POST /api/v3/agroLands**
4879 )))
4880
4881 Пример запроса:
4882
4883 (((
4884 {
4885 "extId": "string", 
4886 "shape": "string", ~/~/ Форма поля
4887 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
4888 "display": "string", ~/~/ Настройки отображения
4889 "year": 0, ~/~/ Год поля
4890 "name": "string", ~/~/ Наименование
4891 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4892 "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая
4893 "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая
4894 "planComment": "string", ~/~/ Комментарий к полю
4895 "cropRotations": [ ~/~/ Данные по севообороту
4896 {
4897 "landId": 0, ~/~/ ID поля
4898 "landName": "string", ~/~/ Название поля
4899 "year": 0, ~/~/ Год урожая
4900 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4901 "cultureName": "string", ~/~/ Название культуры
4902 "productivity": 0, ~/~/ Урожайность
4903 "area": 0, ~/~/ Площадь поля, Га
4904 "total": 0, ~/~/ Валовый сбор
4905 "productivityFact": 0, ~/~/ Фактическая урожайность
4906 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4907 "totalFact": 0, ~/~/ Фактический валовый сбор
4908 "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ
4909 "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева
4910 "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая
4911 "isyearplan": true, ~/~/ Годовой план 
4912 "comment": "string" ~/~/ Комментарий
4913 }
4914 ]
4915 }
4916 )))
4917
4918 (((
4919
4920 )))
4921
4922 Пример ответа:
4923
4924 (((
4925 (((
4926 {
4927 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор культуры
4928 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
4929 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
4930 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
4931 "cropRotations": [ ~/~/ Данные по севообороту
4932 {
4933 "landId": 0, ~/~/ ID поля
4934 "landName": "string", ~/~/ Название поля
4935 "year": 0, ~/~/ Год урожая 
4936 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
4937 "cultureName": "string", ~/~/ Название культуры
4938 "productivity": 0, ~/~/ Урожайность
4939 "area": 0, ~/~/ Площадь поля, Га.
4940 "total": 0, ~/~/ Валовый сбор
4941 "productivityFact": 0, ~/~/ Фактическая урожайность
4942 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
4943 "totalFact": 0, ~/~/ Фактический валовый сбор
4944 "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ
4945 "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева
4946 "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая
4947 "isyearplan": true, ~/~/ годовой план 
4948 "comment": "string" ~/~/ Комментарий
4949 }
4950 ],
4951 "cropVegetation": [ ~/~/ История вегетации поля
4952 {
4953 "values": [  ~/~/ Данные вегетации и состояния посева
4954 {
4955 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4956 "ndvi": 0 ~/~/ Индекс вегетации
4957 }
4958 ],
4959 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
4960 {
4961 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4962 "type": "string", ~/~/ Тип
4963 "pictureid": "string" ~/~/ Идентификатор ресурса
4964 }
4965 ],
4966 "states": [ ~/~/ Ключевые даты развития поля
4967 {
4968 "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата
4969 "state": 0 ~/~/ Статус  0 - Всходы, 1 - Вершина, 2 - Сбор урожая
4970 }
4971 ]
4972 }
4973 ],
4974 "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая
4975 "counts": {
4976 "fieldOperations": 0, ~/~/ Количество операций на поле
4977 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
4978 "facts": 0 ~/~/ Счётчик факта
4979 },
4980 "planComment": "string", ~/~/ Комментарий к полю
4981 )))
4982
4983 (((
4984 "productivity": 0, ~/~/ Урожайность.
4985 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
4986 "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая
4987 "year": 0, ~/~/ Год поля
4988 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4989 "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4990 "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4991 "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
4992 "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто
4993 "id": 0, ~/~/ Идентификатор объекта геозоны
4994 "name": "string", ~/~/ Название объекта геозоны
4995 "type": 0, ~/~/ Тип объекта геозоны
4996 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
4997 "fname": "string", ~/~/ Имя файла
4998 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
4999 "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны
5000 "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны
5001 "description": "string", ~/~/ Описание объекта геозоны
5002 "area": 0, ~/~/ Площадь, м2
5003 "perimetr": 0, ~/~/ Периметр, м
5004 "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд
5005 }
5006
5007
5008 )))
5009 )))
5010 )))
5011
5012 == **Получение поля по id** ==
5013
5014 (% class="box infomessage" %)
5015 (((
5016 **GET /api/v3/agroLands/{id}**
5017 )))
5018
5019 Пример запроса:
5020 id  ~/~/ Идентификатор поля
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-20T07:45:52.611Z", ~/~/ Дата начала работ
5044 "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева
5045 "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая
5046 "isyearplan": true, ~/~/ План года 
5047 "comment": "string" ~/~/ Комментарий
5048 }
5049 ],
5050 "cropVegetation": [ ~/~/ История вегетации поля
5051 {
5052 "values": [ ~/~/ Данные вегетации и состояния посева
5053 {
5054 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5055 "ndvi": 0 ~/~/ Индекс вегетации
5056 }
5057 ],
5058 "resources": [  ~/~/ Данные о снимках для каждого значения NDVI
5059 {
5060 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата
5061 "type": "string", ~/~/ Тип 
5062 "pictureid": "string" ~/~/ Идентификатор ресурса
5063 }
5064 ],
5065 "states": [ ~/~/ Ключевые даты развития поля
5066 {
5067 "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 
5068 "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая
5069 }
5070 ]
5071 }
5072 ],
5073 "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая
5074 "counts": {
5075 "fieldOperations": 0, ~/~/ Количество операций на поле
5076 "actualFieldOperations": 0,  ~/~/ Кол-во актуальных операций на поле
5077 "facts": 0 ~/~/ Счётчик факта
5078 },
5079 "planComment": "string", ~/~/ Комментарий к полю
5080 "productivity": 0, ~/~/ Урожайность.
5081 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5082 )))
5083
5084 (((
5085 (((
5086 "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая
5087 "year": 0, ~/~/ Год поля
5088 "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 
5089 "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5090 "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5091 "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5092 "status": 0,  ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой)
5093 "id": 0, ~/~/ Идентификатор объекта геозоны
5094 "name": "string", ~/~/ Название объекта геозоны
5095 "type": 0, ~/~/ Тип объекта геозоны 
5096 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5097 "fname": "string", ~/~/ Имя файла
5098 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5099 "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны
5100 "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны
5101 "description": "string", ~/~/ Описание объекта геозоны
5102 "area": 0, ~/~/ Площадь, м2
5103 "perimetr": 0, ~/~/ Периметр, м
5104 "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд
5105 }
5106 )))
5107
5108
5109 == **Удаление существующего поля** ==
5110
5111 (% class="box errormessage" %)
5112 (((
5113 **DELETE /api/v3/agroLands/{id}**
5114 )))
5115
5116 Пример запроса:
5117 id  ~/~/ Идентификатор поля
5118
5119 Пример ответа:
5120
5121 (((
5122 200 ~/~/ Успех
5123 )))
5124
5125 (((
5126
5127 )))
5128
5129 (((
5130 (((
5131 (((
5132
5133 )))
5134
5135 (((
5136 == **Изменение поля** ==
5137
5138 (% class="box infomessage" %)
5139 (((
5140 **PUT /api/v3/agroLands**
5141 )))
5142
5143 Пример запроса:
5144
5145 (((
5146 (((
5147 {
5148 "id": 0, ~/~/ Идентификатор поля
5149 "extId": "string", ~/~/ ExtId
5150 "shape": "string", ~/~/ Форма поля
5151 "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
5152 "display": "string", ~/~/ Настройки отображения
5153 "year": 0, ~/~/ Год поля
5154 "name": "string", ~/~/ Наименование
5155 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5156 "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая
5157 "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая
5158 "planComment": "string", ~/~/Комментарий к полю
5159 "cropRotations": [  ~/~/ Данные по севообороту
5160 {
5161 "landId": 0, ~/~/ ID поля
5162 "landName": "string", ~/~/ Название поля
5163 "year": 0, ~/~/ Год урожая
5164 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5165 "cultureName": "string", ~/~/ Название культуры
5166 "productivity": 0, ~/~/ Урожайность
5167 "area": 0, ~/~/ Площадь поля, Га.
5168 "total": 0, ~/~/ Валовый сбор
5169 "productivityFact": 0, ~/~/ Фактическая урожайность
5170 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5171 "totalFact": 0, ~/~/ Фактический валовый сбор
5172 "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ
5173 "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева
5174 "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая
5175 "isyearplan": true, 
5176 "comment": "string" ~/~/ Комментарий
5177 }
5178 ],
5179 "deleteStatistic": true ~/~/ Нужно ли удалять статистику
5180 }
5181 )))
5182 )))
5183
5184 (((
5185
5186 )))
5187
5188 Пример ответа:
5189
5190 (((
5191 (((
5192 (((
5193 {
5194 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5195 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5196 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5197 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5198 "cropRotations": [ ~/~/ Данные по севообороту
5199 {
5200 "landId": 0, ~/~/ ID поля
5201 "landName": "string", ~/~/ Название поля
5202 "year": 0, ~/~/  Год урожая
5203 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5204 "cultureName": "string", ~/~/ Название культуры
5205 "productivity": 0, ~/~/ Урожайность
5206 "area": 0, ~/~/ Площадь поля, Га
5207 "total": 0, ~/~/ Валовый сбор
5208 "productivityFact": 0, ~/~/ Фактическая урожайность
5209 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5210 "totalFact": 0, ~/~/ Фактический валовый сбор
5211 "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ
5212 "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева
5213 "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая
5214 "isyearplan": true, ~/~/ 
5215 "comment": "string" ~/~/ Комментарий
5216 }
5217 ],
5218 "cropVegetation": [ ~/~/ История вегетации поля
5219 {
5220 "values": [ ~/~/ Данные вегетации и состояния посева
5221 {
5222 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5223 "ndvi": 0 ~/~/ Индекс вегетации
5224 }
5225 ],
5226 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5227 {
5228 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5229 "type": "string", ~/~/ Тип
5230 "pictureid": "string" ~/~/ Идентификатор ресурса
5231 }
5232 ],
5233 "states": [ ~/~/ Ключевые даты развития поля 
5234 {
5235 "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата
5236 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5237 }
5238 ]
5239 }
5240 ],
5241 "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая
5242 "counts": { 
5243 "fieldOperations": 0, ~/~/ Количество операций на поле
5244 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5245 "facts": 0 ~/~/ Счётчик факта
5246 },
5247 "planComment": "string", ~/~/ Комментарий к полю
5248 "productivity": 0, ~/~/ Урожайность.
5249 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5250 "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая
5251 "year": 0, ~/~/ Год поля
5252 "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5253 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5254 "factState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5255 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой
5256 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 
5257 "id": 0, ~/~/ Идентификатор объекта геозоны
5258 "name": "string", ~/~/ Название объекта геозоны
5259 "type": 0, ~/~/ Тип объекта геозоны
5260 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5261 "fname": "string", ~/~/ Имя файла
5262 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5263 "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны
5264 "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны
5265 "description": "string", ~/~/ Описание объекта геозоны
5266 "area": 0, ~/~/ Площадь, м2
5267 "perimetr": 0, ~/~/ Периметр, м
5268 "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд
5269 }
5270 )))
5271 )))
5272 )))
5273 )))
5274 )))
5275
5276
5277 == **Редактирование года урожая ** ==
5278
5279 (% class="box successmessage" %)
5280 (((
5281 **POST /api/v3/agroLands/updateOpenCloseYear**
5282 )))
5283
5284 Пример запроса:
5285
5286 (((
5287 (((
5288 {
5289 "agroLandIds": [  ~/~/ Идентификаторы полей для которых меняется год урожая
5290 0
5291 ],
5292 "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая
5293 "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая
5294 }
5295 )))
5296
5297
5298 )))
5299
5300 Пример ответа:
5301
5302 (((
5303 (((
5304 {
5305 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры
5306 "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии
5307 "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле
5308 "sourceId": 0, ~/~/ Ссылка на участок прошлого года
5309 "cropRotations": [ ~/~/ Данные по севообороту
5310 {
5311 "landId": 0, ~/~/ ID поля
5312 "landName": "string", ~/~/ Название поля
5313 "year": 0, ~/~/ Год урожая
5314 "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры
5315 "cultureName": "string", ~/~/ Название культуры
5316 "productivity": 0, ~/~/ Урожайность
5317 "area": 0, ~/~/ Площадь поля, Га.
5318 "total": 0, ~/~/ Валовый сбор
5319 "productivityFact": 0, ~/~/ Фактическая урожайность
5320 "areaFact": 0, ~/~/ Фактическая площадь поля, Га.
5321 "totalFact": 0, ~/~/ Фактический валовый сбор
5322 "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ
5323 "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева
5324 "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая
5325 "isyearplan": true, ~/~/ 
5326 "comment": "string" ~/~/ Комментарий
5327 }
5328 ],
5329 "cropVegetation": [ ~/~/ История вегетации поля
5330 {
5331 "values": [ ~/~/ Данные вегетации и состояния посева
5332 {
5333 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5334 "ndvi": 0 ~/~/ Индекс вегетации
5335 }
5336 ],
5337 "resources": [ ~/~/ Данные о снимках для каждого значения NDVI
5338 {
5339 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата
5340 "type": "string", ~/~/ Тип
5341 "pictureid": "string" ~/~/ Идентификатор ресурса
5342 }
5343 ],
5344 "states": [ ~/~/ Ключевые даты развития поля
5345 {
5346 "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 
5347 "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая
5348 }
5349 ]
5350 }
5351 ],
5352 "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая
5353 "counts": { 
5354 "fieldOperations": 0, ~/~/ Количество операций на поле
5355 "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле
5356 "facts": 0 ~/~/ Счётчик факта
5357 },
5358 "planComment": "string", ~/~/ Комментарий к полю
5359 "productivity": 0, ~/~/ Урожайность.
5360 "sqPlan": 0, ~/~/ Определяет площадь поля, Га.
5361 "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая
5362 "year": 0, ~/~/ Год поля
5363 "planState": 0,  ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5364 "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5365 "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5366 "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой
5367 "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто
5368 "id": 0, ~/~/ Идентификатор объекта геозоны
5369 "name": "string", ~/~/ Название объекта геозоны
5370 "type": 0, ~/~/ Тип объекта геозоны
5371 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
5372 "fname": "string", ~/~/ Имя файла
5373 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
5374 "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны
5375 "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны
5376 "description": "string", ~/~/ Описание объекта геозоны
5377 "area": 0, ~/~/ Площадь, м2
5378 "perimetr": 0, ~/~/ ериметр, м
5379 "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд
5380 }
5381 )))
5382
5383
5384 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
5385 )))
5386 )))
5387 )))
5388
5389 == (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
5390
5391
5392 (% class="box infomessage" %)
5393 (((
5394 **GET api/v3/Vehicles/recyclebin/all**
5395 )))
5396
5397 Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
5398
5399 Параметр запроса: {parentId} - идентификатор агента
5400
5401 В заголовках запроса: X-Auth: Токен авторизации
5402
5403 Ответ:
5404
5405 [ 
5406 {
5407 "recordTime": "", ~/~/Время записи
5408 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5409 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5410 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5411 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5412 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5413 "details": { ~/~/Список деталей объекта, помещённого в корзину
5414 "items": [ ~/~/ 
5415 nullable: true ~/~/Детали
5416 {
5417 "name": "string", ~/~/наименование столбца
5418 "value": "string" ~/~/содержание столбца
5419 }
5420 ]
5421 },
5422 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5423 "string"
5424 ]
5425 }
5426 ]
5427
5428
5429 == (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) ==
5430
5431 (% class="box infomessage" %)
5432 (((
5433 **POST api/v3/Vehicles/recyclebin/erase**
5434 )))
5435
5436 В заголовках запроса: X-Auth: Токен авторизации
5437
5438 Пример запроса:
5439
5440 [
5441 0
5442 ]
5443
5444
5445 Пример ответа:
5446
5447 [ 
5448 {
5449 "recordTime": "", ~/~/Время записи
5450 "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
5451 "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
5452 "objectId": 0, ~/~/ID объекта, помещённого в корзин
5453 "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
5454 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5455 "details": { ~/~/Список деталей объекта, помещённого в корзину
5456 "items": [ ~/~/Детали
5457 {
5458 "name": "", ~/~/Имя свойства
5459 "value": "" ~/~/Значение свойства
5460 }
5461 ]
5462 },
5463 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5464 ""
5465 ]
5466 }
5467 ]
5468
5469 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
5470
5471 == (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
5472
5473 (% class="box infomessage" %)
5474 (((
5475 **POST api/v3/Vehicles/recyclebin/restore**
5476 )))
5477
5478 В заголовках запроса: X-Auth: Токен авторизации
5479
5480 Параметры в теле запроса (JSON):
5481
5482 Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
5483
5484 В заголовках запроса: X-Auth: Токен авторизации
5485
5486
5487 Пример запроса:
5488
5489 (((
5490 [
5491 )))
5492
5493 (((
5494 0
5495 )))
5496
5497 (((
5498 ]
5499 )))
5500
5501
5502 Пример ответа:
5503
5504 [
5505 {
5506 "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
5507 "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
5508 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
5509 "objectId": 0, ~/~/ID объекта, помещённого в корзину
5510 "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
5511 "objectType": 1, ~/~/Тип объекта, помещённого в корзину
5512 "details": { ~/~/Список деталей объекта, помещённого в корзину
5513 "items": [ ~/~/Детали
5514 {
5515 "name": "string", ~/~/Имя свойства
5516 "value": "string" ~/~/Значение свойства
5517 }
5518 ]
5519 },
5520 "errors": [ ~/~/Список ошибок удаления/восстановления объекта
5521 "string"
5522 ]
5523 }
5524 ]
5525
5526
5527 = **Раздел: Журнал заданий ** =
5528
5529
5530 == **Создание задания в Журнале заданий** ==
5531
5532 (% class="box infomessage" %)
5533 (((
5534 **POST /api/v3/vehicletasks**
5535 )))
5536
5537 Пример запроса:
5538
5539 (((
5540 {
5541 "vehicleId": 0, ~/~/ Идентификатор ТС
5542 "description": "string", ~/~/ Описание
5543 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5544 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5545 "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы
5546 "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы
5547 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5548 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5549 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5550 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5551 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5552 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5553 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5554 "cost": { 
5555 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5556 "Name": "string", ~/~/ Наименование
5557 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection )
5558 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5559 "Norm": 0 ~/~/ Норма внесения
5560 },
5561 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 
5562 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5563 "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания
5564 "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления
5565 "deleted": true, ~/~/ Признак удаления
5566 "extId": "string", 
5567 "GeoIds": [ ~/~/ Cвязанные поля
5568 0
5569 ]
5570 }
5571 )))
5572
5573
5574 Пример ответа:
5575
5576 {
5577 "vehicleId": 0, ~/~/ Идентификатор ТС
5578 "description": "string", ~/~/ Описание
5579 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5580 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5581 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5582 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5583 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5584 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5585 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5586 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5587 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5588 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5589 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5590 "cost": { 
5591 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5592 "Name": "string", ~/~/ Наименование
5593 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5594 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5595 "Norm": 0 ~/~/ Норма внесения
5596 },
5597 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5598 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5599 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5600 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5601 "deleted": true, ~/~/ Признак удаления
5602 "extId": "string", ~/~/ ExtId
5603 "GeoIds": [ ~/~/ Связанные поля
5604 0
5605 ]
5606 }
5607
5608
5609 == **Редактирование задания в Журнале заданий** ==
5610
5611 (% class="box successmessage" %)
5612 (((
5613 **PUT /api/v3/vehicletasks**
5614 )))
5615
5616 Пример запроса:
5617
5618 (((
5619 {
5620 "vehicleId": 0, ~/~/ Идентификатор ТС
5621 "description": "string", ~/~/ Описание
5622 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5623 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5624 "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы
5625 "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы
5626 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5627 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5628 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5629 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5630 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5631 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5632 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5633 "cost": { 
5634 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5635 "Name": "string", ~/~/ Наименование
5636 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5637 "MeasureType": 0,  ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5638 "Norm": 0 ~/~/ Норма внесения
5639 },
5640 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5641 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5642 "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания
5643 "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления
5644 "deleted": true, ~/~/ Признак удаления
5645 "extId": "string", ~/~/ ExtId
5646 "GeoIds": [ ~/~/ Связанные поля
5647 0
5648 ]
5649 }
5650 )))
5651
5652
5653 Пример ответа:
5654
5655 {
5656 "vehicleId": 0, ~/~/ Идентификатор ТС
5657 "description": "string", ~/~/ Описание
5658 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5659 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5660 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5661 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5662 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5663 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5664 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5665 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5666 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5667 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5668 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5669 "cost": { 
5670 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5671 "Name": "string", ~/~/ Наименование
5672 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5673 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5674 "Norm": 0 ~/~/ Норма внесения
5675 },
5676 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5677 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5678 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5679 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5680 "deleted": true, ~/~/ Признак удаления
5681 "extId": "string", ~/~/ ExtId
5682 "GeoIds": [ ~/~/ Связанные поля
5683 0
5684 ]
5685 }
5686
5687
5688 == **Удаление задания в Журнале заданий** ==
5689
5690 (% class="box warningmessage" %)
5691 (((
5692 **DELETE /api/v3/vehicletasks**
5693 )))
5694
5695 Пример запроса:
5696
5697 (((
5698 [
5699 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 
5700 ]
5701 )))
5702
5703 (((
5704
5705 )))
5706
5707 Пример ответа:
5708
5709 {
5710 "vehicleId": 0, ~/~/ Идентификатор ТС
5711 "description": "string", ~/~/ Описание
5712 "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата
5713 "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя
5714 "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы
5715 "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы
5716 "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ
5717 "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция
5718 "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата
5719 "minWidth": 0, ~/~/ Минимальная ширина агрегата, м
5720 "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м
5721 "minSpeed": 0, ~/~/ Минимальная скорость, км/ч
5722 "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч
5723 "cost": { 
5724 "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор
5725 "Name": "string", ~/~/ Наименование
5726 "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection)
5727 "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 
5728 "Norm": 0 ~/~/ Норма внесения
5729 },
5730 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
5731 "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
5732 "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания
5733 "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления
5734 "deleted": true, ~/~/ Признак удаления
5735 "extId": "string", ~/~/ ExtId
5736 "GeoIds": [ ~/~/ Связанные поля
5737 0
5738 ]
5739 }
5740
5741
5742 == **Получение списка Журнала заданий** ==
5743
5744 (% class="box infomessage" %)
5745 (((
5746 **POST /api/v3/vehicletasks/getbyperiod**
5747 )))
5748
5749 Пример запроса:
5750
5751 (((
5752 {
5753 "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода.
5754 "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода.
5755 "TimeZone": 0, ~/~/ Часовой пояс.
5756 "OperationsIds": [  ~/~/ Идентификаторы видов работ для фильтрации журнала
5757 "3fa85f64-5717-4562-b3fc-2c963f66afa6"
5758 ],
5759 "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала
5760 0
5761 ],
5762 "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала
5763 0
5764 ],
5765 "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска.
5766 "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 
5767 }
5768 )))
5769
5770
5771 Пример ответа:
5772
5773 (((
5774 {
5775 "total": 0,  ~/~/ Общее количество записей
5776 "pages": 0,  ~/~/ Общее количество страниц
5777 "currentPage": 0, ~/~/ Текущая страница
5778 "items": [  ~/~/ Записи 
5779 {
5780 "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5781 "isGroup": true,  ~/~/ Вид задания (true - групповое, иначе - одиночное).
5782 "name": "string", ~/~/ Название задания.
5783 "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc
5784 "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc
5785 "workKind": "string", ~/~/ Вид работ
5786 "techOp": "string", ~/~/ Тех. операция
5787 "trailerModel": "string", ~/~/ Модель агрегата
5788 "width": "string", ~/~/ Ширина, м
5789 "speed": "string", ~/~/ Тех. скорость
5790 "fields": "string", ~/~/ Поля
5791 "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га)
5792 "vehicles": "string", ~/~/ Объект-модель
5793 "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов)
5794 "drivers": "string", ~/~/ Водители
5795 "tmc": "string", ~/~/ ТМЦ
5796 "client": "string", ~/~/  Клиент
5797 "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания
5798 "dep": "string", ~/~/ Подразделение
5799 "geoIds": [ ~/~/  Связанные поля
5800 0
5801 ]
5802 }
5803 ]
5804 }
5805 )))
5806
5807
5808 (% class="box" lang="en-US" style="text-align: center;" %)
5809 (((
5810 (% 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]] **
5811 )))

Меню

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