Version 43.1 by Илья Крайнов on 2022/11/18 17:47
Show last authors
1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %)
2 == Описание ГЛОНАССSoft Public API 3.0 ==
3
4 == ==
5
6 (% class="box" style="text-align: center;" %)
7 (((
8 (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
9 )))
10
11 (% style="color:#000000" %)−(%%) Между запросами должна быть пауза в 1 секунду (превышение отвергается системой с уведомлением о превышении частоты запросов).
12
13 (% style="color:#000000" %)−(%%) Для работы со всеми методами API необходимо в заголовок добавлять __**X-Auth**__ (токен авторизации, получаемый методом __**auth/login**__).
14
15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de.
16
17
18 (% class="box" style="text-align: center;" %)
19 (((
20 (% style="color:#000000; font-size:14pt" %)**Раздел Авторизация**
21 )))
22
23 (% class="box successmessage" %)
24 (((
25 (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**
26 )))
27
28 (% style="color:#000000" %) Метод позволяет получить токен авторизации, который необходимо добавлять в заголовок для работы со всеми методами API. В параметрах метода передается имя пользователя и пароль.
29
30 (% style="color:#000000" %)Метод запроса: **POST**
31
32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]]
33
34 (% style="color:#000000" %)В случае успешного выполнения метода, поле «__**AuthId**__» содержит токен авторизации «__**X-Auth**__».
35
36 (% style="color:#000000" %)Параметры в теле запроса (JSON):
37
38 (% style="color:#000000" %){
39 "login": "testuser",
40 "password": "testuser"
41 }(%%)
42
43
44 (% style="color:#000000" %)**Ответ:**
45
46 (% lang="en-US" %)
47 (% style="color:#000000" %){
48
49 (% lang="en-US" %)
50 (% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации
51 "User": "testuser" , ~/~/ имя пользователя
52
53 (% lang="en-US" %)
54 }
55
56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
57
58
59 (% class="box infomessage" %)
60 (((
61 (% style="color:#000000; line-height:100%" %)**Проверка авторизации **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/auth/check**
62 )))
63
64 (% style="color:#000000" %) Метод позволяет проверить статус авторизации. Метод позволяет проверить активен токен авторизации или нет (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
65
66 (% style="color:#000000" %)Метод запроса: **GET**
67
68 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/check>>url:https://hosting.glonasssoft.ru/api/v3/auth/check]]
69
70 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
71
72 (% lang="en-US" %)
73 (% style="color:#000000" %)**Ответ: В случае если сессия активна HTTP ответ «200». В случае если сессия разорвана HTTP ответ «401».**
74
75
76 (% class="box" style="text-align: center;" %)
77 (((
78 (% style="color:#000000; font-size:14pt" %)**Раздел Клиенты**
79 )))
80
81 (% class="box infomessage" %)
82 (((
83 (% style="color:#000000" %)**Получение основных параметров клиента — **(% lang="en-US" %)**GET **(%%)**/(% lang="en-US" %)api/v3/agents(%%)**
84 )))
85
86 (% style="color:#000000" %) Метод позволяет получить основные параметры клиентов: наименование, полное наименование, тип, статус и идентификатор клиента-родителя. Метод возвращает информацию о клиентах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
87
88 (% style="color:#000000" %)− информация о клиентах предоставляется при наличии права «Просмотр клиентов»;
89
90 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах;
91
92 (% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».
93
94 (% style="color:#000000" %)Метод запроса: **GET**
95
96 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/agents?parentId=>>url:https://hosting.glonasssoft.ru/api/v3/agents?parentId=]](% style="color:#000000" %)<parentId>
97
98 (% style="color:#000000" %)Параметр запроса: <__**parentId**__> - идентификатор клиента-родителя (опционально)
99
100 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
101
102 (% style="color:#000000" %)Ответ:
103
104 (% style="color:#000000" %){
105 "agentId": "", ~/~/ идентификатор клиента
106 "parentId": "", ~/~/ идентификатор клиента-родителя
107 "name": "", ~/~/ наименование клиента
108 "fullName": "", ~/~/ полное наименование клиента
109 "agentInfoType": "", ~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
110 "status": "", ~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ)
111 }
112
113
114 (% class="box" style="text-align: center;" %)
115 (((
116 (% style="color:#000000; font-size:14pt" %)**Раздел Пользователи**
117 )))
118
119 (% class="box successmessage" %)
120 (((
121 (% style="color:#000000; line-height:100%" %)**Добавление пользователя — **(% lang="en-US" %)**POST /api/v3/users**
122 )))
123
124 (% style="color:#000000" %) Метод позволяет добавить пользователя. Метод позволяет добавить пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
125
126 (% style="color:#000000" %)Метод запроса: **POST**
127
128 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
129
130 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
131
132 (% style="color:#000000" %)Параметры в теле запроса (JSON):
133
134 (% style="color:#000000" %){ 
135 "lastName": "", ~/~/ фамилия
136 "firstName": "", ~/~/ имя
137 "position": "", ~/~/ должность
138 "phone": "", ~/~/ телефон
139 "organization": "", ~/~/ организация
140 "login": "", ~/~/ логин (обязателен)
141 "password": "", ~/~/ пароль (обязателен)
142 "email": "", ~/~/ email (обязателен)
143 "description": "", ~/~/ описание
144 "isEnabled": "", ~/~/ признак включения
145 "parentId": "", ~/~/ Guid родительского агента
146 "leaderId": "", ~/~/ Guid руководителя (null - не задан)
147 "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
148 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 }
153
154 (% style="text-align:left" %)
155 (% style="color:#000000; font-weight:normal" %)Ответ:
156
157 (% style="text-align:left" %)
158 (% style="color:#000000; font-weight:normal" %){    
159
160 (% style="text-align:left" %)
161 (% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
162 "lastName": "" , ~/~/ Фамилия ,
163 "firstName": "" , ~/~/ Имя
164 "position": "" , ~/~/ Должность
165 "phone": "" , ~/~/ Телефон
166 "organization": "" , ~/~/ Организация
167 "login": "" , ~/~/ Логин
168 "password": "" , ~/~/ Пароль
169 "email": "" , ~/~/ Email
170 "description": "" , ~/~/ Описание
171 "isEnabled": "" , ~/~/ Признак включения
172 "parentId": "" , ~/~/ Guid родительского агента
173 "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
174 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 "kind": "" , ~/~/ тип аутентификации
176 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178
179 (% style="text-align:left" %)
180 (% style="color:#000000; font-weight:normal" %)}
181
182
183 (% class="box successmessage" %)
184 (((
185 (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
186 )))
187
188 (% style="color:#000000" %) Метод позволяет получить основные параметры пользователей: логин, имя, адрес электронной почты, номер телефона, статус, идентификатор клиента-родителя и прочее.
189
190 (% style="color:#000000" %)Метод возвращает информацию о пользователях клиента-родителя авторизованного пользователя и пользователях его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**.
191
192 (% style="color:#000000" %)Метод запроса: **POST**
193
194 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
195
196 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
197
198 (% style="color:#000000" %)Параметры в теле запроса (JSON):
199
200 (% style="color:#000000" %){
201
202 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
203 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
204 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
205 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
206
207 (% style="color:#000000" %)}
208
209 (% style="color:#000000" %)Ответ:
210
211 (% style="color:#000000" %){         (%%)
212
213 "id": "" , ~/~/ идентификатор пользователя
214 "lastName": "" , ~/~/ фамилия
215 "firstName": "" , ~/~/ имя
216 "position": "" , ~/~/ должность
217 "phone": "" , ~/~/ телефон
218 "parentId": "" , ~/~/ идентификатор клиента-родителя
219 "parentName": "" , ~/~/ наименование клиента-родителя
220 "organization": "" , ~/~/ организация
221 "login": "" , ~/~/ логин
222 "email": "" , ~/~/ E-mail
223 "sessionDuration":"", ~/~/ длительность сессии в минутах
224 "status": "1",  ~/~/ статус пользователя
225 "astLogged": "", ~/~/ дата/время последней авторизации
226
227 (% style="color:#000000" %)}
228
229
230 (% class="box successmessage" %)
231 (((
232 (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
233 )))
234
235 (% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
236
237 (% style="color:#000000" %)Метод запроса: **GET**
238
239 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
240
241 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242
243 (% style="color:#000000" %)Ответ:
244
245 (((
246 (((
247 {
248 )))
249 )))
250
251 (((
252 (((
253 "id": "", ~/~/ GUID пользователя
254 )))
255 )))
256
257 (((
258 (((
259 "lastName": "", ~/~/ Фамилия
260 )))
261 )))
262
263 (((
264 (((
265 "firstName": "", ~/~/ Имя
266 )))
267 )))
268
269 (((
270 (((
271 "position": "", ~/~/ Должность
272 )))
273 )))
274
275 (((
276 (((
277 "phone": "", ~/~/ Номер телефона
278 )))
279 )))
280
281 (((
282 (((
283 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
284 )))
285 )))
286
287 (((
288 (((
289 "parentName": "", Наименование клиента, которому принадлежит пользователь
290 )))
291 )))
292
293 (((
294 (((
295 "organization": "", ~/~/ Организация
296 )))
297 )))
298
299 (((
300 (((
301 "login": "", ~/~/ Логин пользователя
302 )))
303 )))
304
305 (((
306 (((
307 "email": "", ~/~/ Адрес электронной почты
308 )))
309 )))
310
311 (((
312 (((
313 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
314 )))
315 )))
316
317 (((
318 (((
319 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
320 )))
321 )))
322
323 (((
324 (((
325 "description": "", ~/~/ Описание
326 )))
327 )))
328
329 (((
330 (((
331 "isEnabled": , ~/~/ Включен, true - включен, false - отключен
332 )))
333 )))
334
335 (((
336 (((
337 "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
338 )))
339 )))
340
341 (((
342 (((
343 "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
344 )))
345 )))
346
347 (((
348 (((
349 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
350 )))
351 )))
352
353 (((
354 (((
355 "sessionDuration": 30, ~/~/ Длительность сессии в минутах
356 )))
357 )))
358
359 (((
360 (((
361 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
362 )))
363 )))
364
365 (((
366 (((
367 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
368 )))
369 )))
370
371 (((
372 (((
373 "groups": [], ~/~/ Список ролей пользователя
374 )))
375 )))
376
377 (((
378 (((
379 "customGroups": [], ~/~/ Список клиентских ролей пользователя
380 )))
381 )))
382
383 (((
384 (((
385 "authDevices": [ ], ~/~/ Список авторизованных устройств
386 )))
387 )))
388
389 (((
390 (((
391 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
392 )))
393 )))
394
395 (((
396 (((
397 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
398 )))
399 )))
400
401 (((
402 (((
403 }
404 )))
405 )))
406
407
408 (% class="box warningmessage" %)
409 (((
410 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
411 )))
412
413 (% style="color:#000000" %) Метод позволяет отредактировать пользователя. Метод позволяет отредактировать пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
414
415 (% style="color:#000000" %)Метод запроса: **PUT**
416
417 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users>>url:https://hosting.glonasssoft.ru/api/v3/users]]
418
419 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
420
421 **При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
422
423 (% lang="en-US" style="text-align:left" %)
424 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
425
426 (% lang="en-US" style="text-align:left" %)
427 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){  
428
429 (% lang="en-US" style="text-align:left" %)
430 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 
431 "lastName": "" , ~/~/ фамилия
432 "firstName": "" , ~/~/ имя
433 "position": "" , ~/~/ должность
434 "phone": "" , ~/~/ телефон
435 "organization": "" , ~/~/ организация
436 "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
437 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
438 "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
439 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
440 "isEnabled": "" , ~/~/ признак включения
441 "parentId": "" , ~/~/ Guid родительского агента
442 "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
443 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
444 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
445 "kind": "" , ~/~/ тип аутентификации
446 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
447 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
448
449 (% lang="en-US" style="text-align:left" %)
450 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__
451
452 (% lang="en-US" style="text-align:left" %)
453 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~://
454
455 (% lang="en-US" style="text-align:left" %)
456 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
457
458 (% lang="en-US" style="text-align:left" %)
459 (% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя
460 "lastName": "" , ~/~/ фамилия
461 "firstName": "" , ~/~/ имя
462 "position": "" , ~/~/ должность
463 "phone": "" , ~/~/ телефон
464 "organization": "" , ~/~/ организация
465 "login": "" , ~/~/ логин
466 "password": "" , ~/~/ пароль 
467 "email": "" , ~/~/ email
468 "description": "" , ~/~/ описание
469 "isEnabled": "" , ~/~/ признак включения
470 "parentId": "" , ~/~/ Guid родительского агента
471 "sessionDuration": "" , ~/~/ продолжительность сессии, в минутах 
472 "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
473 "kind": "" , ~/~/ тип аутентификации
474 "target": "" , ~/~/ в случае аутентификации по email - email-адрес
475 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
476
477 (% lang="en-US" style="text-align:left" %)
478 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
479
480
481 (% class="box warningmessage" %)
482 (((
483 (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
484 )))
485
486 (% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
487
488 (% style="color:#000000" %)Метод запроса: **PUT**
489
490 (% 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}
491
492 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid пользователя
493
494 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
495
496 (% style="color:#000000" %)Параметры в теле запроса (JSON):
497
498 (% style="color:#000000" %){
499
500 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован)
501 "description": "" , ~/~/ описание
502 "data": "" , ~/~/ данные, связанные со сменой статуса
503
504 (% style="color:#000000" %)}
505
506 (% style="text-align:left" %)
507 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
508
509
510 (% class="box warningmessage" %)
511 (((
512 **Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
513 )))
514
515 Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
516
517 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
518
519 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
520
521 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
522
523 [ 
524 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
525 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
526 ]
527
528 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
529
530
531 (% class="box warningmessage" %)
532 (((
533 **Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
534 )))
535
536 Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
537
538 (% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
539
540 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
541
542 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
543
544 [ 
545 "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
546 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
547 ]
548
549 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
550 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
551
552 (((
553 В теле ответа:
554 {
555 "errorMessages": [
556 "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
557 ],
558 "users": [
559 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
560 ]
561 }
562 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
563 "users" - массив id пользователей, которых не удалось включить или отключить.
564
565 )))
566
567 (% class="box errormessage" %)
568 (((
569 (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
570 )))
571
572 (% style="color:#000000" %) Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
573
574 (% style="color:#000000" %)Метод запроса: **DELETE**
575
576 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/>>url:https://hosting.glonasssoft.ru/api/v3/users/]](% style="color:#000000" %){id}
577
578 (% style="color:#000000" %)Параметр запроса: {**__id__**} - Guid пользователя
579
580 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
581
582 (% style="text-align:left" %)
583 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
584
585
586 (% class="box" style="text-align: center;" %)
587 (((
588 (% style="color:#000000; font-size:14pt" %)**Раздел Транспортные средства**
589 )))
590
591 (% class="box infomessage" %)
592 (((
593 (% style="color:#000000; line-height:100%" %)**Получение информации об объекте — **(% lang="en-US" %)**GET /api/v3/vehicles/{vehicleId}**
594 )))
595
596 (% style="color:#000000" %) Метод позволяет получить всю информацию из карточки объекта: ID, имя объекта, imei, тип устройства, SIM1, SIM2, ID клиента, название клиента, ID модели, наименование модели объекта, ID подразделения, водители, ТО, текущий пробег, моточасы, нормы расхода, полную историю статусов со всеми комментариями, список датчиков (тип, наименование, тип входа, номер входа, псевдоним, тип датчика, тип тарировки, тарировка, состояние чекбоксов «отображается в подсказке» и «отображать последнее валидное значение».
597
598 (% style="color:#000000" %) Метод возвращает информацию об объекте с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
599
600 (% style="color:#000000" %)− возвращается информация об объекте клиента-родителя авторизованного пользователя и объекте его дочерних клиентов;
601
602 (% style="color:#000000" %)− информация о ТО предоставляется с учётом прав на **«__Просмотр заданий на техобслуживание__»**.
603
604 (% style="color:#000000" %)Метод запроса: **GET**
605
606 (% 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>
607
608 (% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
609
610 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
611
612 (% style="color:#000000" %)Ответ:
613
614 (((
615 {
616 )))
617
618 (((
619 "vehicleId": "", ~/~/ ID объекта
620 )))
621
622 (((
623 "name": "", ~/~/ Имя объекта
624 )))
625
626 (((
627 "imei": "", ~/~/ IMEI объекта
628 )))
629
630 (((
631 "deviceTypeId": , ~/~/ ID типа устройства
632 )))
633
634 (((
635 "deviceTypeName": "", ~/~/ Название типа устройства
636 )))
637
638 (((
639 "sim1": "", ~/~/ Номер SIM1
640 )))
641
642 (((
643 "parentId": "", Номер SIM2
644 )))
645
646 (((
647 "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
648 )))
649
650 (((
651 "modelId": "", ID модели объекта
652 )))
653
654 (((
655 "modelName": "", Имя модели объекта
656 )))
657
658 (((
659 "createdAt": "", Дата создания объекта
660 )))
661
662 (((
663 "mileageCalcMethod": "", Выбранный метод расчета пробега
664 )))
665
666 (((
667 "counters": { ~/~/ Нормы
668 )))
669
670 (((
671 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
672 )))
673
674 (((
675 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
676 )))
677
678 (((
679 "mileage": "", ~/~/ Пробег по нормам в метрах
680 )))
681
682 (((
683 "motohours": "" ~/~/ Моточасы по нормам, в секундах
684 )))
685
686 (((
687 },
688 )))
689
690 (((
691 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
692 )))
693
694 (((
695 {
696 )))
697
698 (((
699 "id": "", ~/~/ ID  задания
700 )))
701
702 (((
703 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
704 )))
705
706 (((
707 "name": "", ~/~/ Наименование задания
708 )))
709
710 (((
711 "description": "", ~/~/ Описание задания
712 )))
713
714 (((
715 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
716 )))
717
718 (((
719 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
720 )))
721
722 (((
723 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
724 )))
725
726 (((
727 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
728 )))
729
730 (((
731 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
732 )))
733
734 (((
735 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
736 )))
737
738 (((
739 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
740 )))
741
742 (((
743 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
744 )))
745
746 (((
747 }
748 )))
749
750 (((
751 ]
752 )))
753
754 (((
755 }
756 )))
757
758 (% style="text-align:left" %)
759 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
760
761 (% style="text-align:left" %)
762 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
763
764
765 (% class="box successmessage" %)
766 (((
767 (% style="color:#000000; line-height:100%" %)**Добавление объекта — **(% lang="en-US" %)**POST /api/v3/vehicles**
768 )))
769
770 (% style="color:#000000" %) Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**, //Content-Type//: __**application/json**__; //charset//=__**utf-8**__).
771
772 (% style="color:#000000" %)Метод запроса: **POST**
773
774 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
775
776 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
777
778 (% style="color:#000000" %)Параметры в теле запроса (JSON): //Обязательные параметры наименование и модель объекта //В теле запроса - объект JSON
779
780 (% style="color:#000000" %){
781
782 "parentId": "" , ~/~/ ID клиента
783 "name": "" , ~/~/ имя ТС
784 "imei": "" , ~/~/ IMEI
785 "deviceTypeId": "" , ~/~/ ID типа устройства
786 "modelId": "" , ~/~/ ID модели
787 "unitId": "" , ~/~/ ID подразделения
788 "sim1": "" , ~/~/ Номер SIM 1
789 "sim2": "" , ~/~/ Номер SIM2
790 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
791 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
792 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
793 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
794 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
795 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
796 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
797 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
798 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
799 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
800 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
801 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
802 "counters": ~/~/ счетчики
803 {
804 "mileage": "" , ~/~/ пробег
805 "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег"
806 "motohours": "" , ~/~/ моточасы
807 "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы"
808 },
809 "cmsv6Parameters": { ~/~/ параметры CMSv6
810 "enabled": true, ~/~/ флаг включения
811 "id": "" , ~/~/ идентификатор
812 "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
813 "login": "" , ~/~/ имя учетной записи
814 "password": "" ~/~/ пароль учетной записи
815 },
816 "inspectionTasks": ~/~/ задания на ТО
817 {
818 "enabled": "" , ~/~/ Признак включения
819 "name": "" , ~/~/ Имя задания
820 "description": "" , ~/~/ Описание задания
821 "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает)
822 "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
823 "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает)
824 "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
825 "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает)
826 "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
827 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано)
828 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
829 }
830
831 (% style="color:#000000" %) }
832
833 (% style="color:#000000" %)Ответ:
834
835 (% style="color:#000000" %){
836
837 "vehicleId": "", ~/~/ID ТС 
838 "parentId": "", ~/~/Guid владельца ТС
839 "name": "", ~/~/Имя объекта
840 "imei": "", ~/~/IMEI
841 "deviceTypeId": "", ~/~/ID типа устройства
842 "modelId": "", ~/~/ID модели
843 "unitId": "", ~/~/ID подразделения
844 "sim1": "", ~/~/SIM1
845 "sim2": "", ~/~/SIM2
846 "consumptionPer100Km": "", ~/~/Расход топлива на 100 км
847 "consumptionIdle": "", ~/~/Расход топлива на холостом ходу
848 "counters": { ~/~/Счётчики
849 "mileageEnabled": true,
850 "motohoursEnabled": true,
851 "mileage": "",
852 "motohours": 345.0
853 },
854 "cmsv6Parameters": { ~/~/Параметры CmsV6
855 "id": null,
856 "enabled": true, ~/~/флаг включения
857 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
858 "login": "", ~/~/ имя учетной записи
859 "password": "" ~/~/ пароль учетной записи
860 },
861 "inspectionTasks": { ~/~/ задания на ТО
862 "id": "", ~/~/ ID задачи
863 "enabled": false, ~/~/ Признак включения
864 "name": "", ~/~/ Имя задания
865 "description": "", ~/~/ Описание задания
866 "mileageCondition": "", ~/~/ Условие по пробегу
867 "lastMileage": "", ~/~/ Пробег (в метрах)
868 "motohoursCondition": "", ~/~/ Условие по моточасам
869 "lastMotohours": "", ~/~/ Моточасы
870 "periodicCondition": "", ~/~/ Условие периодичности по времени
871 "kind": "", ~/~/ Вид периодичности по времени 
872 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
873 }
874
875 (% style="text-align:left" %)
876 (% style="color:#000000" %)}
877
878 **Валидация:**
879 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
880 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
881 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
882
883
884 (% class="box successmessage" %)
885 (((
886 (% style="color:#000000; line-height:100%" %)**Получение параметров объектов — **(% lang="en-US" %)**POST /api/v3/vehicles/find**
887 )))
888
889 (% style="color:#000000" %) Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
890
891 (% style="color:#000000" %) Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**):
892
893 (% style="color:#000000" %)− возвращается информация об объектах клиента-родителя авторизованного пользователя и объектах его дочерних клиентов;
894
895 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов;
896
897 (% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**;
898
899 (% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**;
900
901 (% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**.
902
903 (% style="color:#000000" %)Метод запроса: **POST**
904
905 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/find>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/find]]
906
907 (% style="color:#000000" %)В заголовках запроса:
908
909 (% style="color:#000000" %)− Content-Type: __**application/json**__
910
911 (% style="color:#000000" %)− X-Auth: Токен авторизации
912
913 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса.
914
915 (% style="color:#000000" %)Параметры в теле запроса (JSON):
916
917 (% class="western" style="color:#000000" %)##{##
918
919 (% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
920 "name": null, ~/~/ Имя ТС (string, опционально) 
921 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
922 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
923 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
924 "parentId": null, ~/~/ ID клиента (Guid, опционально) 
925 "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
926 (% style="color:#000000" %)}
927
928 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
929
930 (% style="color:#000000" %)Ответ:
931
932 (% style="color:#000000" %){
933
934 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта
935 "name": "" ~/~/ наименование объекта
936 "imei": "" ~/~/ IMEI объекта
937 "deviceTypeId": "" ~/~/ идентификатор типа устройства
938 "deviceTypeName": "" ~/~/ наименование типа устройства
939 "sim1": "" ~/~/ первый номер телефона
940 "sim2": "" ~/~/ второй номер телефона
941 "parentId": "" ~/~/ идентификатор клиента-родителя
942 "parentName": "" ~/~/ наименование клиента-родителя
943 "modelId": "" ~/~/ идентификатор модели объекта
944 "modelName": "" ~/~/ наименование модели объекта
945 "unitId": "" ~/~/ идентификатор подразделения
946 "unitName": "" ~/~/ наименование подразделения
947 "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
948 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
949 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
950 (% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
951 (% style="color:#000000" %)}
952
953 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.
954
955
956 (% class="box successmessage" %)
957 (((
958 (% style="color:#000000; line-height:100%" %)**Изменение статуса объекта — **(% lang="en-US" %)**POST /api/v3/vehicles/changeStatus/{vehicleId}**
959 )))
960
961 (% style="color:#000000" %) Метод позволяет изменить статус объекта. Метод позволяет изменить статус объекта, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
962
963 (% style="color:#000000" %)Метод запроса: **POST**
964
965 (% 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}
966
967 (% style="color:#000000" %)Параметр запроса: {__**vehicleId**__} - ID ТС
968
969 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
970
971 (% style="color:#000000" %)Параметры в теле запроса (JSON):
972
973 (% style="color:#000000" %){
974
975 "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
976 ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
977 ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
978 "date": "", ~/~/ Дата смены статуса (null если сменить немедленно)
979 "description": "", ~/~/ Описание
980 "data": "", ~/~/ Данные
981 "overwrite": false, ~/~/ Флаг перезаписи
982 "stage": "", ~/~/ Состояние, может быть null
983
984 (% style="color:#000000" %)}
985
986 (% style="color:#000000" %)Ответ:
987
988 (% style="color:#000000" %){
989
990 "status": "", ~/~/ значение статуса
991 "date": "", ~/~/ Дата смены статуса 
992 "description": "", ~/~/ Описание
993 "data": "", ~/~/ Данные
994 "overwrite": false, ~/~/ Флаг перезаписи
995 "stage": "", ~/~/ Состояние
996
997 (% style="text-align:left" %)
998 (% style="color:#000000" %) }
999
1000
1001 (% class="box warningmessage" %)
1002 (((
1003 (% style="color:#000000; line-height:100%" %)**Редактирование объекта — **(% lang="en-US" %)**PUT /api/v3/vehicles**
1004 )))
1005
1006 (% style="color:#000000" %) Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1007
1008 (% style="color:#000000" %)Метод запроса: **PUT**
1009
1010 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles>>url:https://hosting.glonasssoft.ru/api/v3/vehicles]]
1011
1012 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1013
1014 (% style="color:#000000" %)Параметры в теле запроса (JSON):
1015
1016 (% style="color:#000000" %){    
1017
1018 (((
1019 (% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС
1020 "parentId": "", ~/~/ ID клиента
1021 "name": "", ~/~/ имя ТС
1022 "imei": "", ~/~/ IMEI
1023 "deviceTypeId": "", ~/~/ ID типа устройства
1024 "modelId": "", ~/~/ , ID модели    
1025 "unitId": "", ~/~/ подразделения
1026 "sim1": "", ~/~/ SIM 1
1027 "sim2": "", ~/~/ SIM2     (%%)
1028 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
1029 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
1030 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
1031 "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
1032 "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
1033 "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
1034 "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
1035 "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
1036 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
1037 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
1038 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
1039 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
1040 (% style="color:#000000" %) "counters": 
1041 {
1042 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1043 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1044 "mileage": "", ~/~/ пробег, в метрах 
1045 "motohours": "" ~/~/ моточасы, в секундах
1046 }
1047 "cmsv6Parameters": ~/~/ параметры CMSv6
1048 {       
1049 "id": "", ~/~/ идентификатор
1050 "enabled": true, ~/~/ флаг включения
1051 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1052 "login": "", ~/~/ имя учетной записи
1053 "password": "", ~/~/ пароль учетной записи
1054 }
1055 "inspectionTasks": ~/~/ задания на ТО
1056 {
1057 "id": "", ~/~/ ID задания
1058 "enabled": false, ~/~/ Признак включения
1059 "name": "", ~/~/ Имя задания
1060 "description": "", ~/~/ Описание задания
1061 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
1062 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
1063 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
1064 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
1065 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
1066 "kind": "", ~/~/ Вид периодичности по времени
1067 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1068 } 
1069 )))
1070
1071 (% style="color:#000000" %)}
1072
1073 (% style="color:#000000" %)Ответ:
1074
1075 (% lang="en-US" style="text-align:left" %)
1076 (% lang="ru-RU" style="color:#000000; font-weight:normal" %){    
1077
1078 (% lang="en-US" style="text-align:left" %)
1079 "vehicleId": "", ~/~/ ID ТС
1080 "parentId": "", ~/~/ ID клиента
1081 "name": "", ~/~/ имя ТС
1082 "imei": "", ~/~/ IMEI
1083 "deviceTypeId": "", ~/~/ типа устройства
1084 "modelId": "", ~/~/ ID модели
1085 "unitId": "", ~/~/ ID подразделения
1086 "sim1": "", ~/~/ SIM 1
1087 "sim2": "", ~/~/ SIM2
1088 "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км
1089 "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу
1090 "counters": 
1091 {
1092 "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
1093 "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
1094 "mileage": "", ~/~/ пробег
1095 "motohours": "", ~/~/ моточасы
1096 }
1097 "cmsv6Parameters": ~/~/ параметры CMSv6
1098 {
1099 "id": ~/~/ идентификатор
1100 "enabled": true, ~/~/ флаг включения
1101 "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6
1102 "login": "", ~/~/ имя учетной записи
1103 "password": "", ~/~/ пароль учетной записи
1104 }
1105 "inspectionTasks": ~/~/ задания на ТО
1106 {
1107 "id": "", ~/~/ ID задания
1108 "enabled": false, ~/~/ Признак включения
1109 "name": "", ~/~/ Имя задания
1110 "description": "", ~/~/ Описание задания
1111 "mileageCondition": "", ~/~/ Условие по пробегу
1112 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО
1113 "motohoursCondition": "", ~/~/ Условие по моточасам
1114 "lastMotohours": "", ~/~/ Моточасы
1115 "periodicCondition": "", ~/~/ Условие периодичности по времени
1116 "kind": "", ~/~/ Вид периодичности по времени
1117 "maxQuantity": "", ~/~/ Сколько раз выполнить задание
1118 }
1119
1120 (% lang="en-US" style="text-align:left" %)
1121 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)}
1122
1123 **валидация:**
1124 - сезонный параметр может быть задан только если задана соответствующая обычная норма;
1125 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма;
1126 - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1127
1128
1129 (% class="box errormessage" %)
1130 (((
1131 (% style="color:#000000; line-height:100%" %)**Удаление объекта — **(% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1132 )))
1133
1134 (% style="color:#000000" %) Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1135
1136 (% style="color:#000000" %)Метод запроса: **DELETE**
1137
1138 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){vehicleId}
1139
1140 (% style="color:#000000" %)Параметр запроса: {__**id**__} - Guid объекта
1141
1142 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1143
1144 (% style="text-align:left" %)
1145 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».**
1146
1147
1148 (% class="box" lang="en-US" style="text-align: center;" %)
1149 (((
1150 (% style="color:#000000; font-size:14pt" %)**Раздел Устройства**
1151 )))
1152
1153 (% class="box infomessage" %)
1154 (((
1155 (% style="color:#000000; line-height:100%" %)**Получение списка типов устройств **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/devices/types**
1156 )))
1157
1158 (% style="color:#000000" %) Метод позволяет получить список типов устройств. Метод возвращает информацию о типах устройств с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1159
1160 (% style="color:#000000" %)Метод запроса: **GET**
1161
1162 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]
1163
1164 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1165
1166 (% style="color:#000000" %)Ответ:
1167
1168 (% style="color:#000000" %){
1169
1170 "deviceTypeId" : "", ~/~/ ID типа устройства
1171 "deviceTypeName" : "" ~/~/ Название типа устройства
1172
1173 (% style="text-align:left" %)
1174 (% style="color:#000000" %)}
1175
1176
1177 (% class="box" style="text-align: center;" %)
1178 (((
1179 (% style="color:#000000; font-size:14pt" %)**Раздел Датчики**
1180 )))
1181
1182 (% class="box infomessage" %)
1183 (((
1184 (% style="color:#000000; line-height:100%" %)**Получение списка типов датчиков **(% style="color:#000000" %)**— **(% lang="en-US" %)**GET /api/v3/sensors/types**
1185 )))
1186
1187 (% style="color:#000000" %) Метод позволяет получить список типов датчиков. Метод возвращает информацию о типах датчиков с учетом настроек авторизованного пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
1188
1189 (% style="color:#000000" %)Метод запроса: **GET**
1190
1191 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/sensors/types>>url:https://hosting.glonasssoft.ru/api/v3/sensors/types]]
1192
1193 (% style="color:#000000" %)В заголовках запроса:X-Auth: Токен авторизации
1194
1195 (% style="color:#000000" %)Ответ:
1196
1197 (% style="color:#000000" %){
1198
1199 "id": "", ~/~/ ID типа датчика 
1200 "name": "", ~/~/ Название
1201 "description": "", ~/~/ Описание
1202
1203 (% style="text-align:left" %)
1204 (% style="color:#000000" %)}
1205
1206
1207 (% class="box" lang="en-US" style="text-align: center;" %)
1208 (((
1209 (% 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]] **
1210 )))

Меню

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