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
-
... ... @@ -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" %)**Действующие ограничения** ... ... @@ -237,44 +237,172 @@ 237 237 (% style="color:#000000; line-height:100%" %)**Получение информации о пользователе — **(% lang="en-US" %)**GET /api/v3/users/{GUID}** 238 238 ))) 239 239 240 -(% style="color:#000000" %) епредоставляется при наличии права **«__Просмотр пользователей__»**.235 +(% style="color:#000000" %)Метод возвращает подробную информацию о пользователе клиента-родителя авторизованного пользователя или пользователя его дочерних клиентов. Информация о пользователях предоставляется при наличии права **«__Просмотр пользователей__»**. 241 241 242 242 (% style="color:#000000" %)Метод запроса: **GET** 243 243 244 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 245 246 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 247 - 248 248 (% style="color:#000000" %)Ответ: 249 249 250 250 ((( 251 251 ((( 252 252 { 246 +))) 247 +))) 248 + 249 +((( 250 +((( 253 253 "id": "", ~/~/ GUID пользователя 254 - "lastName": "", ~/~/ Фамилия 252 +))) 253 +))) 254 + 255 +((( 256 +((( 257 + "lastName": "", ~/~/ Фамилия 258 +))) 259 +))) 260 + 261 +((( 262 +((( 255 255 "firstName": "", ~/~/ Имя 264 +))) 265 +))) 266 + 267 +((( 268 +((( 256 256 "position": "", ~/~/ Должность 270 +))) 271 +))) 272 + 273 +((( 274 +((( 257 257 "phone": "", ~/~/ Номер телефона 276 +))) 277 +))) 278 + 279 +((( 280 +((( 258 258 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 282 +))) 283 +))) 284 + 285 +((( 286 +((( 259 259 "parentName": "", Наименование клиента, которому принадлежит пользователь 288 +))) 289 +))) 290 + 291 +((( 292 +((( 260 260 "organization": "", ~/~/ Организация 294 +))) 295 +))) 296 + 297 +((( 298 +((( 261 261 "login": "", ~/~/ Логин пользователя 300 +))) 301 +))) 302 + 303 +((( 304 +((( 262 262 "email": "", ~/~/ Адрес электронной почты 306 +))) 307 +))) 308 + 309 +((( 310 +((( 263 263 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 312 +))) 313 +))) 314 + 315 +((( 316 +((( 264 264 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 318 +))) 319 +))) 320 + 321 +((( 322 +((( 265 265 "description": "", ~/~/ Описание 324 +))) 325 +))) 326 + 327 +((( 328 +((( 266 266 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 330 +))) 331 +))) 332 + 333 +((( 334 +((( 267 267 "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 336 +))) 337 +))) 338 + 339 +((( 340 +((( 268 268 "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 342 +))) 343 +))) 344 + 345 +((( 346 +((( 269 269 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 348 +))) 349 +))) 350 + 351 +((( 352 +((( 270 270 "sessionDuration": 30, ~/~/ Длительность сессии в минутах 354 +))) 355 +))) 356 + 357 +((( 358 +((( 271 271 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 360 +))) 361 +))) 362 + 363 +((( 364 +((( 272 272 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 366 +))) 367 +))) 368 + 369 +((( 370 +((( 273 273 "groups": [], ~/~/ Список ролей пользователя 372 +))) 373 +))) 374 + 375 +((( 376 +((( 274 274 "customGroups": [], ~/~/ Список клиентских ролей пользователя 378 +))) 379 +))) 380 + 381 +((( 382 +((( 275 275 "authDevices": [ ], ~/~/ Список авторизованных устройств 384 +))) 385 +))) 386 + 387 +((( 388 +((( 276 276 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 390 +))) 391 +))) 392 + 393 +((( 394 +((( 277 277 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 396 +))) 397 +))) 398 + 399 +((( 400 +((( 278 278 } 279 279 ))) 280 280 ))) ... ... @@ -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 ... ... @@ -488,40 +488,145 @@ 488 488 489 489 ((( 490 490 { 612 +))) 613 + 614 +((( 491 491 "vehicleId": "", ~/~/ ID объекта 616 +))) 617 + 618 +((( 492 492 "name": "", ~/~/ Имя объекта 620 +))) 621 + 622 +((( 493 493 "imei": "", ~/~/ IMEI объекта 624 +))) 625 + 626 +((( 494 494 "deviceTypeId": , ~/~/ ID типа устройства 628 +))) 629 + 630 +((( 495 495 "deviceTypeName": "", ~/~/ Название типа устройства 632 +))) 633 + 634 +((( 496 496 "sim1": "", ~/~/ Номер SIM1 636 +))) 637 + 638 +((( 497 497 "parentId": "", Номер SIM2 498 - "parentName": "", Наименование клиента-родителя 640 +))) 641 + 642 +((( 643 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя 644 +))) 645 + 646 +((( 499 499 "modelId": "", ID модели объекта 648 +))) 649 + 650 +((( 500 500 "modelName": "", Имя модели объекта 652 +))) 653 + 654 +((( 501 501 "createdAt": "", Дата создания объекта 656 +))) 657 + 658 +((( 502 502 "mileageCalcMethod": "", Выбранный метод расчета пробега 660 +))) 661 + 662 +((( 503 503 "counters": { ~/~/ Нормы 664 +))) 665 + 666 +((( 504 504 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 668 +))) 669 + 670 +((( 505 505 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 672 +))) 673 + 674 +((( 506 506 "mileage": "", ~/~/ Пробег по нормам в метрах 676 +))) 677 + 678 +((( 507 507 "motohours": "" ~/~/ Моточасы по нормам, в секундах 680 +))) 681 + 682 +((( 508 508 }, 684 +))) 685 + 686 +((( 509 509 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 688 +))) 689 + 690 +((( 510 510 { 511 - "id": "", ~/~/ ID задания 692 +))) 693 + 694 +((( 695 + "id": "", ~/~/ ID задания 696 +))) 697 + 698 +((( 512 512 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 700 +))) 701 + 702 +((( 513 513 "name": "", ~/~/ Наименование задания 704 +))) 705 + 706 +((( 514 514 "description": "", ~/~/ Описание задания 708 +))) 709 + 710 +((( 515 515 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 712 +))) 713 + 714 +((( 516 516 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 716 +))) 717 + 718 +((( 517 517 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 720 +))) 721 + 722 +((( 518 518 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 724 +))) 725 + 726 +((( 519 519 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 728 +))) 729 + 730 +((( 520 520 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 732 +))) 733 + 734 +((( 521 521 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 736 +))) 737 + 738 +((( 522 522 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 740 +))) 741 + 742 +((( 523 523 } 744 +))) 745 + 746 +((( 524 524 ] 748 +))) 749 + 750 +((( 525 525 } 526 526 ))) 527 527 ... ... @@ -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 -} 913 +(% class="western" style="color:#000000" %)##{## 697 697 915 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 916 + "name": null, ~/~/ Имя ТС (string, опционально) 917 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 918 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 919 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 920 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 921 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%) 922 +(% style="color:#000000" %)} 923 + 698 698 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 699 699 700 700 (% style="color:#000000" %)Ответ: