Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/03/12 10:28
- Manage
-
Copy
- Actions
-
Export
-
Print Preview
- Viewers
-
Source
-
Children
-
Content
-
Attachments (1)
-
History
-
Information
-
Likes
Change comment:
There is no comment for this version
Summary
Details
-
Page properties
-
- Content
-
... ... @@ -454,46 +454,43 @@ 454 454 455 455 (% style="color:#000000" %){ 456 456 457 -(% class="western" %) 458 -{{{ "vehicleId": "", //ID ТС 459 - "parentId": "", //Guid владельца ТС 460 - "name": "", //Имя объекта 461 - "imei": "", //IMEI 462 - "deviceTypeId": "", //ID типа устройства 463 - "modelId": "", //ID модели 464 - "unitId": "", //ID подразделения 465 - "sim1": "", //SIM1 466 - "sim2": "", //SIM2 467 - "consumptionPer100Km": "", //Расход топлива на 100 км 468 - "consumptionIdle": "", //Расход топлива на холостом ходу 469 - "counters": { //Счётчики 470 - "mileageEnabled": true, 471 - "motohoursEnabled": true, 472 - "mileage": "", 473 - "motohours": 345.0 457 + "vehicleId": "", ~/~/ID ТС 458 + "parentId": "", ~/~/Guid владельца ТС 459 + "name": "", ~/~/Имя объекта 460 + "imei": "", ~/~/IMEI 461 + "deviceTypeId": "", ~/~/ID типа устройства 462 + "modelId": "", ~/~/ID модели 463 + "unitId": "", ~/~/ID подразделения 464 + "sim1": "", ~/~/SIM1 465 + "sim2": "", ~/~/SIM2 466 + "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 467 + "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 468 + "counters": { ~/~/Счётчики 469 + "mileageEnabled": true, 470 + "motohoursEnabled": true, 471 + "mileage": "", 472 + "motohours": 345.0 474 474 }, 475 - 476 - 477 - 478 - 479 - 480 - 474 + "cmsv6Parameters": { ~/~/Параметры CmsV6 475 + "id": null, 476 + "enabled": true, ~/~/флаг включения 477 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 478 + "login": "", ~/~/ имя учетной записи 479 + "password": "" ~/~/ пароль учетной записи 481 481 }, 482 - "inspectionTasks": [ // задания на ТО 483 - { 484 - "id": "", // ID задачи 485 - "enabled": false, // Признак включения 486 - "name": "", // Имя задания 487 - "description": "", // Описание задания 488 - "mileageCondition": "", // Условие по пробегу 489 - "lastMileage": "", // Пробег (в метрах) 490 - "motohoursCondition": "", // Условие по моточасам 491 - "lastMotohours": "", // Моточасы 492 - "periodicCondition": "", // Условие периодичности по времени 493 - "kind": "", // Вид периодичности по времени 494 - "maxQuantity": "" // Сколько раз выполнить задание (null - однократно) 495 - } 496 - ]}}} 481 + "inspectionTasks": { ~/~/ задания на ТО 482 + "id": "", ~/~/ ID задачи 483 + "enabled": false, ~/~/ Признак включения 484 + "name": "", ~/~/ Имя задания 485 + "description": "", ~/~/ Описание задания 486 + "mileageCondition": "", ~/~/ Условие по пробегу 487 + "lastMileage": "", ~/~/ Пробег (в метрах) 488 + "motohoursCondition": "", ~/~/ Условие по моточасам 489 + "lastMotohours": "", ~/~/ Моточасы 490 + "periodicCondition": "", ~/~/ Условие периодичности по времени 491 + "kind": "", ~/~/ Вид периодичности по времени 492 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 493 + } 497 497 498 498 (% style="text-align:left" %) 499 499 (% style="color:#000000" %)} ... ... @@ -512,11 +512,11 @@ 512 512 513 513 (% style="color:#000000" %)− возвращает информацию об объектах с учетом заданных настроек видимости объектов; 514 514 515 -(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав «Видимость объектов заблокированных договоров в панели управления» или «Видимость объектов заблокированных договоров в мониторинге»; 512 +(% style="color:#000000" %)− информация предоставляется с учетом наличия прав на просмотр объектов заблокированных договоров (объекты, принадлежащие заблокированному договору возвращаются при наличии любого из прав **«__Видимость объектов заблокированных договоров в панели управления__»** или **«__Видимость объектов заблокированных договоров в мониторинге__»**; 516 516 517 -(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права «Просмотр номеров телефонов объектов»; 514 +(% style="color:#000000" %)− информация о телефонах SIM1/SIM2 предоставляется при наличии права **«__Просмотр номеров телефонов объектов__»**; 518 518 519 -(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права «Просмотр статуса объекта». 516 +(% style="color:#000000" %)− информация о статусе объекта предоставляется при наличии права **«__Просмотр статуса объекта__»**. 520 520 521 521 (% style="color:#000000" %)Метод запроса: **POST** 522 522 ... ... @@ -530,19 +530,41 @@ 530 530 531 531 (% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): 532 532 533 -(% class="western" style="color:#000000" %)##{ "vehicleId": null,~/~/84350, ~/~/ ID ТС (int, опционально) "name": null, ~/~/ Имя ТС (string, опционально) "imei": null,~/~/"710179307",##530 +(% class="western" style="color:#000000" %)##{## 534 534 535 -(% class="western" style="color:#000000" %)##~/~/ IMEI (string, опционально) "sim": null, ~/~/"938112", ~/~/ Номер телефона (string, опционально) "deviceTypeId": null,~/~/5## 532 +(% class="western" style="color:#000000" %)## "vehicleId": null, ~/~/ 84350, ID ТС (int, опционально) 533 + "name": null, ~/~/ Имя ТС (string, опционально) 534 + "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 535 + "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 536 + "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 537 + "parentId": null, ~/~/ ID клиента (Guid, опционально) 538 + "unitId": null ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально)##(%%) 539 +(% style="color:#000000" %)} 536 536 537 -(% class="western" style="color:#000000" %)##~/~/IDтипа устройства(short,опционально)"parentId":null,~/~/IDклиента(Guid,опционально)"unitId":null##541 +(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. 538 538 539 -(% class="western" style="color:#000000" %)##~/~/"b33548c3-73c3-40e4-8b78-81470ae744ed" ~/~/ ID подразделения (Guid, опционально)##(% style="color:#000000" %)}543 +(% style="color:#000000" %)Ответ: 540 540 541 -(% style="color:#000000" %) Фильтрация осуществляется по точному совпадению значений параметров «vehicleId», «deviceTypeId», «parentId», «unitId», и по частичному - «name», «imei», «sim». Фильтрация по значению параметра «sim» осуществляется при наличии у авторизованного пользователя права «Просмотр номеров телефонов объектов».545 +(% style="color:#000000" %){ 542 542 543 -(% style="color:#000000" %)Ответ: [ { «vehicleId»: «», //идентификатор объекта «name»: «», // наименование объекта «imei»: «», // IMEI объекта «deviceTypeId»: «», // идентификатор типа устройства «deviceTypeName»: «», // наименование типа устройства «sim1»: «», // первый номер телефона «sim2»: «», //второй номер телефона «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «modelId»: «», //идентификатор модели объекта «modelName»: «», //наименование модели объекта «unitId»: «», //идентификатор подразделения «unitName»: «», //наименование подразделения «status»: «», // статус объекта //«//createdAt//»: «» дата создания объектов //}, … ] 547 +(% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 548 + "name": "" ~/~/ наименование объекта 549 + "imei": "" ~/~/ IMEI объекта 550 + "deviceTypeId": "" ~/~/ идентификатор типа устройства 551 + "deviceTypeName": "" ~/~/ наименование типа устройства 552 + "sim1": "" ~/~/ первый номер телефона 553 + "sim2": "" ~/~/ второй номер телефона 554 + "parentId": "" ~/~/ идентификатор клиента-родителя 555 + "parentName": "" ~/~/ наименование клиента-родителя 556 + "modelId": "" ~/~/ идентификатор модели объекта 557 + "modelName": "" ~/~/ наименование модели объекта 558 + "unitId": "" ~/~/ идентификатор подразделения 559 + "unitName": "" ~/~/ наименование подразделения 560 + "status": "" ~/~/ статус объекта 561 + "createdAt": "" ~/~/ дата создания объектов (%%) 562 +(% style="color:#000000" %)} 544 544 545 -(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«Просмотр номеров телефонов объектов»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«Просмотр статуса объекта»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 564 +(% style="color:#000000" %) Параметры «sim1» и «sim2» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «status» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 546 546 547 547 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 548 548 ... ... @@ -562,30 +562,32 @@ 562 562 563 563 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 564 564 565 -(% style="color:#000000" %)Параметры в теле запроса (JSON): {584 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 566 566 567 -(% class="western" %) 568 -{{{ "status": "", // значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 569 - // 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 570 - // 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 571 - "date": "", // Дата смены статуса (null если сменить немедленно) 572 - "description": "", // Описание 573 - "data": "", // Данные 574 - "overwrite": false, // Флаг перезаписи 575 - "stage": "", // Состояние, может быть null}}} 586 +(% style="color:#000000" %){ 576 576 577 -(% style="color:#000000" %)} 588 + "status": "", ~/~/ значение статуса (-1 - Новый, 0 - Блокировка, 1 - Активен, 2 - Отменен, 3 - Оборудован, 4 - Диагностика, 589 + ~/~/ 5 - Сервис, 6 - Демонтаж, 7 - Монтаж, 8 - Дозаказ, 9 - Обслужен, 10 - Списан, 590 + ~/~/ 11 - Неисправен, 12 - Проверен, 13 - Не эксплуатируется) 591 + "date": "", ~/~/ Дата смены статуса (null если сменить немедленно) 592 + "description": "", ~/~/ Описание 593 + "data": "", ~/~/ Данные 594 + "overwrite": false, ~/~/ Флаг перезаписи 595 + "stage": "", ~/~/ Состояние, может быть null 578 578 579 -(% style="color:#000000" %) Ответ: {597 + (% style="color:#000000" %)} 580 580 581 -(% class="western" %) 582 -{{{ "status": "", // значение статуса 583 - "date": "", // Дата смены статуса 584 - "description": "", // Описание 585 - "data": "", // Данные 586 - "overwrite": false, // Флаг перезаписи 587 - "stage": "", // Состояние}}} 599 +(% style="color:#000000" %)Ответ: 588 588 601 +(% style="color:#000000" %){ 602 + 603 + "status": "", ~/~/ значение статуса 604 + "date": "", ~/~/ Дата смены статуса 605 + "description": "", ~/~/ Описание 606 + "data": "", ~/~/ Данные 607 + "overwrite": false, ~/~/ Флаг перезаписи 608 + "stage": "", ~/~/ Состояние 609 + 589 589 (% style="text-align:left" %) 590 590 (% style="color:#000000" %)} 591 591 ... ... @@ -605,8 +605,51 @@ 605 605 606 606 (% style="color:#000000" %)Параметры в теле запроса (JSON): 607 607 608 -(% style="color:#000000" %) //Обязательныепараметры наименование и модель объекта //В теле запроса - объект JSON{«vehicleId»: «», //ID ТС «parentId»: «», //ID клиента «name»: «», //имя ТС «imei»: «», //IMEI «deviceTypeId»: «», //ID типа устройства «modelId»: «», «unitId»: «», //ID подразделения «sim1»: «», //SIM 1 «sim2»: «», //SIM2 «consumptionPer100Km»: «», //Расход топлива на 100 км «consumptionIdle»: «», //Расход топлива на холостом ходу «counters»: { «mileageEnabled»: true, //флаг активности счётчика «пробег» «motohoursEnabled»: true, //флаг активности счётчика «моточасы» «mileage»: «», //пробег «motohours»: «» //моточасы }, «cmsv6Parameters»: { //параметры CMSv6 «id»: «», //идентификатор «enabled»: true, //флаг включения «host»: «», //IP-адрес или доменное имя из URL веб-сайта CMSV6 «login»: «», //имя учетной записи «password»: «» //пароль учетной записи }, «inspectionTasks»: [ //задания на ТО { «id»: «», //ID задания «enabled»: false, //Признак включения «name»: «», //Имя задания «description»: «», //Описание задания «mileageCondition»: «», //Условие по пробегу (в метрах, null - условие не работает) «lastMileage»: «», //Пробег (в метрах) на момент последнего ТО (null - неважно) «motohoursCondition»: «», //Условие по моточасам (в секундах, null - условие не работает) «lastMotohours»: «», //Моточасы (в секундах) на момент последнего ТО (null - неважно) «periodicCondition»: «», //Условие периодичности по времени (null - условие не работает) «kind»: «», //Вид периодичности по времени «maxQuantity»: «» //Сколько раз выполнить задание } ] }629 +(% style="color:#000000" %) { 609 609 631 +(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 632 + "parentId": "", ~/~/ ID клиента 633 + "name": "", ~/~/ имя ТС 634 + "imei": "", ~/~/ IMEI 635 + "deviceTypeId": "", ~/~/ ID типа устройства 636 + "modelId": "", ~/~/ , ID модели 637 + "unitId": "", ~/~/ подразделения 638 + "sim1": "", ~/~/ SIM 1 639 + "sim2": "", ~/~/ SIM2 640 + "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 641 + "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 642 + "counters": 643 + { 644 + "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 645 + "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 646 + "mileage": «», пробег 647 + "motohours": «» моточасы 648 + } 649 + "cmsv6Parameters": ~/~/ параметры CMSv6 650 + { 651 + "id": "", ~/~/ идентификатор 652 + "enabled": true, ~/~/ флаг включения 653 + "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 654 + "login": "", ~/~/ имя учетной записи 655 + "password": "", ~/~/ пароль учетной записи 656 + } 657 + "inspectionTasks": ~/~/ задания на ТО 658 + { 659 + "id": "", ~/~/ ID задания 660 + "enabled": false, ~/~/ Признак включения 661 + "name": "", ~/~/ Имя задания 662 + "description": "", ~/~/ Описание задания 663 + "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 664 + "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 665 + "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 666 + "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 667 + "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 668 + "kind": "", ~/~/ Вид периодичности по времени 669 + "maxQuantity": "", ~/~/ Сколько раз выполнить задание 670 + } 671 + 672 +(% style="color:#000000" %)} 673 + 610 610 (% style="color:#000000" %)Ответ: 611 611 612 612 (% lang="en-US" style="text-align:left" %)