Редактировал(а) Андрей Калиновский 2025/04/24 15:46
<
От версии < 212.5 >
отредактировано Андрей Калиновский
на 2025/03/12 10:28
К версии < 224.1 >
отредактировано Андрей Калиновский
на 2025/04/24 15:44
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Содержимое
... ... @@ -11,6 +11,11 @@
11 11  
12 12  В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов.
13 13  
14 +(% class="box infomessage" %)
15 +(((
16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя.
17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему.
18 +)))
14 14  
15 15  **Содержание страницы:**
16 16  )))
... ... @@ -118,29 +118,41 @@
118 118  Запрос должен содержать данные параметра "**agentId**"
119 119  
120 120  (% style="color:#000000" %)Ответ:
126 +
127 +(((
121 121  {
122 - "agentId": "",  (%%)
123 - "parentId": "",
124 - "parentName": "string",
125 - "name": "string",
126 - "fullName": "string",
127 - "agentInfoType": 0,
128 - "isForeign": true/false,
129 - "district": "string", 
130 - "region": "string",
131 - "city": "string",
132 - "inn": "string",
133 - "kpp": "string",
134 - "address": "string",
135 - "addressFact": "string",
136 - "email": "string",
137 - "director": "string",
138 - "bankName": "string",
139 - "bankBIK": "string",
140 - "bankRS": "string",
141 - "bankKS": "string"
142 - }
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 +)))
143 143  
160 +
144 144  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
145 145  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
146 146  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
... ... @@ -2512,6 +2512,8 @@
2512 2512   "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода
2513 2513   "fuelConsumption": 0, ~/~/ Расход топлива
2514 2514   "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении
2532 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне
2533 +
2515 2515   }
2516 2516   ]
2517 2517   }
... ... @@ -2557,7 +2557,8 @@
2557 2557   "model": "string", ~/~/ Модель объекта
2558 2558   "fuels": [ ~/~/ Массив данным по заправкам и сливам
2559 2559   {
2560 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив
2579 + "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling
2580 +
2561 2561   "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало
2562 2562   "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание
2563 2563   "valueFuel": 0, ~/~/ Количество
... ... @@ -2786,6 +2786,35 @@
2786 2786   }
2787 2787  ]
2788 2788  
2809 +
2810 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) ==
2811 +
2812 +(% class="box successmessage" %)
2813 +(((
2814 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis**
2815 +)))
2816 +
2817 +(% style="color:#000000" %)Метод запроса: **PUT**
2818 +
2819 +Пример запроса:
2820 +
2821 +(((
2822 +{
2823 + "id": 0,  ~/~/ Идентификатор объекта геозоны
2824 + "name": "string",  ~/~/ Наименование объекта геозоны
2825 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
2826 + "description": "string", ~/~/ Описание объекта геозоны
2827 + "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
2828 + "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
2829 + "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
2830 +}
2831 +)))
2832 +
2833 +
2834 +Пример ответа:
2835 +
2836 +200 ~/~/ Success
2837 +
2789 2789  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) =
2790 2790  
2791 2791  == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) ==
... ... @@ -4802,8 +4802,51 @@
4802 4802   }
4803 4803   ]
4804 4804  }
4854 +
4855 +
4856 +== **Превышение скорости** ==
4857 +
4858 +(% class="box infomessage" %)
4859 +(((
4860 +**POST /api/v3/Reports/overSpeedDuration**
4805 4805  )))
4806 4806  
4863 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение).
4864 +
4865 +Пример запроса:
4866 +
4867 +(((
4868 +{
4869 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства
4870 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента)
4871 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента)
4872 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK
4873 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 
4874 +}
4875 +)))
4876 +
4877 +(((
4878 +
4879 +)))
4880 +
4881 +(((
4882 +Пример ответа:
4883 +)))
4884 +
4885 +(((
4886 +(((
4887 +[
4888 + {
4889 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/  Дата и время события 
4890 + "duration": 0, ~/~/ Продолжительность события в секундах 
4891 + "maxSpeed": 0, ~/~/ Максимальная скорость 
4892 + "speedLimit": 0 ~/~/ Ограничение скорости 
4893 + }
4894 +]
4895 +)))
4896 +)))
4897 +)))
4898 +
4807 4807  = (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) =
4808 4808  
4809 4809  
... ... @@ -4878,13 +4878,16 @@
4878 4878  **POST /api/v3/agroLands**
4879 4879  )))
4880 4880  
4973 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 
4974 +X-agent  - ID клиента
4975 +
4881 4881  Пример запроса:
4882 4882  
4883 4883  (((
4884 4884  {
4885 4885   "extId": "string", 
4886 - "shape": "string", ~/~/ Форма поля
4887 - "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля
4981 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля
4982 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля
4888 4888   "display": "string", ~/~/ Настройки отображения
4889 4889   "year": 0, ~/~/ Год поля
4890 4890   "name": "string", ~/~/ Наименование
... ... @@ -5926,7 +5926,216 @@
5926 5926  
5927 5927  
5928 5928  
6024 += **Раздел: Яндекс Маршруты** =
5929 5929  
6026 +
6027 +== **Возвращение списка маршрутов** ==
6028 +
6029 +(% class="box infomessage" %)
6030 +(((
6031 +**GET /api/v3/TransportRoutes**
6032 +)))
6033 +
6034 +Пример запроса:
6035 +Id  ~/~/ Идентификатор поля
6036 +
6037 +
6038 +Пример ответа:
6039 +
6040 +(((
6041 +[
6042 + {
6043 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
6044 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6045 + "name": "string", ~/~/ Наименование маршрута.
6046 + "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6047 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6048 + 0
6049 + ]
6050 + }
6051 +]
6052 +)))
6053 +
6054 +
6055 +
6056 +== **Добавить маршрут** ==
6057 +
6058 +(% class="box infomessage" %)
6059 +(((
6060 +**POST /api/v3/TransportRoutes**
6061 +)))
6062 +
6063 +Пример запроса: 
6064 +{
6065 + "name": "string",  ~/~/  Опредлеляет наименование маршрута.
6066 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6067 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
6068 + "vehicles": [  ~/~/ Определяет список ТС для маршрута
6069 + 0
6070 + ]
6071 +}
6072 +
6073 +
6074 +Пример ответа:
6075 +
6076 +(((
6077 +{
6078 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6079 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6080 + "name": "string", ~/~/ Определяет наименование маршрута 
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 +(% class="box successmessage" %)
6092 +(((
6093 +**PUT /api/v3/TransportRoutes**
6094 +)))
6095 +
6096 +Пример запроса:
6097 +
6098 +(((
6099 +{
6100 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
6101 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
6102 + "name": "string", ~/~/ Опредлеляет наименование маршрута.
6103 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
6104 + "vehicles": [ ~/~/ Определяет список ТС для маршрута
6105 + 0
6106 + ]
6107 +}
6108 +)))
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 +(% class="box infomessage" %)
6129 +(((
6130 +**POST /api/v3/TransportRoutes/getroutesvehicles**
6131 +)))
6132 +
6133 +Пример запроса:
6134 +
6135 +(((
6136 +[
6137 + "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
6138 +]
6139 +)))
6140 +
6141 +
6142 +Пример ответа:
6143 +
6144 +(((
6145 +[
6146 + {
6147 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
6148 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
6149 + }
6150 +]
6151 +)))
6152 +
6153 +
6154 +== **Удалить маршрут** ==
6155 +
6156 +(% class="box warningmessage" %)
6157 +(((
6158 +**DELETE /api/v3/TransportRoutes/{id}**
6159 +)))
6160 +
6161 +Пример запроса:
6162 +Id  ~/~/ Идентификатор поля
6163 +
6164 +
6165 +==== ====
6166 +
6167 += **Раздел: Управление доступа к машинам** =
6168 +
6169 +
6170 +== Получение списка транспортных средств видимых пользователю ==
6171 +
6172 +(% class="box infomessage" %)
6173 +(((
6174 +**GET /api/v3/UserVisibleVehicles/{userId}**
6175 +)))
6176 +
6177 +Пример ответа:
6178 +
6179 +(((
6180 +{
6181 + "vehicleIds": [  ~/~/ Идентификаторы ТС
6182 + 0
6183 + ]
6184 +}
6185 +)))
6186 +
6187 +
6188 +
6189 +== Задает видимость транспортных средств пользователю ==
6190 +
6191 +(% class="box infomessage" %)
6192 +(((
6193 +**POST /api/v3/UserVisibleVehicles**
6194 +)))
6195 +
6196 +Пример запроса:
6197 +
6198 +(((
6199 +(((
6200 +{
6201 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
6202 + "vehicleIds": [ ~/~/ Идентификаторы ТС
6203 + 0
6204 + ]
6205 +}
6206 +)))
6207 +
6208 +(((
6209 +
6210 +)))
6211 +
6212 +(((
6213 +
6214 +)))
6215 +
6216 +(((
6217 +Пример ответа :
6218 +)))
6219 +
6220 +(((
6221 +
6222 +)))
6223 +
6224 +(((
6225 +200 ~/~/ Success
6226 +)))
6227 +)))
6228 +
6229 +
6230 +
6231 +
6232 +
6233 +
5930 5930  (% class="box" lang="en-US" style="text-align: center;" %)
5931 5931  (((
5932 5932  (% 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 г.