Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 131.1 >
edited by Андрей Калиновский
on 2024/01/30 15:09
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,92 +2135,6 @@
2135 2135   }
2136 2136  ]
2137 2137  
2138 -
2139 -(% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**
2140 -
2141 -
2142 -(% class="box infomessage" %)
2143 -(((
2144 -**POST/api/v3/vehicles/moveStop**
2145 -)))
2146 -
2147 -Метод запроса: **POST**
2148 -
2149 -URL запроса: [[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/moveStop]]
2150 -
2151 -В заголовках запроса: X-Auth: Токен авторизации
2152 -
2153 -
2154 -Тело запроса:
2155 -
2156 -{
2157 -
2158 - "vehicleIds": [ ], ~/~/ Список ID объектов
2159 -
2160 - "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2161 -
2162 - "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2163 -
2164 - "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2165 -
2166 -}
2167 -
2168 -
2169 -Ответ:
2170 -
2171 -[
2172 -
2173 - {
2174 -
2175 - "vehicleId": 0, ~/~/ ID объекта
2176 -
2177 - "vehicleName": "string", ~/~/ Имя объекта
2178 -
2179 - "moves": [ ~/~/ Событие движения
2180 -
2181 - {
2182 -
2183 - "mileage": 0, ~/~/ Пробег, км
2184 -
2185 - "eventId": 0, ~/~/ Идентификатор события
2186 -
2187 - "eventName": "string", ~/~/ Название события
2188 -
2189 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2190 -
2191 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2192 -
2193 - "duration": 0 ~/~/ Продолжительность события, секунд
2194 -
2195 - }
2196 -
2197 - ],
2198 -
2199 - "stops": [ ~/~/ События стоянок
2200 -
2201 - {
2202 -
2203 - "address": "string", ~/~/ Адрес события
2204 -
2205 - "eventId": 0, ~/~/ Идентификатор события
2206 -
2207 - "eventName": "string", ~/~/ Название события
2208 -
2209 - "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2210 -
2211 - "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2212 -
2213 - "duration": 0 ~/~/ Продолжительность события, секунд
2214 -
2215 -
2216 - }
2217 -
2218 - ]
2219 -
2220 - }
2221 -
2222 -]
2223 -
2224 2224  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2225 2225  
2226 2226  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3119,83 +3119,6 @@
3119 3119  Success
3120 3120  
3121 3121  
3122 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3123 -
3124 -== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3125 -
3126 -(% class="box infomessage" %)
3127 -(((
3128 -**POST /api/v3/Trailers**
3129 -)))
3130 -
3131 -Пример запроса:
3132 -
3133 -{
3134 - "startDate": "2023-11-14T10:48:03.671Z",
3135 - "endDate": "2023-11-14T10:48:03.671Z",
3136 - "ids": [ 0 ],
3137 - "timezone": 0
3138 -}
3139 -
3140 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3141 -|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3142 -|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3143 -|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3144 -|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3145 -
3146 -Пример ответа:
3147 -
3148 -[
3149 - {
3150 - "SD": "2023-11-14T10:48:03.717Z",
3151 - "ED": "2023-11-14T10:48:03.717Z", 
3152 - "id": 0,
3153 - "SLat": 0,
3154 - "SLon": 0,
3155 - "ELat": 0,
3156 - "ELon": 0,
3157 - "mileage": 0
3158 - "Duration": 0
3159 - "Address": "string",
3160 - "Address2": "string",
3161 - "name": "string",
3162 - "rid": "string",
3163 - "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3164 - "trailer": {
3165 - "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3166 - "Number": "string",
3167 - "Description": "string",
3168 - "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3169 - "ExternalID": "string",
3170 - "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3171 - "CreateTime": "2023-11-14T10:48:03.717Z",
3172 - "UpdateTime": "2023-11-14T10:48:03.717Z",
3173 - "IsDeleted": true
3174 - },
3175 - "filesCount": 0,
3176 - }
3177 -]
3178 -
3179 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3180 -|SD|Дата и время начала события
3181 -|ED|Дата и время окончания события
3182 -|id|ID объекта
3183 -|SLat|Широта начальной координаты
3184 -|SLon|Долгота начальной координаты
3185 -|ELat|Широта конечной координаты
3186 -|ELon|Долгота конечной координаты
3187 -|mileage|Пробег
3188 -|Duration|Продолжительность
3189 -|Address|Адрес начального местоположения
3190 -|Address2|Адрес конечного местоположения
3191 -|name|Имя радиометки
3192 -|rid|Номер радиометки
3193 -|rguid|ID радиометки
3194 -|trailer|Информация об агрегате
3195 -|ModelGuid|ID агрегата
3196 -|Number|Название/номер агрегата
3197 -|Description|Текст примечания агрегата
3198 -
3199 3199  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3200 3200  
3201 3201  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3217,19 +3217,13 @@
3217 3217   {
3218 3218   "name": "string",
3219 3219   "number": 0,
3220 - "period": 0,
3031 + "period": 0, ~/~/ Частота трансляции радиометки
3221 3221   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3222 3222   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3034 + "deleted": true
3223 3223   }
3224 3224  ]
3225 3225  
3226 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3227 -|parentId|ID клиента
3228 -|name|Название карты-метки
3229 -|number|Номер
3230 -|period|Период запросов в секундах (работает только для агрегатов)
3231 -|id|ID карты-метки
3232 -
3233 3233  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3234 3234  
3235 3235  (% class="box infomessage" %)
... ... @@ -3245,19 +3245,13 @@
3245 3245   {
3246 3246   "name": "string",
3247 3247   "number": 0,
3248 - "period": 0,
3053 + "period": 0, ~/~/ Частота трансляции радиометки
3249 3249   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3250 3250   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3056 + "deleted": true
3251 3251   }
3252 3252  ]
3253 3253  
3254 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3255 -|name|Название карты-метки
3256 -|number|Номер
3257 -|period|Период запросов в секундах (работает только для агрегатов)
3258 -|id|ID карты-метки
3259 -|parentId|ID клиента
3260 -
3261 3261  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3262 3262  
3263 3263  (% class="box successmessage" %)
... ... @@ -3272,6 +3272,7 @@
3272 3272   "number": 0,
3273 3273   "period": 0,
3274 3274   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3074 + "deleted": true
3275 3275  }
3276 3276  
3277 3277  Ответ:
... ... @@ -3282,15 +3282,9 @@
3282 3282   "period": 0,
3283 3283   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3284 3284   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3085 + "deleted": true
3285 3285  }
3286 3286  
3287 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3288 -|name|Название карты-метки
3289 -|number|Номер
3290 -|period|Период запросов в секундах (работает только для агрегатов)
3291 -|id|ID карты-метки
3292 -|parentId|ID клиента
3293 -
3294 3294  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3295 3295  
3296 3296  (% class="box warningmessage" %)
... ... @@ -3306,6 +3306,7 @@
3306 3306   "period": 0,
3307 3307   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3308 3308   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3103 + "deleted": true
3309 3309  }
3310 3310  
3311 3311  Ответ:
... ... @@ -3316,15 +3316,9 @@
3316 3316   "period": 0,
3317 3317   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3318 3318   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3114 + "deleted": true
3319 3319  }
3320 3320  
3321 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3322 -|name|Название карты-метки
3323 -|number|Номер
3324 -|period|Период запросов в секундах (работает только для агрегатов)
3325 -|id|ID карты-метки
3326 -|parentId|ID клиента
3327 -
3328 3328  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3329 3329  
3330 3330  (% class="box errormessage" %)
... ... @@ -3573,8 +3573,6 @@
3573 3573  **PUT /api/v3/Billing/client/balance**
3574 3574  )))
3575 3575  
3576 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3577 -
3578 3578  Тело запроса:
3579 3579  
3580 3580  {
... ... @@ -3588,50 +3588,6 @@
3588 3588  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3589 3589  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3590 3590  
3591 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3592 -
3593 -(% class="box warningmessage" %)
3594 -(((
3595 -**PUT /api/v3/billing/client/balance/deposit**
3596 -)))
3597 -
3598 -Создает операцию **Пополнение **с указанной суммой
3599 -
3600 -Тело запроса:
3601 -
3602 -{
3603 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3604 - "Balance": 0
3605 -}
3606 -
3607 -Ответ: Success
3608 -
3609 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3610 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3611 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3612 -
3613 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3614 -
3615 -Создает операцию **Списание **с указанной суммой
3616 -
3617 -(% class="box warningmessage" %)
3618 -(((
3619 -**PUT /api/v3/billing/client/balance/withdraw**
3620 -)))
3621 -
3622 -Тело запроса:
3623 -
3624 -{
3625 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3626 - "Balance": 0
3627 -}
3628 -
3629 -Ответ: Success
3630 -
3631 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3632 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3633 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3634 -
3635 3635  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3636 3636  
3637 3637  (% class="box warningmessage" %)
... ... @@ -3704,305 +3704,6 @@
3704 3704  |PeriodValue|Значение периода.
3705 3705  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3706 3706  
3707 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3708 -
3709 -(% class="box warningmessage" %)
3710 -(((
3711 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3712 -)))
3713 -
3714 -== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3715 -
3716 -(% class="box infomessage" %)
3717 -(((
3718 -**POST /api/v3/vehicles/import/{agentId}**
3719 -)))
3720 -
3721 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3722 -
3723 -В пути указывается **agentId** - id клиента.
3724 -
3725 -**Заголовок**
3726 -
3727 -**X-Auth: [токен авторизации]**
3728 -
3729 -**Параметры**
3730 -
3731 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3732 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3733 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3734 -
3735 -В теле использовать тип **form-data,** тип значения** file**
3736 -
3737 -**Ключи**
3738 -
3739 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3740 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3741 -|csv|В значении передаем файл датчиков, формат **csv**
3742 -
3743 -Ответ:
3744 -
3745 -{
3746 - "vehicleId": 0,
3747 - "name": "string",
3748 - "errors": ["string"]
3749 -}
3750 -
3751 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3752 -|vehicleId|ID созданного объекта
3753 -|name|Имя созданного объекта
3754 -|errors|Ошибки и их описание
3755 -
3756 -== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3757 -
3758 -(% class="box infomessage" %)
3759 -(((
3760 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3761 -)))
3762 -
3763 -(% class="wikigeneratedid" %)
3764 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3765 -
3766 -(% class="wikigeneratedid" %)
3767 -В пути указывается **vehicleId **- id объекта.
3768 -
3769 -**Заголовок**
3770 -
3771 -**X-Auth: [токен авторизации]**
3772 -
3773 -В теле использовать тип **form-data.**
3774 -
3775 -Ключи:
3776 -
3777 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3778 -|**history**|В значении передавать файл с историей
3779 -
3780 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3781 -
3782 -Ответ:
3783 -
3784 -{
3785 - "results": [
3786 - {
3787 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3788 - "vehicleId": 0,
3789 - "errors": [
3790 - "string"
3791 - ],
3792 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3793 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3794 - "producedCount": 0,
3795 - "msgCount": 0
3796 - }
3797 - ]
3798 -}
3799 -
3800 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3801 -|results|Результаты импорта в разрезе ТС
3802 -|vehicleGuid|Guid ТС
3803 -|vehicleId|ID ТС
3804 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3805 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3806 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3807 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3808 -|msgCount|Кол-во обработанных сообщений всего
3809 -
3810 -== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3811 -
3812 -(% class="box infomessage" %)
3813 -(((
3814 -**GET /api/v3/vehicles/import/history/status**
3815 -)))
3816 -
3817 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3818 -
3819 -Ответ:
3820 -
3821 -{
3822 - "activity": true,
3823 - "progress": 0,
3824 - "message": "string"
3825 -}
3826 -
3827 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3828 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3829 -|progress|Guid ТС
3830 -
3831 -== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3832 -
3833 -(% class="box infomessage" %)
3834 -(((
3835 -**POST /api/v3/vehicles/export**
3836 -)))
3837 -
3838 -Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3839 -
3840 -Тело запроса:
3841 -
3842 -[
3843 - id
3844 -]
3845 -
3846 -Ответ: Success 200, получаете файлы с настройками.
3847 -
3848 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3849 -
3850 -(% class="box infomessage" %)
3851 -(((
3852 -**POST /api/v3/vehicles/export/history**
3853 -)))
3854 -
3855 -Метод возвращает список сообщений терминала объекта за выбранный период.
3856 -
3857 -Тело запроса:
3858 -
3859 -{
3860 - "vehicleId": 0,
3861 - "asArchive": true,
3862 - "from": "2023-09-27T12:17:45.973Z",
3863 - "to": "2023-09-27T12:17:45.973Z"
3864 -}
3865 -
3866 -Ответ:
3867 -
3868 -Получаете файл. Сообщение: Code 200/Success
3869 -
3870 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3871 -|vehicleId|ID объекта
3872 -|asArchive|true - Архивировать файл, False - не архивировать
3873 -|from|Дата и время начала запроса
3874 -|to|Дата и время окончания запроса
3875 -
3876 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3877 -
3878 -(% class="box infomessage" %)
3879 -(((
3880 -**GET /api/v3/vehicles/export/history/status**
3881 -)))
3882 -
3883 -Метод возвращает список сообщений терминала объекта за выбранный период.
3884 -
3885 -Ответ:
3886 -
3887 -{
3888 - "activity": true,
3889 - "progress": 0,
3890 - "message": "string"
3891 -}
3892 -
3893 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3894 -|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3895 -|progress|Прогресс экспорта, от 0 до 100%
3896 -|message|Текст описывающий статус
3897 -
3898 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3899 -
3900 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3901 -
3902 -(% class="box infomessage" %)
3903 -(((
3904 -**POST /api/v3/EcoDriving/rating**
3905 -)))
3906 -
3907 -Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3908 -
3909 -Тело запроса:
3910 -
3911 -{
3912 - "vehicleIds": [vehicleId],
3913 - "from": "2023-11-22T09:29:48.051Z",
3914 - "to": "2023-11-22T09:29:48.051Z"
3915 -}
3916 -
3917 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3918 -|vehicleIds|Массив ID объектов
3919 -|from|Дата начала запроса
3920 -|to|Дата окончания запроса
3921 -
3922 -Ответ:
3923 -
3924 -{
3925 - "items": [
3926 - {
3927 - "from": "2023-11-22T09:29:48.052Z",
3928 - "to": "2023-11-22T09:29:48.052Z",
3929 - "vehicleId": 0,
3930 - "vehicleName": "string",
3931 - "vehicleModel": "string",
3932 - "penalty": 0,
3933 - "score": 0,
3934 - "totalViolations": 0,
3935 - "violationsByType": {
3936 - "overspeedingViolations": 0,
3937 - "accelerationViolations": 0,
3938 - "brakingViolations": 0,
3939 - "turningViolations": 0,
3940 - "dangerousDrivingViolations": 0,
3941 - "sensorViolations": 0
3942 - },
3943 - "moveTime": 0,
3944 - "mileage": 0,
3945 - "tripsCount": 0,
3946 - "trips": [
3947 - {
3948 - "penalty": 0,
3949 - "score": 0,
3950 - "violationsCount": 0,
3951 - "violationsByType": {
3952 - "overspeedingViolations": 0,
3953 - "accelerationViolations": 0,
3954 - "brakingViolations": 0,
3955 - "turningViolations": 0,
3956 - "dangerousDrivingViolations": 0,
3957 - "sensorViolations": 0
3958 - },
3959 - "moveTime": 0,
3960 - "mileage": 0,
3961 - "motohours": 0,
3962 - "maxSpeed": 0,
3963 - "startAddress": "string",
3964 - "endAddress": "string",
3965 - "drivers": [
3966 - {
3967 - "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3968 - "driverName": "string",
3969 - "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3970 - }
3971 - ]
3972 - }
3973 - ]
3974 - }
3975 - ]
3976 -}
3977 -
3978 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3979 -|from|Дата начала запроса
3980 -|to|Дата  окончания
3981 -|vehicleId|ID объекта
3982 -|vehicleName|Имя объекта
3983 -|vehicleModel|Модель объекта
3984 -|penalty|Сумма штрафных баллов
3985 -|score|Оценка
3986 -|totalViolations|Суммарное количество нарушений
3987 -|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3988 -|overspeedingViolations|Превышение скорости
3989 -|accelerationViolations|Ускорение
3990 -|brakingViolations|Торможение
3991 -|turningViolations|Резкий поворот
3992 -|dangerousDrivingViolations|Резкое вождение
3993 -|sensorViolations|Нарушение по датчику
3994 -|moveTime|Время в движении
3995 -|mileage|Пробег
3996 -|tripsCount|Количество рейсов
3997 -|motohours|Моточасы
3998 -|maxSpeed|Максимальная скорость
3999 -|startAddress|Адрес начала рейса
4000 -|endAddress|Адрес окончания рейса
4001 -|drivers|Список водителей, которые были на объекте в течениии рейса
4002 -|driverGuid|Guid водителя
4003 -|driverName|Имя водителя
4004 -|driverRfid|Номер Карты-метки
4005 -
4006 4006  (% class="box" lang="en-US" style="text-align: center;" %)
4007 4007  (((
4008 4008  (% 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 г.