Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
<
>
edited by Андрей Калиновский
on 2025/05/06 12:40
on 2025/05/06 12:40
edited by Андрей Калиновский
on 2025/06/09 16:20
on 2025/06/09 16:20
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Content
-
... ... @@ -877,7 +877,7 @@ 877 877 { 878 878 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 879 879 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 880 - "deleted": true,880 + "deleted": false, 881 881 "extId": "string", 882 882 "name": "string", 883 883 "picture": "string", ... ... @@ -896,7 +896,7 @@ 896 896 { 897 897 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 898 898 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 899 - "deleted": true,899 + "deleted": false, 900 900 "extId": "string", 901 901 "name": "string", 902 902 "picture": "string", ... ... @@ -930,7 +930,7 @@ 930 930 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 931 931 ))) 932 932 933 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.933 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 934 934 935 935 (% style="color:#000000" %)Метод запроса: **PUT** 936 936 ... ... @@ -997,7 +997,7 @@ 997 997 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 998 998 ))) 999 999 1000 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 1001 1001 1002 1002 (% style="color:#000000" %)Метод запроса: **DELETE** 1003 1003 ... ... @@ -1628,7 +1628,7 @@ 1628 1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1629 1629 1630 1630 1631 -(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами** 1631 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1632 1632 1633 1633 (% class="box infomessage" %) 1634 1634 ((( ... ... @@ -2455,6 +2455,8 @@ 2455 2455 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2456 2456 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2457 2457 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2458 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2459 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2458 2458 "fuelConsumption": 0, ~/~/ Расход топлива 2459 2459 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2460 2460 "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне ... ... @@ -2794,7 +2794,7 @@ 2794 2794 "id": 0, ~/~/ ID уведомления 2795 2795 "name": "string", ~/~/ Название уведомления 2796 2796 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2797 - "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 - Назначение водителя) 2798 2798 "userId": "", ~/~/ Пользователь, создавший уведомление 2799 2799 "parentId": "", ~/~/ Идентификатор клиента 2800 2800 "parentName": "string" ~/~/ Имя клиента ... ... @@ -4247,7 +4247,6 @@ 4247 4247 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4248 4248 |msgCount|Кол-во обработанных сообщений всего 4249 4249 4250 - 4251 4251 == **Импортировать историю ТС (Асинхронный запрос)** == 4252 4252 4253 4253 (% class="box successmessage" %) ... ... @@ -5915,6 +5915,62 @@ 5915 5915 ))) 5916 5916 5917 5917 5919 += **Раздел: Роли** = 5920 + 5921 +== **Получение списка клиентских и системных ролей пользователя ** == 5922 + 5923 +(% class="box successmessage" %) 5924 +((( 5925 +**POST /api/v3/groups/find** 5926 +))) 5927 + 5928 +Пример запроса: 5929 + 5930 +((( 5931 +{ 5932 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 5933 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 5934 +} 5935 +))) 5936 + 5937 +((( 5938 + 5939 +))) 5940 + 5941 +((( 5942 +Пример ответа: 5943 +))) 5944 + 5945 +((( 5946 +((( 5947 +{ 5948 + "groups": [ ~/~/ Системные роли пользователя 5949 + { 5950 + "code": "string", ~/~/ Код роли. 5951 + "name": "string", ~/~/ Имя 5952 + "shortName": "string" ~/~/ Короткое имя 5953 + } 5954 + ], 5955 + "customGroups": [ ~/~/ Системные роли пользователя 5956 + { 5957 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 5958 + "name": "string", ~/~/ Наименование 5959 + "shortName": "string", ~/~/ Короткое наименование 5960 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 5961 + } 5962 + ] 5963 +} 5964 +))) 5965 +))) 5966 + 5967 +((( 5968 + 5969 +))) 5970 + 5971 +((( 5972 + 5973 +))) 5974 + 5918 5918 = **Раздел: Локатор ** = 5919 5919 5920 5920 ... ... @@ -5922,7 +5922,7 @@ 5922 5922 5923 5923 (% class="box infomessage" %) 5924 5924 ((( 5925 -**GET /api/v3/locators** 5982 +**GET /api/v3/locators ** 5926 5926 ))) 5927 5927 5928 5928 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5931,33 +5931,83 @@ 5931 5931 Пример ответа: 5932 5932 5933 5933 ((( 5991 +((( 5992 +{ 5993 + "vehiclesIds": [ ~/~/ Объекты 5994 + 0 5995 + ], 5996 + "geoIds": [ ~/~/ Геозоны 5997 + 0 5998 + ], 5999 + "fieldsIds": [ ~/~/ Поля 6000 + 0 6001 + ], 6002 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6003 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6004 + "agentName": "string", ~/~/ Наименование агента. 6005 + "isEnabled": true, ~/~/ Активность 6006 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6007 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6008 + "name": "string", ~/~/ Наименование. 6009 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6010 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6011 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6012 + "validity": 0, ~/~/ Значение срока действия 6013 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6014 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6015 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6016 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6017 + "url": "string", ~/~/ Ссылка 6018 + "language": 0, ~/~/ Язык 6019 + "showVehicleName": true, ~/~/ Наименование объекта 6020 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6021 + "allowTrackReport": true, ~/~/ Трек 6022 + "showTrackTracing": true, ~/~/ Трассировка трека 6023 + "showSensors": true, ~/~/ Датчик 6024 + "availableMapLayers": [ ~/~/ Слои на карте 6025 + 0 6026 + ] 6027 +} 6028 +))) 6029 +))) 6030 + 6031 + 6032 +== **Получение перечня моделей ** == 6033 + 6034 +(% class="box successmessage" %) 6035 +((( 6036 +**POST /api/v3/models/find** 6037 +))) 6038 + 6039 +Пример запроса: 6040 + 6041 +((( 6042 +((( 6043 +{ 6044 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6045 + "name": "string", ~/~/ Наименование локатора 6046 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6047 +))) 6048 + 6049 + 6050 + 6051 + Пример ответа: 6052 + 6053 + 6054 +((( 5934 5934 [ 5935 5935 { 5936 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5937 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5938 - "agentName": "string", ~/~/ Наименование агента. 5939 - "isEnabled": true, ~/~/ Активен 5940 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5941 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5942 - "name": "string", ~/~/ Наименование 5943 - "status": 0, ~/~/ 5944 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5945 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5946 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5947 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5948 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5949 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5950 - "url": "string", ~/~/ Ссылка 5951 - "language": 0, ~/~/ Язык. 5952 - "vehiclesCount": 0, ~/~/ Количество объектов. 5953 - "geozonesCount": 0, ~/~/ Количество геозон. 5954 - "fieldsCount": 0 ~/~/ Количество полей. 6057 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6058 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6059 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6060 + "name": "string", ~/~/ Наименование локатора 6061 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 5955 5955 } 5956 5956 ] 5957 5957 ))) 6065 +))) 5958 5958 5959 5959 5960 - 5961 5961 == **Создание локатора** == 5962 5962 5963 5963 (% class="box successmessage" %) ... ... @@ -5978,6 +5978,24 @@ 5978 5978 "autoProlongation": true, ~/~/ Автопродление срока действия. 5979 5979 "url": "string", ~/~/ Ссылка 5980 5980 "language": 0 ~/~/ Язык 6088 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6089 + "vehiclesIds": [ ~/~/ Oбъекты 6090 + 0 6091 + ], 6092 + "geoIds": [ ~/~/ Геозоны 6093 + 0 6094 + ], 6095 + "fieldsIds": [ ~/~/ Поля 6096 + 0 6097 + ], 6098 + "showVehicleName": true, ~/~/ Наименование объекта 6099 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6100 + "allowTrackReport": true, ~/~/ Трек 6101 + "showTrackTracing": true, ~/~/ Трассировка трека 6102 + "showSensors": true, ~/~/ Датчик 6103 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6104 + 0 6105 + ] 5981 5981 } 5982 5982 ))) 5983 5983 ... ... @@ -6010,10 +6010,29 @@ 6010 6010 "autoProlongation": true, ~/~/ Автопродление срока действия 6011 6011 "url": "string", ~/~/ Ссылка 6012 6012 "language": 0 ~/~/ Язык 6138 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6139 + "vehiclesIds": [ ~/~/ Oбъекты 6140 + 0 6141 + ], 6142 + "geoIds": [ ~/~/ Геозоны 6143 + 0 6144 + ], 6145 + "fieldsIds": [ ~/~/ Поля 6146 + 0 6147 + ], 6148 + "showVehicleName": true, ~/~/ Наименование объекта 6149 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6150 + "allowTrackReport": true, ~/~/ Трек 6151 + "showTrackTracing": true, ~/~/ Трассировка трека 6152 + "showSensors": true, ~/~/ Датчик 6153 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6154 + 0 6155 + ] 6013 6013 } 6157 + 6158 + 6014 6014 ))) 6015 6015 6016 - 6017 6017 Пример ответа: 6018 6018 6019 6019 200 ~/~/ Success ... ... @@ -6177,7 +6177,6 @@ 6177 6177 Id ~/~/ Идентификатор поля 6178 6178 6179 6179 6180 -==== ==== 6181 6181 6182 6182 = **Раздел: Управление доступа к машинам** = 6183 6183