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,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" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -3007,6 +3007,83 @@ 3007 3007 Success 3008 3008 3009 3009 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 + 3010 3010 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3011 3011 3012 3012 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -3028,13 +3028,19 @@ 3028 3028 { 3029 3029 "name": "string", 3030 3030 "number": 0, 3031 - "period": 0, ~/~/ Частота трансляции радиометки3053 + "period": 0, 3032 3032 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3033 3033 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 - "deleted": true 3035 3035 } 3036 3036 ] 3037 3037 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 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3039 3039 3040 3040 (% class="box infomessage" %) ... ... @@ -3050,13 +3050,19 @@ 3050 3050 { 3051 3051 "name": "string", 3052 3052 "number": 0, 3053 - "period": 0, ~/~/ Частота трансляции радиометки3081 + "period": 0, 3054 3054 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3055 3055 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3056 - "deleted": true 3057 3057 } 3058 3058 ] 3059 3059 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 + 3060 3060 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3061 3061 3062 3062 (% class="box successmessage" %) ... ... @@ -3071,7 +3071,6 @@ 3071 3071 "number": 0, 3072 3072 "period": 0, 3073 3073 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3074 - "deleted": true 3075 3075 } 3076 3076 3077 3077 Ответ: ... ... @@ -3082,9 +3082,15 @@ 3082 3082 "period": 0, 3083 3083 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3084 3084 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3085 - "deleted": true 3086 3086 } 3087 3087 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 + 3088 3088 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3089 3089 3090 3090 (% class="box warningmessage" %) ... ... @@ -3100,7 +3100,6 @@ 3100 3100 "period": 0, 3101 3101 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3102 3102 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3103 - "deleted": true 3104 3104 } 3105 3105 3106 3106 Ответ: ... ... @@ -3111,9 +3111,15 @@ 3111 3111 "period": 0, 3112 3112 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3113 3113 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3114 - "deleted": true 3115 3115 } 3116 3116 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 + 3117 3117 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3118 3118 3119 3119 (% class="box errormessage" %) ... ... @@ -3447,6 +3447,212 @@ 3447 3447 |PeriodValue|Значение периода. 3448 3448 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3449 3449 3494 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3495 + 3496 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3497 + 3498 +(% class="box infomessage" %) 3499 +((( 3500 +**POST /api/v3/vehicles/import/{agentId}** 3501 +))) 3502 + 3503 +**agentId** - id клиента. 3504 + 3505 + 3506 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 3507 + 3508 +(% class="box infomessage" %) 3509 +((( 3510 +**POST /api/v3/vehicles/import/history/{vehicleId}** 3511 +))) 3512 + 3513 +(% class="wikigeneratedid" %) 3514 +**vehicleId **- id объекта. 3515 + 3516 + 3517 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 3518 + 3519 +(% class="box infomessage" %) 3520 +((( 3521 +**GET /api/v3/vehicles/import/history/status** 3522 +))) 3523 + 3524 + 3525 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 3526 + 3527 +(% class="box infomessage" %) 3528 +((( 3529 +**POST /api/v3/vehicles/export** 3530 +))) 3531 + 3532 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 3533 + 3534 +Тело запроса: 3535 + 3536 +[ 3537 + id 3538 +] 3539 + 3540 +Ответ: Success 200, получаете файлы с настройками. 3541 + 3542 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 3543 + 3544 +(% class="box infomessage" %) 3545 +((( 3546 +**POST /api/v3/vehicles/export/history** 3547 +))) 3548 + 3549 +Метод возвращает список сообщений терминала объекта за выбранный период. 3550 + 3551 +Тело запроса: 3552 + 3553 +{ 3554 + "vehicleId": 0, 3555 + "asArchive": true, 3556 + "from": "2023-09-27T12:17:45.973Z", 3557 + "to": "2023-09-27T12:17:45.973Z" 3558 +} 3559 + 3560 +Ответ: 3561 + 3562 +Получаете файл. Сообщение: Code 200/Success 3563 + 3564 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3565 +|vehicleId|ID объекта 3566 +|asArchive|true - Архивировать файл, False - не архивировать 3567 +|from|Дата и время начала запроса 3568 +|to|Дата и время окончания запроса 3569 + 3570 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 3571 + 3572 +(% class="box infomessage" %) 3573 +((( 3574 +**GET /api/v3/vehicles/export/history/status** 3575 +))) 3576 + 3577 +Метод возвращает список сообщений терминала объекта за выбранный период. 3578 + 3579 +Ответ: 3580 + 3581 +{ 3582 + "activity": true, 3583 + "progress": 0, 3584 + "message": "string" 3585 +} 3586 + 3587 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3588 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 3589 +|progress|Прогресс экспорта, от 0 до 100% 3590 +|message|Текст описывающий статус 3591 + 3592 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 3593 + 3594 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 3595 + 3596 +(% class="box infomessage" %) 3597 +((( 3598 +**POST /api/v3/EcoDriving/rating** 3599 +))) 3600 + 3601 +Позволяет получить список нарушений массива объектов объектов за выбранный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 3602 + 3603 +Тело запроса: 3604 + 3605 +{ 3606 + "vehicleIds": [vehicleId], 3607 + "from": "2023-11-22T09:29:48.051Z", 3608 + "to": "2023-11-22T09:29:48.051Z" 3609 +} 3610 + 3611 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3612 +|vehicleIds|Массив ID объектов 3613 +|from|Дата начала запроса 3614 +|to|Дата окончания запроса 3615 + 3616 +Ответ: 3617 + 3618 +{ 3619 + "items": [ 3620 + { 3621 + "from": "2023-11-22T09:29:48.052Z", 3622 + "to": "2023-11-22T09:29:48.052Z", 3623 + "vehicleId": 0, 3624 + "vehicleName": "string", 3625 + "vehicleModel": "string", 3626 + "penalty": 0, 3627 + "score": 0, 3628 + "totalViolations": 0, 3629 + "violationsByType": { 3630 + "overspeedingViolations": 0, 3631 + "accelerationViolations": 0, 3632 + "brakingViolations": 0, 3633 + "turningViolations": 0, 3634 + "dangerousDrivingViolations": 0, 3635 + "sensorViolations": 0 3636 + }, 3637 + "moveTime": 0, 3638 + "mileage": 0, 3639 + "tripsCount": 0, 3640 + "trips": [ 3641 + { 3642 + "penalty": 0, 3643 + "score": 0, 3644 + "violationsCount": 0, 3645 + "violationsByType": { 3646 + "overspeedingViolations": 0, 3647 + "accelerationViolations": 0, 3648 + "brakingViolations": 0, 3649 + "turningViolations": 0, 3650 + "dangerousDrivingViolations": 0, 3651 + "sensorViolations": 0 3652 + }, 3653 + "moveTime": 0, 3654 + "mileage": 0, 3655 + "motohours": 0, 3656 + "maxSpeed": 0, 3657 + "startAddress": "string", 3658 + "endAddress": "string", 3659 + "drivers": [ 3660 + { 3661 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3662 + "driverName": "string", 3663 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3664 + } 3665 + ] 3666 + } 3667 + ] 3668 + } 3669 + ] 3670 +} 3671 + 3672 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3673 +|from|Дата начала запроса 3674 +|to|Дата окончания 3675 +|vehicleId|ID объекта 3676 +|vehicleName|Имя объекта 3677 +|vehicleModel|Модель объекта 3678 +|penalty|Сумма штрафных баллов 3679 +|score|Оценка 3680 +|totalViolations|Суммарное количество нарушений 3681 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа 3682 +|overspeedingViolations|Превышение скорости 3683 +|accelerationViolations|Ускорение 3684 +|brakingViolations|Торможение 3685 +|turningViolations|Резкий поворот 3686 +|dangerousDrivingViolations|Резкое вождение 3687 +|sensorViolations|Нарушение по датчику 3688 +|moveTime|Время в движении 3689 +|mileage|Пробег 3690 +|tripsCount|Количество рейсов 3691 +|motohours|Моточасы 3692 +|maxSpeed|Максимальная скорость 3693 +|startAddress|Адрес начала рейса 3694 +|endAddress|Адрес окончания рейса 3695 +|drivers|Список водителей, которые были на объекте в течениии рейса 3696 +|driverGuid|Guid водителя 3697 +|driverName|Имя водителя 3698 +|driverRfid|Номер Карты-метки 3699 + 3450 3450 (% class="box" lang="en-US" style="text-align: center;" %) 3451 3451 ((( 3452 3452 (% 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]] **