Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 31.1 >
edited by Илья Крайнов
on 2022/10/24 15:19
To version < 47.1 >
edited by Илья Крайнов
on 2022/11/21 10:32
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
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,54 @@
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" %)В заголовках запроса: X-Auth: Токен авторизации
242 +
243 +(% style="color:#000000" %)Ответ:
244 +
245 +(((
246 +(((
247 +{
248 + "id": "", ~/~/ GUID пользователя
249 + "lastName": "", ~/~/ Фамилия 
250 + "firstName": "", ~/~/ Имя
251 + "position": "", ~/~/ Должность
252 + "phone": "", ~/~/ Номер телефона
253 + "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
254 + "parentName": "", Наименование клиента, которому принадлежит пользователь
255 + "organization": "", ~/~/ Организация
256 + "login": "", ~/~/ Логин пользователя
257 + "email": "", ~/~/ Адрес электронной почты
258 + "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
259 + "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
260 + "description": "", ~/~/ Описание
261 + "isEnabled": , ~/~/ Включен, true - включен, false - отключен
262 + "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
263 + "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
264 + "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
265 + "sessionDuration": 30, ~/~/ Длительность сессии в минутах
266 + "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
267 + "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
268 + "groups": [], ~/~/ Список ролей пользователя
269 + "customGroups": [], ~/~/ Список клиентских ролей пользователя
270 + "authDevices": [ ], ~/~/ Список авторизованных устройств
271 + "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
272 + "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
273 +}
274 +)))
275 +)))
276 +
277 +
230 230  (% class="box warningmessage" %)
231 231  (((
232 232  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -240,6 +240,8 @@
240 240  
241 241  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
242 242  
291 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
292 +
243 243  (% lang="en-US" style="text-align:left" %)
244 244  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
245 245  
... ... @@ -253,10 +253,10 @@
253 253   "position": "" , ~/~/ должность
254 254   "phone": "" , ~/~/ телефон
255 255   "organization": "" , ~/~/ организация
256 - "login": "" , ~/~/ логин
257 - "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 - "email": "" , ~/~/ email
259 - "description": "" , ~/~/ описание
306 + "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
307 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
308 + "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
309 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
260 260   "isEnabled": "" , ~/~/ признак включения
261 261   "parentId": "" , ~/~/ Guid родительского агента
262 262   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -350,7 +350,7 @@
350 350  
351 351  (% class="box warningmessage" %)
352 352  (((
353 -**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/find**
403 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
354 354  )))
355 355  
356 356  Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
... ... @@ -366,8 +366,23 @@
366 366   "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
367 367   ]
368 368  
369 -(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
419 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
420 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
370 370  
422 +(((
423 +В теле ответа:
424 +{
425 + "errorMessages": [
426 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
427 + ],
428 + "users": [
429 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
430 + ]
431 +}
432 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
433 +"users" - массив id пользователей, которых не удалось включить или отключить.
434 +
435 +)))
371 371  
372 372  (% class="box errormessage" %)
373 373  (((
... ... @@ -416,22 +416,44 @@
416 416  
417 417  (% style="color:#000000" %)Ответ:
418 418  
419 -(% style="color:#000000" %){
420 -
421 - "vehicleId": "" , ~/~/ идентификатор объекта
422 - "name": "" , ~/~/ имя объекта
423 - "imei": "" , ~/~/ IMEI объекта
424 - "deviceTypeId": "" , ~/~/ идентификатор устройства объекта
425 - "deviceTypeName": "" , ~/~/ наименование устройства объекта
426 - "parentId": "" , ~/~/ идентификатор клиента-родителя
427 - "parentName": "" , ~/~/ наименование клиента-родителя,
428 - "modelId": "" , ~/~/ идентификатор модели объекта
429 - "modelName": "" , ~/~/ наименование модели объекта,
430 - "unitId": "" , ~/~/ идентификатор подразделения
431 - "unitName": "" , ~/~/ наименование подразделения
432 - "status": "" , ~/~/ статус объекта
433 -
484 +(((
485 +{
486 + "vehicleId": "", ~/~/ ID объекта
487 + "name": "", ~/~/ Имя объекта
488 + "imei": "", ~/~/ IMEI объекта
489 + "deviceTypeId": , ~/~/ ID типа устройства
490 + "deviceTypeName": "", ~/~/ Название типа устройства
491 + "sim1": "", ~/~/ Номер SIM1
492 + "parentId": "", Номер SIM2
493 + "parentName": "", Наименование клиента-родителя
494 + "modelId": "", ID модели объекта
495 + "modelName": "", Имя модели объекта
496 + "createdAt": "", Дата создания объекта
497 + "mileageCalcMethod": "", Выбранный метод расчета пробега
498 + "counters": { ~/~/ Нормы
499 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
500 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
501 + "mileage": "", ~/~/ Пробег по нормам в метрах
502 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
503 + },
504 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
505 + {
506 + "id": "", ~/~/ ID  задания
507 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
508 + "name": "", ~/~/ Наименование задания
509 + "description": "", ~/~/ Описание задания
510 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
511 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
512 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
513 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
514 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
515 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
516 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
517 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
518 + }
519 + ]
434 434  }
521 +)))
435 435  
436 436  (% style="text-align:left" %)
437 437  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -592,17 +592,17 @@
592 592  
593 593  (% style="color:#000000" %)Параметры в теле запроса (JSON):
594 594  
595 -(% class="western" style="color:#000000" %)##{##
682 +{
683 + "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
684 + "name": null, ~/~/ Имя ТС (string, опционально)
685 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
686 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
687 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
688 + "parentId": null, ~/~/ ID клиента (Guid, опционально)
689 + "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
690 + "customFields": null ~/~/ значение любого из произвольных полей ТС
691 +}
596 596  
597 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
598 - "name": null, ~/~/ Имя ТС (string, опционально) 
599 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
600 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
601 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
602 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
603 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
604 -(% style="color:#000000" %)}
605 -
606 606  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
607 607  
608 608  (% style="color:#000000" %)Ответ:
... ... @@ -719,8 +719,8 @@
719 719   {
720 720   "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег»
721 721   "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы»
722 - "mileage": «», пробег
723 - "motohours": «» моточасы
809 + "mileage": "", ~/~/ пробег, в метрах 
810 + "motohours": "" ~/~/ моточасы, в секундах
724 724   }
725 725   "cmsv6Parameters": ~/~/ параметры CMSv6
726 726   {       

Меню

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