Last modified by Андрей Калиновский on 2025/02/20 09:52
<
From version < 85.1 >
edited by Илья Крайнов
on 2023/03/29 18:03
To version < 91.1 >
edited by Илья Крайнов
on 2023/05/22 15:34
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -436,7 +436,7 @@
436 436   "email": "" , ~/~/ E-mail
437 437   "sessionDuration":"", ~/~/ длительность сессии в минутах
438 438   "status": "1",  ~/~/ статус пользователя
439 - "astLogged": "", ~/~/ дата/время последней авторизации
439 + "lastLogged": "", ~/~/ дата/время последней авторизации
440 440  
441 441  (% style="color:#000000" %)}
442 442  
... ... @@ -701,9 +701,9 @@
701 701  
702 702  (% style="color:#000000" %)Метод запроса: **GET**
703 703  
704 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %)<(% lang="en-US" %)v(%%)ehicleID>
704 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID}
705 705  
706 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__> - идентификатор объекта (опционально)
706 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32))
707 707  
708 708  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
709 709  
... ... @@ -717,20 +717,124 @@
717 717   "deviceTypeId": , ~/~/ ID типа устройства
718 718   "deviceTypeName": "", ~/~/ Название типа устройства
719 719   "sim1": "", ~/~/ Номер SIM1
720 - "parentId": "", Номер SIM2
721 - "parentName": "", Наименование клиента-родителя
722 - "modelId": "", ID модели объекта
723 - "modelName": "", Имя модели объекта
724 - "createdAt": "", Дата создания объекта
725 - "mileageCalcMethod": "", Выбранный метод расчета пробега
726 - "counters": { ~/~/ Нормы
727 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен)
728 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен)
729 - "mileage": "", ~/~/ Пробег по нормам в метрах
730 - "motohours": "" ~/~/ Моточасы по нормам, в секундах
731 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега
732 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов
720 + "sim2": "", ~/~/ Номер SIM2
721 +
722 + "parentId": "", ~/~/ ID клиента-родителя
723 + "parentName": "", ~/~/ Наименование клиента-родителя
724 + "modelId": "", ~/~/ ID модели объекта
725 + "modelName": "", ~/~/ Имя модели объекта
726 +
727 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения
728 + "unitName": "string", ~/~/ Наименование подразделения
729 + "status": 0, ~/~/ Статус объекта
730 +
731 + "createdAt": "", ~/~/ Дата создания объекта
733 733   },
733 +
734 +"customFields": [ ~/~/ Произвольные поля
735 + {
736 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля
737 + "name": "string", ~/~/ Имя поля
738 + "value": "string", ~/~/ Значение поля
739 + "forClient": true, ~/~/ Не используемая функция
740 + "forTooltip": true, ~/~/ Отображать в подсказке
741 + "forReport": true ~/~/ Отображать в отчете
742 + }
743 +
744 +], ~/~/ Данные с вкладки нормы
745 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено)
746 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено)
747 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу
748 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 
749 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас
750 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 
751 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км
752 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км
753 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас
754 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на  моточас
755 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
756 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 
757 +
758 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания
759 + "mileageCoeff": 0, ~/~/ коэффициент пробега
760 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна
761 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна
762 + "counters": { ~/~/ Счетчики
763 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна
764 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна
765 + "mileage": 0, ~/~/ Текущий пробег
766 + "motohours": 0, ~/~/ Текущие моточасы
767 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега
768 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов
769 + },
770 +
771 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга
772 + "id": "string", ~/~/ ID объекта
773 + "enabled": true, ~/~/ Включить, true - активна, false - не активна
774 + "host": "string", ~/~/ CMSV6 Web Host
775 + "login": "string", ~/~/ CMSV6 Account
776 + "password": "string" ~/~/ CMSV6 Password
777 + },
778 +
779 +"commandTemplates": [ ~/~/ Шаблоны команд
780 + {
781 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды
782 + "name": "string", ~/~/ Наименование команды
783 + "command": "string", ~/~/ Текст команды
784 + "retries": 0 ~/~/ Количество попыток
785 + }
786 + ],
787 +
788 + "sensors": [ ~/~/ Датчики
789 + {
790 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика
791 + "kind": 0, ~/~/ Тип, 0 - простой, 1 - виртуальный
792 + "type": 0, ~/~/ Тип датчика
793 + "name": "string", ~/~/ Имя датчика
794 + "inputType": 0, ~/~/ Тип входа
795 + "inputNumber": 0, ~/~/ Номер входа
796 + "pseudonym": "string", ~/~/ Псевдоним
797 + "medianDegree": 0, ~/~/ Медианная фильтрация
798 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл.
799 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл.
800 + "gradeType": 0, ~/~/ Тип тарировки
801 + "gradesTables": [ ~/~/ Тип тарировки Таблица
802 + {
803 + "grades": [ ~/~/ Тарировка
804 + {
805 + "input": 0, ~/~/ Входящее значение
806 + "output": 0 ~/~/ Выходящее значение
807 + }
808 + ],
809 + "relevanceTime": "2023-05-22T09:57:39.562Z"
810 + }
811 + ],
812 + "showInTooltip": true, ~/~/ Отображать в подсказке
813 + "showLastValid": true, ~/~/ Отображать последнее валидное значение
814 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива
815 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания
816 + "agrFunction": 0,
817 + "expr": "string",
818 + "children": [
819 + "string"
820 + ],
821 + "customParams": {
822 + "additionalProp1": "string",
823 + "additionalProp2": "string",
824 + "additionalProp3": "string"
825 + },
826 + "summaryMaxValue": 0
827 + }
828 +
829 + "drivers": [ ~/~/ Водители
830 + {
831 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
832 + "name": "string",
833 + "description": "string",
834 + "isDefault": true
835 + }
836 + ],
837 +
734 734   "inspectionTasks": [ ~/~/ Задания на тех. обслуживание
735 735   {
736 736   "id": "", ~/~/ ID  задания
... ... @@ -746,7 +746,17 @@
746 746   "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано)
747 747   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
748 748   }
749 - ]
853 + ],
854 +
855 + "statusHistory": [ ~/~/ История статусов
856 + {
857 + "status": 0,
858 + "date": "2023-05-22T09:57:39.562Z",
859 + "description": "string",
860 + "additionalInfo": "string"
861 + }
862 + ]
863 +
750 750  }
751 751  )))
752 752  
... ... @@ -763,7 +763,7 @@
763 763  (% lang="en-US" %)**POST /api/v3/vehicles**
764 764  )))
765 765  
766 -(% style="color:#000000" %)Метод позволяет добавить объект. Метод позволяет добавить объект, указанный в запросе.
880 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе.
767 767  
768 768  (% style="color:#000000" %)Метод запроса: **POST**
769 769  
... ... @@ -795,6 +795,11 @@
795 795   "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас
796 796   "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х
797 797   "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х
912 +
913 + "mileageCalcMethod": 0,
914 + "mileageCoeff": 0,
915 + "locationByCellId": true,
916 + "dottedLineTrackWhenNoCoords": true,
798 798   "counters": ~/~/ счетчики
799 799   {
800 800   "mileage": "" , ~/~/ пробег
... ... @@ -824,7 +824,72 @@
824 824   "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно)
825 825   }
826 826  
827 -(% style="color:#000000" %) }
946 +"drivers": [ ~/~/ Водители
947 + {
948 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
949 + "isDefault": true
950 + }
951 + ],
952 + "commandTemplates": [ ~/~/ Шаблон команды
953 + {
954 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
955 + "name": "string",
956 + "command": "string",
957 + "retries": 0
958 + }
959 + ],
960 + "sensors": [ ~/~/ Датчики
961 + {
962 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
963 + "kind": 0,
964 + "type": 0,
965 + "name": "string",
966 + "inputType": 0,
967 + "inputNumber": 0,
968 + "pseudonym": "string",
969 + "medianDegree": 0,
970 + "isInverted": true,
971 + "disabled": true,
972 + "gradeType": 0,
973 + "gradesTables": [
974 + {
975 + "grades": [
976 + {
977 + "input": 0,
978 + "output": 0
979 + }
980 + ],
981 + "relevanceTime": "2023-05-22T12:19:59.728Z"
982 + }
983 + ],
984 + "showInTooltip": true,
985 + "showLastValid": true,
986 + "showAsDutOnGraph": true,
987 + "showWithoutIgn": true,
988 + "agrFunction": 0,
989 + "expr": "string",
990 + "children": [
991 + "string"
992 + ],
993 + "customParams": {
994 + "additionalProp1": "string",
995 + "additionalProp2": "string",
996 + "additionalProp3": "string"
997 + },
998 + "summaryMaxValue": 0
999 + }
1000 + ],
1001 + "customFields": [ ~/~/ Произвольные поля
1002 + {
1003 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
1004 + "name": "string",
1005 + "value": "string",
1006 + "forClient": true,
1007 + "forTooltip": true,
1008 + "forReport": true
1009 + }
1010 + ]
1011 +}
828 828  
829 829  (% style="color:#000000" %)Ответ:
830 830  
... ... @@ -1011,7 +1011,7 @@
1011 1011  (% lang="en-US" %)**PUT /api/v3/vehicles**
1012 1012  )))
1013 1013  
1014 -(% style="color:#000000" %)Метод позволяет отредактировать объект. Метод позволяет отредактировать объект, указанный в запросе.
1198 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе.
1015 1015  
1016 1016  (% style="color:#000000" %)Метод запроса: **PUT**
1017 1017  
... ... @@ -1140,7 +1140,7 @@
1140 1140  (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}**
1141 1141  )))
1142 1142  
1143 -(% style="color:#000000" %)Метод позволяет удалить объект. Метод позволяет удалить объект, указанный в строке запроса.
1327 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса.
1144 1144  
1145 1145  (% style="color:#000000" %)Метод запроса: **DELETE**
1146 1146  
... ... @@ -1349,7 +1349,7 @@
1349 1349  Метод запроса **GET**
1350 1350  
1351 1351  (% style="text-align: left;" %)
1352 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]
1536 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1353 1353  
1354 1354  (% style="text-align: left;" %)
1355 1355  (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления
... ... @@ -1409,15 +1409,6 @@
1409 1409  (% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия
1410 1410  (% style="color:#000000" %)}
1411 1411  
1412 -== (% style="color:#000000; font-size:16px" %)**Добавление уведомления**(%%) ==
1413 -
1414 -(% class="box successmessage" %)
1415 -(((
1416 -**POST /api/v3/notifications/**
1417 -)))
1418 -
1419 -Метод возвращает
1420 -
1421 1421  == (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) ==
1422 1422  
1423 1423  (% class="box warningmessage" %)
... ... @@ -1425,8 +1425,67 @@
1425 1425  **PUT /api/v3/notifications/**
1426 1426  )))
1427 1427  
1428 -Метод возвращает
1603 +Метод позволяет отредактировать уведомление.
1429 1429  
1605 +Метод запроса **PUT**
1606 +
1607 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications
1608 +
1609 +В заголовках запроса: X-Auth: Токен авторизации
1610 +
1611 +Тело запроса:
1612 +{
1613 + "id": 0, ~/~/ id уведомления
1614 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
1615 + "userId": "", ~/~/ Пользователь, создавший уведомление
1616 + "parentId": "", ~/~/ Идентификатор клиента
1617 + "parentName": "string", ~/~/ Имя клиента
1618 + "name": "string", ~/~/ Название уведомления
1619 + "active": true, ~/~/ Состояние true - активен, false - деактивирован
1620 + "vehicleIds": [ ~/~/ Список id объектов для анализа
1621 + 0
1622 + ],
1623 + "geoids": [ ~/~/ Список id геообъектов для анализа
1624 + 0
1625 + ],
1626 + "fieldids": [ ~/~/ Список id полей для анализа
1627 + 0
1628 + ],
1629 + "settings": { ~/~/ Список параметров уведомления
1630 + "additionalProp1": "string",
1631 + "additionalProp2": "string",
1632 + "additionalProp3": "string"
1633 + },
1634 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
1635 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
1636 + ""
1637 + ],
1638 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
1639 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
1640 + "string"
1641 + ],
1642 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
1643 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
1644 + {
1645 + "id": 0, ~/~/ Идентификатор участника чата
1646 + "info": "string" ~/~/ Дополнительные сведения
1647 + }
1648 + ],
1649 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
1650 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
1651 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
1652 + "kind": 0, ~/~/ Определяет вид уведомления
1653 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время
1654 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC)
1655 + "timezone": 0, ~/~/ Сдвиг часового пояса
1656 + "validity": 0, ~/~/ Срок действия в днях (1-90)
1657 + "autoProlongation": true ~/~/ Автопродление срока действия
1658 +}
1659 +
1660 +Ответ:
1661 +
1662 +Success
1663 +
1430 1430  == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) ==
1431 1431  
1432 1432  (% class="box errormessage" %)
... ... @@ -1434,9 +1434,20 @@
1434 1434  **DELETE /api/v3/notifications/{id}**
1435 1435  )))
1436 1436  
1437 -Метод возвращает
1671 +Метод позволяет удалить выбранное уведомление.
1438 1438  
1673 +Метод запроса **DELETE**
1439 1439  
1675 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id}
1676 +
1677 +Передаваемый параметр: {id} - id уведомления
1678 +
1679 +В заголовках запроса: X-Auth: Токен авторизации
1680 +
1681 +Ответ:
1682 +
1683 +Success
1684 +
1440 1440  (% class="box" lang="en-US" style="text-align: center;" %)
1441 1441  (((
1442 1442  (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **

Меню

ГЛОНАССSoft wiki - 2024 г.