Изменения документа Дополнительные API методы

Редактировал(а) Павел Субботин 2025/12/09 14:16
<
От версии < 7.1 >
отредактировано Павел Субботин
на 2025/12/09 14:16
К версии < 3.1 >
отредактировано Андрей Калиновский
на 2025/08/25 16:03
>
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Автор документа
... ... @@ -1,1 +1,1 @@
1 -XWiki.subbotinpa
1 +XWiki.Gadmin
Содержимое
... ... @@ -6,486 +6,6 @@
6 6  == Управление подразделениями ==
7 7  
8 8  
9 -=== Поиск подразделения ===
10 10  
11 -(% class="box infomessage" %)
12 -(((
13 -**POST /api/v3/Units/find **
14 -)))
15 15  
16 -Пример запроса: 
17 -
18 -
19 -{
20 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 
21 - "name": "string", ~/~/ Наименование подразделения 
22 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента-родителя
23 -}
24 -
25 -
26 -Пример ответа:
27 -
28 -[
29 - {
30 - "name": "string", ~/~/ Наименование подразделения 
31 - "description": "string", ~/~/ Дополнительное описание
32 - "color": "string", ~/~/ Цвет 
33 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 
34 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-родителя
35 - "deleted": true ~/~/ Признак удаления 
36 - }
37 -
38 -
39 -=== Добавление подразделения ===
40 -
41 -(% class="box successmessage" %)
42 -(((
43 -**POST /api/v3/Units**
44 -)))
45 -
46 -
47 -Пример запроса:
48 -
49 -
50 -{
51 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
52 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца
53 - "name": "string", ~/~/ Наименование
54 - "description": "string", ~/~/ Дополнительное описание
55 - "color": "string", ~/~/ Цвет
56 - "extId": "string" ~/~/ extId
57 -}
58 -
59 -
60 -Пример ответа:
61 -
62 -{
63 - "name": "string", ~/~/ Наименование
64 - "description": "string", ~/~/ Дополнительное описание
65 - "color": "string", ~/~/ Цвет
66 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 
67 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
68 - "deleted": true ~/~/ Признак удаления 
69 -}
70 -
71 -
72 -=== Редактирование подразделения ===
73 -
74 -(% class="box errormessage" %)
75 -(((
76 -**PUT /api/v3/Units**
77 -)))
78 -
79 -Пример запроса:
80 -
81 -{
82 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 
83 - "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца
84 - "name": "string", ~/~/ Наименование
85 - "description": "string", ~/~/ Дополнительное описание
86 - "color": "string", ~/~/ Цвет
87 - "extId": "string" ~/~/ extId
88 -}
89 -
90 -
91 -Пример ответа:
92 -
93 -{
94 - "name": "string", ~/~/ Наименование
95 - "description": "string", ~/~/ Дополнительное описание
96 - "color": "string", ~/~/ Цвет
97 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
98 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
99 - "deleted": true ~/~/ Признак удаления
100 -}
101 -
102 -
103 -
104 -=== Удаление подразделения ===
105 -
106 -(% class="box errormessage" %)
107 -(((
108 -**DELETE /api/v3/Units/{unitId}**
109 -)))
110 -
111 -unitId - Guid подразделения
112 -
113 -
114 -Пример ответа:
115 -
116 -200 ~/~/ Success
117 -
118 -
119 -
120 120  == Управление группами ==
121 -
122 -
123 -=== Получить информацию группы по идентификатору группы ===
124 -
125 -(% class="box infomessage" %)
126 -(((
127 -**GET /api/v3/VehiclesGroups/{groupId}**
128 -)))
129 -
130 -groupId - Идентификатор группы
131 -
132 -
133 -Пример ответа:
134 -
135 -{ 
136 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
137 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
138 - "Name": "string", ~/~/ Наименование группы
139 - "VehiclesIds": [ 
140 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы. 
141 - ],
142 - "ModelsIds": [
143 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
144 - ],
145 - "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
146 -}
147 -
148 -
149 -=== Удалить группу ===
150 -
151 -(% class="box errormessage" %)
152 -(((
153 -**DELETE /api/v3/VehiclesGroups/{groupId}**
154 -)))
155 -
156 -groupId - Идентификатор группы
157 -
158 -
159 -Пример ответа:
160 -
161 -200 ~/~/ Success
162 -
163 -
164 -
165 -=== Получить информацию группы по идентификатору клиента ===
166 -
167 -(% class="box infomessage" %)
168 -(((
169 -**GET /api/v3/VehiclesGroups/list/{agentId}**
170 -)))
171 -
172 -agentId - Идентификатор клиента
173 -
174 -
175 -Пример ответа:
176 -
177 -[
178 - {
179 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
180 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
181 - "Name": "string", ~/~/ Наименование группы.
182 - "VehiclesIds": [ 
183 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
184 - ],
185 - "ModelsIds": [
186 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
187 - ],
188 - "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
189 - }
190 -]
191 -
192 -
193 -=== Создать группу ===
194 -
195 -(% class="box successmessage" %)
196 -(((
197 -**POST /api/v3/VehiclesGroups**
198 -)))
199 -
200 -Пример запроса: 
201 -{
202 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
203 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
204 - "Name": "string", ~/~/ Наименование группы.
205 - "VehiclesIds": [
206 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
207 - ],
208 - "ModelsIds": [
209 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
210 - ],
211 - "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
212 -}
213 -
214 -
215 -Пример ответа:
216 -
217 -{
218 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
219 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
220 - "Name": "string", ~/~/ Наименование группы.
221 - "VehiclesIds": [
222 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
223 - ],
224 - "ModelsIds": [
225 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
226 - ],
227 - "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
228 -}
229 -
230 -
231 -=== Изменить группу ===
232 -
233 -(% class="box warningmessage" %)
234 -(((
235 -**PUT /api/v3/VehiclesGroups**
236 -)))
237 -
238 -Пример запроса:
239 -
240 -{
241 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
242 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
243 - "Name": "string", ~/~/ Наименование группы.
244 - "VehiclesIds": [
245 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
246 - ],
247 - "ModelsIds": [
248 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
249 - ],
250 - "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
251 -}
252 -
253 -
254 -Пример ответа:
255 -
256 -{
257 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор группы.
258 - "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор владельца.
259 - "Name": "string", ~/~/ Наименование группы.
260 - "VehiclesIds": [
261 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы объектов группы.
262 - ],
263 - "ModelsIds": [
264 - "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы моделей объектов группы.
265 - ],
266 - "Type": 0 ~/~/ Тип группировки: 0 - по объектам, 1 - по моделям объектов
267 -}
268 -
269 -
270 -= **Раздел: Яндекс Маршруты** =
271 -
272 -
273 -== **Возвращение списка маршрутов** ==
274 -
275 -(% class="box infomessage" %)
276 -(((
277 -**GET /api/v3/TransportRoutes**
278 -)))
279 -
280 -Пример запроса:
281 -Id  ~/~/ Идентификатор поля
282 -
283 -Пример ответа:
284 -
285 -[
286 - {
287 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 
288 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
289 - "name": "string", ~/~/ Наименование маршрута.
290 - "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
291 - "vehicles": [  ~/~/ Определяет список ТС для маршрута
292 - 0
293 - ]
294 - }
295 -]
296 -
297 -
298 -== **Добавить маршрут** ==
299 -
300 -(% class="box successmessage" %)
301 -(((
302 -**POST /api/v3/TransportRoutes**
303 -)))
304 -
305 -Пример запроса: 
306 -{
307 - "name": "string",  ~/~/  Опредлеляет наименование маршрута.
308 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
309 - "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
310 - "vehicles": [  ~/~/ Определяет список ТС для маршрута
311 - 0
312 - ]
313 -}
314 -
315 -
316 -Пример ответа:
317 -
318 -{
319 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
320 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
321 - "name": "string", ~/~/ Определяет наименование маршрута 
322 - "kind": 0,  ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 
323 - "vehicles": [ ~/~/ Определяет список ТС для маршрута
324 - 0
325 - ]
326 -}
327 -
328 -
329 -== **Обновление маршрута** ==
330 -
331 -(% class="box warningmessage" %)
332 -(((
333 -**PUT /api/v3/TransportRoutes**
334 -)))
335 -
336 -Пример запроса:
337 -
338 -{
339 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
340 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
341 - "name": "string", ~/~/ Опредлеляет наименование маршрута.
342 - "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water)
343 - "vehicles": [ ~/~/ Определяет список ТС для маршрута
344 - 0
345 - ]
346 -}
347 -
348 -Пример ответа:
349 -
350 -{
351 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID
352 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут
353 - "name": "string", ~/~/ Определяет наименование маршрута 
354 - "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water )
355 - "vehicles": [ ~/~/ Определяет список ТС для маршрута
356 - 0
357 - ]
358 -}
359 -
360 -
361 -== **Получить связки маршрутов ТС** ==
362 -
363 -(% class="box successmessage" %)
364 -(((
365 -**POST /api/v3/TransportRoutes/getroutesvehicles**
366 -)))
367 -
368 -Пример запроса:
369 -
370 -[
371 - "3fa85f64-5717-4562-b3fc-2c963f66afa6"  ~/~/ идентификатор маршрута
372 -]
373 -
374 -Пример ответа:
375 -
376 -[
377 - {
378 - "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС
379 - "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута
380 - }
381 -]
382 -
383 -
384 -== **Удалить маршрут** ==
385 -
386 -(% class="box errormessage" %)
387 -(((
388 -**DELETE /api/v3/TransportRoutes/{id}**
389 -)))
390 -
391 -Пример запроса:
392 -Id  ~/~/ Идентификатор поля
393 -
394 -
395 -= **Раздел: Управление доступа к машинам** =
396 -
397 -
398 -== Получение списка транспортных средств видимых пользователю ==
399 -
400 -(% class="box infomessage" %)
401 -(((
402 -**GET /api/v3/UserVisibleVehicles/{userId}**
403 -)))
404 -
405 -Пример ответа:
406 -
407 -{
408 - "vehicleIds": [  ~/~/ Идентификаторы ТС
409 - 0
410 - ]
411 -}
412 -
413 -
414 -== Задает видимость транспортных средств пользователю ==
415 -
416 -(% class="box successmessage" %)
417 -(((
418 -**POST /api/v3/UserVisibleVehicles**
419 -)))
420 -
421 -Пример запроса:
422 -
423 -{
424 - "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Идентификатор пользователя
425 - "vehicleIds": [ ~/~/ Идентификаторы ТС
426 - 0
427 - ]
428 -}
429 -
430 -
431 -Пример ответа :
432 -
433 -
434 -200 ~/~/ Success
435 -
436 -
437 -
438 -== Фотомониторинг ==
439 -
440 -
441 -=== Получение списка фотографий ===
442 -
443 -(% class="box successmessage" %)
444 -(((
445 -**POST /api/v3/DevicePhoto/getByPeriod**
446 -)))
447 -
448 -Пример запроса:
449 -
450 -(((
451 -{
452 - "vehicleId": 0, ~/~/ ID ТС, для которого запрашиваются данные
453 - "from": "2025-12-09T11:01:12.441Z", ~/~/ Дата и время начала периода
454 - "to": "2025-12-09T11:01:12.441Z" ~/~/ Дата и время окончания периода
455 -}
456 -)))
457 -
458 -
459 -Пример ответа:
460 -
461 -(((
462 -[
463 - {
464 - "vehicleId": 0, ~/~/ ID ТС
465 - "creationTime": "2025-12-09T11:01:12.472Z", ~/~/ Дата и время создания файла.
466 - "name": "string", ~/~/ Наименование файла 
467 - "fileUrl": "string", ~/~/ URL адреса файла изображения.
468 - "latitude": 0, ~/~/ Широта
469 - "longitude": 0 ~/~/ Долгота
470 - }
471 -]
472 -)))
473 -
474 -
475 -
476 -
477 -
478 -
479 -
480 -
481 -
482 -
483 -
484 -
485 -
486 -
487 -
488 -
489 -
490 -
491 -

Меню

ГЛОНАССSoft wiki - 2024 г.