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

Редактировал(а) Андрей Калиновский 2025/10/23 15:13
<
От версии < 8.1
отредактировано Андрей Калиновский
на 2025/10/23 15:13
К версии < 5.1 >
отредактировано Андрей Калиновский
на 2025/08/25 16:45
Изменить комментарий: К данной версии нет комментариев

Комментарий

Подробности

Icon Свойства страницы
Содержимое
... ... @@ -3,7 +3,7 @@
3 3  {{toc/}}
4 4  
5 5  
6 -== Раздел: Управление подразделениями ==
6 +== Управление подразделениями ==
7 7  
8 8  
9 9  === Поиск подразделения ===
... ... @@ -120,7 +120,7 @@
120 120  == Управление группами ==
121 121  
122 122  
123 -=== Получить информацию группы по идентификатору группы ===
123 +=== Получить информацию группы по идентификатору группы ===
124 124  
125 125  (% class="box infomessage" %)
126 126  (((
... ... @@ -146,7 +146,7 @@
146 146  }
147 147  
148 148  
149 -=== Удалить группу ===
149 +=== Удалить группу ===
150 150  
151 151  (% class="box errormessage" %)
152 152  (((
... ... @@ -190,7 +190,7 @@
190 190  ]
191 191  
192 192  
193 -=== Создать группу ===
193 +=== Создать группу ===
194 194  
195 195  (% class="box successmessage" %)
196 196  (((
... ... @@ -228,7 +228,7 @@
228 228  }
229 229  
230 230  
231 -=== Изменить группу ===
231 +=== Изменить группу ===
232 232  
233 233  (% class="box warningmessage" %)
234 234  (((
... ... @@ -268,381 +268,12 @@
268 268  
269 269  
270 270  
271 -== Раздел: **Запрос посещений геообъектов** ==
272 272  
273 -=== **Получение списка всех геообъектов** ===
274 274  
275 -(% class="box successmessage" %)
276 -(((
277 -**~ POST /api/v3/gis/find**
278 -)))
279 279  
280 -Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них.
281 281  
282 -Метод запроса: **POST**
283 283  
284 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/gis/find
285 285  
286 -В заголовках запроса: X-Auth: Токен авторизации
287 287  
288 -Тело запроса:
289 289  
290 -{
291 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента, для которого надо получить данные
292 -}
293 -
294 -Ответ:
295 -
296 -[
297 - {
298 - "id": 0, ~/~/ Идентификатор объекта геозоны
299 - "name": "string", ~/~/ Название объекта геозоны
300 - "type": 0, ~/~/ Тип объекта геозоны
301 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
302 - "fname": "string", ~/~/ Имя файла
303 - "parentId": "string", ~/~/ Идентификатор клиента
304 - "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета
305 - "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета
306 - "description": "string", ~/~/ Описание
307 - "area": 0, ~/~/ Площадь, м^^2^^
308 - "perimetr": 0, ~/~/ Периметр, м
309 - "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания
310 - }
311 -]
312 -
313 -=== **Запрос пересечений по объектам** ===
314 -
315 -(% class="box successmessage" %)
316 -(((
317 -**~ POST /api/v3/gis/intersections/vehicles**
318 -)))
319 -
320 -Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период.
321 -
322 -Метод запроса: **POST**
323 -
324 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles
325 -
326 -В заголовках запроса: X-Auth: Токен авторизации
327 -
328 -Тело запроса:
329 -
330 -{
331 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
332 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
333 - "ids": [ ], ~/~/ Массив id объектов
334 - "byTime": 0, ~/~/ Объединение событий по времени 
335 - "byDist": 0, ~/~/ Объединение событий по расстоянию
336 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
337 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
338 -}
339 -
340 -Ответ:
341 -[
342 - {
343 - "geozoneId": 0, ~/~/ ID геообъекта
344 - "geozoneName": "string", ~/~/ Название геообъекта
345 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
346 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
347 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
348 - "vehicleId": 0, ~/~/ ID объекта
349 - "vehicleName": "string" ~/~/ Имя объекта
350 - }
351 -]
352 -
353 -=== **Запрос пересечений по геообъектам** ===
354 -
355 -(% class="box successmessage" %)
356 -(((
357 -**~ POST /api/v3/gis/intersections/geozones**
358 -)))
359 -
360 -Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период.
361 -
362 -Метод запроса: **POST**
363 -
364 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones
365 -
366 -В заголовках запроса: X-Auth: Токен авторизации
367 -
368 -Тело запроса:
369 -
370 -{
371 - "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса
372 - "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания
373 - "ids": [ ], ~/~/ Массив id геообъектов
374 - "byTime": 0, ~/~/ Объединение событий по времени 
375 - "byDist": 0, ~/~/ Объединение событий по расстоянию
376 - "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
377 - "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра
378 -}
379 -
380 -Ответ:
381 -
382 -[
383 - {
384 - "geozoneId": 0, ~/~/ ID геообъекта
385 - "geozoneName": "string", ~/~/ Название геообъекта
386 - "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда
387 - "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда
388 - "duration": 0, ~/~/ Продолжительность нахождения в геообъекте
389 - "vehicleId": 0, ~/~/ ID объекта
390 - "vehicleName": "string" ~/~/ Имя объекта
391 - }
392 -]
393 -
394 -
395 -=== **Обновить информацию по геозоне** ===
396 -
397 -(% class="box warningmessage" %)
398 -(((
399 -**~ PUT /api/v3/gis**
400 -)))
401 -
402 -Метод запроса: **PUT**
403 -
404 -Пример запроса:
405 -
406 -{
407 - "id": 0,  ~/~/ Идентификатор объекта геозоны
408 - "name": "string",  ~/~/ Наименование объекта геозоны
409 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Подразделение
410 - "description": "string", ~/~/ Описание объекта геозоны
411 - "beginCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата начала расчетов для геозоны
412 - "endCalc": "2025-04-24T12:10:28.751Z",  ~/~/ Дата окончания расчетов для геозоны
413 - "settingsData": "string"  ~/~/ Параметры отображения в формате XML.
414 - "type": 0, ~/~/ Тип геозоны - линия,полигон
415 - "radius": 0, ~/~/ Радиус геозоны
416 - "shape": "string", ~/~/ Координаты геозоны
417 - "shape_format": "string" ~/~/ Формат xml,json
418 -
419 -}
420 -
421 -
422 -Пример ответа:
423 -
424 -200 ~/~/ Success
425 -
426 -
427 -
428 -=== **Получение информации о геозоне по ID геозоны** ===
429 -
430 -(% class="box infomessage" %)
431 -(((
432 -**GET /api/v3/gis/{geozoneId}**
433 -)))
434 -
435 -geozoneId ~/~/ id геозоны
436 -
437 -
438 -Пример ответа:
439 -
440 -(((
441 -{
442 - "id": 0, ~/~/ Идентификатор объекта геозоны
443 - "name": "string", ~/~/ Наименование объекта геозоны
444 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение
445 - "description": "string", ~/~/ Описание объекта геозоны
446 - "beginCalc": "2025-09-03T06:08:58.533Z", ~/~/ Дата начала расчетов для геозоны
447 - "endCalc": "2025-09-03T06:08:58.533Z", ~/~/ Дата окончания расчетов для геозоны
448 - "settingsData": "string", ~/~/ Параметры отображения в формате XML.
449 - "type": 0, ~/~/ Тип геозоны - линия,полигон
450 - "radius": 0, ~/~/ Радиус геозоны
451 - "shape": "string", ~/~/ Координаты геозоны
452 - "shape_format": "string" ~/~/ Формат xml,json 
453 -}
454 -)))
455 -
456 -
457 -
458 -=== **Создание геообъекта ** ===
459 -
460 -(% class="box successmessage" %)
461 -(((
462 -**POST /api/v3/gis**
463 -)))
464 -
465 -Пример запроса:
466 -
467 -(((
468 -{
469 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Наименование объекта геозоны
470 - "name": "string", ~/~/ Подразделение
471 - "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Описание объекта геозоны
472 - "description": "string", ~/~/ Дата начала расчетов для геозоны
473 - "beginCalc": "2025-09-03T06:13:08.168Z", ~/~/ Дата начала расчетов для геозоны
474 - "endCalc": "2025-09-03T06:13:08.168Z", ~/~/ Дата окончания расчетов для геозоны
475 - "settingsData": "string", ~/~/ Параметры отображения в формате XML
476 - "type": 0, ~/~/ Тип геозоны - линия,полигон
477 - "radius": 0, ~/~/ Радиус геозоны
478 - "shape": "string", ~/~/ Координаты геозоны
479 - "shape_format": "string" ~/~/ Формат xml,json
480 -}
481 -)))
482 -
483 -
484 -Пример ответа:
485 -
486 -200 ~/~/ Success
487 -
488 -
489 -=== **Удаление геообъекта ** ===
490 -
491 -(% class="box errormessage" %)
492 -(((
493 -**DELETE /api/v3/gis/{geozoneId}**
494 -)))
495 -
496 -geozoneId  ~/~/ Id геообъекта
497 -
498 -
499 -Пример ответа:
500 -
501 -200 ~/~/ Success
502 -
503 -
504 -
505 -== Раздел: **Команды для работы со справочником культуры** ==
506 -
507 -=== **Получение списка справочника культур по клиенту** ===
508 -
509 -(% class="box infomessage" %)
510 -(((
511 -**~ GET /api/v3/cultures/{id}**
512 -)))
513 -
514 -id ~/~/ id пользователя, для которого запрашивается информация
515 -
516 -
517 -Пример ответа:
518 -
519 -(((
520 520  
521 -)))
522 -
523 -(((
524 -[
525 - {
526 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели
527 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя
528 - "name": "string", ~/~/ Наименование
529 - "productivity": 0, ~/~/ Урожайность Ц/Га
530 - "color": "c633d6", ~/~/ Цвет 
531 - "picture": "Culture18" ~/~/ ссылка на изображение
532 - }
533 -]
534 -)))
535 -
536 -
537 -
538 -=== **Удалить запись из справочника культур по клиенту** ===
539 -
540 -(% class="box errormessage" %)
541 -(((
542 -**DELETE /api/v3/cultures/{id} **
543 -)))
544 -
545 -id ~/~/ id культуры
546 -
547 -
548 -Пример ответа:
549 -
550 -200 ~/~/ Success
551 -
552 -
553 -=== **Добавить запись в справочник культур по клиенту ** ===
554 -
555 -(% class="box successmessage" %)
556 -(((
557 -**POST /api/v3/cultures **
558 -)))
559 -
560 -Пример запроса:
561 -
562 -(((
563 -{
564 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/ Guid родителя
565 - "name": "string",  ~/~/  Наименование
566 - "productivity": 0,  ~/~/  Урожайность Ц/Га
567 - "color": "c633d6",  ~/~/  Цвет
568 - "picture": "Culture18"  ~/~/  Ссылка на изображение
569 -}
570 -)))
571 -
572 -
573 -Пример ответа:
574 -
575 -200 ~/~/ Success
576 -
577 -
578 -=== **Редактировать запись из списка справочника культур по клиенту** ===
579 -
580 -(% class="box warningmessage" %)
581 -(((
582 -**PUT /api/v3/cultures**
583 -)))
584 -
585 -Пример запроса:
586 -
587 -(((
588 -{
589 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/  ID модели
590 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  ~/~/  Guid родителя
591 - "name": "string",  ~/~/  Наименование
592 - "productivity": 0,  ~/~/ Урожайность Ц/Га
593 - "color": "c633d6",  ~/~/  Цвет
594 - "picture": "Culture18"  ~/~/  ссылка на изображение
595 -}
596 -)))
597 -
598 -
599 -Пример ответа:
600 -
601 -200 ~/~/ Success
602 -
603 -
604 -
605 -
606 -== **Раздел: Фотомониторинг** ==
607 -
608 -
609 -=== **Получение списка фотографий ** ===
610 -
611 -(% class="box successmessage" %)
612 -(((
613 -**POST /api/v3/DevicePhoto/getByPeriod**
614 -)))
615 -
616 -Пример запроса: 
617 -
618 -
619 -(((
620 -{
621 - "vehicleId": 0, ~/~/ ID ТС, для которого запрашиваются данные
622 - "from": "2025-10-23T12:01:03.727Z", ~/~/ Дата и время начала периода
623 - "to": "2025-10-23T12:01:03.727Z" ~/~/ Дата и время окончания периода
624 -}
625 -)))
626 -
627 -
628 -Пример ответа:
629 -
630 -(((
631 -[
632 - {
633 - "vehicleId": 0, ~/~/ ID ТС, для которого запрашиваются данные
634 - "creationTime": "2025-10-23T12:01:03.727Z", ~/~/ Время создания файла.
635 - "name": "string", ~/~/ Наименование.
636 - "fileUrl": "string", ~/~/ Адрес файла изображения.
637 - "latitude": 0, ~/~/ Широта
638 - "longitude": 0 ~/~/ Долгота.
639 - }
640 -]
641 -)))
642 -
643 -
644 -
645 -
646 -
647 -
648 -

Меню

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