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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.krainovim
1 +XWiki.Gadmin
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,56 @@
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 +Номер входа
1933 +)))
1934 +
1935 +(% class="wikigeneratedid" %)
1936 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
1937 +
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  
1962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1963 +|vehicleId|ID объекта
1964 +|from|Дата и время начала периода запроса
1965 +|to|Дата и время окончания периода запроса
1966 +
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": { ~/~/ список параметров датчиков передаваемых терминалом
1973 + "deviceTime": "2023-11-29T07:40:44.052Z",
1974 + "serverTime": "2023-11-29T07:40:44.052Z",
1975 + "speed": 0,
1976 + "altitude": 0,
1977 + "latitude": 0,
1978 + "longitude": 0,
1979 + "satellites": 0,
1980 + "course": 0,
1981 + "voltage": 0,
1982 + "parameters": {
1914 1914   "additionalProp1": "string",
1915 1915   "additionalProp2": "string",
1916 1916   "additionalProp3": "string"
1917 1917   },
1918 - "photoCount": 0 ~/~/ Кол-во фото
1987 + "photoCount": 0,
1988 + "lbsCorrectedCoords": true,
1989 + "protocolType": 0
1919 1919   }
1920 1920   ]
1921 1921   }
1922 1922  ]
1923 1923  
1924 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1995 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1996 +|deviceTime|Время сообщения терминала
1997 +|serverTime|Время когда сообщение поступило на сервер
1998 +|speed|Скорость
1999 +|altitude|Высота над уровнем моря
2000 +|latitude|Широта
2001 +|longitude|Долгота
2002 +|satellites|Кол-во спутников
2003 +|course|Курс
2004 +|voltage|Бортовое напряжение
2005 +|parameters|Список параметров и их значений
2006 +|photoCount|Количество фото
2007 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2008 +|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" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2109,6 +2109,129 @@
2109 2109   }
2110 2110  ]
2111 2111  
2143 +
2144 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2145 +
2146 +(% class="box infomessage" %)
2147 +(((
2148 +**POST /api/v3/vehicles/moveStop**
2149 +)))
2150 +
2151 +Метод запроса: **POST**
2152 +
2153 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2154 +
2155 +В заголовках запроса: X-Auth: Токен авторизации
2156 +
2157 +
2158 +Тело запроса:
2159 +
2160 +{
2161 +
2162 + "vehicleIds": [ ], ~/~/ Список ID объектов
2163 +
2164 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2165 +
2166 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2167 +
2168 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2169 +
2170 +}
2171 +
2172 +Ответ:
2173 +
2174 +[
2175 +
2176 + {
2177 +
2178 + "vehicleId": 0, ~/~/ ID объекта
2179 +
2180 + "vehicleName": "string", ~/~/ Имя объекта
2181 +
2182 + "moves": [ ~/~/ Событие движения
2183 +
2184 + {
2185 +
2186 + "mileage": 0, ~/~/ Пробег, км
2187 +
2188 + "eventId": 0, ~/~/ Идентификатор события
2189 +
2190 + "eventName": "string", ~/~/ Название события
2191 +
2192 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2193 +
2194 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2195 +
2196 + "duration": 0 ~/~/ Продолжительность события, секунд
2197 +
2198 + }
2199 +
2200 + ],
2201 +
2202 + "stops": [ ~/~/ События стоянок
2203 +
2204 + {
2205 +
2206 + "address": "string", ~/~/ Адрес события
2207 +
2208 + "eventId": 0, ~/~/ Идентификатор события
2209 +
2210 + "eventName": "string", ~/~/ Название события
2211 +
2212 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2213 +
2214 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2215 +
2216 + "duration": 0 ~/~/ Продолжительность события, секунд
2217 +
2218 +
2219 + }
2220 +
2221 + ]
2222 +
2223 + }
2224 +
2225 +]
2226 +
2227 +
2228 +
2229 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2230 +
2231 +(% class="box infomessage" %)
2232 +(((
2233 +**POST /api/v3/vehicles/getlastdata**
2234 +)))
2235 +
2236 +Метод запроса: **POST**
2237 +
2238 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2239 +
2240 +В заголовках запроса: X-Auth: Токен авторизации
2241 +
2242 +
2243 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2244 +
2245 +Ответ:
2246 + {
2247 + "vehicleId": 0, ~/~/Идентификатор объекта.
2248 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2249 + "vehicleNumber": "string",~/~/Номер объекта.
2250 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2251 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2252 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2253 + "speed": 0,~/~/Скорость объекта.
2254 + "course": 0,~/~/Курс движения [0;360]
2255 + "latitude": 0,~/~/Широта [-90°;90°].
2256 + "longitude": 0,~/~/Долгота [-180°;180°].
2257 + "address": "string",~/~/Адрес.
2258 + "geozones": [ ~/~/Сведения по геозонам.
2259 + {
2260 + "id": 0,
2261 + "name": "string"
2262 + }
2263 +
2264 +
2265 +
2112 2112  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2113 2113  
2114 2114  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3007,6 +3007,83 @@
3007 3007  Success
3008 3008  
3009 3009  
3164 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3165 +
3166 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3167 +
3168 +(% class="box infomessage" %)
3169 +(((
3170 +**POST /api/v3/Trailers**
3171 +)))
3172 +
3173 +Пример запроса:
3174 +
3175 +{
3176 + "startDate": "2023-11-14T10:48:03.671Z",
3177 + "endDate": "2023-11-14T10:48:03.671Z",
3178 + "ids": [ 0 ],
3179 + "timezone": 0
3180 +}
3181 +
3182 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3183 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3184 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3185 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3186 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3187 +
3188 +Пример ответа:
3189 +
3190 +[
3191 + {
3192 + "SD": "2023-11-14T10:48:03.717Z",
3193 + "ED": "2023-11-14T10:48:03.717Z", 
3194 + "id": 0,
3195 + "SLat": 0,
3196 + "SLon": 0,
3197 + "ELat": 0,
3198 + "ELon": 0,
3199 + "mileage": 0
3200 + "Duration": 0
3201 + "Address": "string",
3202 + "Address2": "string",
3203 + "name": "string",
3204 + "rid": "string",
3205 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3206 + "trailer": {
3207 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3208 + "Number": "string",
3209 + "Description": "string",
3210 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3211 + "ExternalID": "string",
3212 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3213 + "CreateTime": "2023-11-14T10:48:03.717Z",
3214 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3215 + "IsDeleted": true
3216 + },
3217 + "filesCount": 0,
3218 + }
3219 +]
3220 +
3221 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3222 +|SD|Дата и время начала события
3223 +|ED|Дата и время окончания события
3224 +|id|ID объекта
3225 +|SLat|Широта начальной координаты
3226 +|SLon|Долгота начальной координаты
3227 +|ELat|Широта конечной координаты
3228 +|ELon|Долгота конечной координаты
3229 +|mileage|Пробег
3230 +|Duration|Продолжительность
3231 +|Address|Адрес начального местоположения
3232 +|Address2|Адрес конечного местоположения
3233 +|name|Имя радиометки
3234 +|rid|Номер радиометки
3235 +|rguid|ID радиометки
3236 +|trailer|Информация об агрегате
3237 +|ModelGuid|ID агрегата
3238 +|Number|Название/номер агрегата
3239 +|Description|Текст примечания агрегата
3240 +
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, ~/~/ Частота трансляции радиометки
3262 + "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  
3268 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3269 +|parentId|ID клиента
3270 +|name|Название карты-метки
3271 +|number|Номер
3272 +|period|Период запросов в секундах (работает только для агрегатов)
3273 +|id|ID карты-метки
3274 +
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, ~/~/ Частота трансляции радиометки
3290 + "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  
3296 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3297 +|name|Название карты-метки
3298 +|number|Номер
3299 +|period|Период запросов в секундах (работает только для агрегатов)
3300 +|id|ID карты-метки
3301 +|parentId|ID клиента
3302 +
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  
3329 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3330 +|name|Название карты-метки
3331 +|number|Номер
3332 +|period|Период запросов в секундах (работает только для агрегатов)
3333 +|id|ID карты-метки
3334 +|parentId|ID клиента
3335 +
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  
3363 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3364 +|name|Название карты-метки
3365 +|number|Номер
3366 +|period|Период запросов в секундах (работает только для агрегатов)
3367 +|id|ID карты-метки
3368 +|parentId|ID клиента
3369 +
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  
3618 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3619 +
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  
3633 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3634 +
3635 +(% class="box warningmessage" %)
3636 +(((
3637 +**PUT /api/v3/billing/client/balance/deposit**
3638 +)))
3639 +
3640 +Создает операцию **Пополнение **с указанной суммой
3641 +
3642 +Тело запроса:
3643 +
3644 +{
3645 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3646 + "Balance": 0
3647 +}
3648 +
3649 +Ответ: Success
3650 +
3651 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3652 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3653 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3654 +
3655 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3656 +
3657 +Создает операцию **Списание **с указанной суммой
3658 +
3659 +(% class="box warningmessage" %)
3660 +(((
3661 +**PUT /api/v3/billing/client/balance/withdraw**
3662 +)))
3663 +
3664 +Тело запроса:
3665 +
3666 +{
3667 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3668 + "Balance": 0
3669 +}
3670 +
3671 +Ответ: Success
3672 +
3673 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3674 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3675 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3676 +
3378 3378  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3379 3379  
3380 3380  (% class="box warningmessage" %)
... ... @@ -3447,6 +3447,371 @@
3447 3447  |PeriodValue|Значение периода.
3448 3448  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3449 3449  
3749 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3750 +
3751 +(% class="box warningmessage" %)
3752 +(((
3753 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3754 +)))
3755 +
3756 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3757 +
3758 +(% class="box infomessage" %)
3759 +(((
3760 +**POST /api/v3/vehicles/import/{agentId}**
3761 +)))
3762 +
3763 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3764 +
3765 +В пути указывается **agentId** - id клиента.
3766 +
3767 +**Заголовок**
3768 +
3769 +**X-Auth: [токен авторизации]**
3770 +
3771 +**Параметры**
3772 +
3773 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3774 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3775 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3776 +
3777 +В теле использовать тип **form-data,** тип значения** file**
3778 +
3779 +**Ключи**
3780 +
3781 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3782 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3783 +|csv|В значении передаем файл датчиков, формат **csv**
3784 +
3785 +Ответ:
3786 +
3787 +{
3788 + "vehicleId": 0,
3789 + "name": "string",
3790 + "errors": ["string"]
3791 +}
3792 +
3793 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3794 +|vehicleId|ID созданного объекта
3795 +|name|Имя созданного объекта
3796 +|errors|Ошибки и их описание
3797 +
3798 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3799 +
3800 +(% class="box infomessage" %)
3801 +(((
3802 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3803 +)))
3804 +
3805 +(% class="wikigeneratedid" %)
3806 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3807 +
3808 +(% class="wikigeneratedid" %)
3809 +В пути указывается **vehicleId **- id объекта.
3810 +
3811 +**Заголовок**
3812 +
3813 +**X-Auth: [токен авторизации]**
3814 +
3815 +В теле использовать тип **form-data.**
3816 +
3817 +Ключи:
3818 +
3819 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3820 +|**history**|В значении передавать файл с историей
3821 +
3822 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3823 +
3824 +Ответ:
3825 +
3826 +{
3827 + "results": [
3828 + {
3829 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3830 + "vehicleId": 0,
3831 + "errors": [
3832 + "string"
3833 + ],
3834 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3835 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3836 + "producedCount": 0,
3837 + "msgCount": 0
3838 + }
3839 + ]
3840 +}
3841 +
3842 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3843 +|results|Результаты импорта в разрезе ТС
3844 +|vehicleGuid|Guid ТС
3845 +|vehicleId|ID ТС
3846 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3847 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3848 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3849 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3850 +|msgCount|Кол-во обработанных сообщений всего
3851 +
3852 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3853 +
3854 +(% class="box infomessage" %)
3855 +(((
3856 +**GET /api/v3/vehicles/import/history/status**
3857 +)))
3858 +
3859 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3860 +
3861 +Ответ:
3862 +
3863 +{
3864 + "activity": true,
3865 + "progress": 0,
3866 + "message": "string"
3867 +}
3868 +
3869 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3870 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3871 +|progress|Guid ТС
3872 +
3873 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3874 +
3875 +(% class="box infomessage" %)
3876 +(((
3877 +**POST /api/v3/vehicles/export**
3878 +)))
3879 +
3880 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3881 +
3882 +Тело запроса:
3883 +
3884 +[
3885 + id
3886 +]
3887 +
3888 +Ответ: Success 200, получаете файлы с настройками.
3889 +
3890 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3891 +
3892 +(% class="box infomessage" %)
3893 +(((
3894 +**POST /api/v3/vehicles/export/history**
3895 +)))
3896 +
3897 +Метод возвращает список сообщений терминала объекта за выбранный период.
3898 +
3899 +Тело запроса:
3900 +
3901 +{
3902 + "vehicleId": 0,
3903 + "asArchive": true,
3904 + "from": "2023-09-27T12:17:45.973Z",
3905 + "to": "2023-09-27T12:17:45.973Z"
3906 +}
3907 +
3908 +Ответ:
3909 +
3910 +Получаете файл. Сообщение: Code 200/Success
3911 +
3912 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3913 +|vehicleId|ID объекта
3914 +|asArchive|true - Архивировать файл, False - не архивировать
3915 +|from|Дата и время начала запроса
3916 +|to|Дата и время окончания запроса
3917 +
3918 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3919 +
3920 +(% class="box infomessage" %)
3921 +(((
3922 +**GET /api/v3/vehicles/export/history/status**
3923 +)))
3924 +
3925 +Метод возвращает список сообщений терминала объекта за выбранный период.
3926 +
3927 +Ответ:
3928 +
3929 +{
3930 + "activity": true,
3931 + "progress": 0,
3932 + "message": "string"
3933 +}
3934 +
3935 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3936 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3937 +|progress|Прогресс экспорта, от 0 до 100%
3938 +|message|Текст описывающий статус
3939 +
3940 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3941 +
3942 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3943 +
3944 +(% class="box infomessage" %)
3945 +(((
3946 +**POST /api/v3/EcoDriving/rating**
3947 +)))
3948 +
3949 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3950 +
3951 +Тело запроса:
3952 +
3953 +{
3954 + "vehicleIds": [vehicleId],
3955 + "from": "2023-11-22T09:29:48.051Z",
3956 + "to": "2023-11-22T09:29:48.051Z"
3957 +}
3958 +
3959 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3960 +|vehicleIds|Массив ID объектов
3961 +|from|Дата начала запроса
3962 +|to|Дата окончания запроса
3963 +
3964 +Ответ:
3965 +
3966 +{
3967 + "items": [
3968 + {
3969 + "from": "2023-11-22T09:29:48.052Z",
3970 + "to": "2023-11-22T09:29:48.052Z",
3971 + "vehicleId": 0,
3972 + "vehicleName": "string",
3973 + "vehicleModel": "string",
3974 + "penalty": 0,
3975 + "score": 0,
3976 + "totalViolations": 0,
3977 + "violationsByType": {
3978 + "overspeedingViolations": 0,
3979 + "accelerationViolations": 0,
3980 + "brakingViolations": 0,
3981 + "turningViolations": 0,
3982 + "dangerousDrivingViolations": 0,
3983 + "sensorViolations": 0
3984 + },
3985 + "moveTime": 0,
3986 + "mileage": 0,
3987 + "tripsCount": 0,
3988 + "trips": [
3989 + {
3990 + "penalty": 0,
3991 + "score": 0,
3992 + "violationsCount": 0,
3993 + "violationsByType": {
3994 + "overspeedingViolations": 0,
3995 + "accelerationViolations": 0,
3996 + "brakingViolations": 0,
3997 + "turningViolations": 0,
3998 + "dangerousDrivingViolations": 0,
3999 + "sensorViolations": 0
4000 + },
4001 + "moveTime": 0,
4002 + "mileage": 0,
4003 + "motohours": 0,
4004 + "maxSpeed": 0,
4005 + "startAddress": "string",
4006 + "endAddress": "string",
4007 + "drivers": [
4008 + {
4009 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4010 + "driverName": "string",
4011 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4012 + }
4013 + ]
4014 + }
4015 + ]
4016 + }
4017 + ]
4018 +}
4019 +
4020 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4021 +|from|Дата начала запроса
4022 +|to|Дата  окончания
4023 +|vehicleId|ID объекта
4024 +|vehicleName|Имя объекта
4025 +|vehicleModel|Модель объекта
4026 +|penalty|Сумма штрафных баллов
4027 +|score|Оценка
4028 +|totalViolations|Суммарное количество нарушений
4029 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4030 +|overspeedingViolations|Превышение скорости
4031 +|accelerationViolations|Ускорение
4032 +|brakingViolations|Торможение
4033 +|turningViolations|Резкий поворот
4034 +|dangerousDrivingViolations|Резкое вождение
4035 +|sensorViolations|Нарушение по датчику
4036 +|moveTime|Время в движении
4037 +|mileage|Пробег
4038 +|tripsCount|Количество рейсов
4039 +|motohours|Моточасы
4040 +|maxSpeed|Максимальная скорость
4041 +|startAddress|Адрес начала рейса
4042 +|endAddress|Адрес окончания рейса
4043 +|drivers|Список водителей, которые были на объекте в течениии рейса
4044 +|driverGuid|Guid водителя
4045 +|driverName|Имя водителя
4046 +|driverRfid|Номер Карты-метки
4047 +
4048 +(% style="color:#000000; font-size:18.6667px" %)Раздел: Топливные карты
4049 +
4050 +====== **Запрос транзакций по топливным картам** ======
4051 +
4052 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК»
4053 +
4054 +(% class="box infomessage" %)
4055 +(((
4056 +**POST**/api/v3/fuelcards/transactions
4057 +)))
4058 +
4059 +Запрос должен содержать параметры:
4060 +
4061 +{
4062 +
4063 + "startDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата начала периода построения
4064 +
4065 + "endDate": "2024-03-14T13:10:21.797Z", ~/~/ Дата окончания периода построения
4066 +
4067 + "ids": [
4068 +
4069 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid-ы топливных карт
4070 +
4071 + ],
4072 +
4073 + "timezone": 0, ~/~/ Часовой пояс
4074 +
4075 + "agent": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Guid клиента владельца
4076 +
4077 +}
4078 +
4079 +Ответ:
4080 +
4081 + {
4082 +
4083 + "date": "2024-03-14T13:14:26.212Z", ~/~/ Дата транзакции
4084 +
4085 + " driver ": "string", ~/~/ Имя водителя
4086 +
4087 + "amount": 0, ~/~/ Количество топлива
4088 +
4089 + "amountDut": 0, ~/~/ Количество топлива по ДУТ
4090 +
4091 + "amountDiff": 0, ~/~/ Разница в литрах
4092 +
4093 + "amountDiffPerc": 0, ~/~/ Разница в %
4094 +
4095 + "summa": 0, ~/~/  Стоимость в руб.
4096 +
4097 + "serviceName": "string", ~/~/ Тип топлива
4098 +
4099 + "price": 0, ~/~/ Цена за литр в руб.
4100 +
4101 + "cardName": "string", ~/~/ Наименование ТК
4102 +
4103 + "cardNum": "string", ~/~/ Номер ТК
4104 +
4105 + "operator": "string", ~/~/ Оператор ТК
4106 +
4107 + "address": "string", ~/~/ Адрес АЗС
4108 +
4109 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/  Guid топливной карты
4110 +
4111 + }
4112 +
4113 +
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 г.