Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -171,7 +171,7 @@ 171 171 (% style="color:#000000" %)Ответ: 172 172 173 173 { 174 - "agentId": "",(% style="color:#000000" %) 174 + "agentId": "",(% style="color:#000000" %) (%%) 175 175 "parentId": "", 176 176 "parentName": "string", 177 177 "name": "string", ... ... @@ -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" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -2952,83 +2952,6 @@ 2952 2952 Success 2953 2953 2954 2954 2955 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 2956 - 2957 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 2958 - 2959 -(% class="box infomessage" %) 2960 -((( 2961 -**POST /api/v3/Trailers** 2962 -))) 2963 - 2964 -Пример запроса: 2965 - 2966 -{ 2967 - "startDate": "2023-11-14T10:48:03.671Z", 2968 - "endDate": "2023-11-14T10:48:03.671Z", 2969 - "ids": [ 0 ], 2970 - "timezone": 0 2971 -} 2972 - 2973 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2974 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 2975 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 2976 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 2977 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 2978 - 2979 -Пример ответа: 2980 - 2981 -[ 2982 - { 2983 - "SD": "2023-11-14T10:48:03.717Z", 2984 - "ED": "2023-11-14T10:48:03.717Z", 2985 - "id": 0, 2986 - "SLat": 0, 2987 - "SLon": 0, 2988 - "ELat": 0, 2989 - "ELon": 0, 2990 - "mileage": 0 2991 - "Duration": 0 2992 - "Address": "string", 2993 - "Address2": "string", 2994 - "name": "string", 2995 - "rid": "string", 2996 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2997 - "trailer": { 2998 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2999 - "Number": "string", 3000 - "Description": "string", 3001 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3002 - "ExternalID": "string", 3003 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3004 - "CreateTime": "2023-11-14T10:48:03.717Z", 3005 - "UpdateTime": "2023-11-14T10:48:03.717Z", 3006 - "IsDeleted": true 3007 - }, 3008 - "filesCount": 0, 3009 - } 3010 -] 3011 - 3012 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3013 -|SD|Дата и время начала события 3014 -|ED|Дата и время окончания события 3015 -|id|ID объекта 3016 -|SLat|Широта начальной координаты 3017 -|SLon|Долгота начальной координаты 3018 -|ELat|Широта конечной координаты 3019 -|ELon|Долгота конечной координаты 3020 -|mileage|Пробег 3021 -|Duration|Продолжительность 3022 -|Address|Адрес начального местоположения 3023 -|Address2|Адрес конечного местоположения 3024 -|name|Имя радиометки 3025 -|rid|Номер радиометки 3026 -|rguid|ID радиометки 3027 -|trailer|Информация об агрегате 3028 -|ModelGuid|ID агрегата 3029 -|Number|Название/номер агрегата 3030 -|Description|Текст примечания агрегата 3031 - 3032 3032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3033 3033 3034 3034 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -3469,217 +3469,6 @@ 3469 3469 |PeriodValue|Значение периода. 3470 3470 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3471 3471 3472 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3473 - 3474 -(% class="wikigeneratedid" %) 3475 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3476 - 3477 -(% class="box infomessage" %) 3478 -((( 3479 -**POST /api/v3/vehicles/import/{agentId}** 3480 -))) 3481 - 3482 -**agentId** - id клиента. 3483 - 3484 - 3485 -(% class="wikigeneratedid" %) 3486 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3487 - 3488 -(% class="box infomessage" %) 3489 -((( 3490 -**POST /api/v3/vehicles/import/history/{vehicleId}** 3491 -))) 3492 - 3493 -(% class="wikigeneratedid" %) 3494 -**vehicleId **- id объекта. 3495 - 3496 - 3497 -(% class="wikigeneratedid" %) 3498 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3499 - 3500 -(% class="box infomessage" %) 3501 -((( 3502 -**GET /api/v3/vehicles/import/history/status** 3503 -))) 3504 - 3505 - 3506 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3507 - 3508 -(% class="box infomessage" %) 3509 -((( 3510 -**POST /api/v3/vehicles/export** 3511 -))) 3512 - 3513 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3514 - 3515 -Тело запроса: 3516 - 3517 -[ 3518 - id 3519 -] 3520 - 3521 -Ответ: Success 200, получаете файлы с настройками. 3522 - 3523 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3524 - 3525 -(% class="box infomessage" %) 3526 -((( 3527 -**POST /api/v3/vehicles/export/history** 3528 -))) 3529 - 3530 -Метод возвращает список сообщений терминала объекта за выбранный период. 3531 - 3532 -Тело запроса: 3533 - 3534 -{ 3535 - "vehicleId": 0, 3536 - "asArchive": true, 3537 - "from": "2023-09-27T12:17:45.973Z", 3538 - "to": "2023-09-27T12:17:45.973Z" 3539 -} 3540 - 3541 -Ответ: 3542 - 3543 -Получаете файл. Сообщение: Code 200/Success 3544 - 3545 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3546 -|vehicleId|ID объекта 3547 -|asArchive|true - Архивировать файл, False - не архивировать 3548 -|from|Дата и время начала запроса 3549 -|to|Дата и время окончания запроса 3550 - 3551 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3552 - 3553 -(% class="box infomessage" %) 3554 -((( 3555 -**GET /api/v3/vehicles/export/history/status** 3556 -))) 3557 - 3558 -Метод возвращает список сообщений терминала объекта за выбранный период. 3559 - 3560 -Ответ: 3561 - 3562 -{ 3563 - "activity": true, 3564 - "progress": 0, 3565 - "message": "string" 3566 -} 3567 - 3568 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3569 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3570 -|progress|Прогресс экспорта, от 0 до 100% 3571 -|message|Текст описывающий статус 3572 - 3573 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3574 - 3575 -(% class="wikigeneratedid" %) 3576 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3577 - 3578 -(% class="box infomessage" %) 3579 -((( 3580 -**POST /api/v3/EcoDriving/rating** 3581 -))) 3582 - 3583 -Позволяет получить список нарушений массива объектов объектов за выбранный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3584 - 3585 -Тело запроса: 3586 - 3587 -{ 3588 - "vehicleIds": [vehicleId], 3589 - "from": "2023-11-22T09:29:48.051Z", 3590 - "to": "2023-11-22T09:29:48.051Z" 3591 -} 3592 - 3593 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3594 -|vehicleIds|Массив ID объектов 3595 -|from|Дата начала запроса 3596 -|to|Дата окончания запроса 3597 - 3598 -Ответ: 3599 - 3600 -{ 3601 - "items": [ 3602 - { 3603 - "from": "2023-11-22T09:29:48.052Z", 3604 - "to": "2023-11-22T09:29:48.052Z", 3605 - "vehicleId": 0, 3606 - "vehicleName": "string", 3607 - "vehicleModel": "string", 3608 - "penalty": 0, 3609 - "score": 0, 3610 - "totalViolations": 0, 3611 - "violationsByType": { 3612 - "overspeedingViolations": 0, 3613 - "accelerationViolations": 0, 3614 - "brakingViolations": 0, 3615 - "turningViolations": 0, 3616 - "dangerousDrivingViolations": 0, 3617 - "sensorViolations": 0 3618 - }, 3619 - "moveTime": 0, 3620 - "mileage": 0, 3621 - "tripsCount": 0, 3622 - "trips": [ 3623 - { 3624 - "penalty": 0, 3625 - "score": 0, 3626 - "violationsCount": 0, 3627 - "violationsByType": { 3628 - "overspeedingViolations": 0, 3629 - "accelerationViolations": 0, 3630 - "brakingViolations": 0, 3631 - "turningViolations": 0, 3632 - "dangerousDrivingViolations": 0, 3633 - "sensorViolations": 0 3634 - }, 3635 - "moveTime": 0, 3636 - "mileage": 0, 3637 - "motohours": 0, 3638 - "maxSpeed": 0, 3639 - "startAddress": "string", 3640 - "endAddress": "string", 3641 - "drivers": [ 3642 - { 3643 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3644 - "driverName": "string", 3645 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3646 - } 3647 - ] 3648 - } 3649 - ] 3650 - } 3651 - ] 3652 -} 3653 - 3654 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3655 -|from|Дата начала запроса 3656 -|to|Дата окончания 3657 -|vehicleId|ID объекта 3658 -|vehicleName|Имя объекта 3659 -|vehicleModel|Модель объекта 3660 -|penalty|Сумма штрафных баллов 3661 -|score|Оценка 3662 -|totalViolations|Суммарное количество нарушений 3663 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3664 -|overspeedingViolations|Превышение скорости 3665 -|accelerationViolations|Ускорение 3666 -|brakingViolations|Торможение 3667 -|turningViolations|Резкий поворот 3668 -|dangerousDrivingViolations|Резкое вождение 3669 -|sensorViolations|Нарушение по датчику 3670 -|moveTime|Время в движении 3671 -|mileage|Пробег 3672 -|tripsCount|Количество рейсов 3673 -|motohours|Моточасы 3674 -|maxSpeed|Максимальная скорость 3675 -|startAddress|Адрес начала рейса 3676 -|endAddress|Адрес окончания рейса 3677 -|drivers|Список водителей, которые были на объекте в течениии рейса 3678 -|driverGuid|Guid водителя 3679 -|driverName|Имя водителя 3680 -|driverRfid|Номер Карты-метки 3681 - 3682 - 3683 3683 (% class="box" lang="en-US" style="text-align: center;" %) 3684 3684 ((( 3685 3685 (% 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]] **