Last modified by Андрей Калиновский on 2025/02/25 16:35
<
From version < 29.1 >
edited by Артем Шемяков
on 2022/09/22 10:34
To version < 48.1 >
edited by Илья Крайнов
on 2022/11/21 10: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
... ... @@ -3,6 +3,11 @@
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 +
6 6  (% class="box" style="text-align: center;" %)
7 7  (((
8 8  (% style="color:#000000; font-size:18.6667px" %)**Действующие ограничения**
... ... @@ -137,9 +137,9 @@
137 137   "position": "", ~/~/ должность
138 138   "phone": "", ~/~/ телефон
139 139   "organization": "", ~/~/ организация
140 - "login": "", ~/~/ логин
141 - "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
142 - "email": "", ~/~/ email
145 + "login": "", ~/~/ логин (обязателен)
146 + "password": "", ~/~/ пароль (обязателен)
147 + "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": "" , ~/~/ группы пользователя, названия групп
156 + "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» названия группы пользователя
182 + "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  
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 +
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  
296 +**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!**
297 +
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": "" , ~/~/ описание
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": "" , ~/~/ описание
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__»**).
361 +(% 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  
385 +(% class="box warningmessage" %)
386 +(((
387 +**Блокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/disable**
388 +)))
389 +
390 +Метода позволяет выполнить массовую блокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
391 +
392 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
393 +
394 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/disable>>https://hosting.glonasssoft.ru/api/v3/users/disable]]
395 +
396 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
397 +
398 + [ 
399 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
400 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
401 + ]
402 +
403 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**
404 +
405 +
406 +(% class="box warningmessage" %)
407 +(((
408 +**Разблокировка пользователей** (% style="color:#000000; line-height:100%" %)**— POST /api/v3/users/enable**
409 +)))
410 +
411 +Метода позволяет выполнить массовую разблокировку пользователей (% style="color:#000000" %)(обязательный параметр в заголовках запроса - токен авторизации **«__X-Auth__»**).
412 +
413 +(% style="color:#000000" %)Метод запроса: (% style="color:#000000; line-height:100%" %)**POST**
414 +
415 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/enable>>https://hosting.glonasssoft.ru/api/v3/users/enable]]
416 +
417 +(% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON):
418 +
419 + [ 
420 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc",
421 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
422 + ]
423 +
424 +(% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%)
425 +\\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__
426 +
427 +(((
428 +В теле ответа:
429 +{
430 + "errorMessages": [
431 + "Agent 0f8c2a8b-4b71-48d0-b780-341053089874 cannot access to object Agents d493fd88-60c8-465d-afad-912f5ac9d719."
432 + ],
433 + "users": [
434 + "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1"
435 + ]
436 +}
437 +\\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями.
438 +"users" - массив id пользователей, которых не удалось включить или отключить.
439 +
440 +)))
441 +
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,44 @@
374 374  
375 375  (% style="color:#000000" %)Ответ:
376 376  
377 -(% style="color:#000000" %){
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": "" , ~/~/ статус объекта
391 -
489 +(((
490 +{
491 + "vehicleId": "", ~/~/ ID объекта
492 + "name": "", ~/~/ Имя объекта
493 + "imei": "", ~/~/ IMEI объекта
494 + "deviceTypeId": , ~/~/ ID типа устройства
495 + "deviceTypeName": "", ~/~/ Название типа устройства
496 + "sim1": "", ~/~/ Номер SIM1
497 + "parentId": "", Номер SIM2
498 + "parentName": "", Наименование клиента-родителя
499 + "modelId": "", ID модели объекта
500 + "modelName": "", Имя модели объекта
501 + "createdAt": "", Дата создания объекта
502 + "mileageCalcMethod": "", Выбранный метод расчета пробега
503 + "counters": { ~/~/ Нормы
504 + "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
505 + "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
506 + "mileage": "", ~/~/ Пробег по нормам в метрах
507 + "motohours": "" ~/~/ Моточасы по нормам, в секундах
508 + },
509 + "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
510 + {
511 + "id": "", ~/~/ ID  задания
512 + "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен)
513 + "name": "", ~/~/ Наименование задания
514 + "description": "", ~/~/ Описание задания
515 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает)
516 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно)
517 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает)
518 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно)
519 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает)
520 + "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает)
521 + "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
522 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
523 + }
524 + ]
392 392  }
526 +)))
393 393  
394 394  (% style="text-align:left" %)
395 395  Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже:
... ... @@ -550,17 +550,17 @@
550 550  
551 551  (% style="color:#000000" %)Параметры в теле запроса (JSON):
552 552  
553 -(% class="western" style="color:#000000" %)##{##
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 +}
554 554  
555 -(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 
556 - "name": null, ~/~/ Имя ТС (string, опционально) 
557 - "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 
558 - "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 
559 - "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 
560 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 
561 - "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%)
562 -(% style="color:#000000" %)}
563 -
564 564  (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**.
565 565  
566 566  (% style="color:#000000" %)Ответ:
... ... @@ -660,7 +660,7 @@
660 660   "modelId": "", ~/~/ , ID модели    
661 661   "unitId": "", ~/~/ подразделения
662 662   "sim1": "", ~/~/ SIM 1
663 - "sim2": "", ~/~/ SIM2 (%%)
797 + "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": «» моточасы
814 + "mileage": "", ~/~/ пробег, в метрах 
815 + "motohours": "" ~/~/ моточасы, в секундах
682 682   }
683 683   "cmsv6Parameters": ~/~/ параметры CMSv6
684 684   {       

Меню

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