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