Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
<
>
edited by Андрей Калиновский
on 2025/05/06 11:26
on 2025/05/06 11:26
edited by Андрей Калиновский
on 2025/05/26 15:33
on 2025/05/26 15:33
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,81 +1628,6 @@ 1628 1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1629 1629 1630 1630 1631 -== **Импортировать историю ТС (Асинхронный запрос)** == 1632 - 1633 -(% class="box successmessage" %) 1634 -((( 1635 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1636 -))) 1637 - 1638 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 1639 - 1640 -Метод запроса: **POST** 1641 - 1642 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1643 - 1644 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1645 - 1646 - 1647 -Ответ: 1648 - 1649 -{ 1650 - 1651 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1652 - 1653 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1654 - 1655 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1656 - 1657 - "Message": "string", ~/~/ Информация о выполнении запроса 1658 - 1659 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1660 - 1661 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1662 - 1663 - "Data": "string" ~/~/ Данные 1664 - 1665 -} 1666 - 1667 - 1668 -== **Возвращает статус асинхронного запроса импорта истории ТС** == 1669 - 1670 -(% class="box infomessage" %) 1671 -((( 1672 -**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1673 -))) 1674 - 1675 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 1676 - 1677 -Метод запроса: **GET** 1678 - 1679 -URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1680 - 1681 -Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1682 - 1683 - 1684 -Ответ: 1685 - 1686 -{ 1687 - 1688 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1689 - 1690 - "Status": 0, ~/~/ Перечисление состояний выполения запроса 1691 -~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1692 - 1693 - "Message": "string", ~/~/ Информация о выполнении запроса 1694 - 1695 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1696 - 1697 -~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1698 - 1699 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1700 - 1701 - "Data": "string" ~/~/ Данные 1702 - 1703 -} 1704 - 1705 - 1706 1706 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1707 1707 1708 1708 (% class="box infomessage" %) ... ... @@ -1848,7 +1848,6 @@ 1848 1848 "stage": "", ~/~/ Состояние 1849 1849 (% style="color:#000000" %) } 1850 1850 1851 -== == 1852 1852 1853 1853 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1854 1854 ... ... @@ -4323,6 +4323,43 @@ 4323 4323 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4324 4324 |msgCount|Кол-во обработанных сообщений всего 4325 4325 4250 +== **Импортировать историю ТС (Асинхронный запрос)** == 4251 + 4252 +(% class="box successmessage" %) 4253 +((( 4254 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4255 +))) 4256 + 4257 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4258 + 4259 +Метод запроса: **POST** 4260 + 4261 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4262 + 4263 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4264 + 4265 + 4266 +Ответ: 4267 + 4268 +{ 4269 + 4270 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4271 + 4272 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4273 + 4274 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4275 + 4276 + "Message": "string", ~/~/ Информация о выполнении запроса 4277 + 4278 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4279 + 4280 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4281 + 4282 + "Data": "string" ~/~/ Данные 4283 + 4284 +} 4285 + 4286 + 4326 4326 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4327 4327 4328 4328 (% class="box infomessage" %) ... ... @@ -4340,10 +4340,59 @@ 4340 4340 "message": "string" 4341 4341 } 4342 4342 4343 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4344 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4345 -|progress|Guid ТС 4304 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4305 +**Параметр** 4306 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4307 +**Описание** 4308 +))) 4309 +|((( 4310 +activity 4311 +)))|((( 4312 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4313 +))) 4314 +|((( 4315 +progress 4316 +)))|((( 4317 +Guid ТС 4318 +))) 4346 4346 4320 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4321 + 4322 +(% class="box infomessage" %) 4323 +((( 4324 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4325 +))) 4326 + 4327 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4328 + 4329 +Метод запроса: **GET** 4330 + 4331 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4332 + 4333 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4334 + 4335 + 4336 +Ответ: 4337 + 4338 +{ 4339 + 4340 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4341 + 4342 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4343 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4344 + 4345 + "Message": "string", ~/~/ Информация о выполнении запроса 4346 + 4347 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4348 + 4349 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4350 + 4351 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4352 + 4353 + "Data": "string" ~/~/ Данные 4354 + 4355 +} 4356 + 4347 4347 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4348 4348 4349 4349 (% class="box infomessage" %) ... ... @@ -5904,6 +5904,62 @@ 5904 5904 ))) 5905 5905 5906 5906 5917 += **Раздел: Роли** = 5918 + 5919 +== **Получение списка клиентских и системных ролей пользователя ** == 5920 + 5921 +(% class="box successmessage" %) 5922 +((( 5923 +**POST **/api/v3/groups/find 5924 +))) 5925 + 5926 +Пример запроса: 5927 + 5928 +((( 5929 +{ 5930 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 5931 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 5932 +} 5933 +))) 5934 + 5935 +((( 5936 + 5937 +))) 5938 + 5939 +((( 5940 +Пример ответа: 5941 +))) 5942 + 5943 +((( 5944 +((( 5945 +{ 5946 + "groups": [ ~/~/ Системные роли пользователя 5947 + { 5948 + "code": "string", ~/~/ Код роли. 5949 + "name": "string", ~/~/ Имя 5950 + "shortName": "string" ~/~/ Короткое имя 5951 + } 5952 + ], 5953 + "customGroups": [ ~/~/ Системные роли пользователя 5954 + { 5955 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 5956 + "name": "string", ~/~/ Наименование 5957 + "shortName": "string", ~/~/ Короткое наименование 5958 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 5959 + } 5960 + ] 5961 +} 5962 +))) 5963 +))) 5964 + 5965 +((( 5966 + 5967 +))) 5968 + 5969 +((( 5970 + 5971 +))) 5972 + 5907 5907 = **Раздел: Локатор ** = 5908 5908 5909 5909 ... ... @@ -5911,7 +5911,7 @@ 5911 5911 5912 5912 (% class="box infomessage" %) 5913 5913 ((( 5914 -**GET /api/v3/locators** 5980 +**GET /api/v3/locators ** 5915 5915 ))) 5916 5916 5917 5917 В заголовках запроса: X-Auth: Токен авторизации ... ... @@ -5920,33 +5920,83 @@ 5920 5920 Пример ответа: 5921 5921 5922 5922 ((( 5989 +((( 5990 +{ 5991 + "vehiclesIds": [ ~/~/ Объекты 5992 + 0 5993 + ], 5994 + "geoIds": [ ~/~/ Геозоны 5995 + 0 5996 + ], 5997 + "fieldsIds": [ ~/~/ Поля 5998 + 0 5999 + ], 6000 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6001 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6002 + "agentName": "string", ~/~/ Наименование агента. 6003 + "isEnabled": true, ~/~/ Активность 6004 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6005 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6006 + "name": "string", ~/~/ Наименование. 6007 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6008 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6009 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6010 + "validity": 0, ~/~/ Значение срока действия 6011 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6012 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6013 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6014 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6015 + "url": "string", ~/~/ Ссылка 6016 + "language": 0, ~/~/ Язык 6017 + "showVehicleName": true, ~/~/ Наименование объекта 6018 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6019 + "allowTrackReport": true, ~/~/ Трек 6020 + "showTrackTracing": true, ~/~/ Трассировка трека 6021 + "showSensors": true, ~/~/ Датчик 6022 + "availableMapLayers": [ ~/~/ Слои на карте 6023 + 0 6024 + ] 6025 +} 6026 +))) 6027 +))) 6028 + 6029 + 6030 +== **Получение перечня моделей ** == 6031 + 6032 +(% class="box successmessage" %) 6033 +((( 6034 +**POST /api/v3/models/find** 6035 +))) 6036 + 6037 +Пример запроса: 6038 + 6039 +((( 6040 +((( 6041 +{ 6042 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6043 + "name": "string", ~/~/ Наименование локатора 6044 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6045 +))) 6046 + 6047 + 6048 + 6049 + Пример ответа: 6050 + 6051 + 6052 +((( 5923 5923 [ 5924 5924 { 5925 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5926 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5927 - "agentName": "string", ~/~/ Наименование агента. 5928 - "isEnabled": true, ~/~/ Активен 5929 - "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5930 - "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5931 - "name": "string", ~/~/ Наименование 5932 - "status": 0, ~/~/ 5933 - "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5934 - "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5935 - "validity": 0, ~/~/ Срок действия в днях (1-90). 5936 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5937 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5938 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5939 - "url": "string", ~/~/ Ссылка 5940 - "language": 0, ~/~/ Язык. 5941 - "vehiclesCount": 0, ~/~/ Количество объектов. 5942 - "geozonesCount": 0, ~/~/ Количество геозон. 5943 - "fieldsCount": 0 ~/~/ Количество полей. 6055 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6056 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6057 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6058 + "name": "string", ~/~/ Наименование локатора 6059 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 5944 5944 } 5945 5945 ] 5946 5946 ))) 6063 +))) 5947 5947 5948 5948 5949 - 5950 5950 == **Создание локатора** == 5951 5951 5952 5952 (% class="box successmessage" %) ... ... @@ -5967,6 +5967,24 @@ 5967 5967 "autoProlongation": true, ~/~/ Автопродление срока действия. 5968 5968 "url": "string", ~/~/ Ссылка 5969 5969 "language": 0 ~/~/ Язык 6086 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6087 + "vehiclesIds": [ ~/~/ Oбъекты 6088 + 0 6089 + ], 6090 + "geoIds": [ ~/~/ Геозоны 6091 + 0 6092 + ], 6093 + "fieldsIds": [ ~/~/ Поля 6094 + 0 6095 + ], 6096 + "showVehicleName": true, ~/~/ Наименование объекта 6097 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6098 + "allowTrackReport": true, ~/~/ Трек 6099 + "showTrackTracing": true, ~/~/ Трассировка трека 6100 + "showSensors": true, ~/~/ Датчик 6101 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6102 + 0 6103 + ] 5970 5970 } 5971 5971 ))) 5972 5972 ... ... @@ -5999,10 +5999,29 @@ 5999 5999 "autoProlongation": true, ~/~/ Автопродление срока действия 6000 6000 "url": "string", ~/~/ Ссылка 6001 6001 "language": 0 ~/~/ Язык 6136 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6137 + "vehiclesIds": [ ~/~/ Oбъекты 6138 + 0 6139 + ], 6140 + "geoIds": [ ~/~/ Геозоны 6141 + 0 6142 + ], 6143 + "fieldsIds": [ ~/~/ Поля 6144 + 0 6145 + ], 6146 + "showVehicleName": true, ~/~/ Наименование объекта 6147 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6148 + "allowTrackReport": true, ~/~/ Трек 6149 + "showTrackTracing": true, ~/~/ Трассировка трека 6150 + "showSensors": true, ~/~/ Датчик 6151 + "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6152 + 0 6153 + ] 6002 6002 } 6155 + 6156 + 6003 6003 ))) 6004 6004 6005 - 6006 6006 Пример ответа: 6007 6007 6008 6008 200 ~/~/ Success ... ... @@ -6166,7 +6166,6 @@ 6166 6166 Id ~/~/ Идентификатор поля 6167 6167 6168 6168 6169 -==== ==== 6170 6170 6171 6171 = **Раздел: Управление доступа к машинам** = 6172 6172