Last modified by Андрей Калиновский on 2025/05/06 12:41
<
From version < 215.1 >
edited by Андрей Калиновский
on 2025/03/25 13:59
To version < 229.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,59 @@
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 +(% class="box infomessage" %)
4326 +(((
4327 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}**
4328 +)))
4329 +
4330 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4331 +
4332 +Метод запроса: **GET**
4333 +
4334 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}**
4335 +
4336 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса
4337 +
4338 +
4339 +Ответ:
4340 +
4341 +{
4342 +
4343 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4344 +
4345 + "Status": 0, ~/~/ Перечисление состояний выполения запроса
4346 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest
4347 +
4348 + "Message": "string", ~/~/ Информация о выполнении запроса
4349 +
4350 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса
4351 +
4352 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None
4353 +
4354 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4355 +
4356 + "Data": "string" ~/~/ Данные
4357 +
4358 +}
4359 +
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  }
4871 +
4872 +
4873 +== **Превышение скорости** ==
4874 +
4875 +(% class="box infomessage" %)
4876 +(((
4877 +**POST /api/v3/Reports/overSpeedDuration**
4813 4813  )))
4814 4814  
4880 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4881 +
4882 +Пример запроса:
4883 +
4884 +(((
4885 +{
4886 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4887 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4888 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4889 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4890 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4891 +}
4892 +)))
4893 +
4894 +(((
4895 +
4896 +)))
4897 +
4898 +(((
4899 +Пример ответа:
4900 +)))
4901 +
4902 +(((
4903 +(((
4904 +[
4905 + {
4906 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4907 + "duration": 0, ~/~/ Продолжительность события в секундах 
4908 + "maxSpeed": 0, ~/~/ Максимальная скорость 
4909 + "speedLimit": 0 ~/~/ Ограничение скорости 
4910 + }
4911 +]
4912 +)))
4913 +)))
4914 +)))
4915 +
4815 4815  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4816 4816  
4817 4817  
... ... @@ -5937,7 +5937,216 @@
5937 5937  
5938 5938  
5939 5939  
6041 += **Раздел: Яндекс Маршруты** =
5940 5940  
6043 +
6044 +== **Возвращение списка маршрутов** ==
6045 +
6046 +(% class="box infomessage" %)
6047 +(((
6048 +**GET /api/v3/TransportRoutes**
6049 +)))
6050 +
6051 +Пример запроса:
6052 +Id  ~/~/ Идентификатор поля
6053 +
6054 +
6055 +Пример ответа:
6056 +
6057 +(((
6058 +[
6059 + {
6060 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6061 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6062 + "name": "string", ~/~/ Наименование маршрута.
6063 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6064 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6065 + 0
6066 + ]
6067 + }
6068 +]
6069 +)))
6070 +
6071 +
6072 +
6073 +== **Добавить маршрут** ==
6074 +
6075 +(% class="box infomessage" %)
6076 +(((
6077 +**POST /api/v3/TransportRoutes**
6078 +)))
6079 +
6080 +Пример запроса: 
6081 +{
6082 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6083 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6084 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6085 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6086 + 0
6087 + ]
6088 +}
6089 +
6090 +
6091 +Пример ответа:
6092 +
6093 +(((
6094 +{
6095 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6096 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6097 + "name": "string", ~/~/ Определяет наименование маршрута 
6098 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6099 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6100 + 0
6101 + ]
6102 +}
6103 +)))
6104 +
6105 +
6106 +== **Обновление маршрута** ==
6107 +
6108 +(% class="box successmessage" %)
6109 +(((
6110 +**PUT /api/v3/TransportRoutes**
6111 +)))
6112 +
6113 +Пример запроса:
6114 +
6115 +(((
6116 +{
6117 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6118 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6119 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6120 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6121 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6122 + 0
6123 + ]
6124 +}
6125 +)))
6126 +
6127 +
6128 +Пример ответа:
6129 +
6130 +(((
6131 +{
6132 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6133 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6134 + "name": "string", ~/~/ Определяет наименование маршрута 
6135 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6136 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6137 + 0
6138 + ]
6139 +}
6140 +)))
6141 +
6142 +
6143 +== **Получить связки маршрутов ТС** ==
6144 +
6145 +(% class="box infomessage" %)
6146 +(((
6147 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6148 +)))
6149 +
6150 +Пример запроса:
6151 +
6152 +(((
6153 +[
6154 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6155 +]
6156 +)))
6157 +
6158 +
6159 +Пример ответа:
6160 +
6161 +(((
6162 +[
6163 + {
6164 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6165 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6166 + }
6167 +]
6168 +)))
6169 +
6170 +
6171 +== **Удалить маршрут** ==
6172 +
6173 +(% class="box warningmessage" %)
6174 +(((
6175 +**DELETE /api/v3/TransportRoutes/{id}**
6176 +)))
6177 +
6178 +Пример запроса:
6179 +Id  ~/~/ Идентификатор поля
6180 +
6181 +
6182 +==== ====
6183 +
6184 += **Раздел: Управление доступа к машинам** =
6185 +
6186 +
6187 +== Получение списка транспортных средств видимых пользователю ==
6188 +
6189 +(% class="box infomessage" %)
6190 +(((
6191 +**GET /api/v3/UserVisibleVehicles/{userId}**
6192 +)))
6193 +
6194 +Пример ответа:
6195 +
6196 +(((
6197 +{
6198 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6199 + 0
6200 + ]
6201 +}
6202 +)))
6203 +
6204 +
6205 +
6206 +== Задает видимость транспортных средств пользователю ==
6207 +
6208 +(% class="box infomessage" %)
6209 +(((
6210 +**POST /api/v3/UserVisibleVehicles**
6211 +)))
6212 +
6213 +Пример запроса:
6214 +
6215 +(((
6216 +(((
6217 +{
6218 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6219 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6220 + 0
6221 + ]
6222 +}
6223 +)))
6224 +
6225 +(((
6226 +
6227 +)))
6228 +
6229 +(((
6230 +
6231 +)))
6232 +
6233 +(((
6234 +Пример ответа :
6235 +)))
6236 +
6237 +(((
6238 +
6239 +)))
6240 +
6241 +(((
6242 +200 ~/~/ Success
6243 +)))
6244 +)))
6245 +
6246 +
6247 +
6248 +
6249 +
6250 +
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 г.