Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 137.1 >
edited by Андрей Калиновский
on 2024/02/28 09:37
To version < 119.2 >
edited by Илья Крайнов
on 2023/11/24 15:58
>
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
... ... @@ -173,6 +173,7 @@
173 173  {
174 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,25 @@
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 типа протокола
2004 -
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 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2245 -
2246 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
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" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -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" %)
... ... @@ -3768,95 +3768,21 @@
3768 3768  **POST /api/v3/vehicles/import/{agentId}**
3769 3769  )))
3770 3770  
3771 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3508 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp **. В формате **xml **экспортируются объекты из нашей системы.
3772 3772  
3773 -В пути указывается **agentId** - id клиента.
3510 +**agentId** - id клиента, указывается в пути запроса. (обязательный)
3774 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 3806  == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3807 3807  
3808 3808  (% class="box infomessage" %)
3809 3809  (((
3810 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3516 +**POST /api/v3/vehicles/import/history/{vehicleId}**
3811 3811  )))
3812 3812  
3813 3813  (% class="wikigeneratedid" %)
3814 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3520 +**vehicleId **- id объекта.
3815 3815  
3816 -(% class="wikigeneratedid" %)
3817 -В пути указывается **vehicleId **- id объекта.
3818 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 3860  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3861 3861  
3862 3862  (% class="box infomessage" %)
... ... @@ -3864,20 +3864,7 @@
3864 3864  **GET /api/v3/vehicles/import/history/status**
3865 3865  )))
3866 3866  
3867 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3868 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 3881  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3882 3882  
3883 3883  (% class="box infomessage" %)
... ... @@ -3947,7 +3947,7 @@
3947 3947  
3948 3948  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3949 3949  
3950 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3600 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3951 3951  
3952 3952  (% class="box infomessage" %)
3953 3953  (((

Меню

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