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": "", ~/~/ пароль (обязателен) 142 - "email": "", ~/~/ email (обязателен)140 + "login": "", ~/~/ логин 141 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 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": ["",""], ~/~/ группы пользователя,перечисление названия групп(data-row)151 + "groups": "" , ~/~/ группы пользователя, названия групп 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": (% 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,184 +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 -))) 249 -))) 250 - 251 -((( 252 -((( 253 - "id": "", ~/~/ GUID пользователя 254 -))) 255 -))) 256 - 257 -((( 258 -((( 259 - "lastName": "", ~/~/ Фамилия 260 -))) 261 -))) 262 - 263 -((( 264 -((( 265 - "firstName": "", ~/~/ Имя 266 -))) 267 -))) 268 - 269 -((( 270 -((( 271 - "position": "", ~/~/ Должность 272 -))) 273 -))) 274 - 275 -((( 276 -((( 277 - "phone": "", ~/~/ Номер телефона 278 -))) 279 -))) 280 - 281 -((( 282 -((( 283 - "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 284 -))) 285 -))) 286 - 287 -((( 288 -((( 289 - "parentName": "", Наименование клиента, которому принадлежит пользователь 290 -))) 291 -))) 292 - 293 -((( 294 -((( 295 - "organization": "", ~/~/ Организация 296 -))) 297 -))) 298 - 299 -((( 300 -((( 301 - "login": "", ~/~/ Логин пользователя 302 -))) 303 -))) 304 - 305 -((( 306 -((( 307 - "email": "", ~/~/ Адрес электронной почты 308 -))) 309 -))) 310 - 311 -((( 312 -((( 313 - "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 314 -))) 315 -))) 316 - 317 -((( 318 -((( 319 - "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 320 -))) 321 -))) 322 - 323 -((( 324 -((( 325 - "description": "", ~/~/ Описание 326 -))) 327 -))) 328 - 329 -((( 330 -((( 331 - "isEnabled": , ~/~/ Включен, true - включен, false - отключен 332 -))) 333 -))) 334 - 335 -((( 336 -((( 337 - "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 338 -))) 339 -))) 340 - 341 -((( 342 -((( 343 - "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 344 -))) 345 -))) 346 - 347 -((( 348 -((( 349 - "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 350 -))) 351 -))) 352 - 353 -((( 354 -((( 355 - "sessionDuration": 30, ~/~/ Длительность сессии в минутах 356 -))) 357 -))) 358 - 359 -((( 360 -((( 361 - "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 362 -))) 363 -))) 364 - 365 -((( 366 -((( 367 - "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 368 -))) 369 -))) 370 - 371 -((( 372 -((( 373 - "groups": [], ~/~/ Список ролей пользователя 374 -))) 375 -))) 376 - 377 -((( 378 -((( 379 - "customGroups": [], ~/~/ Список клиентских ролей пользователя 380 -))) 381 -))) 382 - 383 -((( 384 -((( 385 - "authDevices": [ ], ~/~/ Список авторизованных устройств 386 -))) 387 -))) 388 - 389 -((( 390 -((( 391 - "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 392 -))) 393 -))) 394 - 395 -((( 396 -((( 397 - "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 398 -))) 399 -))) 400 - 401 -((( 402 -((( 403 -} 404 -))) 405 -))) 406 - 407 - 408 408 (% class="box warningmessage" %) 409 409 ((( 410 410 (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users** ... ... @@ -418,8 +418,6 @@ 418 418 419 419 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 420 420 421 -**При редактировании необходимо передавать все параметры пользователя в теле запроса! Те параметры, значения которых не будут переданы - будут стерты!** 422 - 423 423 (% lang="en-US" style="text-align:left" %) 424 424 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 425 425 ... ... @@ -433,10 +433,10 @@ 433 433 "position": "" , ~/~/ должность 434 434 "phone": "" , ~/~/ телефон 435 435 "organization": "" , ~/~/ организация 436 - "login": "" , ~/~/ логин (%style="color:#000000"%)(Если null - менять не надо)(%%)437 - (%lang="ru-RU"style="color:#000000;font-weight:normal"%)"password": "" , ~/~/ пароль (Если null - менять438 - "email": "" , ~/~/ email (%style="color:#000000"%)(Если null - менять не надо)(%%)439 - (%lang="ru-RU"style="color:#000000;font-weight:normal"%)"description": "" , ~/~/ описание256 + "login": "" , ~/~/ логин 257 + "password": "" , ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) 258 + "email": "" , ~/~/ email 259 + "description": "" , ~/~/ описание 440 440 "isEnabled": "" , ~/~/ признак включения 441 441 "parentId": "" , ~/~/ Guid родительского агента 442 442 "leaderId": "" , ~/~/ Guid руководителя (null - не задан) ... ... @@ -549,7 +549,6 @@ 549 549 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200»**(%%) 550 550 \\(% style="color:#000000" %)__Для двух, описанных выше, методов если не получилось выполнить включение или отключение некоторых пользователей из переданного списка возвращается ответ - 206 Partial Content__ 551 551 552 -((( 553 553 В теле ответа: 554 554 { 555 555 "errorMessages": [ ... ... @@ -562,7 +562,6 @@ 562 562 \\\\"errorMessages" - массив ошибок, из-за которых не выполнилось действие с пользователями. 563 563 "users" - массив id пользователей, которых не удалось включить или отключить. 564 564 565 -))) 566 566 567 567 (% class="box errormessage" %) 568 568 ((( ... ... @@ -611,149 +611,22 @@ 611 611 612 612 (% style="color:#000000" %)Ответ: 613 613 614 -((( 615 -{ 616 -))) 432 +(% style="color:#000000" %){ 617 617 618 -((( 619 - "vehicleId": "", ~/~/ ID объекта 620 -))) 434 + "vehicleId": "" , ~/~/ идентификатор объекта 435 + "name": "" , ~/~/ имя объекта 436 + "imei": "" , ~/~/ IMEI объекта 437 + "deviceTypeId": "" , ~/~/ идентификатор устройства объекта 438 + "deviceTypeName": "" , ~/~/ наименование устройства объекта 439 + "parentId": "" , ~/~/ идентификатор клиента-родителя 440 + "parentName": "" , ~/~/ наименование клиента-родителя, 441 + "modelId": "" , ~/~/ идентификатор модели объекта 442 + "modelName": "" , ~/~/ наименование модели объекта, 443 + "unitId": "" , ~/~/ идентификатор подразделения 444 + "unitName": "" , ~/~/ наименование подразделения 445 + "status": "" , ~/~/ статус объекта 621 621 622 -((( 623 - "name": "", ~/~/ Имя объекта 624 -))) 625 - 626 -((( 627 - "imei": "", ~/~/ IMEI объекта 628 -))) 629 - 630 -((( 631 - "deviceTypeId": , ~/~/ ID типа устройства 632 -))) 633 - 634 -((( 635 - "deviceTypeName": "", ~/~/ Название типа устройства 636 -))) 637 - 638 -((( 639 - "sim1": "", ~/~/ Номер SIM1 640 -))) 641 - 642 -((( 643 - "parentId": "", Номер SIM2 644 -))) 645 - 646 -((( 647 - "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя 648 -))) 649 - 650 -((( 651 - "modelId": "", ID модели объекта 652 -))) 653 - 654 -((( 655 - "modelName": "", Имя модели объекта 656 -))) 657 - 658 -((( 659 - "createdAt": "", Дата создания объекта 660 -))) 661 - 662 -((( 663 - "mileageCalcMethod": "", Выбранный метод расчета пробега 664 -))) 665 - 666 -((( 667 - "counters": { ~/~/ Нормы 668 -))) 669 - 670 -((( 671 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 672 -))) 673 - 674 -((( 675 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 676 -))) 677 - 678 -((( 679 - "mileage": "", ~/~/ Пробег по нормам в метрах 680 -))) 681 - 682 -((( 683 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 684 -))) 685 - 686 -((( 687 - }, 688 -))) 689 - 690 -((( 691 - "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 692 -))) 693 - 694 -((( 695 - { 696 -))) 697 - 698 -((( 699 - "id": "", ~/~/ ID задания 700 -))) 701 - 702 -((( 703 - "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 704 -))) 705 - 706 -((( 707 - "name": "", ~/~/ Наименование задания 708 -))) 709 - 710 -((( 711 - "description": "", ~/~/ Описание задания 712 -))) 713 - 714 -((( 715 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 716 -))) 717 - 718 -((( 719 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 720 -))) 721 - 722 -((( 723 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 724 -))) 725 - 726 -((( 727 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 728 -))) 729 - 730 -((( 731 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 732 -))) 733 - 734 -((( 735 - "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 736 -))) 737 - 738 -((( 739 - "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 740 -))) 741 - 742 -((( 743 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 744 -))) 745 - 746 -((( 747 - } 748 -))) 749 - 750 -((( 751 - ] 752 -))) 753 - 754 -((( 755 755 } 756 -))) 757 757 758 758 (% style="text-align:left" %) 759 759 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: