Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 47.1 >
edited by Илья Крайнов
on 2022/11/21 10:32
To version < 38.1 >
edited by Илья Крайнов
on 2022/11/17 14:49
>
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": "", ~/~/ пароль (обязателен)
142 - "email": "", ~/~/ email (обязателен)
140 + "login": "", ~/~/ логин
141 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 + "email": "", ~/~/ email
143 143   "description": "", ~/~/ описание
144 144   "isEnabled": "", ~/~/ признак включения
145 145   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -174,7 +174,7 @@
174 174   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
175 175   "kind": "" , ~/~/ тип аутентификации
176 176   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
177 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
177 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
178 178  
179 179  (% style="text-align:left" %)
180 180  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -227,54 +227,6 @@
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 -
278 278  (% class="box warningmessage" %)
279 279  (((
280 280  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -288,8 +288,6 @@
288 288  
289 289  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
290 290  
291 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
292 -
293 293  (% lang="en-US" style="text-align:left" %)
294 294  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
295 295  
... ... @@ -303,10 +303,10 @@
303 303   "position": "" , ~/~/ должность
304 304   "phone": "" , ~/~/ телефон
305 305   "organization": "" , ~/~/ организация
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": "" , ~/~/ описание
256 + "login": "" , ~/~/ логин
257 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 + "email": "" , ~/~/ email
259 + "description": "" , ~/~/ описание
310 310   "isEnabled": "" , ~/~/ признак включения
311 311   "parentId": "" , ~/~/ Guid родительского агента
312 312   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -419,7 +419,6 @@
419 419  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
420 420  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
421 421  
422 -(((
423 423  В теле ответа:
424 424  {
425 425   "errorMessages": [
... ... @@ -432,7 +432,6 @@
432 432  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
433 433  "users" - массив id пользователей, которых не удалось включить или отключить.
434 434  
435 -)))
436 436  
437 437  (% class="box errormessage" %)
438 438  (((
... ... @@ -481,44 +481,77 @@
481 481  
482 482  (% style="color:#000000" %)Ответ:
483 483  
484 -(((
485 485  {
433 +
486 486   "vehicleId": "", ~/~/ ID объекта
435 +
487 487   "name": "", ~/~/ Имя объекта
437 +
488 488   "imei": "", ~/~/ IMEI объекта
439 +
489 489   "deviceTypeId": , ~/~/ ID типа устройства
441 +
490 490   "deviceTypeName": "", ~/~/ Название типа устройства
443 +
491 491   "sim1": "", ~/~/ Номер SIM1
445 +
492 492   "parentId": "", Номер SIM2
493 - "parentName": "", Наименование клиента-родителя
447 +
448 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
449 +
494 494   "modelId": "", ID модели объекта
451 +
495 495   "modelName": "", Имя модели объекта
453 +
496 496   "createdAt": "", Дата создания объекта
455 +
497 497   "mileageCalcMethod": "", Выбранный метод расчета пробега
457 +
498 498   "counters": { ~/~/ Нормы
459 +
499 499   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
461 +
500 500   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
463 +
501 501   "mileage": "", ~/~/ Пробег по нормам в метрах
465 +
502 502   "motohours": "" ~/~/ Моточасы по нормам, в секундах
467 +
503 503   },
469 +
504 504   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
471 +
505 505   {
506 - "id": "", ~/~/ ID  задания
473 +
474 + "id": "", ~/~/ ID  задания
475 +
507 507   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
477 +
508 508   "name": "", ~/~/ Наименование задания
479 +
509 509   "description": "", ~/~/ Описание задания
481 +
510 510   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
483 +
511 511   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
485 +
512 512   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
487 +
513 513   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
489 +
514 514   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
491 +
515 515   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493 +
516 516   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
495 +
517 517   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497 +
518 518   }
499 +
519 519   ]
501 +
520 520  }
521 -)))
522 522  
523 523  (% style="text-align:left" %)
524 524  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -679,17 +679,17 @@
679 679  
680 680  (% style="color:#000000" %)Параметры в теле запроса (JSON):
681 681  
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 -}
663 +(% class="western" style="color:#000000" %)##{##
692 692  
665 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
666 + "name": null, ~/~/ Имя ТС (string, опционально) 
667 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
668 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
669 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
670 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 
671 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
672 +(% style="color:#000000" %)}
673 +
693 693  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
694 694  
695 695  (% style="color:#000000" %)Ответ:

Меню

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