Last modified by Андрей Калиновский on 2025/06/27 16:12
<
From version < 221.1 >
edited by Андрей Калиновский
on 2025/04/24 15:22
To version < 237.1 >
edited by Андрей Калиновский
on 2025/05/26 15:33
>
Change comment: There is no comment for this version

Summary

Details

Icon 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,77 +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 -Метод запроса: **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 -
1702 1702  == (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1703 1703  
1704 1704  (% class="box infomessage" %)
... ... @@ -1844,7 +1844,6 @@
1844 1844   "stage": "", ~/~/ Состояние
1845 1845  (% style="color:#000000" %) }
1846 1846  
1847 -== ==
1848 1848  
1849 1849  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1850 1850  
... ... @@ -4319,6 +4319,43 @@
4319 4319  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4320 4320  |msgCount|Кол-во обработанных сообщений всего
4321 4321  
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 +
4322 4322  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4323 4323  
4324 4324  (% class="box infomessage" %)
... ... @@ -4336,10 +4336,59 @@
4336 4336   "message": "string"
4337 4337  }
4338 4338  
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 ТС
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 +)))
4342 4342  
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 +
4343 4343  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
4344 4344  
4345 4345  (% class="box infomessage" %)
... ... @@ -5900,6 +5900,62 @@
5900 5900  )))
5901 5901  
5902 5902  
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 +
5903 5903  = **Раздел: Локатор ** =
5904 5904  
5905 5905  
... ... @@ -5907,7 +5907,7 @@
5907 5907  
5908 5908  (% class="box infomessage" %)
5909 5909  (((
5910 -**GET /api/v3/locators**
5980 +**GET /api/v3/locators **
5911 5911  )))
5912 5912  
5913 5913  В заголовках запроса: X-Auth: Токен авторизации
... ... @@ -5916,33 +5916,83 @@
5916 5916  Пример ответа:
5917 5917  
5918 5918  (((
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 +(((
5919 5919  [
5920 5920   {
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 ~/~/ Количество полей.
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 - Машины) 
5940 5940   }
5941 5941  ]
5942 5942  )))
6063 +)))
5943 5943  
5944 5944  
5945 -
5946 5946  == **Создание локатора** ==
5947 5947  
5948 5948  (% class="box successmessage" %)
... ... @@ -5963,6 +5963,24 @@
5963 5963   "autoProlongation": true, ~/~/ Автопродление срока действия.
5964 5964   "url": "string", ~/~/ Ссылка
5965 5965   "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 + ]
5966 5966  }
5967 5967  )))
5968 5968  
... ... @@ -5995,10 +5995,29 @@
5995 5995   "autoProlongation": true, ~/~/ Автопродление срока действия
5996 5996   "url": "string", ~/~/ Ссылка
5997 5997   "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 + ]
5998 5998  }
6155 +
6156 +
5999 5999  )))
6000 6000  
6001 -
6002 6002  Пример ответа:
6003 6003  
6004 6004  200 ~/~/ Success
... ... @@ -6162,12 +6162,11 @@
6162 6162  Id  ~/~/ Идентификатор поля
6163 6163  
6164 6164  
6165 -==== ====
6166 6166  
6167 -==== **Раздел: Управление доступа к машинам** ====
6323 += **Раздел: Управление доступа к машинам** =
6168 6168  
6169 6169  
6170 -== Получение списка ID ==
6326 +== Получение списка транспортных средств видимых пользователю ==
6171 6171  
6172 6172  (% class="box infomessage" %)
6173 6173  (((
... ... @@ -6174,15 +6174,63 @@
6174 6174  **GET /api/v3/UserVisibleVehicles/{userId}**
6175 6175  )))
6176 6176  
6333 +Пример ответа:
6177 6177  
6335 +(((
6336 +{
6337 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6338 + 0
6339 + ]
6340 +}
6341 +)))
6178 6178  
6179 6179  
6180 6180  
6345 +== Задает видимость транспортных средств пользователю ==
6181 6181  
6347 +(% class="box infomessage" %)
6348 +(((
6349 +**POST /api/v3/UserVisibleVehicles**
6350 +)))
6182 6182  
6352 +Пример запроса:
6183 6183  
6354 +(((
6355 +(((
6356 +{
6357 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6358 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6359 + 0
6360 + ]
6361 +}
6362 +)))
6184 6184  
6364 +(((
6365 +
6366 +)))
6185 6185  
6368 +(((
6369 +
6370 +)))
6371 +
6372 +(((
6373 +Пример ответа :
6374 +)))
6375 +
6376 +(((
6377 +
6378 +)))
6379 +
6380 +(((
6381 +200 ~/~/ Success
6382 +)))
6383 +)))
6384 +
6385 +
6386 +
6387 +
6388 +
6389 +
6186 6186  (% class="box" lang="en-US" style="text-align: center;" %)
6187 6187  (((
6188 6188  (% 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 г.