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

Summary

Details

Icon Page properties
Content
... ... @@ -1921,61 +1921,6 @@
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 -
1979 1979  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1980 1980  
1981 1981  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -3084,7 +3084,6 @@
3084 3084  |Number|Название/номер агрегата
3085 3085  |Description|Текст примечания агрегата
3086 3086  
3087 -
3088 3088  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3089 3089  
3090 3090  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3106,13 +3106,19 @@
3106 3106   {
3107 3107   "name": "string",
3108 3108   "number": 0,
3109 - "period": 0, ~/~/ Частота трансляции радиометки
3053 + "period": 0,
3110 3110   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3111 3111   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3112 - "deleted": true
3113 3113   }
3114 3114  ]
3115 3115  
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 +
3116 3116  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3117 3117  
3118 3118  (% class="box infomessage" %)
... ... @@ -3128,13 +3128,19 @@
3128 3128   {
3129 3129   "name": "string",
3130 3130   "number": 0,
3131 - "period": 0, ~/~/ Частота трансляции радиометки
3081 + "period": 0,
3132 3132   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3133 3133   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3134 - "deleted": true
3135 3135   }
3136 3136  ]
3137 3137  
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 +
3138 3138  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3139 3139  
3140 3140  (% class="box successmessage" %)
... ... @@ -3149,7 +3149,6 @@
3149 3149   "number": 0,
3150 3150   "period": 0,
3151 3151   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3152 - "deleted": true
3153 3153  }
3154 3154  
3155 3155  Ответ:
... ... @@ -3160,9 +3160,15 @@
3160 3160   "period": 0,
3161 3161   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3162 3162   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3163 - "deleted": true
3164 3164  }
3165 3165  
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 +
3166 3166  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3167 3167  
3168 3168  (% class="box warningmessage" %)
... ... @@ -3178,7 +3178,6 @@
3178 3178   "period": 0,
3179 3179   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3180 3180   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3181 - "deleted": true
3182 3182  }
3183 3183  
3184 3184  Ответ:
... ... @@ -3189,9 +3189,15 @@
3189 3189   "period": 0,
3190 3190   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3191 3191   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3192 - "deleted": true
3193 3193  }
3194 3194  
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 +
3195 3195  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3196 3196  
3197 3197  (% class="box errormessage" %)
... ... @@ -3525,6 +3525,218 @@
3525 3525  |PeriodValue|Значение периода.
3526 3526  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3527 3527  
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 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3513 +
3514 +(% class="box infomessage" %)
3515 +(((
3516 +**POST /api/v3/vehicles/import/history/{vehicleId}**
3517 +)))
3518 +
3519 +(% class="wikigeneratedid" %)
3520 +**vehicleId **- id объекта.
3521 +
3522 +
3523 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3524 +
3525 +(% class="box infomessage" %)
3526 +(((
3527 +**GET /api/v3/vehicles/import/history/status**
3528 +)))
3529 +
3530 +
3531 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3532 +
3533 +(% class="box infomessage" %)
3534 +(((
3535 +**POST /api/v3/vehicles/export**
3536 +)))
3537 +
3538 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3539 +
3540 +Тело запроса:
3541 +
3542 +[
3543 + id
3544 +]
3545 +
3546 +Ответ: Success 200, получаете файлы с настройками.
3547 +
3548 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3549 +
3550 +(% class="box infomessage" %)
3551 +(((
3552 +**POST /api/v3/vehicles/export/history**
3553 +)))
3554 +
3555 +Метод возвращает список сообщений терминала объекта за выбранный период.
3556 +
3557 +Тело запроса:
3558 +
3559 +{
3560 + "vehicleId": 0,
3561 + "asArchive": true,
3562 + "from": "2023-09-27T12:17:45.973Z",
3563 + "to": "2023-09-27T12:17:45.973Z"
3564 +}
3565 +
3566 +Ответ:
3567 +
3568 +Получаете файл. Сообщение: Code 200/Success
3569 +
3570 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3571 +|vehicleId|ID объекта
3572 +|asArchive|true - Архивировать файл, False - не архивировать
3573 +|from|Дата и время начала запроса
3574 +|to|Дата и время окончания запроса
3575 +
3576 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3577 +
3578 +(% class="box infomessage" %)
3579 +(((
3580 +**GET /api/v3/vehicles/export/history/status**
3581 +)))
3582 +
3583 +Метод возвращает список сообщений терминала объекта за выбранный период.
3584 +
3585 +Ответ:
3586 +
3587 +{
3588 + "activity": true,
3589 + "progress": 0,
3590 + "message": "string"
3591 +}
3592 +
3593 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3594 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3595 +|progress|Прогресс экспорта, от 0 до 100%
3596 +|message|Текст описывающий статус
3597 +
3598 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3599 +
3600 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3601 +
3602 +(% class="box infomessage" %)
3603 +(((
3604 +**POST /api/v3/EcoDriving/rating**
3605 +)))
3606 +
3607 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3608 +
3609 +Тело запроса:
3610 +
3611 +{
3612 + "vehicleIds": [vehicleId],
3613 + "from": "2023-11-22T09:29:48.051Z",
3614 + "to": "2023-11-22T09:29:48.051Z"
3615 +}
3616 +
3617 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3618 +|vehicleIds|Массив ID объектов
3619 +|from|Дата начала запроса
3620 +|to|Дата окончания запроса
3621 +
3622 +Ответ:
3623 +
3624 +{
3625 + "items": [
3626 + {
3627 + "from": "2023-11-22T09:29:48.052Z",
3628 + "to": "2023-11-22T09:29:48.052Z",
3629 + "vehicleId": 0,
3630 + "vehicleName": "string",
3631 + "vehicleModel": "string",
3632 + "penalty": 0,
3633 + "score": 0,
3634 + "totalViolations": 0,
3635 + "violationsByType": {
3636 + "overspeedingViolations": 0,
3637 + "accelerationViolations": 0,
3638 + "brakingViolations": 0,
3639 + "turningViolations": 0,
3640 + "dangerousDrivingViolations": 0,
3641 + "sensorViolations": 0
3642 + },
3643 + "moveTime": 0,
3644 + "mileage": 0,
3645 + "tripsCount": 0,
3646 + "trips": [
3647 + {
3648 + "penalty": 0,
3649 + "score": 0,
3650 + "violationsCount": 0,
3651 + "violationsByType": {
3652 + "overspeedingViolations": 0,
3653 + "accelerationViolations": 0,
3654 + "brakingViolations": 0,
3655 + "turningViolations": 0,
3656 + "dangerousDrivingViolations": 0,
3657 + "sensorViolations": 0
3658 + },
3659 + "moveTime": 0,
3660 + "mileage": 0,
3661 + "motohours": 0,
3662 + "maxSpeed": 0,
3663 + "startAddress": "string",
3664 + "endAddress": "string",
3665 + "drivers": [
3666 + {
3667 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3668 + "driverName": "string",
3669 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3670 + }
3671 + ]
3672 + }
3673 + ]
3674 + }
3675 + ]
3676 +}
3677 +
3678 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3679 +|from|Дата начала запроса
3680 +|to|Дата  окончания
3681 +|vehicleId|ID объекта
3682 +|vehicleName|Имя объекта
3683 +|vehicleModel|Модель объекта
3684 +|penalty|Сумма штрафных баллов
3685 +|score|Оценка
3686 +|totalViolations|Суммарное количество нарушений
3687 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3688 +|overspeedingViolations|Превышение скорости
3689 +|accelerationViolations|Ускорение
3690 +|brakingViolations|Торможение
3691 +|turningViolations|Резкий поворот
3692 +|dangerousDrivingViolations|Резкое вождение
3693 +|sensorViolations|Нарушение по датчику
3694 +|moveTime|Время в движении
3695 +|mileage|Пробег
3696 +|tripsCount|Количество рейсов
3697 +|motohours|Моточасы
3698 +|maxSpeed|Максимальная скорость
3699 +|startAddress|Адрес начала рейса
3700 +|endAddress|Адрес окончания рейса
3701 +|drivers|Список водителей, которые были на объекте в течениии рейса
3702 +|driverGuid|Guid водителя
3703 +|driverName|Имя водителя
3704 +|driverRfid|Номер Карты-метки
3705 +
3528 3528  (% class="box" lang="en-US" style="text-align: center;" %)
3529 3529  (((
3530 3530  (% 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 г.