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

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Gadmin
1 +XWiki.krainovim
Content
... ... @@ -171,8 +171,9 @@
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",
176 176   "name": "string",
177 177   "fullName": "string",
178 178   "agentInfoType": 0,
... ... @@ -183,6 +183,7 @@
183 183  |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
184 184  |(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 
185 185  |(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя
187 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя
186 186  |(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента
187 187  |(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента
188 188  |(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)
... ... @@ -354,21 +354,6 @@
354 354  
355 355  Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
356 356  
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 -
372 372  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
373 373  
374 374  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -1802,7 +1802,7 @@
1802 1802  
1803 1803  (% style="color:#000000" %)Метод запроса: **GET**
1804 1804  
1805 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]]
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]]
1806 1806  
1807 1807  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1808 1808  
... ... @@ -1885,51 +1885,6 @@
1885 1885   }
1886 1886  ]
1887 1887  
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 1933  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1934 1934  
1935 1935  (% class="box infomessage" %)
... ... @@ -1954,11 +1954,6 @@
1954 1954   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1955 1955  }
1956 1956  
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 -
1962 1962  Ответ:
1963 1963  
1964 1964  [
... ... @@ -1965,43 +1965,80 @@
1965 1965   {
1966 1966   "messages": [
1967 1967   {
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": {
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": { ~/~/ список параметров датчиков передаваемых терминалом
1978 1978   "additionalProp1": "string",
1979 1979   "additionalProp2": "string",
1980 1980   "additionalProp3": "string"
1981 1981   },
1982 - "photoCount": 0,
1983 - "lbsCorrectedCoords": true,
1984 - "protocolType": 0
1918 + "photoCount": 0 ~/~/ Кол-во фото
1985 1985   }
1986 1986   ]
1987 1987   }
1988 1988  ]
1989 1989  
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 типа протокола
1924 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
2004 2004  
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 +
2005 2005  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
2006 2006  
2007 2007  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2135,142 +2135,6 @@
2135 2135   }
2136 2136  ]
2137 2137  
2138 -
2139 -== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2140 -
2141 -(% class="box infomessage" %)
2142 -(((
2143 -**POST /api/v3/vehicles/moveStop**
2144 -)))
2145 -
2146 -Метод запроса: **POST**
2147 -
2148 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2149 -
2150 -В заголовках запроса: X-Auth: Токен авторизации
2151 -
2152 -
2153 -Тело запроса:
2154 -
2155 -{
2156 -
2157 - "vehicleIds": [ ], ~/~/ Список ID объектов
2158 -
2159 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2160 -
2161 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2162 -
2163 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2164 -
2165 -}
2166 -
2167 -Ответ:
2168 -
2169 -[
2170 -
2171 - {
2172 -
2173 - "vehicleId": 0, ~/~/ ID объекта
2174 -
2175 - "vehicleName": "string", ~/~/ Имя объекта
2176 -
2177 - "moves": [ ~/~/ Событие движения
2178 -
2179 - {
2180 -
2181 - "mileage": 0, ~/~/ Пробег, км
2182 -
2183 - "eventId": 0, ~/~/ Идентификатор события
2184 -
2185 - "eventName": "string", ~/~/ Название события
2186 -
2187 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2188 -
2189 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2190 -
2191 - "duration": 0 ~/~/ Продолжительность события, секунд
2192 -
2193 - }
2194 -
2195 - ],
2196 -
2197 - "stops": [ ~/~/ События стоянок
2198 -
2199 - {
2200 -
2201 - "address": "string", ~/~/ Адрес события
2202 -
2203 - "eventId": 0, ~/~/ Идентификатор события
2204 -
2205 - "eventName": "string", ~/~/ Название события
2206 -
2207 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2208 -
2209 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2210 -
2211 - "duration": 0 ~/~/ Продолжительность события, секунд
2212 -
2213 -
2214 - }
2215 -
2216 - ]
2217 -
2218 - }
2219 -
2220 -]
2221 -
2222 -
2223 -
2224 -== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2225 -
2226 -(% class="box infomessage" %)
2227 -(((
2228 -**POST /api/v3/vehicles/getlastdata**
2229 -)))
2230 -
2231 -Метод запроса: **POST**
2232 -
2233 -URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2234 -
2235 -В заголовках запроса: X-Auth: Токен авторизации
2236 -
2237 -
2238 -Тело запроса:
2239 -
2240 -{
2241 -
2242 - "vehicleIds": [ ], ~/~/ Список ID машины
2243 -
2244 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2245 -
2246 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на траспортном средстве.
2247 -
2248 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2249 -
2250 -}
2251 -
2252 -
2253 -Ответ:
2254 - {
2255 - "vehicleId": 0, ~/~/Идентификатор объекта.
2256 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2257 - "vehicleNumber": "string",~/~/Номер объекта.
2258 - "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2259 - "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на траспортном средстве.
2260 - "state": 0,~/~/Определяет состояния объекта в мониторинге: в движении, остановка, стоянка, отключена, нет данных.
2261 - "speed": 0,~/~/Скорость объекта.
2262 - "course": 0,~/~/Курс движения [0;360]
2263 - "latitude": 0,~/~/Широта [-90°;90°].
2264 - "longitude": 0,~/~/Долгота [-180°;180°].
2265 - "address": "string",~/~/Адрес.
2266 - "geozones": [ ~/~/Сведения по геозонам.
2267 - {
2268 - "id": 0,
2269 - "name": "string"
2270 - }
2271 -
2272 -
2273 -
2274 2274  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2275 2275  
2276 2276  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3169,83 +3169,6 @@
3169 3169  Success
3170 3170  
3171 3171  
3172 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3173 -
3174 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3175 -
3176 -(% class="box infomessage" %)
3177 -(((
3178 -**POST /api/v3/Trailers**
3179 -)))
3180 -
3181 -Пример запроса:
3182 -
3183 -{
3184 - "startDate": "2023-11-14T10:48:03.671Z",
3185 - "endDate": "2023-11-14T10:48:03.671Z",
3186 - "ids": [ 0 ],
3187 - "timezone": 0
3188 -}
3189 -
3190 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3191 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3192 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3193 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3194 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3195 -
3196 -Пример ответа:
3197 -
3198 -[
3199 - {
3200 - "SD": "2023-11-14T10:48:03.717Z",
3201 - "ED": "2023-11-14T10:48:03.717Z", 
3202 - "id": 0,
3203 - "SLat": 0,
3204 - "SLon": 0,
3205 - "ELat": 0,
3206 - "ELon": 0,
3207 - "mileage": 0
3208 - "Duration": 0
3209 - "Address": "string",
3210 - "Address2": "string",
3211 - "name": "string",
3212 - "rid": "string",
3213 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3214 - "trailer": {
3215 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3216 - "Number": "string",
3217 - "Description": "string",
3218 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3219 - "ExternalID": "string",
3220 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3221 - "CreateTime": "2023-11-14T10:48:03.717Z",
3222 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3223 - "IsDeleted": true
3224 - },
3225 - "filesCount": 0,
3226 - }
3227 -]
3228 -
3229 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3230 -|SD|Дата и время начала события
3231 -|ED|Дата и время окончания события
3232 -|id|ID объекта
3233 -|SLat|Широта начальной координаты
3234 -|SLon|Долгота начальной координаты
3235 -|ELat|Широта конечной координаты
3236 -|ELon|Долгота конечной координаты
3237 -|mileage|Пробег
3238 -|Duration|Продолжительность
3239 -|Address|Адрес начального местоположения
3240 -|Address2|Адрес конечного местоположения
3241 -|name|Имя радиометки
3242 -|rid|Номер радиометки
3243 -|rguid|ID радиометки
3244 -|trailer|Информация об агрегате
3245 -|ModelGuid|ID агрегата
3246 -|Number|Название/номер агрегата
3247 -|Description|Текст примечания агрегата
3248 -
3249 3249  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3250 3250  
3251 3251  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3267,19 +3267,13 @@
3267 3267   {
3268 3268   "name": "string",
3269 3269   "number": 0,
3270 - "period": 0,
3031 + "period": 0, ~/~/ Частота трансляции радиометки
3271 3271   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3272 3272   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3034 + "deleted": true
3273 3273   }
3274 3274  ]
3275 3275  
3276 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3277 -|parentId|ID клиента
3278 -|name|Название карты-метки
3279 -|number|Номер
3280 -|period|Период запросов в секундах (работает только для агрегатов)
3281 -|id|ID карты-метки
3282 -
3283 3283  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3284 3284  
3285 3285  (% class="box infomessage" %)
... ... @@ -3295,19 +3295,13 @@
3295 3295   {
3296 3296   "name": "string",
3297 3297   "number": 0,
3298 - "period": 0,
3053 + "period": 0, ~/~/ Частота трансляции радиометки
3299 3299   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3300 3300   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3056 + "deleted": true
3301 3301   }
3302 3302  ]
3303 3303  
3304 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3305 -|name|Название карты-метки
3306 -|number|Номер
3307 -|period|Период запросов в секундах (работает только для агрегатов)
3308 -|id|ID карты-метки
3309 -|parentId|ID клиента
3310 -
3311 3311  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3312 3312  
3313 3313  (% class="box successmessage" %)
... ... @@ -3322,6 +3322,7 @@
3322 3322   "number": 0,
3323 3323   "period": 0,
3324 3324   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3074 + "deleted": true
3325 3325  }
3326 3326  
3327 3327  Ответ:
... ... @@ -3332,15 +3332,9 @@
3332 3332   "period": 0,
3333 3333   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3334 3334   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 + "deleted": true
3335 3335  }
3336 3336  
3337 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3338 -|name|Название карты-метки
3339 -|number|Номер
3340 -|period|Период запросов в секундах (работает только для агрегатов)
3341 -|id|ID карты-метки
3342 -|parentId|ID клиента
3343 -
3344 3344  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3345 3345  
3346 3346  (% class="box warningmessage" %)
... ... @@ -3356,6 +3356,7 @@
3356 3356   "period": 0,
3357 3357   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3358 3358   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3103 + "deleted": true
3359 3359  }
3360 3360  
3361 3361  Ответ:
... ... @@ -3366,15 +3366,9 @@
3366 3366   "period": 0,
3367 3367   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3368 3368   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3114 + "deleted": true
3369 3369  }
3370 3370  
3371 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3372 -|name|Название карты-метки
3373 -|number|Номер
3374 -|period|Период запросов в секундах (работает только для агрегатов)
3375 -|id|ID карты-метки
3376 -|parentId|ID клиента
3377 -
3378 3378  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3379 3379  
3380 3380  (% class="box errormessage" %)
... ... @@ -3623,8 +3623,6 @@
3623 3623  **PUT /api/v3/Billing/client/balance**
3624 3624  )))
3625 3625  
3626 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3627 -
3628 3628  Тело запроса:
3629 3629  
3630 3630  {
... ... @@ -3638,50 +3638,6 @@
3638 3638  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3639 3639  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3640 3640  
3641 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3642 -
3643 -(% class="box warningmessage" %)
3644 -(((
3645 -**PUT /api/v3/billing/client/balance/deposit**
3646 -)))
3647 -
3648 -Создает операцию **Пополнение **с указанной суммой
3649 -
3650 -Тело запроса:
3651 -
3652 -{
3653 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3654 - "Balance": 0
3655 -}
3656 -
3657 -Ответ: Success
3658 -
3659 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3660 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3661 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3662 -
3663 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3664 -
3665 -Создает операцию **Списание **с указанной суммой
3666 -
3667 -(% class="box warningmessage" %)
3668 -(((
3669 -**PUT /api/v3/billing/client/balance/withdraw**
3670 -)))
3671 -
3672 -Тело запроса:
3673 -
3674 -{
3675 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3676 - "Balance": 0
3677 -}
3678 -
3679 -Ответ: Success
3680 -
3681 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3682 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3683 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3684 -
3685 3685  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3686 3686  
3687 3687  (% class="box warningmessage" %)
... ... @@ -3754,305 +3754,6 @@
3754 3754  |PeriodValue|Значение периода.
3755 3755  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3756 3756  
3757 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3758 -
3759 -(% class="box warningmessage" %)
3760 -(((
3761 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3762 -)))
3763 -
3764 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3765 -
3766 -(% class="box infomessage" %)
3767 -(((
3768 -**POST /api/v3/vehicles/import/{agentId}**
3769 -)))
3770 -
3771 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3772 -
3773 -В пути указывается **agentId** - id клиента.
3774 -
3775 -**Заголовок**
3776 -
3777 -**X-Auth: [токен авторизации]**
3778 -
3779 -**Параметры**
3780 -
3781 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3782 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3783 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3784 -
3785 -В теле использовать тип **form-data,** тип значения** file**
3786 -
3787 -**Ключи**
3788 -
3789 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3790 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3791 -|csv|В значении передаем файл датчиков, формат **csv**
3792 -
3793 -Ответ:
3794 -
3795 -{
3796 - "vehicleId": 0,
3797 - "name": "string",
3798 - "errors": ["string"]
3799 -}
3800 -
3801 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3802 -|vehicleId|ID созданного объекта
3803 -|name|Имя созданного объекта
3804 -|errors|Ошибки и их описание
3805 -
3806 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3807 -
3808 -(% class="box infomessage" %)
3809 -(((
3810 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3811 -)))
3812 -
3813 -(% class="wikigeneratedid" %)
3814 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3815 -
3816 -(% class="wikigeneratedid" %)
3817 -В пути указывается **vehicleId **- id объекта.
3818 -
3819 -**Заголовок**
3820 -
3821 -**X-Auth: [токен авторизации]**
3822 -
3823 -В теле использовать тип **form-data.**
3824 -
3825 -Ключи:
3826 -
3827 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3828 -|**history**|В значении передавать файл с историей
3829 -
3830 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3831 -
3832 -Ответ:
3833 -
3834 -{
3835 - "results": [
3836 - {
3837 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3838 - "vehicleId": 0,
3839 - "errors": [
3840 - "string"
3841 - ],
3842 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3843 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3844 - "producedCount": 0,
3845 - "msgCount": 0
3846 - }
3847 - ]
3848 -}
3849 -
3850 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3851 -|results|Результаты импорта в разрезе ТС
3852 -|vehicleGuid|Guid ТС
3853 -|vehicleId|ID ТС
3854 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3855 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3856 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3857 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3858 -|msgCount|Кол-во обработанных сообщений всего
3859 -
3860 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3861 -
3862 -(% class="box infomessage" %)
3863 -(((
3864 -**GET /api/v3/vehicles/import/history/status**
3865 -)))
3866 -
3867 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3868 -
3869 -Ответ:
3870 -
3871 -{
3872 - "activity": true,
3873 - "progress": 0,
3874 - "message": "string"
3875 -}
3876 -
3877 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3878 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3879 -|progress|Guid ТС
3880 -
3881 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3882 -
3883 -(% class="box infomessage" %)
3884 -(((
3885 -**POST /api/v3/vehicles/export**
3886 -)))
3887 -
3888 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3889 -
3890 -Тело запроса:
3891 -
3892 -[
3893 - id
3894 -]
3895 -
3896 -Ответ: Success 200, получаете файлы с настройками.
3897 -
3898 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3899 -
3900 -(% class="box infomessage" %)
3901 -(((
3902 -**POST /api/v3/vehicles/export/history**
3903 -)))
3904 -
3905 -Метод возвращает список сообщений терминала объекта за выбранный период.
3906 -
3907 -Тело запроса:
3908 -
3909 -{
3910 - "vehicleId": 0,
3911 - "asArchive": true,
3912 - "from": "2023-09-27T12:17:45.973Z",
3913 - "to": "2023-09-27T12:17:45.973Z"
3914 -}
3915 -
3916 -Ответ:
3917 -
3918 -Получаете файл. Сообщение: Code 200/Success
3919 -
3920 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3921 -|vehicleId|ID объекта
3922 -|asArchive|true - Архивировать файл, False - не архивировать
3923 -|from|Дата и время начала запроса
3924 -|to|Дата и время окончания запроса
3925 -
3926 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3927 -
3928 -(% class="box infomessage" %)
3929 -(((
3930 -**GET /api/v3/vehicles/export/history/status**
3931 -)))
3932 -
3933 -Метод возвращает список сообщений терминала объекта за выбранный период.
3934 -
3935 -Ответ:
3936 -
3937 -{
3938 - "activity": true,
3939 - "progress": 0,
3940 - "message": "string"
3941 -}
3942 -
3943 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3944 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3945 -|progress|Прогресс экспорта, от 0 до 100%
3946 -|message|Текст описывающий статус
3947 -
3948 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3949 -
3950 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3951 -
3952 -(% class="box infomessage" %)
3953 -(((
3954 -**POST /api/v3/EcoDriving/rating**
3955 -)))
3956 -
3957 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3958 -
3959 -Тело запроса:
3960 -
3961 -{
3962 - "vehicleIds": [vehicleId],
3963 - "from": "2023-11-22T09:29:48.051Z",
3964 - "to": "2023-11-22T09:29:48.051Z"
3965 -}
3966 -
3967 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3968 -|vehicleIds|Массив ID объектов
3969 -|from|Дата начала запроса
3970 -|to|Дата окончания запроса
3971 -
3972 -Ответ:
3973 -
3974 -{
3975 - "items": [
3976 - {
3977 - "from": "2023-11-22T09:29:48.052Z",
3978 - "to": "2023-11-22T09:29:48.052Z",
3979 - "vehicleId": 0,
3980 - "vehicleName": "string",
3981 - "vehicleModel": "string",
3982 - "penalty": 0,
3983 - "score": 0,
3984 - "totalViolations": 0,
3985 - "violationsByType": {
3986 - "overspeedingViolations": 0,
3987 - "accelerationViolations": 0,
3988 - "brakingViolations": 0,
3989 - "turningViolations": 0,
3990 - "dangerousDrivingViolations": 0,
3991 - "sensorViolations": 0
3992 - },
3993 - "moveTime": 0,
3994 - "mileage": 0,
3995 - "tripsCount": 0,
3996 - "trips": [
3997 - {
3998 - "penalty": 0,
3999 - "score": 0,
4000 - "violationsCount": 0,
4001 - "violationsByType": {
4002 - "overspeedingViolations": 0,
4003 - "accelerationViolations": 0,
4004 - "brakingViolations": 0,
4005 - "turningViolations": 0,
4006 - "dangerousDrivingViolations": 0,
4007 - "sensorViolations": 0
4008 - },
4009 - "moveTime": 0,
4010 - "mileage": 0,
4011 - "motohours": 0,
4012 - "maxSpeed": 0,
4013 - "startAddress": "string",
4014 - "endAddress": "string",
4015 - "drivers": [
4016 - {
4017 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4018 - "driverName": "string",
4019 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4020 - }
4021 - ]
4022 - }
4023 - ]
4024 - }
4025 - ]
4026 -}
4027 -
4028 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4029 -|from|Дата начала запроса
4030 -|to|Дата  окончания
4031 -|vehicleId|ID объекта
4032 -|vehicleName|Имя объекта
4033 -|vehicleModel|Модель объекта
4034 -|penalty|Сумма штрафных баллов
4035 -|score|Оценка
4036 -|totalViolations|Суммарное количество нарушений
4037 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4038 -|overspeedingViolations|Превышение скорости
4039 -|accelerationViolations|Ускорение
4040 -|brakingViolations|Торможение
4041 -|turningViolations|Резкий поворот
4042 -|dangerousDrivingViolations|Резкое вождение
4043 -|sensorViolations|Нарушение по датчику
4044 -|moveTime|Время в движении
4045 -|mileage|Пробег
4046 -|tripsCount|Количество рейсов
4047 -|motohours|Моточасы
4048 -|maxSpeed|Максимальная скорость
4049 -|startAddress|Адрес начала рейса
4050 -|endAddress|Адрес окончания рейса
4051 -|drivers|Список водителей, которые были на объекте в течениии рейса
4052 -|driverGuid|Guid водителя
4053 -|driverName|Имя водителя
4054 -|driverRfid|Номер Карты-метки
4055 -
4056 4056  (% class="box" lang="en-US" style="text-align: center;" %)
4057 4057  (((
4058 4058  (% 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 г.