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,47 +237,121 @@ 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 -((( 252 252 { 245 +))) 246 + 247 +((( 253 253 "id": "", ~/~/ GUID пользователя 254 - "lastName": "", ~/~/ Фамилия 249 +))) 250 + 251 +((( 252 + "lastName": "", ~/~/ Фамилия 253 +))) 254 + 255 +((( 255 255 "firstName": "", ~/~/ Имя 257 +))) 258 + 259 +((( 256 256 "position": "", ~/~/ Должность 261 +))) 262 + 263 +((( 257 257 "phone": "", ~/~/ Номер телефона 265 +))) 266 + 267 +((( 258 258 "parentId": "", ~/~/ GUID клиента, которому принадлежит пользователь 269 +))) 270 + 271 +((( 259 259 "parentName": "", Наименование клиента, которому принадлежит пользователь 273 +))) 274 + 275 +((( 260 260 "organization": "", ~/~/ Организация 277 +))) 278 + 279 +((( 261 261 "login": "", ~/~/ Логин пользователя 281 +))) 282 + 283 +((( 262 262 "email": "", ~/~/ Адрес электронной почты 285 +))) 286 + 287 +((( 263 263 "language": , ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 289 +))) 290 + 291 +((( 264 264 "isReadOnly": , ~/~/ Право только на чтение, true - включено, false - отключено 293 +))) 294 + 295 +((( 265 265 "description": "", ~/~/ Описание 297 +))) 298 + 299 +((( 266 266 "isEnabled": , ~/~/ Включен, true - включен, false - отключен 301 +))) 302 + 303 +((( 267 267 "doubleAuth": , ~/~/ Состояние двухэтапной аутентификации, true - включен, false - отключен 305 +))) 306 + 307 +((( 268 268 "doubleAuthEmail": "", ~/~/ Адрес электронной почты двухэтапной аутентификации 309 +))) 310 + 311 +((( 269 269 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 313 +))) 314 + 315 +((( 270 270 "sessionDuration": 30, ~/~/ Длительность сессии в минутах 317 +))) 318 + 319 +((( 271 271 "status": 0, ~/~/ Статус пользователя, 0 - новый, 1 - подтвержден, 2 - активен, 3 - уточнить, 4 - блокирован 321 +))) 322 + 323 +((( 272 272 "lastLogged": "2022-08-22T06:57:51.002129Z", ~/~/ Дата и время последнего входа пользователя 325 +))) 326 + 327 +((( 273 273 "groups": [], ~/~/ Список ролей пользователя 329 +))) 330 + 331 +((( 274 274 "customGroups": [], ~/~/ Список клиентских ролей пользователя 333 +))) 334 + 335 +((( 275 275 "authDevices": [ ], ~/~/ Список авторизованных устройств 337 +))) 338 + 339 +((( 276 276 "mobileDoubleAuthDevices": [], ~/~/ Список авторизованных мобильных устройств 341 +))) 342 + 343 +((( 277 277 "pushNotificationsDevices": [] ~/~/ Список мобильных устройств которые были подписаны на мобильные уведомления 345 +))) 346 + 347 +((( 278 278 } 279 279 ))) 280 -))) 281 281 282 282 283 283 (% class="box warningmessage" %) ... ... @@ -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 { 558 +))) 559 + 560 +((( 491 491 "vehicleId": "", ~/~/ ID объекта 562 +))) 563 + 564 +((( 492 492 "name": "", ~/~/ Имя объекта 566 +))) 567 + 568 +((( 493 493 "imei": "", ~/~/ IMEI объекта 570 +))) 571 + 572 +((( 494 494 "deviceTypeId": , ~/~/ ID типа устройства 574 +))) 575 + 576 +((( 495 495 "deviceTypeName": "", ~/~/ Название типа устройства 578 +))) 579 + 580 +((( 496 496 "sim1": "", ~/~/ Номер SIM1 582 +))) 583 + 584 +((( 497 497 "parentId": "", Номер SIM2 498 - "parentName": "", Наименование клиента-родителя 586 +))) 587 + 588 +((( 589 + "parentName": "", (% style="color:#000000" %)Наименование клиента-родителя 590 +))) 591 + 592 +((( 499 499 "modelId": "", ID модели объекта 594 +))) 595 + 596 +((( 500 500 "modelName": "", Имя модели объекта 598 +))) 599 + 600 +((( 501 501 "createdAt": "", Дата создания объекта 602 +))) 603 + 604 +((( 502 502 "mileageCalcMethod": "", Выбранный метод расчета пробега 606 +))) 607 + 608 +((( 503 503 "counters": { ~/~/ Нормы 610 +))) 611 + 612 +((( 504 504 "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 614 +))) 615 + 616 +((( 505 505 "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 618 +))) 619 + 620 +((( 506 506 "mileage": "", ~/~/ Пробег по нормам в метрах 622 +))) 623 + 624 +((( 507 507 "motohours": "" ~/~/ Моточасы по нормам, в секундах 626 +))) 627 + 628 +((( 508 508 }, 630 +))) 631 + 632 +((( 509 509 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 634 +))) 635 + 636 +((( 510 510 { 511 - "id": "", ~/~/ ID задания 638 +))) 639 + 640 +((( 641 + "id": "", ~/~/ ID задания 642 +))) 643 + 644 +((( 512 512 "enabled": "", ~/~/ Флаг активности задания (true - включен, false - отключен) 646 +))) 647 + 648 +((( 513 513 "name": "", ~/~/ Наименование задания 650 +))) 651 + 652 +((( 514 514 "description": "", ~/~/ Описание задания 654 +))) 655 + 656 +((( 515 515 "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 658 +))) 659 + 660 +((( 516 516 "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 662 +))) 663 + 664 +((( 517 517 "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 666 +))) 667 + 668 +((( 518 518 "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 670 +))) 671 + 672 +((( 519 519 "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 674 +))) 675 + 676 +((( 520 520 "kind": "", ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 678 +))) 679 + 680 +((( 521 521 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 682 +))) 683 + 684 +((( 522 522 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 686 +))) 687 + 688 +((( 523 523 } 690 +))) 691 + 692 +((( 524 524 ] 694 +))) 695 + 696 +((( 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 -} 859 +(% class="western" style="color:#000000" %)##{## 697 697 861 +(% class="western" style="color:#000000" %) "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 862 + "name": null, ~/~/ Имя ТС (string, опционально) 863 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 864 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 865 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 866 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 867 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)(%%) 868 +(% style="color:#000000" %)} 869 + 698 698 (% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 699 699 700 700 (% style="color:#000000" %)Ответ: