Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 120.1 >
edited by Илья Крайнов
on 2023/11/27 09:31
To version < 115.1 >
edited by Илья Крайнов
on 2023/11/14 14:29
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -1921,6 +1921,61 @@
1921 1921   }
1922 1922  ]
1923 1923  
1924 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1925 +
1926 +(% class="box infomessage" %)
1927 +(((
1928 +**POST /api/v3/vehicles/export/history**
1929 +)))
1930 +
1931 +Метод возвращает список сообщений терминала объекта за выбранный период.
1932 +
1933 +(% style="text-align: left;" %)
1934 +Метод запроса **POST**
1935 +
1936 +(% style="text-align: left;" %)
1937 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1938 +
1939 +(% style="text-align: left;" %)
1940 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1941 +
1942 +{
1943 + "vehicleId": 0, ~/~/ ID объекта
1944 + "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1945 + "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1946 + "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1947 +}
1948 +
1949 +Ответ:
1950 +
1951 +Получаете файл. Сообщение: Code 200/Success
1952 +
1953 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1954 +
1955 +(% class="box infomessage" %)
1956 +(((
1957 +**GET /api/v3/vehicles/export/history/status**
1958 +)))
1959 +
1960 +Метод возвращает список сообщений терминала объекта за выбранный период.
1961 +
1962 +(% style="text-align: left;" %)
1963 +Метод запроса **GET**
1964 +
1965 +(% style="text-align: left;" %)
1966 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1967 +
1968 +(% style="text-align: left;" %)
1969 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1970 +
1971 +Ответ:
1972 +
1973 +{
1974 + "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1975 + "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1976 + "message": "string" ~/~/ текст описывающий статус.
1977 +}
1978 +
1924 1924  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1925 1925  
1926 1926  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -3029,6 +3029,7 @@
3029 3029  |Number|Название/номер агрегата
3030 3030  |Description|Текст примечания агрегата
3031 3031  
3087 +
3032 3032  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3033 3033  
3034 3034  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3050,19 +3050,13 @@
3050 3050   {
3051 3051   "name": "string",
3052 3052   "number": 0,
3053 - "period": 0,
3109 + "period": 0, ~/~/ Частота трансляции радиометки
3054 3054   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3055 3055   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3112 + "deleted": true
3056 3056   }
3057 3057  ]
3058 3058  
3059 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3060 -|parentId|ID клиента
3061 -|name|Название карты-метки
3062 -|number|Номер
3063 -|period|Период запросов в секундах (работает только для агрегатов)
3064 -|id|ID карты-метки
3065 -
3066 3066  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3067 3067  
3068 3068  (% class="box infomessage" %)
... ... @@ -3078,19 +3078,13 @@
3078 3078   {
3079 3079   "name": "string",
3080 3080   "number": 0,
3081 - "period": 0,
3131 + "period": 0, ~/~/ Частота трансляции радиометки
3082 3082   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3083 3083   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3134 + "deleted": true
3084 3084   }
3085 3085  ]
3086 3086  
3087 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3088 -|name|Название карты-метки
3089 -|number|Номер
3090 -|period|Период запросов в секундах (работает только для агрегатов)
3091 -|id|ID карты-метки
3092 -|parentId|ID клиента
3093 -
3094 3094  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3095 3095  
3096 3096  (% class="box successmessage" %)
... ... @@ -3105,6 +3105,7 @@
3105 3105   "number": 0,
3106 3106   "period": 0,
3107 3107   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3152 + "deleted": true
3108 3108  }
3109 3109  
3110 3110  Ответ:
... ... @@ -3115,15 +3115,9 @@
3115 3115   "period": 0,
3116 3116   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3117 3117   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3163 + "deleted": true
3118 3118  }
3119 3119  
3120 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3121 -|name|Название карты-метки
3122 -|number|Номер
3123 -|period|Период запросов в секундах (работает только для агрегатов)
3124 -|id|ID карты-метки
3125 -|parentId|ID клиента
3126 -
3127 3127  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3128 3128  
3129 3129  (% class="box warningmessage" %)
... ... @@ -3139,6 +3139,7 @@
3139 3139   "period": 0,
3140 3140   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3141 3141   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3181 + "deleted": true
3142 3142  }
3143 3143  
3144 3144  Ответ:
... ... @@ -3149,15 +3149,9 @@
3149 3149   "period": 0,
3150 3150   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3151 3151   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3192 + "deleted": true
3152 3152  }
3153 3153  
3154 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3155 -|name|Название карты-метки
3156 -|number|Номер
3157 -|period|Период запросов в секундах (работает только для агрегатов)
3158 -|id|ID карты-метки
3159 -|parentId|ID клиента
3160 -
3161 3161  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3162 3162  
3163 3163  (% class="box errormessage" %)
... ... @@ -3491,219 +3491,6 @@
3491 3491  |PeriodValue|Значение периода.
3492 3492  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3493 3493  
3494 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3495 -
3496 -(% class="box warningmessage" %)
3497 -(((
3498 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3499 -)))
3500 -
3501 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3502 -
3503 -(% class="box infomessage" %)
3504 -(((
3505 -**POST /api/v3/vehicles/import/{agentId}**
3506 -)))
3507 -
3508 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp **. В формате **xml **экспортируются объекты из нашей системы.
3509 -
3510 -**agentId** - id клиента, указывается в пути запроса. (обязательный)
3511 -
3512 -
3513 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3514 -
3515 -(% class="box infomessage" %)
3516 -(((
3517 -**POST /api/v3/vehicles/import/history/{vehicleId}**
3518 -)))
3519 -
3520 -(% class="wikigeneratedid" %)
3521 -**vehicleId **- id объекта.
3522 -
3523 -
3524 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3525 -
3526 -(% class="box infomessage" %)
3527 -(((
3528 -**GET /api/v3/vehicles/import/history/status**
3529 -)))
3530 -
3531 -
3532 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3533 -
3534 -(% class="box infomessage" %)
3535 -(((
3536 -**POST /api/v3/vehicles/export**
3537 -)))
3538 -
3539 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3540 -
3541 -Тело запроса:
3542 -
3543 -[
3544 - id
3545 -]
3546 -
3547 -Ответ: Success 200, получаете файлы с настройками.
3548 -
3549 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3550 -
3551 -(% class="box infomessage" %)
3552 -(((
3553 -**POST /api/v3/vehicles/export/history**
3554 -)))
3555 -
3556 -Метод возвращает список сообщений терминала объекта за выбранный период.
3557 -
3558 -Тело запроса:
3559 -
3560 -{
3561 - "vehicleId": 0,
3562 - "asArchive": true,
3563 - "from": "2023-09-27T12:17:45.973Z",
3564 - "to": "2023-09-27T12:17:45.973Z"
3565 -}
3566 -
3567 -Ответ:
3568 -
3569 -Получаете файл. Сообщение: Code 200/Success
3570 -
3571 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3572 -|vehicleId|ID объекта
3573 -|asArchive|true - Архивировать файл, False - не архивировать
3574 -|from|Дата и время начала запроса
3575 -|to|Дата и время окончания запроса
3576 -
3577 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3578 -
3579 -(% class="box infomessage" %)
3580 -(((
3581 -**GET /api/v3/vehicles/export/history/status**
3582 -)))
3583 -
3584 -Метод возвращает список сообщений терминала объекта за выбранный период.
3585 -
3586 -Ответ:
3587 -
3588 -{
3589 - "activity": true,
3590 - "progress": 0,
3591 - "message": "string"
3592 -}
3593 -
3594 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3595 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3596 -|progress|Прогресс экспорта, от 0 до 100%
3597 -|message|Текст описывающий статус
3598 -
3599 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3600 -
3601 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3602 -
3603 -(% class="box infomessage" %)
3604 -(((
3605 -**POST /api/v3/EcoDriving/rating**
3606 -)))
3607 -
3608 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3609 -
3610 -Тело запроса:
3611 -
3612 -{
3613 - "vehicleIds": [vehicleId],
3614 - "from": "2023-11-22T09:29:48.051Z",
3615 - "to": "2023-11-22T09:29:48.051Z"
3616 -}
3617 -
3618 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3619 -|vehicleIds|Массив ID объектов
3620 -|from|Дата начала запроса
3621 -|to|Дата окончания запроса
3622 -
3623 -Ответ:
3624 -
3625 -{
3626 - "items": [
3627 - {
3628 - "from": "2023-11-22T09:29:48.052Z",
3629 - "to": "2023-11-22T09:29:48.052Z",
3630 - "vehicleId": 0,
3631 - "vehicleName": "string",
3632 - "vehicleModel": "string",
3633 - "penalty": 0,
3634 - "score": 0,
3635 - "totalViolations": 0,
3636 - "violationsByType": {
3637 - "overspeedingViolations": 0,
3638 - "accelerationViolations": 0,
3639 - "brakingViolations": 0,
3640 - "turningViolations": 0,
3641 - "dangerousDrivingViolations": 0,
3642 - "sensorViolations": 0
3643 - },
3644 - "moveTime": 0,
3645 - "mileage": 0,
3646 - "tripsCount": 0,
3647 - "trips": [
3648 - {
3649 - "penalty": 0,
3650 - "score": 0,
3651 - "violationsCount": 0,
3652 - "violationsByType": {
3653 - "overspeedingViolations": 0,
3654 - "accelerationViolations": 0,
3655 - "brakingViolations": 0,
3656 - "turningViolations": 0,
3657 - "dangerousDrivingViolations": 0,
3658 - "sensorViolations": 0
3659 - },
3660 - "moveTime": 0,
3661 - "mileage": 0,
3662 - "motohours": 0,
3663 - "maxSpeed": 0,
3664 - "startAddress": "string",
3665 - "endAddress": "string",
3666 - "drivers": [
3667 - {
3668 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3669 - "driverName": "string",
3670 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3671 - }
3672 - ]
3673 - }
3674 - ]
3675 - }
3676 - ]
3677 -}
3678 -
3679 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3680 -|from|Дата начала запроса
3681 -|to|Дата  окончания
3682 -|vehicleId|ID объекта
3683 -|vehicleName|Имя объекта
3684 -|vehicleModel|Модель объекта
3685 -|penalty|Сумма штрафных баллов
3686 -|score|Оценка
3687 -|totalViolations|Суммарное количество нарушений
3688 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3689 -|overspeedingViolations|Превышение скорости
3690 -|accelerationViolations|Ускорение
3691 -|brakingViolations|Торможение
3692 -|turningViolations|Резкий поворот
3693 -|dangerousDrivingViolations|Резкое вождение
3694 -|sensorViolations|Нарушение по датчику
3695 -|moveTime|Время в движении
3696 -|mileage|Пробег
3697 -|tripsCount|Количество рейсов
3698 -|motohours|Моточасы
3699 -|maxSpeed|Максимальная скорость
3700 -|startAddress|Адрес начала рейса
3701 -|endAddress|Адрес окончания рейса
3702 -|drivers|Список водителей, которые были на объекте в течениии рейса
3703 -|driverGuid|Guid водителя
3704 -|driverName|Имя водителя
3705 -|driverRfid|Номер Карты-метки
3706 -
3707 3707  (% class="box" lang="en-US" style="text-align: center;" %)
3708 3708  (((
3709 3709  (% 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 г.