Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 49.1 >
edited by Илья Крайнов
on 2022/11/21 11:03
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
... ... @@ -3,11 +3,6 @@
3 3  
4 4  == ==
5 5  
6 -[[ (% style="color:#000000; line-height:100%" %)**Авторизация **(% style="color:#000000" %)**— **(% lang="en-US" %)**POST /api/v3/auth/login**>>Авторизация — POST /api/v3/auth/login||anchor="Авторизация — POST /api/v3/auth/login"]]
7 -
8 -
9 -
10 -
11 11  (% class="box" style="text-align: center;" %)
12 12  (((
13 13  (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
... ... @@ -142,9 +142,9 @@
142 142   "position": "", ~/~/ должность
143 143   "phone": "", ~/~/ телефон
144 144   "organization": "", ~/~/ организация
145 - "login": "", ~/~/ логин (обязателен)
146 - "password": "", ~/~/ пароль (обязателен)
147 - "email": "", ~/~/ email (обязателен)
140 + "login": "", ~/~/ логин
141 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 + "email": "", ~/~/ email
148 148   "description": "", ~/~/ описание
149 149   "isEnabled": "", ~/~/ признак включения
150 150   "parentId": "", ~/~/ Guid родительского агента
... ... @@ -179,7 +179,7 @@
179 179   "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
180 180   "kind": "" , ~/~/ тип аутентификации
181 181   "target": "" , ~/~/ в случае аутентификации по email - email-адрес
182 - "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя
177 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
183 183  
184 184  (% style="text-align:left" %)
185 185  (% style="color:#000000; font-weight:normal" %)}
... ... @@ -232,54 +232,6 @@
232 232  (% style="color:#000000" %)}
233 233  
234 234  
235 -(% class="box successmessage" %)
236 -(((
237 -(% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}**
238 -)))
239 -
240 -(% style="color:#000000" %) Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователе предоставляется при наличии права **«__Просмотр пользователей__»**.
241 -
242 -(% style="color:#000000" %)Метод запроса: **GET**
243 -
244 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)users/{GUID}>>https://hosting.glonasssoft.ru/api/v3/users/{GUID}]]
245 -
246 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
247 -
248 -(% style="color:#000000" %)Ответ:
249 -
250 -(((
251 -(((
252 -{
253 - "id": "", ~/~/ GUID пользователя
254 - "lastName": "", ~/~/ Фамилия 
255 - "firstName": "", ~/~/ Имя
256 - "position": "", ~/~/ Должность
257 - "phone": "", ~/~/ Номер телефона
258 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь
259 - "parentName": "", Наименование клиента, которому принадлежит пользователь
260 - "organization": "", ~/~/ Организация
261 - "login": "", ~/~/ Логин пользователя
262 - "email": "", ~/~/ Адрес электронной почты
263 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский
264 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено
265 - "description": "", ~/~/ Описание
266 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен
267 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен
268 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации
269 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен
270 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах
271 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован
272 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя
273 - "groups": [], ~/~/ Список ролей пользователя
274 - "customGroups": [], ~/~/ Список клиентских ролей пользователя
275 - "authDevices": [ ], ~/~/ Список авторизованных устройств
276 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств
277 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления
278 -}
279 -)))
280 -)))
281 -
282 -
283 283  (% class="box warningmessage" %)
284 284  (((
285 285  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**
... ... @@ -293,8 +293,6 @@
293 293  
294 294  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
295 295  
296 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
297 -
298 298  (% lang="en-US" style="text-align:left" %)
299 299  (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON):
300 300  
... ... @@ -308,10 +308,10 @@
308 308   "position": "" , ~/~/ должность
309 309   "phone": "" , ~/~/ телефон
310 310   "organization": "" , ~/~/ организация
311 - "login": "" , ~/~/ логин   (% style="color:#000000" %)(Если null - менять не надо)(%%)
312 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "password": "" , ~/~/ пароль (Если null - менять не надо)
313 - "email": "" , ~/~/ email   (% style="color:#000000" %)(Если null - менять не надо)(%%)
314 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "description": "" , ~/~/ описание
256 + "login": "" , ~/~/ логин
257 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
258 + "email": "" , ~/~/ email
259 + "description": "" , ~/~/ описание
315 315   "isEnabled": "" , ~/~/ признак включения
316 316   "parentId": "" , ~/~/ Guid родительского агента
317 317   "leaderId": "" , ~/~/ Guid руководителя (null - не задан)
... ... @@ -424,7 +424,6 @@
424 424  (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
425 425  \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
426 426  
427 -(((
428 428  В теле ответа:
429 429  {
430 430   "errorMessages": [
... ... @@ -437,7 +437,6 @@
437 437  \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
438 438  "users" - массив id пользователей, которых не удалось включить или отключить.
439 439  
440 -)))
441 441  
442 442  (% class="box errormessage" %)
443 443  (((
... ... @@ -486,44 +486,77 @@
486 486  
487 487  (% style="color:#000000" %)Ответ:
488 488  
489 -(((
490 490  {
433 +
491 491   "vehicleId": "", ~/~/ ID объекта
435 +
492 492   "name": "", ~/~/ Имя объекта
437 +
493 493   "imei": "", ~/~/ IMEI объекта
439 +
494 494   "deviceTypeId": , ~/~/ ID типа устройства
441 +
495 495   "deviceTypeName": "", ~/~/ Название типа устройства
443 +
496 496   "sim1": "", ~/~/ Номер SIM1
445 +
497 497   "parentId": "", Номер SIM2
498 - "parentName": "", Наименование клиента-родителя
447 +
448 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя
449 +
499 499   "modelId": "", ID модели объекта
451 +
500 500   "modelName": "", Имя модели объекта
453 +
501 501   "createdAt": "", Дата создания объекта
455 +
502 502   "mileageCalcMethod": "", Выбранный метод расчета пробега
457 +
503 503   "counters": { ~/~/ Нормы
459 +
504 504   "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
461 +
505 505   "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
463 +
506 506   "mileage": "", ~/~/ Пробег по нормам в метрах
465 +
507 507   "motohours": "" ~/~/ Моточасы по нормам, в секундах
467 +
508 508   },
469 +
509 509   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
471 +
510 510   {
511 - "id": "", ~/~/ ID  задания
473 +
474 + "id": "", ~/~/ ID  задания
475 +
512 512   "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
477 +
513 513   "name": "", ~/~/ Наименование задания
479 +
514 514   "description": "", ~/~/ Описание задания
481 +
515 515   "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
483 +
516 516   "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
485 +
517 517   "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
487 +
518 518   "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
489 +
519 519   "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
491 +
520 520   "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
493 +
521 521   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
495 +
522 522   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
497 +
523 523   }
499 +
524 524   ]
501 +
525 525  }
526 -)))
527 527  
528 528  (% style="text-align:left" %)
529 529  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -684,17 +684,17 @@
684 684  
685 685  (% style="color:#000000" %)Параметры в теле запроса (JSON):
686 686  
687 -{
688 - "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально)
689 - "name": null, ~/~/ Имя ТС (string, опционально)
690 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально)
691 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально)
692 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально)
693 - "parentId": null, ~/~/ ID клиента (Guid, опционально)
694 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)
695 - "customFields": null ~/~/ значение любого из произвольных полей ТС
696 -}
663 +(% class="western" style="color:#000000" %)##{##
697 697  
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 +
698 698  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
699 699  
700 700  (% style="color:#000000" %)Ответ:
... ... @@ -717,16 +717,7 @@
717 717   "status": "" ~/~/ статус объекта         (%%)(-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 
718 718   ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 
719 719   ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется)
720 -(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  
721 - "customFields": [ 
722 - {
723 - "id": "", ~/~/ идентификатор произвольного поля
724 - "name": "", ~/~/ имя произвольного поля
725 - "value": "", ~/~/ значение произвольного поля
726 - "forClient": true, ~/~/ право на отображение у клиента
727 - "forTooltip": false, ~/~/ право на отображение в подсказке
728 - "forReport": false ~/~/ право на отображение в отчетах
729 - }(%%)
696 +(% style="color:#000000" %) "createdAt": "" ~/~/ дата создания объектов  (%%)
730 730  (% style="color:#000000" %)}
731 731  
732 732  (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**.

Меню

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