Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 114.1 >
edited by Илья Крайнов
on 2023/10/20 16:06
To version < 130.1 >
edited by Михаил Жучков
on 2023/12/26 17:47
>
Change comment: There is no comment for this version

Summary

Details

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