Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 114.1 >
edited by Илья Крайнов
on 2023/10/20 16:06
To version < 127.1 >
edited by Илья Крайнов
on 2023/11/29 10:51
>
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" %)
... ... @@ -1896,6 +1896,11 @@
1896 1896   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1897 1897  }
1898 1898  
1959 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1960 +|vehicleId|ID объекта
1961 +|from|Дата и время начала периода запроса
1962 +|to|Дата и время окончания периода запроса
1963 +
1899 1899  Ответ:
1900 1900  
1901 1901  [
... ... @@ -1902,80 +1902,43 @@
1902 1902   {
1903 1903   "messages": [
1904 1904   {
1905 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1906 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1907 - "speed": 0, ~/~/ Скорость, км/ч
1908 - "altitude": 0, ~/~/ Высота, м
1909 - "latitude": 0, ~/~/ Широта [-90°;90°]
1910 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1911 - "satellites": 0, ~/~/ Кол-во спутников
1912 - "voltage": 0, ~/~/ Напряжение
1913 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1970 + "deviceTime": "2023-11-29T07:40:44.052Z",
1971 + "serverTime": "2023-11-29T07:40:44.052Z",
1972 + "speed": 0,
1973 + "altitude": 0,
1974 + "latitude": 0,
1975 + "longitude": 0,
1976 + "satellites": 0,
1977 + "course": 0,
1978 + "voltage": 0,
1979 + "parameters": {
1914 1914   "additionalProp1": "string",
1915 1915   "additionalProp2": "string",
1916 1916   "additionalProp3": "string"
1917 1917   },
1918 - "photoCount": 0 ~/~/ Кол-во фото
1984 + "photoCount": 0,
1985 + "lbsCorrectedCoords": true,
1986 + "protocolType": 0
1919 1919   }
1920 1920   ]
1921 1921   }
1922 1922  ]
1923 1923  
1924 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1992 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1993 +|deviceTime|Время сообщения терминала
1994 +|serverTime|Время когда сообщение поступило на сервер
1995 +|speed|Скорость
1996 +|altitude|Высота над уровнем моря
1997 +|latitude|Широта
1998 +|longitude|Долгота
1999 +|satellites|Кол-во спутников
2000 +|course|Курс
2001 +|voltage|Бортовое напряжение
2002 +|parameters|Список параметров и их значений
2003 +|photoCount|Количество фото
2004 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2005 +|protocolType|ID типа протокола
1925 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  
3038 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3039 +
3040 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3041 +
3042 +(% class="box infomessage" %)
3043 +(((
3044 +**POST /api/v3/Trailers**
3045 +)))
3046 +
3047 +Пример запроса:
3048 +
3049 +{
3050 + "startDate": "2023-11-14T10:48:03.671Z",
3051 + "endDate": "2023-11-14T10:48:03.671Z",
3052 + "ids": [ 0 ],
3053 + "timezone": 0
3054 +}
3055 +
3056 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3057 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3058 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3059 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3060 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3061 +
3062 +Пример ответа:
3063 +
3064 +[
3065 + {
3066 + "SD": "2023-11-14T10:48:03.717Z",
3067 + "ED": "2023-11-14T10:48:03.717Z", 
3068 + "id": 0,
3069 + "SLat": 0,
3070 + "SLon": 0,
3071 + "ELat": 0,
3072 + "ELon": 0,
3073 + "mileage": 0
3074 + "Duration": 0
3075 + "Address": "string",
3076 + "Address2": "string",
3077 + "name": "string",
3078 + "rid": "string",
3079 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3080 + "trailer": {
3081 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3082 + "Number": "string",
3083 + "Description": "string",
3084 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 + "ExternalID": "string",
3086 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3087 + "CreateTime": "2023-11-14T10:48:03.717Z",
3088 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3089 + "IsDeleted": true
3090 + },
3091 + "filesCount": 0,
3092 + }
3093 +]
3094 +
3095 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3096 +|SD|Дата и время начала события
3097 +|ED|Дата и время окончания события
3098 +|id|ID объекта
3099 +|SLat|Широта начальной координаты
3100 +|SLon|Долгота начальной координаты
3101 +|ELat|Широта конечной координаты
3102 +|ELon|Долгота конечной координаты
3103 +|mileage|Пробег
3104 +|Duration|Продолжительность
3105 +|Address|Адрес начального местоположения
3106 +|Address2|Адрес конечного местоположения
3107 +|name|Имя радиометки
3108 +|rid|Номер радиометки
3109 +|rguid|ID радиометки
3110 +|trailer|Информация об агрегате
3111 +|ModelGuid|ID агрегата
3112 +|Number|Название/номер агрегата
3113 +|Description|Текст примечания агрегата
3114 +
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, ~/~/ Частота трансляции радиометки
3136 + "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  
3142 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3143 +|parentId|ID клиента
3144 +|name|Название карты-метки
3145 +|number|Номер
3146 +|period|Период запросов в секундах (работает только для агрегатов)
3147 +|id|ID карты-метки
3148 +
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, ~/~/ Частота трансляции радиометки
3164 + "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  
3170 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3171 +|name|Название карты-метки
3172 +|number|Номер
3173 +|period|Период запросов в секундах (работает только для агрегатов)
3174 +|id|ID карты-метки
3175 +|parentId|ID клиента
3176 +
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  
3203 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3204 +|name|Название карты-метки
3205 +|number|Номер
3206 +|period|Период запросов в секундах (работает только для агрегатов)
3207 +|id|ID карты-метки
3208 +|parentId|ID клиента
3209 +
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  
3237 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3238 +|name|Название карты-метки
3239 +|number|Номер
3240 +|period|Период запросов в секундах (работает только для агрегатов)
3241 +|id|ID карты-метки
3242 +|parentId|ID клиента
3243 +
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  
3492 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3493 +
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  
3507 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3508 +
3509 +(% class="box warningmessage" %)
3510 +(((
3511 +**PUT /api/v3/billing/client/balance/deposit**
3512 +)))
3513 +
3514 +Создает операцию **Пополнение **с указанной суммой
3515 +
3516 +Тело запроса:
3517 +
3518 +{
3519 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3520 + "Balance": 0
3521 +}
3522 +
3523 +Ответ: Success
3524 +
3525 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3526 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3527 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3528 +
3529 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3530 +
3531 +Создает операцию **Списание **с указанной суммой
3532 +
3533 +(% class="box warningmessage" %)
3534 +(((
3535 +**PUT /api/v3/billing/client/balance/withdraw**
3536 +)))
3537 +
3538 +Тело запроса:
3539 +
3540 +{
3541 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3542 + "Balance": 0
3543 +}
3544 +
3545 +Ответ: Success
3546 +
3547 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3548 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3549 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3550 +
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  
3623 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3624 +
3625 +(% class="box warningmessage" %)
3626 +(((
3627 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3628 +)))
3629 +
3630 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3631 +
3632 +(% class="box infomessage" %)
3633 +(((
3634 +**POST /api/v3/vehicles/import/{agentId}**
3635 +)))
3636 +
3637 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3638 +
3639 +В пути указывается **agentId** - id клиента.
3640 +
3641 +**Заголовок**
3642 +
3643 +**X-Auth: [токен авторизации]**
3644 +
3645 +**Параметры**
3646 +
3647 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3648 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3649 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3650 +
3651 +В теле использовать тип **form-data,** тип значения** file**
3652 +
3653 +**Ключи**
3654 +
3655 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3656 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3657 +|csv|В значении передаем файл датчиков, формат **csv**
3658 +
3659 +Ответ:
3660 +
3661 +{
3662 + "vehicleId": 0,
3663 + "name": "string",
3664 + "errors": ["string"]
3665 +}
3666 +
3667 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3668 +|vehicleId|ID созданного объекта
3669 +|name|Имя созданного объекта
3670 +|errors|Ошибки и их описание
3671 +
3672 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3673 +
3674 +(% class="box infomessage" %)
3675 +(((
3676 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3677 +)))
3678 +
3679 +(% class="wikigeneratedid" %)
3680 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3681 +
3682 +(% class="wikigeneratedid" %)
3683 +В пути указывается **vehicleId **- id объекта.
3684 +
3685 +**Заголовок**
3686 +
3687 +**X-Auth: [токен авторизации]**
3688 +
3689 +В теле использовать тип **form-data.**
3690 +
3691 +Ключи:
3692 +
3693 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3694 +|**history**|В значении передавать файл с историей
3695 +
3696 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3697 +
3698 +Ответ:
3699 +
3700 +{
3701 + "results": [
3702 + {
3703 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3704 + "vehicleId": 0,
3705 + "errors": [
3706 + "string"
3707 + ],
3708 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3709 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3710 + "producedCount": 0,
3711 + "msgCount": 0
3712 + }
3713 + ]
3714 +}
3715 +
3716 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3717 +|results|Результаты импорта в разрезе ТС
3718 +|vehicleGuid|Guid ТС
3719 +|vehicleId|ID ТС
3720 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3721 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3722 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3723 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3724 +|msgCount|Кол-во обработанных сообщений всего
3725 +
3726 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3727 +
3728 +(% class="box infomessage" %)
3729 +(((
3730 +**GET /api/v3/vehicles/import/history/status**
3731 +)))
3732 +
3733 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3734 +
3735 +Ответ:
3736 +
3737 +{
3738 + "activity": true,
3739 + "progress": 0,
3740 + "message": "string"
3741 +}
3742 +
3743 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3744 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3745 +|progress|Guid ТС
3746 +
3747 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3748 +
3749 +(% class="box infomessage" %)
3750 +(((
3751 +**POST /api/v3/vehicles/export**
3752 +)))
3753 +
3754 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3755 +
3756 +Тело запроса:
3757 +
3758 +[
3759 + id
3760 +]
3761 +
3762 +Ответ: Success 200, получаете файлы с настройками.
3763 +
3764 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3765 +
3766 +(% class="box infomessage" %)
3767 +(((
3768 +**POST /api/v3/vehicles/export/history**
3769 +)))
3770 +
3771 +Метод возвращает список сообщений терминала объекта за выбранный период.
3772 +
3773 +Тело запроса:
3774 +
3775 +{
3776 + "vehicleId": 0,
3777 + "asArchive": true,
3778 + "from": "2023-09-27T12:17:45.973Z",
3779 + "to": "2023-09-27T12:17:45.973Z"
3780 +}
3781 +
3782 +Ответ:
3783 +
3784 +Получаете файл. Сообщение: Code 200/Success
3785 +
3786 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3787 +|vehicleId|ID объекта
3788 +|asArchive|true - Архивировать файл, False - не архивировать
3789 +|from|Дата и время начала запроса
3790 +|to|Дата и время окончания запроса
3791 +
3792 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3793 +
3794 +(% class="box infomessage" %)
3795 +(((
3796 +**GET /api/v3/vehicles/export/history/status**
3797 +)))
3798 +
3799 +Метод возвращает список сообщений терминала объекта за выбранный период.
3800 +
3801 +Ответ:
3802 +
3803 +{
3804 + "activity": true,
3805 + "progress": 0,
3806 + "message": "string"
3807 +}
3808 +
3809 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3810 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3811 +|progress|Прогресс экспорта, от 0 до 100%
3812 +|message|Текст описывающий статус
3813 +
3814 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3815 +
3816 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3817 +
3818 +(% class="box infomessage" %)
3819 +(((
3820 +**POST /api/v3/EcoDriving/rating**
3821 +)))
3822 +
3823 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3824 +
3825 +Тело запроса:
3826 +
3827 +{
3828 + "vehicleIds": [vehicleId],
3829 + "from": "2023-11-22T09:29:48.051Z",
3830 + "to": "2023-11-22T09:29:48.051Z"
3831 +}
3832 +
3833 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3834 +|vehicleIds|Массив ID объектов
3835 +|from|Дата начала запроса
3836 +|to|Дата окончания запроса
3837 +
3838 +Ответ:
3839 +
3840 +{
3841 + "items": [
3842 + {
3843 + "from": "2023-11-22T09:29:48.052Z",
3844 + "to": "2023-11-22T09:29:48.052Z",
3845 + "vehicleId": 0,
3846 + "vehicleName": "string",
3847 + "vehicleModel": "string",
3848 + "penalty": 0,
3849 + "score": 0,
3850 + "totalViolations": 0,
3851 + "violationsByType": {
3852 + "overspeedingViolations": 0,
3853 + "accelerationViolations": 0,
3854 + "brakingViolations": 0,
3855 + "turningViolations": 0,
3856 + "dangerousDrivingViolations": 0,
3857 + "sensorViolations": 0
3858 + },
3859 + "moveTime": 0,
3860 + "mileage": 0,
3861 + "tripsCount": 0,
3862 + "trips": [
3863 + {
3864 + "penalty": 0,
3865 + "score": 0,
3866 + "violationsCount": 0,
3867 + "violationsByType": {
3868 + "overspeedingViolations": 0,
3869 + "accelerationViolations": 0,
3870 + "brakingViolations": 0,
3871 + "turningViolations": 0,
3872 + "dangerousDrivingViolations": 0,
3873 + "sensorViolations": 0
3874 + },
3875 + "moveTime": 0,
3876 + "mileage": 0,
3877 + "motohours": 0,
3878 + "maxSpeed": 0,
3879 + "startAddress": "string",
3880 + "endAddress": "string",
3881 + "drivers": [
3882 + {
3883 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3884 + "driverName": "string",
3885 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3886 + }
3887 + ]
3888 + }
3889 + ]
3890 + }
3891 + ]
3892 +}
3893 +
3894 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3895 +|from|Дата начала запроса
3896 +|to|Дата  окончания
3897 +|vehicleId|ID объекта
3898 +|vehicleName|Имя объекта
3899 +|vehicleModel|Модель объекта
3900 +|penalty|Сумма штрафных баллов
3901 +|score|Оценка
3902 +|totalViolations|Суммарное количество нарушений
3903 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3904 +|overspeedingViolations|Превышение скорости
3905 +|accelerationViolations|Ускорение
3906 +|brakingViolations|Торможение
3907 +|turningViolations|Резкий поворот
3908 +|dangerousDrivingViolations|Резкое вождение
3909 +|sensorViolations|Нарушение по датчику
3910 +|moveTime|Время в движении
3911 +|mileage|Пробег
3912 +|tripsCount|Количество рейсов
3913 +|motohours|Моточасы
3914 +|maxSpeed|Максимальная скорость
3915 +|startAddress|Адрес начала рейса
3916 +|endAddress|Адрес окончания рейса
3917 +|drivers|Список водителей, которые были на объекте в течениии рейса
3918 +|driverGuid|Guid водителя
3919 +|driverName|Имя водителя
3920 +|driverRfid|Номер Карты-метки
3921 +
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 г.