Last modified by Андрей Калиновский on 2025/06/27 16:12
<
From version < 215.1 >
edited by Андрей Калиновский
on 2025/03/25 13:59
To version < 240.1 >
edited by Андрей Калиновский
on 2025/06/09 16:36
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -123,29 +123,41 @@
123 123  Запрос должен содержать данные параметра "**agentId**"
124 124  
125 125  (% style="color:#000000" %)Ответ:
126 +
127 +(((
126 126  {
127 - "agentId": "",  (%%)
128 - "parentId": "",
129 - "parentName": "string",
130 - "name": "string",
131 - "fullName": "string",
132 - "agentInfoType": 0,
133 - "isForeign": true/false,
134 - "district": "string", 
135 - "region": "string",
136 - "city": "string",
137 - "inn": "string",
138 - "kpp": "string",
139 - "address": "string",
140 - "addressFact": "string",
141 - "email": "string",
142 - "director": "string",
143 - "bankName": "string",
144 - "bankBIK": "string",
145 - "bankRS": "string",
146 - "bankKS": "string"
147 - }
129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента
130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя
131 + "parentName": "string", ~/~/ Наименование агента
132 + "name": "string", ~/~/ Имя клиента
133 + "fullName": "string", ~/~/ ФИО клиента
134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%))
135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент"
136 + "district": "string", ~/~/ Район
137 + "region": "string", ~/~/ Область
138 + "city": "string", ~/~/ Город
139 + "email": "string", ~/~/ Email
140 + "director": "string", ~/~/ Руководитель
141 + "RegionalData": [ ~/~/ Определяет региональные сведения.
142 + {
143 + "Country": 0, ~/~/ Страна
144 + "groups": [ ~/~/ Список групп
145 + {
146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 
147 + "fields": [ ~/~/ Список значений полей
148 + {
149 + "name": "string", ~/~/ Имя поля формы
150 + "value": "string" ~/~/ Значение поля формы
151 + }
152 + ]
153 + }
154 + ]
155 + }
156 + ]
157 +}
158 +)))
148 148  
160 +
149 149  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
150 150  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
151 151  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
... ... @@ -865,7 +865,7 @@
865 865  {
866 866   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
867 867   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
868 - "deleted": true,
880 + "deleted": false,
869 869   "extId": "string",
870 870   "name": "string",
871 871   "picture": "string",
... ... @@ -884,7 +884,7 @@
884 884  {
885 885   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
886 886   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
887 - "deleted": true,
899 + "deleted": false,
888 888   "extId": "string",
889 889   "name": "string",
890 890   "picture": "string",
... ... @@ -918,7 +918,7 @@
918 918  (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models**
919 919  )))
920 920  
921 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.
933 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе.
922 922  
923 923  (% style="color:#000000" %)Метод запроса: **PUT**
924 924  
... ... @@ -985,7 +985,7 @@
985 985  (% lang="en-US" %)**DELETE /api/v3/models/{Id}**
986 986  )))
987 987  
988 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалить пользователя, указанного в строке запроса.
1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса.
989 989  
990 990  (% style="color:#000000" %)Метод запроса: **DELETE**
991 991  
... ... @@ -1616,77 +1616,6 @@
1616 1616  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1617 1617  
1618 1618  
1619 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1620 -
1621 -(% class="box successmessage" %)
1622 -(((
1623 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
1624 -)))
1625 -
1626 -Метод запроса: **POST**
1627 -
1628 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
1629 -
1630 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
1631 -
1632 -
1633 -Ответ:
1634 -
1635 -{
1636 -
1637 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1638 -
1639 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
1640 -
1641 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
1642 -
1643 - "Message": "string", ~/~/ Информация о выполнении запроса
1644 -
1645 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
1646 -
1647 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1648 -
1649 - "Data": "string" ~/~/ Данные
1650 -
1651 -}
1652 -
1653 -
1654 -== **Возвращает статус асинхронного запроса импорта истории ТС** ==
1655 -
1656 -(% class="box infomessage" %)
1657 -(((
1658 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
1659 -)))
1660 -
1661 -Метод запроса: **GET**
1662 -
1663 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
1664 -
1665 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
1666 -
1667 -
1668 -Ответ:
1669 -
1670 -{
1671 -
1672 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
1673 -
1674 - "Status": 0, ~/~/ Перечисление состояний выполения запроса
1675 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
1676 -
1677 - "Message": "string", ~/~/ Информация о выполнении запроса
1678 -
1679 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
1680 -
1681 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
1682 -
1683 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
1684 -
1685 - "Data": "string" ~/~/ Данные
1686 -
1687 -}
1688 -
1689 -
1690 1690  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1691 1691  
1692 1692  (% class="box infomessage" %)
... ... @@ -1832,7 +1832,6 @@
1832 1832   "stage": "", ~/~/ Состояние
1833 1833  (% style="color:#000000" %) }
1834 1834  
1835 -== ==
1836 1836  
1837 1837  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1838 1838  
... ... @@ -2515,6 +2515,8 @@
2515 2515   "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 
2516 2516   "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода
2517 2517   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2458 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода
2459 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода
2518 2518   "fuelConsumption": 0, ~/~/ Расход топлива
2519 2519   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2520 2520   "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
... ... @@ -2794,6 +2794,35 @@
2794 2794   }
2795 2795  ]
2796 2796  
2739 +
2740 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2741 +
2742 +(% class="box successmessage" %)
2743 +(((
2744 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2745 +)))
2746 +
2747 +(% style="color:#000000" %)Метод запроса: **PUT**
2748 +
2749 +Пример запроса:
2750 +
2751 +(((
2752 +{
2753 + "id": 0,  ~/~/ Идентификатор объекта геозоны
2754 + "name": "string",  ~/~/ Наименование объекта геозоны
2755 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2756 + "description": "string", ~/~/ Описание объекта геозоны
2757 + "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2758 + "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2759 + "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2760 +}
2761 +)))
2762 +
2763 +
2764 +Пример ответа:
2765 +
2766 +200 ~/~/ Success
2767 +
2797 2797  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2798 2798  
2799 2799  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -2825,7 +2825,7 @@
2825 2825   "id": 0, ~/~/ ID уведомления
2826 2826   "name": "string", ~/~/ Название уведомления
2827 2827   "active": true, ~/~/ Состояние true - активен, false - деактивирован
2828 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО
2799 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 
2829 2829   "userId": "", ~/~/ Пользователь, создавший уведомление
2830 2830   "parentId": "", ~/~/ Идентификатор клиента
2831 2831   "parentName": "string" ~/~/ Имя клиента
... ... @@ -2832,6 +2832,155 @@
2832 2832   }
2833 2833  ]
2834 2834  
2806 +
2807 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) ==
2808 +
2809 +(% class="box infomessage" %)
2810 +(((
2811 +**POST /api/v3/notifications**
2812 +)))
2813 +
2814 +Метод запроса **POST**
2815 +
2816 +(% style="text-align: left;" %)
2817 +(% style="color:#000000" %)Пример запроса
2818 +
2819 +(((
2820 +{
2821 + "id": 0, ~/~/ ID правила
2822 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2823 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2824 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2825 + "name": "string", ~/~/ Имя правила
2826 + "active": true, ~/~/ Активность правила
2827 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2828 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2829 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2830 + ],
2831 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2832 + 0
2833 + ],
2834 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2835 + 0
2836 + ],
2837 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2838 + 0
2839 + ],
2840 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2841 + "additionalProp1": "string",  
2842 + "additionalProp2": "string",
2843 + "additionalProp3": "string"
2844 + },
2845 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2846 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2847 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2848 + ],
2849 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2850 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2851 + "string"
2852 + ],
2853 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2854 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2855 + {
2856 + "id": 0, ~/~/ Идентификатор участника чата.
2857 + "info": "string" ~/~/ Дополнительные сведения.
2858 + }
2859 + ],
2860 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2861 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2862 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2863 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2864 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2865 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2866 + "timezone": 0, ~/~/ часовой пояс 
2867 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2868 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2869 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2870 + {
2871 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2872 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2873 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2874 + "additionalProp1": "string",
2875 + "additionalProp2": "string",
2876 + "additionalProp3": "string"
2877 + }
2878 + }
2879 + ]
2880 +}
2881 +)))
2882 +
2883 +(((
2884 +
2885 +)))
2886 +
2887 +(((
2888 +
2889 +)))
2890 +
2891 +Ответ:
2892 +
2893 +{
2894 + "id": 0, ~/~/ ID правила
2895 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя
2896 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило
2897 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
2898 + "name": "string", ~/~/ Имя правила
2899 + "active": true, ~/~/ Активность правила
2900 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто
2901 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа.
2902 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 
2903 + ],
2904 + "vehicleIds": [ ~/~/ Список объектов для анализа.
2905 + 0
2906 + ],
2907 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам.
2908 + 0
2909 + ],
2910 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам.
2911 + 0
2912 + ],
2913 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений.
2914 + "additionalProp1": "string",  
2915 + "additionalProp2": "string",
2916 + "additionalProp3": "string"
2917 + },
2918 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы"
2919 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила
2920 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"
2921 + ],
2922 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям"
2923 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений
2924 + "string"
2925 + ],
2926 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram
2927 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram.
2928 + {
2929 + "id": 0, ~/~/ Идентификатор участника чата.
2930 + "info": "string" ~/~/ Дополнительные сведения.
2931 + }
2932 + ],
2933 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение
2934 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы
2935 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений.
2936 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 
2937 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени)
2938 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC)
2939 + "timezone": 0, ~/~/ часовой пояс 
2940 + "validity": 0, ~/~/ Срок действия в днях (1-90).
2941 + "autoProlongation": true, ~/~/ Автопродление срока действия.
2942 + "templates": [ ~/~/  Переопределения шаблонов уведомлений.
2943 + {
2944 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек
2945 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа.
2946 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка.
2947 + "additionalProp1": "string",
2948 + "additionalProp2": "string",
2949 + "additionalProp3": "string"
2950 + }
2951 + }
2952 + ]
2953 +}
2954 +
2835 2835  == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) ==
2836 2836  
2837 2837  (% class="box infomessage" %)
... ... @@ -4278,6 +4278,43 @@
4278 4278  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4279 4279  |msgCount|Кол-во обработанных сообщений всего
4280 4280  
4401 +== **Импортировать историю ТС (Асинхронный запрос)** ==
4402 +
4403 +(% class="box successmessage" %)
4404 +(((
4405 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4406 +)))
4407 +
4408 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4409 +
4410 +Метод запроса: **POST**
4411 +
4412 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4413 +
4414 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4415 +
4416 +
4417 +Ответ:
4418 +
4419 +{
4420 +
4421 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4422 +
4423 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4424 +
4425 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4426 +
4427 + "Message": "string", ~/~/ Информация о выполнении запроса
4428 +
4429 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4430 +
4431 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4432 +
4433 + "Data": "string" ~/~/ Данные
4434 +
4435 +}
4436 +
4437 +
4281 4281  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4282 4282  
4283 4283  (% class="box infomessage" %)
... ... @@ -4295,10 +4295,59 @@
4295 4295   "message": "string"
4296 4296  }
4297 4297  
4298 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4299 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4300 -|progress|Guid ТС
4455 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4456 +**Параметр**
4457 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4458 +**Описание**
4459 +)))
4460 +|(((
4461 +activity
4462 +)))|(((
4463 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4464 +)))
4465 +|(((
4466 +progress
4467 +)))|(((
4468 +Guid ТС
4469 +)))
4301 4301  
4471 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4472 +
4473 +(% class="box infomessage" %)
4474 +(((
4475 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4476 +)))
4477 +
4478 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4479 +
4480 +Метод запроса: **GET**
4481 +
4482 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4483 +
4484 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4485 +
4486 +
4487 +Ответ:
4488 +
4489 +{
4490 +
4491 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4492 +
4493 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4494 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4495 +
4496 + "Message": "string", ~/~/ Информация о выполнении запроса
4497 +
4498 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4499 +
4500 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4501 +
4502 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4503 +
4504 + "Data": "string" ~/~/ Данные
4505 +
4506 +}
4507 +
4302 4302  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4303 4303  
4304 4304  (% class="box infomessage" %)
... ... @@ -4810,8 +4810,51 @@
4810 4810   }
4811 4811   ]
4812 4812  }
5019 +
5020 +
5021 +== **Превышение скорости** ==
5022 +
5023 +(% class="box infomessage" %)
5024 +(((
5025 +**POST /api/v3/Reports/overSpeedDuration**
4813 4813  )))
4814 4814  
5028 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
5029 +
5030 +Пример запроса:
5031 +
5032 +(((
5033 +{
5034 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
5035 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
5036 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
5037 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
5038 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
5039 +}
5040 +)))
5041 +
5042 +(((
5043 +
5044 +)))
5045 +
5046 +(((
5047 +Пример ответа:
5048 +)))
5049 +
5050 +(((
5051 +(((
5052 +[
5053 + {
5054 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
5055 + "duration": 0, ~/~/ Продолжительность события в секундах 
5056 + "maxSpeed": 0, ~/~/ Максимальная скорость 
5057 + "speedLimit": 0 ~/~/ Ограничение скорости 
5058 + }
5059 +]
5060 +)))
5061 +)))
5062 +)))
5063 +
4815 4815  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4816 4816  
4817 4817  
... ... @@ -5816,6 +5816,62 @@
5816 5816  )))
5817 5817  
5818 5818  
6068 += **Раздел: Роли** =
6069 +
6070 +== **Получение списка клиентских и системных ролей пользователя ** ==
6071 +
6072 +(% class="box successmessage" %)
6073 +(((
6074 +**POST /api/v3/groups/find**
6075 +)))
6076 +
6077 +Пример запроса:
6078 +
6079 +(((
6080 +{
6081 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли
6082 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 
6083 +}
6084 +)))
6085 +
6086 +(((
6087 +
6088 +)))
6089 +
6090 +(((
6091 +Пример ответа:
6092 +)))
6093 +
6094 +(((
6095 +(((
6096 +{
6097 + "groups": [  ~/~/ Системные роли пользователя
6098 + {
6099 + "code": "string", ~/~/ Код роли.
6100 + "name": "string", ~/~/ Имя  
6101 + "shortName": "string" ~/~/ Короткое имя 
6102 + }
6103 + ],
6104 + "customGroups": [ ~/~/ Системные роли пользователя
6105 + {
6106 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли.
6107 + "name": "string", ~/~/ Наименование 
6108 + "shortName": "string", ~/~/ Короткое наименование 
6109 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца
6110 + }
6111 + ]
6112 +}
6113 +)))
6114 +)))
6115 +
6116 +(((
6117 +
6118 +)))
6119 +
6120 +(((
6121 +
6122 +)))
6123 +
5819 5819  = **Раздел: Локатор ** =
5820 5820  
5821 5821  
... ... @@ -5823,7 +5823,7 @@
5823 5823  
5824 5824  (% class="box infomessage" %)
5825 5825  (((
5826 -**GET /api/v3/locators**
6131 +**GET /api/v3/locators **
5827 5827  )))
5828 5828  
5829 5829  В заголовках запроса: X-Auth: Токен авторизации
... ... @@ -5832,33 +5832,83 @@
5832 5832  Пример ответа:
5833 5833  
5834 5834  (((
6140 +(((
6141 +{
6142 + "vehiclesIds": [ ~/~/ Объекты
6143 + 0
6144 + ],
6145 + "geoIds": [ ~/~/ Геозоны
6146 + 0
6147 + ],
6148 + "fieldsIds": [ ~/~/ Поля
6149 + 0
6150 + ],
6151 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора.
6152 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента
6153 + "agentName": "string", ~/~/ Наименование агента.
6154 + "isEnabled": true, ~/~/ Активность 
6155 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания
6156 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления
6157 + "name": "string", ~/~/ Наименование.
6158 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
6159 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время)
6160 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации
6161 + "validity": 0, ~/~/ Значение срока действия
6162 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 
6163 + "autoProlongation": true, ~/~/ Автопродление срока действия.
6164 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
6165 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
6166 + "url": "string", ~/~/ Ссылка
6167 + "language": 0, ~/~/ Язык
6168 + "showVehicleName": true, ~/~/ Наименование объекта
6169 + "showVehicleDirection": true, ~/~/ Направление движения на треке
6170 + "allowTrackReport": true, ~/~/ Трек
6171 + "showTrackTracing": true, ~/~/ Трассировка трека
6172 + "showSensors": true, ~/~/ Датчик
6173 + "availableMapLayers": [ ~/~/  Слои на карте
6174 + 0
6175 + ]
6176 +}
6177 +)))
6178 +)))
6179 +
6180 +
6181 +== **Получение перечня моделей ** ==
6182 +
6183 +(% class="box successmessage" %)
6184 +(((
6185 +**POST /api/v3/models/find**
6186 +)))
6187 +
6188 +Пример запроса:
6189 +
6190 +(((
6191 +(((
6192 +{
6193 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора
6194 + "name": "string", ~/~/ Наименование локатора
6195 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей
6196 +)))
6197 +
6198 +
6199 +
6200 + Пример ответа: 
6201 +
6202 +
6203 +(((
5835 5835  [
5836 5836   {
5837 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор локатора.
5838 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента.
5839 - "agentName": "string", ~/~/ Наименование агента.
5840 - "isEnabled": true, ~/~/ Активен 
5841 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания
5842 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления
5843 - "name": "string", ~/~/ Наименование
5844 - "status": 0, ~/~/ 
5845 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 
5846 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 
5847 - "validity": 0, ~/~/ Срок действия в днях (1-90).
5848 - "autoProlongation": true, ~/~/ Автопродление срока действия.
5849 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор.
5850 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор.
5851 - "url": "string", ~/~/ Ссылка
5852 - "language": 0, ~/~/ Язык.
5853 - "vehiclesCount": 0, ~/~/ Количество объектов.
5854 - "geozonesCount": 0, ~/~/ Количество геозон.
5855 - "fieldsCount": 0 ~/~/ Количество полей.
6206 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 
6207 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные
6208 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные
6209 + "name": "string", ~/~/ Наименование локатора
6210 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 
5856 5856   }
5857 5857  ]
5858 5858  )))
6214 +)))
5859 5859  
5860 5860  
5861 -
5862 5862  == **Создание локатора** ==
5863 5863  
5864 5864  (% class="box successmessage" %)
... ... @@ -5879,6 +5879,24 @@
5879 5879   "autoProlongation": true, ~/~/ Автопродление срока действия.
5880 5880   "url": "string", ~/~/ Ссылка
5881 5881   "language": 0 ~/~/ Язык
6237 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6238 + "vehiclesIds": [ ~/~/ Oбъекты
6239 + 0
6240 + ],
6241 + "geoIds": [ ~/~/ Геозоны
6242 + 0
6243 + ],
6244 + "fieldsIds": [ ~/~/ Поля
6245 + 0
6246 + ],
6247 + "showVehicleName": true, ~/~/ Наименование объекта
6248 + "showVehicleDirection": true, ~/~/ Направление движения на треке
6249 + "allowTrackReport": true, ~/~/ Трек
6250 + "showTrackTracing": true, ~/~/ Трассировка трека
6251 + "showSensors": true, ~/~/ Датчик
6252 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6253 + 0
6254 + ]
5882 5882  }
5883 5883  )))
5884 5884  
... ... @@ -5911,10 +5911,29 @@
5911 5911   "autoProlongation": true, ~/~/ Автопродление срока действия
5912 5912   "url": "string", ~/~/ Ссылка
5913 5913   "language": 0 ~/~/ Язык
6287 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента.
6288 + "vehiclesIds": [ ~/~/ Oбъекты
6289 + 0
6290 + ],
6291 + "geoIds": [ ~/~/ Геозоны
6292 + 0
6293 + ],
6294 + "fieldsIds": [ ~/~/ Поля
6295 + 0
6296 + ],
6297 + "showVehicleName": true, ~/~/ Наименование объекта
6298 + "showVehicleDirection": true, ~/~/ Направление движения на треке
6299 + "allowTrackReport": true, ~/~/ Трек
6300 + "showTrackTracing": true, ~/~/ Трассировка трека
6301 + "showSensors": true, ~/~/ Датчик
6302 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap)
6303 + 0
6304 + ]
5914 5914  }
6306 +
6307 +
5915 5915  )))
5916 5916  
5917 -
5918 5918  Пример ответа:
5919 5919  
5920 5920  200 ~/~/ Success
... ... @@ -5937,7 +5937,215 @@
5937 5937  
5938 5938  
5939 5939  
6332 += **Раздел: Яндекс Маршруты** =
5940 5940  
6334 +
6335 +== **Возвращение списка маршрутов** ==
6336 +
6337 +(% class="box infomessage" %)
6338 +(((
6339 +**GET /api/v3/TransportRoutes**
6340 +)))
6341 +
6342 +Пример запроса:
6343 +Id  ~/~/ Идентификатор поля
6344 +
6345 +
6346 +Пример ответа:
6347 +
6348 +(((
6349 +[
6350 + {
6351 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6352 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6353 + "name": "string", ~/~/ Наименование маршрута.
6354 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6355 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6356 + 0
6357 + ]
6358 + }
6359 +]
6360 +)))
6361 +
6362 +
6363 +
6364 +== **Добавить маршрут** ==
6365 +
6366 +(% class="box infomessage" %)
6367 +(((
6368 +**POST /api/v3/TransportRoutes**
6369 +)))
6370 +
6371 +Пример запроса: 
6372 +{
6373 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6374 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6375 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6376 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6377 + 0
6378 + ]
6379 +}
6380 +
6381 +
6382 +Пример ответа:
6383 +
6384 +(((
6385 +{
6386 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6387 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6388 + "name": "string", ~/~/ Определяет наименование маршрута 
6389 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6390 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6391 + 0
6392 + ]
6393 +}
6394 +)))
6395 +
6396 +
6397 +== **Обновление маршрута** ==
6398 +
6399 +(% class="box successmessage" %)
6400 +(((
6401 +**PUT /api/v3/TransportRoutes**
6402 +)))
6403 +
6404 +Пример запроса:
6405 +
6406 +(((
6407 +{
6408 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6409 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6410 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6411 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6412 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6413 + 0
6414 + ]
6415 +}
6416 +)))
6417 +
6418 +
6419 +Пример ответа:
6420 +
6421 +(((
6422 +{
6423 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6424 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6425 + "name": "string", ~/~/ Определяет наименование маршрута 
6426 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6427 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6428 + 0
6429 + ]
6430 +}
6431 +)))
6432 +
6433 +
6434 +== **Получить связки маршрутов ТС** ==
6435 +
6436 +(% class="box infomessage" %)
6437 +(((
6438 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6439 +)))
6440 +
6441 +Пример запроса:
6442 +
6443 +(((
6444 +[
6445 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6446 +]
6447 +)))
6448 +
6449 +
6450 +Пример ответа:
6451 +
6452 +(((
6453 +[
6454 + {
6455 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6456 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6457 + }
6458 +]
6459 +)))
6460 +
6461 +
6462 +== **Удалить маршрут** ==
6463 +
6464 +(% class="box warningmessage" %)
6465 +(((
6466 +**DELETE /api/v3/TransportRoutes/{id}**
6467 +)))
6468 +
6469 +Пример запроса:
6470 +Id  ~/~/ Идентификатор поля
6471 +
6472 +
6473 +
6474 += **Раздел: Управление доступа к машинам** =
6475 +
6476 +
6477 +== Получение списка транспортных средств видимых пользователю ==
6478 +
6479 +(% class="box infomessage" %)
6480 +(((
6481 +**GET /api/v3/UserVisibleVehicles/{userId}**
6482 +)))
6483 +
6484 +Пример ответа:
6485 +
6486 +(((
6487 +{
6488 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6489 + 0
6490 + ]
6491 +}
6492 +)))
6493 +
6494 +
6495 +
6496 +== Задает видимость транспортных средств пользователю ==
6497 +
6498 +(% class="box infomessage" %)
6499 +(((
6500 +**POST /api/v3/UserVisibleVehicles**
6501 +)))
6502 +
6503 +Пример запроса:
6504 +
6505 +(((
6506 +(((
6507 +{
6508 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6509 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6510 + 0
6511 + ]
6512 +}
6513 +)))
6514 +
6515 +(((
6516 +
6517 +)))
6518 +
6519 +(((
6520 +
6521 +)))
6522 +
6523 +(((
6524 +Пример ответа :
6525 +)))
6526 +
6527 +(((
6528 +
6529 +)))
6530 +
6531 +(((
6532 +200 ~/~/ Success
6533 +)))
6534 +)))
6535 +
6536 +
6537 +
6538 +
6539 +
6540 +
5941 5941  (% class="box" lang="en-US" style="text-align: center;" %)
5942 5942  (((
5943 5943  (% 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 г.