Last modified by Андрей Калиновский on 2025/05/06 12:41
<
From version < 215.1 >
edited by Андрей Калиновский
on 2025/03/25 13:59
To version < 228.1 >
edited by Андрей Калиновский
on 2025/05/06 12:37
>
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" %)Идентификатор клиента-родителя
... ... @@ -1616,81 +1616,10 @@
1616 1616  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1617 1617  
1618 1618  
1619 -== **Импортировать историю ТС (Асинхронный запрос)** ==
1631 +(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**
1620 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 1656  (% class="box infomessage" %)
1657 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 -== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) ==
1691 -
1692 -(% class="box infomessage" %)
1693 -(((
1694 1694  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1695 1695  )))
1696 1696  
... ... @@ -2794,6 +2794,35 @@
2794 2794   }
2795 2795  ]
2796 2796  
2738 +
2739 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2740 +
2741 +(% class="box successmessage" %)
2742 +(((
2743 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2744 +)))
2745 +
2746 +(% style="color:#000000" %)Метод запроса: **PUT**
2747 +
2748 +Пример запроса:
2749 +
2750 +(((
2751 +{
2752 + "id": 0,  ~/~/ Идентификатор объекта геозоны
2753 + "name": "string",  ~/~/ Наименование объекта геозоны
2754 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2755 + "description": "string", ~/~/ Описание объекта геозоны
2756 + "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2757 + "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2758 + "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2759 +}
2760 +)))
2761 +
2762 +
2763 +Пример ответа:
2764 +
2765 +200 ~/~/ Success
2766 +
2797 2797  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2798 2798  
2799 2799  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -4278,6 +4278,45 @@
4278 4278  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4279 4279  |msgCount|Кол-во обработанных сообщений всего
4280 4280  
4251 +== ==
4252 +
4253 +== **Импортировать историю ТС (Асинхронный запрос)** ==
4254 +
4255 +(% class="box successmessage" %)
4256 +(((
4257 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4258 +)))
4259 +
4260 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4261 +
4262 +Метод запроса: **POST**
4263 +
4264 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4265 +
4266 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4267 +
4268 +
4269 +Ответ:
4270 +
4271 +{
4272 +
4273 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4274 +
4275 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4276 +
4277 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4278 +
4279 + "Message": "string", ~/~/ Информация о выполнении запроса
4280 +
4281 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4282 +
4283 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4284 +
4285 + "Data": "string" ~/~/ Данные
4286 +
4287 +}
4288 +
4289 +
4281 4281  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4282 4282  
4283 4283  (% class="box infomessage" %)
... ... @@ -4295,10 +4295,60 @@
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 ТС
4307 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)(((
4308 +**Параметр**
4309 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)(((
4310 +**Описание**
4311 +)))
4312 +|(((
4313 +activity
4314 +)))|(((
4315 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4316 +)))
4317 +|(((
4318 +progress
4319 +)))|(((
4320 +Guid ТС
4321 +)))
4301 4301  
4323 +
4324 +== **Возвращает статус асинхронного запроса импорта истории ТС** ==
4325 +
4326 +(% class="box infomessage" %)
4327 +(((
4328 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4329 +)))
4330 +
4331 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4332 +
4333 +Метод запроса: **GET**
4334 +
4335 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4336 +
4337 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4338 +
4339 +
4340 +Ответ:
4341 +
4342 +{
4343 +
4344 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4345 +
4346 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4347 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4348 +
4349 + "Message": "string", ~/~/ Информация о выполнении запроса
4350 +
4351 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4352 +
4353 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4354 +
4355 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4356 +
4357 + "Data": "string" ~/~/ Данные
4358 +
4359 +}
4360 +
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  }
4872 +
4873 +
4874 +== **Превышение скорости** ==
4875 +
4876 +(% class="box infomessage" %)
4877 +(((
4878 +**POST /api/v3/Reports/overSpeedDuration**
4813 4813  )))
4814 4814  
4881 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4882 +
4883 +Пример запроса:
4884 +
4885 +(((
4886 +{
4887 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4888 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4889 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4890 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4891 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4892 +}
4893 +)))
4894 +
4895 +(((
4896 +
4897 +)))
4898 +
4899 +(((
4900 +Пример ответа:
4901 +)))
4902 +
4903 +(((
4904 +(((
4905 +[
4906 + {
4907 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4908 + "duration": 0, ~/~/ Продолжительность события в секундах 
4909 + "maxSpeed": 0, ~/~/ Максимальная скорость 
4910 + "speedLimit": 0 ~/~/ Ограничение скорости 
4911 + }
4912 +]
4913 +)))
4914 +)))
4915 +)))
4916 +
4815 4815  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4816 4816  
4817 4817  
... ... @@ -5937,7 +5937,216 @@
5937 5937  
5938 5938  
5939 5939  
6042 += **Раздел: Яндекс Маршруты** =
5940 5940  
6044 +
6045 +== **Возвращение списка маршрутов** ==
6046 +
6047 +(% class="box infomessage" %)
6048 +(((
6049 +**GET /api/v3/TransportRoutes**
6050 +)))
6051 +
6052 +Пример запроса:
6053 +Id  ~/~/ Идентификатор поля
6054 +
6055 +
6056 +Пример ответа:
6057 +
6058 +(((
6059 +[
6060 + {
6061 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6062 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6063 + "name": "string", ~/~/ Наименование маршрута.
6064 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6065 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6066 + 0
6067 + ]
6068 + }
6069 +]
6070 +)))
6071 +
6072 +
6073 +
6074 +== **Добавить маршрут** ==
6075 +
6076 +(% class="box infomessage" %)
6077 +(((
6078 +**POST /api/v3/TransportRoutes**
6079 +)))
6080 +
6081 +Пример запроса: 
6082 +{
6083 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6084 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6085 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6086 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6087 + 0
6088 + ]
6089 +}
6090 +
6091 +
6092 +Пример ответа:
6093 +
6094 +(((
6095 +{
6096 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6097 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6098 + "name": "string", ~/~/ Определяет наименование маршрута 
6099 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6100 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6101 + 0
6102 + ]
6103 +}
6104 +)))
6105 +
6106 +
6107 +== **Обновление маршрута** ==
6108 +
6109 +(% class="box successmessage" %)
6110 +(((
6111 +**PUT /api/v3/TransportRoutes**
6112 +)))
6113 +
6114 +Пример запроса:
6115 +
6116 +(((
6117 +{
6118 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6119 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6120 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6121 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6122 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6123 + 0
6124 + ]
6125 +}
6126 +)))
6127 +
6128 +
6129 +Пример ответа:
6130 +
6131 +(((
6132 +{
6133 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6134 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6135 + "name": "string", ~/~/ Определяет наименование маршрута 
6136 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6137 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6138 + 0
6139 + ]
6140 +}
6141 +)))
6142 +
6143 +
6144 +== **Получить связки маршрутов ТС** ==
6145 +
6146 +(% class="box infomessage" %)
6147 +(((
6148 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6149 +)))
6150 +
6151 +Пример запроса:
6152 +
6153 +(((
6154 +[
6155 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6156 +]
6157 +)))
6158 +
6159 +
6160 +Пример ответа:
6161 +
6162 +(((
6163 +[
6164 + {
6165 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6166 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6167 + }
6168 +]
6169 +)))
6170 +
6171 +
6172 +== **Удалить маршрут** ==
6173 +
6174 +(% class="box warningmessage" %)
6175 +(((
6176 +**DELETE /api/v3/TransportRoutes/{id}**
6177 +)))
6178 +
6179 +Пример запроса:
6180 +Id  ~/~/ Идентификатор поля
6181 +
6182 +
6183 +==== ====
6184 +
6185 += **Раздел: Управление доступа к машинам** =
6186 +
6187 +
6188 +== Получение списка транспортных средств видимых пользователю ==
6189 +
6190 +(% class="box infomessage" %)
6191 +(((
6192 +**GET /api/v3/UserVisibleVehicles/{userId}**
6193 +)))
6194 +
6195 +Пример ответа:
6196 +
6197 +(((
6198 +{
6199 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6200 + 0
6201 + ]
6202 +}
6203 +)))
6204 +
6205 +
6206 +
6207 +== Задает видимость транспортных средств пользователю ==
6208 +
6209 +(% class="box infomessage" %)
6210 +(((
6211 +**POST /api/v3/UserVisibleVehicles**
6212 +)))
6213 +
6214 +Пример запроса:
6215 +
6216 +(((
6217 +(((
6218 +{
6219 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6220 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6221 + 0
6222 + ]
6223 +}
6224 +)))
6225 +
6226 +(((
6227 +
6228 +)))
6229 +
6230 +(((
6231 +
6232 +)))
6233 +
6234 +(((
6235 +Пример ответа :
6236 +)))
6237 +
6238 +(((
6239 +
6240 +)))
6241 +
6242 +(((
6243 +200 ~/~/ Success
6244 +)))
6245 +)))
6246 +
6247 +
6248 +
6249 +
6250 +
6251 +
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 г.