Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/02/25 16:35
Change comment:
There is no comment for this version
Summary
Details
- 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 родительского агента ... ... @@ -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 - не задан) ... ... @@ -369,6 +369,7 @@ 369 369 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 370 370 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 371 371 494 +((( 372 372 В теле ответа: 373 373 { 374 374 "errorMessages": [ ... ... @@ -381,6 +381,7 @@ 381 381 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 382 382 "users" - массив id пользователей, которых не удалось включить или отключить. 383 383 507 +))) 384 384 385 385 (% class="box errormessage" %) 386 386 ((( ... ... @@ -429,77 +429,149 @@ 429 429 430 430 (% style="color:#000000" %)Ответ: 431 431 556 +((( 432 432 { 558 +))) 433 433 560 +((( 434 434 "vehicleId": "", ~/~/ ID объекта 562 +))) 435 435 564 +((( 436 436 "name": "", ~/~/ Имя объекта 566 +))) 437 437 568 +((( 438 438 "imei": "", ~/~/ IMEI объекта 570 +))) 439 439 572 +((( 440 440 "deviceTypeId": , ~/~/ ID типа устройства 574 +))) 441 441 576 +((( 442 442 "deviceTypeName": "", ~/~/ Название типа устройства 578 +))) 443 443 580 +((( 444 444 "sim1": "", ~/~/ Номер SIM1 582 +))) 445 445 584 +((( 446 446 "parentId": "", Номер SIM2 586 +))) 447 447 588 +((( 448 448 "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя 590 +))) 449 449 592 +((( 450 450 "modelId": "", ID модели объекта 594 +))) 451 451 596 +((( 452 452 "modelName": "", Имя модели объекта 598 +))) 453 453 600 +((( 454 454 "createdAt": "", Дата создания объекта 602 +))) 455 455 604 +((( 456 456 "mileageCalcMethod": "", Выбранный метод расчета пробега 606 +))) 457 457 608 +((( 458 458 "counters": { ~/~/ Нормы 610 +))) 459 459 612 +((( 460 460 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 614 +))) 461 461 616 +((( 462 462 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 618 +))) 463 463 620 +((( 464 464 "mileage": "", ~/~/ Пробег по нормам в метрах 622 +))) 465 465 624 +((( 466 466 "motohours": "" ~/~/ Моточасы по нормам, в секундах 626 +))) 467 467 628 +((( 468 468 }, 630 +))) 469 469 632 +((( 470 470 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 634 +))) 471 471 636 +((( 472 472 { 638 +))) 473 473 640 +((( 474 474 "id": "", ~/~/ ID задания 642 +))) 475 475 644 +((( 476 476 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 646 +))) 477 477 648 +((( 478 478 "name": "", ~/~/ Наименование задания 650 +))) 479 479 652 +((( 480 480 "description": "", ~/~/ Описание задания 654 +))) 481 481 656 +((( 482 482 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 658 +))) 483 483 660 +((( 484 484 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 662 +))) 485 485 664 +((( 486 486 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 666 +))) 487 487 668 +((( 488 488 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 670 +))) 489 489 672 +((( 490 490 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 674 +))) 491 491 676 +((( 492 492 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 678 +))) 493 493 680 +((( 494 494 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 682 +))) 495 495 684 +((( 496 496 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 686 +))) 497 497 688 +((( 498 498 } 690 +))) 499 499 692 +((( 500 500 ] 694 +))) 501 501 696 +((( 502 502 } 698 +))) 503 503 504 504 (% style="text-align:left" %) 505 505 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: