Редактировал(а) Андрей Калиновский 2025/06/10 15:42
<
От версии < 227.1 >
отредактировано Андрей Калиновский
на 2025/05/06 11:45
К версии < 215.1 >
отредактировано Андрей Калиновский
на 2025/03/25 13:59
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Содержимое
... ... @@ -123,41 +123,29 @@
123 123  Запрос должен содержать данные параметра "**agentId**"
124 124  
125 125  (% style="color:#000000" %)Ответ:
126 -
127 -(((
128 128  {
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 -)))
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 + }
159 159  
160 -
161 161  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
162 162  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
163 163  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
... ... @@ -1628,10 +1628,81 @@
1628 1628  - при задании сезонной нормы обязательны соответствующие даты начала/окончания.
1629 1629  
1630 1630  
1631 -(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**
1619 +== **Импортировать историю ТС (Асинхронный запрос)** ==
1632 1632  
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 +
1633 1633  (% class="box infomessage" %)
1634 1634  (((
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 +(((
1635 1635  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1636 1636  )))
1637 1637  
... ... @@ -2735,35 +2735,6 @@
2735 2735   }
2736 2736  ]
2737 2737  
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 -
2767 2767  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2768 2768  
2769 2769  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -4248,51 +4248,6 @@
4248 4248  |producedCount|Кол-во успешно отправленных в шину данных сообщений
4249 4249  |msgCount|Кол-во обработанных сообщений всего
4250 4250  
4251 -(% class="wikigeneratedid" %)
4252 -== ==
4253 -
4254 -== **Импортировать историю ТС (Асинхронный запрос)** ==
4255 -
4256 -(% class="box successmessage" %)
4257 -(((
4258 -**POST /api/v3/Vehicles/importAsync/history/{vehicleId} **
4259 -)))
4260 -
4261 -При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос.
4262 -
4263 -Метод запроса: **POST**
4264 -
4265 -URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} **
4266 -
4267 -Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства
4268 -
4269 -
4270 -Ответ:
4271 -
4272 -{
4273 -
4274 - "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса
4275 -
4276 - "Status": 0, ~/~/ Перечисление состояний выполнения запроса
4277 -
4278 -~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest)
4279 -
4280 - "Message": "string", ~/~/ Информация о выполнении запроса
4281 -
4282 - "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None)
4283 -
4284 - "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress
4285 -
4286 - "Data": "string" ~/~/ Данные
4287 -
4288 -}
4289 -
4290 -
4291 -== ==
4292 -
4293 -(% class="wikigeneratedid" %)
4294 -== ==
4295 -
4296 4296  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
4297 4297  
4298 4298  (% class="box infomessage" %)
... ... @@ -4314,46 +4314,6 @@
4314 4314  |activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
4315 4315  |progress|Guid ТС
4316 4316  
4317 -(% class="wikigeneratedid" %)
4318 -== ==
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" %)
... ... @@ -4865,51 +4865,8 @@
4865 4865   }
4866 4866   ]
4867 4867  }
4868 -
4869 -
4870 -== **Превышение скорости** ==
4871 -
4872 -(% class="box infomessage" %)
4873 -(((
4874 -**POST /api/v3/Reports/overSpeedDuration**
4875 4875  )))
4876 4876  
4877 - Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4878 -
4879 -Пример запроса:
4880 -
4881 -(((
4882 -{
4883 - "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4884 - "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4885 - "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4886 - "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4887 - "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4888 -}
4889 -)))
4890 -
4891 -(((
4892 -
4893 -)))
4894 -
4895 -(((
4896 -Пример ответа:
4897 -)))
4898 -
4899 -(((
4900 -(((
4901 -[
4902 - {
4903 - "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4904 - "duration": 0, ~/~/ Продолжительность события в секундах 
4905 - "maxSpeed": 0, ~/~/ Максимальная скорость 
4906 - "speedLimit": 0 ~/~/ Ограничение скорости 
4907 - }
4908 -]
4909 -)))
4910 -)))
4911 -)))
4912 -
4913 4913  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4914 4914  
4915 4915  
... ... @@ -6035,216 +6035,7 @@
6035 6035  
6036 6036  
6037 6037  
6038 -= **Раздел: Яндекс Маршруты** =
6039 6039  
6040 -
6041 -== **Возвращение списка маршрутов** ==
6042 -
6043 -(% class="box infomessage" %)
6044 -(((
6045 -**GET /api/v3/TransportRoutes**
6046 -)))
6047 -
6048 -Пример запроса:
6049 -Id  ~/~/ Идентификатор поля
6050 -
6051 -
6052 -Пример ответа:
6053 -
6054 -(((
6055 -[
6056 - {
6057 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6058 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6059 - "name": "string", ~/~/ Наименование маршрута.
6060 - "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6061 - "vehicles": [  ~/~/ Определяет список ТС для маршрута
6062 - 0
6063 - ]
6064 - }
6065 -]
6066 -)))
6067 -
6068 -
6069 -
6070 -== **Добавить маршрут** ==
6071 -
6072 -(% class="box infomessage" %)
6073 -(((
6074 -**POST /api/v3/TransportRoutes**
6075 -)))
6076 -
6077 -Пример запроса: 
6078 -{
6079 - "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6080 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6081 - "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6082 - "vehicles": [  ~/~/ Определяет список ТС для маршрута
6083 - 0
6084 - ]
6085 -}
6086 -
6087 -
6088 -Пример ответа:
6089 -
6090 -(((
6091 -{
6092 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6093 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6094 - "name": "string", ~/~/ Определяет наименование маршрута 
6095 - "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
6096 - "vehicles": [ ~/~/ Определяет список ТС для маршрута
6097 - 0
6098 - ]
6099 -}
6100 -)))
6101 -
6102 -
6103 -== **Обновление маршрута** ==
6104 -
6105 -(% class="box successmessage" %)
6106 -(((
6107 -**PUT /api/v3/TransportRoutes**
6108 -)))
6109 -
6110 -Пример запроса:
6111 -
6112 -(((
6113 -{
6114 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6115 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6116 - "name": "string", ~/~/ Опредлеляет наименование маршрута.
6117 - "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6118 - "vehicles": [ ~/~/ Определяет список ТС для маршрута
6119 - 0
6120 - ]
6121 -}
6122 -)))
6123 -
6124 -
6125 -Пример ответа:
6126 -
6127 -(((
6128 -{
6129 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6130 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6131 - "name": "string", ~/~/ Определяет наименование маршрута 
6132 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6133 - "vehicles": [ ~/~/ Определяет список ТС для маршрута
6134 - 0
6135 - ]
6136 -}
6137 -)))
6138 -
6139 -
6140 -== **Получить связки маршрутов ТС** ==
6141 -
6142 -(% class="box infomessage" %)
6143 -(((
6144 -**POST /api/v3/TransportRoutes/getroutesvehicles**
6145 -)))
6146 -
6147 -Пример запроса:
6148 -
6149 -(((
6150 -[
6151 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6152 -]
6153 -)))
6154 -
6155 -
6156 -Пример ответа:
6157 -
6158 -(((
6159 -[
6160 - {
6161 - "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6162 - "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6163 - }
6164 -]
6165 -)))
6166 -
6167 -
6168 -== **Удалить маршрут** ==
6169 -
6170 -(% class="box warningmessage" %)
6171 -(((
6172 -**DELETE /api/v3/TransportRoutes/{id}**
6173 -)))
6174 -
6175 -Пример запроса:
6176 -Id  ~/~/ Идентификатор поля
6177 -
6178 -
6179 -==== ====
6180 -
6181 -= **Раздел: Управление доступа к машинам** =
6182 -
6183 -
6184 -== Получение списка транспортных средств видимых пользователю ==
6185 -
6186 -(% class="box infomessage" %)
6187 -(((
6188 -**GET /api/v3/UserVisibleVehicles/{userId}**
6189 -)))
6190 -
6191 -Пример ответа:
6192 -
6193 -(((
6194 -{
6195 - "vehicleIds": [  ~/~/ Идентификаторы ТС
6196 - 0
6197 - ]
6198 -}
6199 -)))
6200 -
6201 -
6202 -
6203 -== Задает видимость транспортных средств пользователю ==
6204 -
6205 -(% class="box infomessage" %)
6206 -(((
6207 -**POST /api/v3/UserVisibleVehicles**
6208 -)))
6209 -
6210 -Пример запроса:
6211 -
6212 -(((
6213 -(((
6214 -{
6215 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6216 - "vehicleIds": [ ~/~/ Идентификаторы ТС
6217 - 0
6218 - ]
6219 -}
6220 -)))
6221 -
6222 -(((
6223 -
6224 -)))
6225 -
6226 -(((
6227 -
6228 -)))
6229 -
6230 -(((
6231 -Пример ответа :
6232 -)))
6233 -
6234 -(((
6235 -
6236 -)))
6237 -
6238 -(((
6239 -200 ~/~/ Success
6240 -)))
6241 -)))
6242 -
6243 -
6244 -
6245 -
6246 -
6247 -
6248 6248  (% class="box" lang="en-US" style="text-align: center;" %)
6249 6249  (((
6250 6250  (% 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 г.