Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 114.1 >
edited by Илья Крайнов
on 2023/10/20 16:06
To version < 126.1 >
edited by Илья Крайнов
on 2023/11/29 10:18
>
Change comment: There is no comment for this version

Summary

Details

Icon 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",
... ... @@ -356,6 +356,21 @@
356 356  
357 357  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
358 358  
359 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
360 +
361 +(% class="box warningmessage" %)
362 +(((
363 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
364 +)))
365 +
366 +Метод позволяет изменить статус клиента, указанного в запросе.
367 +
368 +В пути указывается GUID клиента и статус клиента.
369 +
370 +**status **- значение 0 - заблокирован, 1 - активен.
371 +
372 +Ответ: Code 204
373 +
359 359  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
360 360  
361 361  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -1872,6 +1872,51 @@
1872 1872   }
1873 1873  ]
1874 1874  
1890 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1891 +
1892 +(% class="box infomessage" style="text-align: left;" %)
1893 +(((
1894 +**POST /api/v3/terminalMessages/mapping**
1895 +)))
1896 +
1897 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1898 +
1899 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1900 +
1901 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1902 +
1903 +{
1904 + "protocolType": 0,
1905 + "params": ["string"]
1906 +}
1907 +
1908 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1909 +|protocolType|ID типа протокола
1910 +|params|(((
1911 +Массив наименований параметров в сообщении
1912 +)))
1913 +
1914 +Ответ:
1915 +
1916 +{
1917 + "protocolType": 0,
1918 + "mapping": {
1919 + "additionalProp1": {
1920 + "inputType": 0,
1921 + "inputNumber": 0
1922 + },
1923 + "additionalProp2": {
1924 + "inputType": 0,
1925 + "inputNumber": 0
1926 + }
1927 + }
1928 +}
1929 +
1930 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1931 +|protocolType|Тип протокола
1932 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1933 +|inputNumber|Номер входа
1934 +
1875 1875  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1876 1876  
1877 1877  (% class="box infomessage" %)
... ... @@ -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  
3015 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3016 +
3017 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3018 +
3019 +(% class="box infomessage" %)
3020 +(((
3021 +**POST /api/v3/Trailers**
3022 +)))
3023 +
3024 +Пример запроса:
3025 +
3026 +{
3027 + "startDate": "2023-11-14T10:48:03.671Z",
3028 + "endDate": "2023-11-14T10:48:03.671Z",
3029 + "ids": [ 0 ],
3030 + "timezone": 0
3031 +}
3032 +
3033 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3034 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3035 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3036 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3037 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3038 +
3039 +Пример ответа:
3040 +
3041 +[
3042 + {
3043 + "SD": "2023-11-14T10:48:03.717Z",
3044 + "ED": "2023-11-14T10:48:03.717Z", 
3045 + "id": 0,
3046 + "SLat": 0,
3047 + "SLon": 0,
3048 + "ELat": 0,
3049 + "ELon": 0,
3050 + "mileage": 0
3051 + "Duration": 0
3052 + "Address": "string",
3053 + "Address2": "string",
3054 + "name": "string",
3055 + "rid": "string",
3056 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3057 + "trailer": {
3058 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3059 + "Number": "string",
3060 + "Description": "string",
3061 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3062 + "ExternalID": "string",
3063 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3064 + "CreateTime": "2023-11-14T10:48:03.717Z",
3065 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3066 + "IsDeleted": true
3067 + },
3068 + "filesCount": 0,
3069 + }
3070 +]
3071 +
3072 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3073 +|SD|Дата и время начала события
3074 +|ED|Дата и время окончания события
3075 +|id|ID объекта
3076 +|SLat|Широта начальной координаты
3077 +|SLon|Долгота начальной координаты
3078 +|ELat|Широта конечной координаты
3079 +|ELon|Долгота конечной координаты
3080 +|mileage|Пробег
3081 +|Duration|Продолжительность
3082 +|Address|Адрес начального местоположения
3083 +|Address2|Адрес конечного местоположения
3084 +|name|Имя радиометки
3085 +|rid|Номер радиометки
3086 +|rguid|ID радиометки
3087 +|trailer|Информация об агрегате
3088 +|ModelGuid|ID агрегата
3089 +|Number|Название/номер агрегата
3090 +|Description|Текст примечания агрегата
3091 +
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, ~/~/ Частота трансляции радиометки
3113 + "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  
3119 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3120 +|parentId|ID клиента
3121 +|name|Название карты-метки
3122 +|number|Номер
3123 +|period|Период запросов в секундах (работает только для агрегатов)
3124 +|id|ID карты-метки
3125 +
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, ~/~/ Частота трансляции радиометки
3141 + "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  
3147 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3148 +|name|Название карты-метки
3149 +|number|Номер
3150 +|period|Период запросов в секундах (работает только для агрегатов)
3151 +|id|ID карты-метки
3152 +|parentId|ID клиента
3153 +
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  
3180 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3181 +|name|Название карты-метки
3182 +|number|Номер
3183 +|period|Период запросов в секундах (работает только для агрегатов)
3184 +|id|ID карты-метки
3185 +|parentId|ID клиента
3186 +
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  
3214 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3215 +|name|Название карты-метки
3216 +|number|Номер
3217 +|period|Период запросов в секундах (работает только для агрегатов)
3218 +|id|ID карты-метки
3219 +|parentId|ID клиента
3220 +
3117 3117  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3118 3118  
3119 3119  (% class="box errormessage" %)
... ... @@ -3362,6 +3362,8 @@
3362 3362  **PUT /api/v3/Billing/client/balance**
3363 3363  )))
3364 3364  
3469 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3470 +
3365 3365  Тело запроса:
3366 3366  
3367 3367  {
... ... @@ -3375,6 +3375,50 @@
3375 3375  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3376 3376  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3377 3377  
3484 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3485 +
3486 +(% class="box warningmessage" %)
3487 +(((
3488 +**PUT /api/v3/billing/client/balance/deposit**
3489 +)))
3490 +
3491 +Создает операцию **Пополнение **с указанной суммой
3492 +
3493 +Тело запроса:
3494 +
3495 +{
3496 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3497 + "Balance": 0
3498 +}
3499 +
3500 +Ответ: Success
3501 +
3502 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3503 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3504 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3505 +
3506 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3507 +
3508 +Создает операцию **Списание **с указанной суммой
3509 +
3510 +(% class="box warningmessage" %)
3511 +(((
3512 +**PUT /api/v3/billing/client/balance/withdraw**
3513 +)))
3514 +
3515 +Тело запроса:
3516 +
3517 +{
3518 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519 + "Balance": 0
3520 +}
3521 +
3522 +Ответ: Success
3523 +
3524 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3525 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3526 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3527 +
3378 3378  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3379 3379  
3380 3380  (% class="box warningmessage" %)
... ... @@ -3447,6 +3447,305 @@
3447 3447  |PeriodValue|Значение периода.
3448 3448  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3449 3449  
3600 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3601 +
3602 +(% class="box warningmessage" %)
3603 +(((
3604 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3605 +)))
3606 +
3607 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3608 +
3609 +(% class="box infomessage" %)
3610 +(((
3611 +**POST /api/v3/vehicles/import/{agentId}**
3612 +)))
3613 +
3614 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3615 +
3616 +В пути указывается **agentId** - id клиента.
3617 +
3618 +**Заголовок**
3619 +
3620 +**X-Auth: [токен авторизации]**
3621 +
3622 +**Параметры**
3623 +
3624 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3625 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3626 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3627 +
3628 +В теле использовать тип **form-data,** тип значения** file**
3629 +
3630 +**Ключи**
3631 +
3632 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3633 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3634 +|csv|В значении передаем файл датчиков, формат **csv**
3635 +
3636 +Ответ:
3637 +
3638 +{
3639 + "vehicleId": 0,
3640 + "name": "string",
3641 + "errors": ["string"]
3642 +}
3643 +
3644 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3645 +|vehicleId|ID созданного объекта
3646 +|name|Имя созданного объекта
3647 +|errors|Ошибки и их описание
3648 +
3649 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3650 +
3651 +(% class="box infomessage" %)
3652 +(((
3653 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3654 +)))
3655 +
3656 +(% class="wikigeneratedid" %)
3657 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3658 +
3659 +(% class="wikigeneratedid" %)
3660 +В пути указывается **vehicleId **- id объекта.
3661 +
3662 +**Заголовок**
3663 +
3664 +**X-Auth: [токен авторизации]**
3665 +
3666 +В теле использовать тип **form-data.**
3667 +
3668 +Ключи:
3669 +
3670 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3671 +|**history**|В значении передавать файл с историей
3672 +
3673 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3674 +
3675 +Ответ:
3676 +
3677 +{
3678 + "results": [
3679 + {
3680 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3681 + "vehicleId": 0,
3682 + "errors": [
3683 + "string"
3684 + ],
3685 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3686 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3687 + "producedCount": 0,
3688 + "msgCount": 0
3689 + }
3690 + ]
3691 +}
3692 +
3693 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3694 +|results|Результаты импорта в разрезе ТС
3695 +|vehicleGuid|Guid ТС
3696 +|vehicleId|ID ТС
3697 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3698 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3699 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3700 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3701 +|msgCount|Кол-во обработанных сообщений всего
3702 +
3703 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3704 +
3705 +(% class="box infomessage" %)
3706 +(((
3707 +**GET /api/v3/vehicles/import/history/status**
3708 +)))
3709 +
3710 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3711 +
3712 +Ответ:
3713 +
3714 +{
3715 + "activity": true,
3716 + "progress": 0,
3717 + "message": "string"
3718 +}
3719 +
3720 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3721 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3722 +|progress|Guid ТС
3723 +
3724 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3725 +
3726 +(% class="box infomessage" %)
3727 +(((
3728 +**POST /api/v3/vehicles/export**
3729 +)))
3730 +
3731 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3732 +
3733 +Тело запроса:
3734 +
3735 +[
3736 + id
3737 +]
3738 +
3739 +Ответ: Success 200, получаете файлы с настройками.
3740 +
3741 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3742 +
3743 +(% class="box infomessage" %)
3744 +(((
3745 +**POST /api/v3/vehicles/export/history**
3746 +)))
3747 +
3748 +Метод возвращает список сообщений терминала объекта за выбранный период.
3749 +
3750 +Тело запроса:
3751 +
3752 +{
3753 + "vehicleId": 0,
3754 + "asArchive": true,
3755 + "from": "2023-09-27T12:17:45.973Z",
3756 + "to": "2023-09-27T12:17:45.973Z"
3757 +}
3758 +
3759 +Ответ:
3760 +
3761 +Получаете файл. Сообщение: Code 200/Success
3762 +
3763 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3764 +|vehicleId|ID объекта
3765 +|asArchive|true - Архивировать файл, False - не архивировать
3766 +|from|Дата и время начала запроса
3767 +|to|Дата и время окончания запроса
3768 +
3769 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3770 +
3771 +(% class="box infomessage" %)
3772 +(((
3773 +**GET /api/v3/vehicles/export/history/status**
3774 +)))
3775 +
3776 +Метод возвращает список сообщений терминала объекта за выбранный период.
3777 +
3778 +Ответ:
3779 +
3780 +{
3781 + "activity": true,
3782 + "progress": 0,
3783 + "message": "string"
3784 +}
3785 +
3786 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3787 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3788 +|progress|Прогресс экспорта, от 0 до 100%
3789 +|message|Текст описывающий статус
3790 +
3791 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3792 +
3793 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3794 +
3795 +(% class="box infomessage" %)
3796 +(((
3797 +**POST /api/v3/EcoDriving/rating**
3798 +)))
3799 +
3800 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3801 +
3802 +Тело запроса:
3803 +
3804 +{
3805 + "vehicleIds": [vehicleId],
3806 + "from": "2023-11-22T09:29:48.051Z",
3807 + "to": "2023-11-22T09:29:48.051Z"
3808 +}
3809 +
3810 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3811 +|vehicleIds|Массив ID объектов
3812 +|from|Дата начала запроса
3813 +|to|Дата окончания запроса
3814 +
3815 +Ответ:
3816 +
3817 +{
3818 + "items": [
3819 + {
3820 + "from": "2023-11-22T09:29:48.052Z",
3821 + "to": "2023-11-22T09:29:48.052Z",
3822 + "vehicleId": 0,
3823 + "vehicleName": "string",
3824 + "vehicleModel": "string",
3825 + "penalty": 0,
3826 + "score": 0,
3827 + "totalViolations": 0,
3828 + "violationsByType": {
3829 + "overspeedingViolations": 0,
3830 + "accelerationViolations": 0,
3831 + "brakingViolations": 0,
3832 + "turningViolations": 0,
3833 + "dangerousDrivingViolations": 0,
3834 + "sensorViolations": 0
3835 + },
3836 + "moveTime": 0,
3837 + "mileage": 0,
3838 + "tripsCount": 0,
3839 + "trips": [
3840 + {
3841 + "penalty": 0,
3842 + "score": 0,
3843 + "violationsCount": 0,
3844 + "violationsByType": {
3845 + "overspeedingViolations": 0,
3846 + "accelerationViolations": 0,
3847 + "brakingViolations": 0,
3848 + "turningViolations": 0,
3849 + "dangerousDrivingViolations": 0,
3850 + "sensorViolations": 0
3851 + },
3852 + "moveTime": 0,
3853 + "mileage": 0,
3854 + "motohours": 0,
3855 + "maxSpeed": 0,
3856 + "startAddress": "string",
3857 + "endAddress": "string",
3858 + "drivers": [
3859 + {
3860 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3861 + "driverName": "string",
3862 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3863 + }
3864 + ]
3865 + }
3866 + ]
3867 + }
3868 + ]
3869 +}
3870 +
3871 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3872 +|from|Дата начала запроса
3873 +|to|Дата  окончания
3874 +|vehicleId|ID объекта
3875 +|vehicleName|Имя объекта
3876 +|vehicleModel|Модель объекта
3877 +|penalty|Сумма штрафных баллов
3878 +|score|Оценка
3879 +|totalViolations|Суммарное количество нарушений
3880 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3881 +|overspeedingViolations|Превышение скорости
3882 +|accelerationViolations|Ускорение
3883 +|brakingViolations|Торможение
3884 +|turningViolations|Резкий поворот
3885 +|dangerousDrivingViolations|Резкое вождение
3886 +|sensorViolations|Нарушение по датчику
3887 +|moveTime|Время в движении
3888 +|mileage|Пробег
3889 +|tripsCount|Количество рейсов
3890 +|motohours|Моточасы
3891 +|maxSpeed|Максимальная скорость
3892 +|startAddress|Адрес начала рейса
3893 +|endAddress|Адрес окончания рейса
3894 +|drivers|Список водителей, которые были на объекте в течениии рейса
3895 +|driverGuid|Guid водителя
3896 +|driverName|Имя водителя
3897 +|driverRfid|Номер Карты-метки
3898 +
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]] **

Меню

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