Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/06/27 16:12
<
>
edited by Андрей Калиновский
on 2025/05/26 14:43
on 2025/05/26 14:43
edited by Андрей Калиновский
on 2025/04/24 15:41
on 2025/04/24 15:41
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": false,880 + "deleted": true, 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": false,899 + "deleted": true, 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,6 +1628,77 @@ 1628 1628 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1629 1629 1630 1630 1631 +== **Импортировать историю ТС (Асинхронный запрос)** == 1632 + 1633 +(% class="box successmessage" %) 1634 +((( 1635 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1636 +))) 1637 + 1638 +Метод запроса: **POST** 1639 + 1640 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1641 + 1642 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1643 + 1644 + 1645 +Ответ: 1646 + 1647 +{ 1648 + 1649 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1650 + 1651 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1652 + 1653 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1654 + 1655 + "Message": "string", ~/~/ Информация о выполнении запроса 1656 + 1657 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1658 + 1659 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1660 + 1661 + "Data": "string" ~/~/ Данные 1662 + 1663 +} 1664 + 1665 + 1666 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1667 + 1668 +(% class="box infomessage" %) 1669 +((( 1670 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1671 +))) 1672 + 1673 +Метод запроса: **GET** 1674 + 1675 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1676 + 1677 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1678 + 1679 + 1680 +Ответ: 1681 + 1682 +{ 1683 + 1684 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1685 + 1686 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1687 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1688 + 1689 + "Message": "string", ~/~/ Информация о выполнении запроса 1690 + 1691 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1692 + 1693 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1694 + 1695 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1696 + 1697 + "Data": "string" ~/~/ Данные 1698 + 1699 +} 1700 + 1701 + 1631 1631 == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1632 1632 1633 1633 (% class="box infomessage" %) ... ... @@ -1773,6 +1773,7 @@ 1773 1773 "stage": "", ~/~/ Состояние 1774 1774 (% style="color:#000000" %) } 1775 1775 1847 +== == 1776 1776 1777 1777 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1778 1778 ... ... @@ -4247,43 +4247,6 @@ 4247 4247 |producedCount|Кол-во успешно отправленных в шину данных сообщений 4248 4248 |msgCount|Кол-во обработанных сообщений всего 4249 4249 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 - 4287 4287 == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4288 4288 4289 4289 (% class="box infomessage" %) ... ... @@ -4301,59 +4301,10 @@ 4301 4301 "message": "string" 4302 4302 } 4303 4303 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 -))) 4339 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4340 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4341 +|progress|Guid ТС 4319 4319 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 - 4357 4357 == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4358 4358 4359 4359 (% class="box infomessage" %) ... ... @@ -5930,84 +5930,33 @@ 5930 5930 Пример ответа: 5931 5931 5932 5932 ((( 5933 -((( 5934 -{ 5935 - "vehiclesIds": [ ~/~/ Объекты 5936 - 0 5937 - ], 5938 - "geoIds": [ ~/~/ Геозоны 5939 - 0 5940 - ], 5941 - "fieldsIds": [ ~/~/ Поля 5942 - 0 5943 - ], 5944 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5945 - "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5946 - "agentName": "string", ~/~/ Наименование агента. 5947 - "isEnabled": true, ~/~/ Активность 5948 - "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 5949 - "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 5950 - "name": "string", ~/~/ Наименование. 5951 - "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5952 - "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 5953 - "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 5954 - "validity": 0, ~/~/ Значение срока действия 5955 - "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 5956 - "autoProlongation": true, ~/~/ Автопродление срока действия. 5957 - "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5958 - "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5959 - "url": "string", ~/~/ Ссылка 5960 - "language": 0, ~/~/ Язык 5961 - "showVehicleName": true, ~/~/ Наименование объекта 5962 - "showVehicleDirection": true, ~/~/ Направление движения на треке 5963 - "allowTrackReport": true, ~/~/ Трек 5964 - "showTrackTracing": true, ~/~/ Трассировка трека 5965 - "showSensors": true, ~/~/ Датчик 5966 - "availableMapLayers": [ ~/~/ Слои на карте 5967 - 0 5968 - ] 5969 -} 5970 -))) 5971 -))) 5972 - 5973 - 5974 -== **Получение перечня моделей ** == 5975 - 5976 -(% class="box successmessage" %) 5977 -((( 5978 -**POST /api/v3/models/find** 5979 -))) 5980 - 5981 -Пример запроса: 5982 - 5983 -((( 5984 -((( 5985 -{ 5986 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5987 - "name": "string", ~/~/ Наименование локатора 5988 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор пользователя, для которого надо получить данные 5989 -} 5990 -))) 5991 - 5992 - 5993 - 5994 - Пример ответа: 5995 - 5996 - 5997 -((( 5998 5998 [ 5999 5999 { 6000 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6001 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6002 - "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6003 - "name": "string", ~/~/ Наименование локатора 6004 - "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 5921 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5922 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5923 + "agentName": "string", ~/~/ Наименование агента. 5924 + "isEnabled": true, ~/~/ Активен 5925 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5926 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5927 + "name": "string", ~/~/ Наименование 5928 + "status": 0, ~/~/ 5929 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5930 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5931 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5932 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5933 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5934 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5935 + "url": "string", ~/~/ Ссылка 5936 + "language": 0, ~/~/ Язык. 5937 + "vehiclesCount": 0, ~/~/ Количество объектов. 5938 + "geozonesCount": 0, ~/~/ Количество геозон. 5939 + "fieldsCount": 0 ~/~/ Количество полей. 6005 6005 } 6006 6006 ] 6007 6007 ))) 6008 -))) 6009 6009 6010 6010 5945 + 6011 6011 == **Создание локатора** == 6012 6012 6013 6013 (% class="box successmessage" %) ... ... @@ -6028,24 +6028,6 @@ 6028 6028 "autoProlongation": true, ~/~/ Автопродление срока действия. 6029 6029 "url": "string", ~/~/ Ссылка 6030 6030 "language": 0 ~/~/ Язык 6031 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6032 - "vehiclesIds": [ ~/~/ Oбъекты 6033 - 0 6034 - ], 6035 - "geoIds": [ ~/~/ Геозоны 6036 - 0 6037 - ], 6038 - "fieldsIds": [ ~/~/ Поля 6039 - 0 6040 - ], 6041 - "showVehicleName": true, ~/~/ Наименование объекта 6042 - "showVehicleDirection": true, ~/~/ Направление движения на треке 6043 - "allowTrackReport": true, ~/~/ Трек 6044 - "showTrackTracing": true, ~/~/ Трассировка трека 6045 - "showSensors": true, ~/~/ Датчик 6046 - "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6047 - 0 6048 - ] 6049 6049 } 6050 6050 ))) 6051 6051 ... ... @@ -6078,29 +6078,10 @@ 6078 6078 "autoProlongation": true, ~/~/ Автопродление срока действия 6079 6079 "url": "string", ~/~/ Ссылка 6080 6080 "language": 0 ~/~/ Язык 6081 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6082 - "vehiclesIds": [ ~/~/ Oбъекты 6083 - 0 6084 - ], 6085 - "geoIds": [ ~/~/ Геозоны 6086 - 0 6087 - ], 6088 - "fieldsIds": [ ~/~/ Поля 6089 - 0 6090 - ], 6091 - "showVehicleName": true, ~/~/ Наименование объекта 6092 - "showVehicleDirection": true, ~/~/ Направление движения на треке 6093 - "allowTrackReport": true, ~/~/ Трек 6094 - "showTrackTracing": true, ~/~/ Трассировка трека 6095 - "showSensors": true, ~/~/ Датчик 6096 - "availableMapLayers": [ ~/~/ Слои на карте (по умолчанию OpenStreetMap) 6097 - 0 6098 - ] 6099 6099 } 6100 - 6101 - 6102 6102 ))) 6103 6103 6001 + 6104 6104 Пример ответа: 6105 6105 6106 6106 200 ~/~/ Success ... ... @@ -6264,11 +6264,12 @@ 6264 6264 Id ~/~/ Идентификатор поля 6265 6265 6266 6266 6165 +==== ==== 6267 6267 6268 -= **Раздел: Управление доступа к машинам** = 6167 +==== **Раздел: Управление доступа к машинам** ==== 6269 6269 6270 6270 6271 -== Получение списка транспортных средств видимых пользователю == 6170 +== Получение списка транспортных средств видимых пользователю == 6272 6272 6273 6273 (% class="box infomessage" %) 6274 6274 (((