Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 29.1 >
edited by Артем Шемяков
on 2022/09/22 10:34
To version < 41.1 >
edited by Илья Крайнов
on 2022/11/18 17:34
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Artem
1 +XWiki.krainovim
Content
... ... @@ -137,9 +137,9 @@
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин
141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 - "email": "", ~/~/ email
140 + "login": "", ~/~/ логин (обязателен)
141 + "password": "", ~/~/ пароль (обязателен)
142 + "email": "", ~/~/ email (обязателен)
143 143   "description": "", ~/~/ описание
144 144   "isEnabled": "", ~/~/ признак включения
145 145   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -148,7 +148,7 @@
148 148   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
149 149   "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
150 150   "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
151 - "groups": "" , ~/~/ группы пользователя, названия групп
151 + "groups": ["", ""] , ~/~/ группы пользователя, перечисление названия групп (data-row)
152 152  }
153 153  
154 154  (% style="text-align:left" %)
... ... @@ -174,7 +174,7 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
177 + "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -227,6 +227,128 @@
227 227  (% style="color:#000000" %)}
228 228  
229 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" %)Ответ:
242 +
243 +(((
244 +{
245 +)))
246 +
247 +(((
248 + "id": "", ~/~/ GUID пользователя
249 +)))
250 +
251 +(((
252 + "lastName": "", ~/~/ Фамилия
253 +)))
254 +
255 +(((
256 + "firstName": "", ~/~/ Имя
257 +)))
258 +
259 +(((
260 + "position": "", ~/~/ Должность
261 +)))
262 +
263 +(((
264 + "phone": "", ~/~/ Номер телефона
265 +)))
266 +
267 +(((
268 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
269 +)))
270 +
271 +(((
272 + "parentName": "", Наименование клиента, которому принадлежит пользователь
273 +)))
274 +
275 +(((
276 + "organization": "", ~/~/ Организация
277 +)))
278 +
279 +(((
280 + "login": "", ~/~/ Логин пользователя
281 +)))
282 +
283 +(((
284 + "email": "", ~/~/ Адрес электронной почты
285 +)))
286 +
287 +(((
288 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
289 +)))
290 +
291 +(((
292 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
293 +)))
294 +
295 +(((
296 + "description": "", ~/~/ Описание
297 +)))
298 +
299 +(((
300 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
301 +)))
302 +
303 +(((
304 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
305 +)))
306 +
307 +(((
308 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
309 +)))
310 +
311 +(((
312 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
313 +)))
314 +
315 +(((
316 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
317 +)))
318 +
319 +(((
320 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
321 +)))
322 +
323 +(((
324 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
325 +)))
326 +
327 +(((
328 + "groups": [], ~/~/ Список ролей пользователя
329 +)))
330 +
331 +(((
332 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
333 +)))
334 +
335 +(((
336 + "authDevices": [ ], ~/~/ Список авторизованных устройств
337 +)))
338 +
339 +(((
340 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
341 +)))
342 +
343 +(((
344 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
345 +)))
346 +
347 +(((
348 +}
349 +)))
350 +
351 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 232  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -253,10 +253,10 @@
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин
257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 - "email": "" , ~/~/ email
259 - "description": "" , ~/~/ описание
378 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
379 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
380 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
381 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -303,7 +303,7 @@
303 303  (% style="color:#000000" %)**Изменение статуса пользователя**// //**— **(% lang="en-US" %)**PUT /api/v3/users/status/{id}**
304 304  )))
305 305  
306 -(% style="color:#000000" %) Метод позволяет изменить статус пользователя. Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
428 +(% style="color:#000000" %) Метод позволяет изменить статус пользователя, указанного в запросе (обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
307 307  
308 308  (% style="color:#000000" %)Метод запроса: **PUT**
309 309  
... ... @@ -327,6 +327,63 @@
327 327  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
328 328  
329 329  
452 +(% class="box warningmessage" %)
453 +(((
454 +**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
455 +)))
456 +
457 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
458 +
459 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
460 +
461 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
462 +
463 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
464 +
465 + [ 
466 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
467 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
468 + ]
469 +
470 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
471 +
472 +
473 +(% class="box warningmessage" %)
474 +(((
475 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
476 +)))
477 +
478 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
479 +
480 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
481 +
482 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
483 +
484 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
485 +
486 + [ 
487 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
488 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
489 + ]
490 +
491 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
492 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
493 +
494 +(((
495 +В теле ответа:
496 +{
497 + "errorMessages": [
498 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
499 + ],
500 + "users": [
501 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
502 + ]
503 +}
504 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
505 +"users" - массив id пользователей, которых не удалось включить или отключить.
506 +
507 +)))
508 +
330 330  (% class="box errormessage" %)
331 331  (((
332 332  (% style="color:#000000; line-height:100%" %)**Удаление пользователя — **(% lang="en-US" %)**DELETE /api/v3/users/{id}**
... ... @@ -374,22 +374,149 @@
374 374  
375 375  (% style="color:#000000" %)Ответ:
376 376  
377 -(% style="color:#000000" %){
556 +(((
557 +{
558 +)))
378 378  
379 - "vehicleId": "" , ~/~/ идентификатор объекта
380 - "name": "" , ~/~/ имя объекта
381 - "imei": "" , ~/~/ IMEI объекта
382 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
383 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
384 - "parentId": "" , ~/~/ идентификатор клиента-родителя
385 - "parentName": "" , ~/~/ наименование клиента-родителя,
386 - "modelId": "" , ~/~/ идентификатор модели объекта
387 - "modelName": "" , ~/~/ наименование модели объекта,
388 - "unitId": "" , ~/~/ идентификатор подразделения
389 - "unitName": "" , ~/~/ наименование подразделения
390 - "status": "" , ~/~/ статус объекта
560 +(((
561 + "vehicleId": "", ~/~/ ID объекта
562 +)))
391 391  
564 +(((
565 + "name": "", ~/~/ Имя объекта
566 +)))
567 +
568 +(((
569 + "imei": "", ~/~/ IMEI объекта
570 +)))
571 +
572 +(((
573 + "deviceTypeId": , ~/~/ ID типа устройства
574 +)))
575 +
576 +(((
577 + "deviceTypeName": "", ~/~/ Название типа устройства
578 +)))
579 +
580 +(((
581 + "sim1": "", ~/~/ Номер SIM1
582 +)))
583 +
584 +(((
585 + "parentId": "", Номер SIM2
586 +)))
587 +
588 +(((
589 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
590 +)))
591 +
592 +(((
593 + "modelId": "", ID модели объекта
594 +)))
595 +
596 +(((
597 + "modelName": "", Имя модели объекта
598 +)))
599 +
600 +(((
601 + "createdAt": "", Дата создания объекта
602 +)))
603 +
604 +(((
605 + "mileageCalcMethod": "", Выбранный метод расчета пробега
606 +)))
607 +
608 +(((
609 + "counters": { ~/~/ Нормы
610 +)))
611 +
612 +(((
613 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
614 +)))
615 +
616 +(((
617 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
618 +)))
619 +
620 +(((
621 + "mileage": "", ~/~/ Пробег по нормам в метрах
622 +)))
623 +
624 +(((
625 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
626 +)))
627 +
628 +(((
629 + },
630 +)))
631 +
632 +(((
633 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
634 +)))
635 +
636 +(((
637 + {
638 +)))
639 +
640 +(((
641 + "id": "", ~/~/ ID  задания
642 +)))
643 +
644 +(((
645 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
646 +)))
647 +
648 +(((
649 + "name": "", ~/~/ Наименование задания
650 +)))
651 +
652 +(((
653 + "description": "", ~/~/ Описание задания
654 +)))
655 +
656 +(((
657 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
658 +)))
659 +
660 +(((
661 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
662 +)))
663 +
664 +(((
665 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
666 +)))
667 +
668 +(((
669 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
670 +)))
671 +
672 +(((
673 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
674 +)))
675 +
676 +(((
677 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
678 +)))
679 +
680 +(((
681 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
682 +)))
683 +
684 +(((
685 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
686 +)))
687 +
688 +(((
689 + }
690 +)))
691 +
692 +(((
693 + ]
694 +)))
695 +
696 +(((
392 392  }
698 +)))
393 393  
394 394  (% style="text-align:left" %)
395 395  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -660,7 +660,7 @@
660 660   "modelId": "", ~/~/ , ID модели    
661 661   "unitId": "", ~/~/ подразделения
662 662   "sim1": "", ~/~/ SIM 1
663 - "sim2": "", ~/~/ SIM2 (%%)
969 + "sim2": "", ~/~/ SIM2     (%%)
664 664   "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
665 665   "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
666 666   "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
... ... @@ -677,8 +677,8 @@
677 677   {
678 678   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
679 679   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
680 - "mileage": «», пробег
681 - "motohours": «» моточасы
986 + "mileage": "", ~/~/ пробег, в метрах 
987 + "motohours": "" ~/~/ моточасы, в секундах
682 682   }
683 683   "cmsv6Parameters": ~/~/ параметры CMSv6
684 684   {       

Меню

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