Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 114.1 >
edited by Илья Крайнов
on 2023/10/20 16:06
To version < 132.1 >
edited by Андрей Калиновский
on 2024/01/30 15:11
>
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,51 @@
1872 1872   }
1873 1873  ]
1874 1874  
1888 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1889 +
1890 +(% class="box infomessage" style="text-align: left;" %)
1891 +(((
1892 +**POST /api/v3/terminalMessages/mapping**
1893 +)))
1894 +
1895 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1896 +
1897 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1898 +
1899 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1900 +
1901 +{
1902 + "protocolType": 0,
1903 + "params": ["string"]
1904 +}
1905 +
1906 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1907 +|protocolType|ID типа протокола
1908 +|params|(((
1909 +Массив наименований параметров в сообщении
1910 +)))
1911 +
1912 +Ответ:
1913 +
1914 +{
1915 + "protocolType": 0,
1916 + "mapping": {
1917 + "additionalProp1": {
1918 + "inputType": 0,
1919 + "inputNumber": 0
1920 + },
1921 + "additionalProp2": {
1922 + "inputType": 0,
1923 + "inputNumber": 0
1924 + }
1925 + }
1926 +}
1927 +
1928 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1929 +|protocolType|Тип протокола
1930 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1931 +|inputNumber|Номер входа
1932 +
1875 1875  == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1876 1876  
1877 1877  (% class="box infomessage" %)
... ... @@ -1896,6 +1896,11 @@
1896 1896   "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса
1897 1897  }
1898 1898  
1957 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1958 +|vehicleId|ID объекта
1959 +|from|Дата и время начала периода запроса
1960 +|to|Дата и время окончания периода запроса
1961 +
1899 1899  Ответ:
1900 1900  
1901 1901  [
... ... @@ -1902,80 +1902,43 @@
1902 1902   {
1903 1903   "messages": [
1904 1904   {
1905 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства
1906 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера
1907 - "speed": 0, ~/~/ Скорость, км/ч
1908 - "altitude": 0, ~/~/ Высота, м
1909 - "latitude": 0, ~/~/ Широта [-90°;90°]
1910 - "longitude": 0, ~/~/ Долгота [-180°;180°]
1911 - "satellites": 0, ~/~/ Кол-во спутников
1912 - "voltage": 0, ~/~/ Напряжение
1913 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом
1968 + "deviceTime": "2023-11-29T07:40:44.052Z",
1969 + "serverTime": "2023-11-29T07:40:44.052Z",
1970 + "speed": 0,
1971 + "altitude": 0,
1972 + "latitude": 0,
1973 + "longitude": 0,
1974 + "satellites": 0,
1975 + "course": 0,
1976 + "voltage": 0,
1977 + "parameters": {
1914 1914   "additionalProp1": "string",
1915 1915   "additionalProp2": "string",
1916 1916   "additionalProp3": "string"
1917 1917   },
1918 - "photoCount": 0 ~/~/ Кол-во фото
1982 + "photoCount": 0,
1983 + "lbsCorrectedCoords": true,
1984 + "protocolType": 0
1919 1919   }
1920 1920   ]
1921 1921   }
1922 1922  ]
1923 1923  
1924 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
1990 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1991 +|deviceTime|Время сообщения терминала
1992 +|serverTime|Время когда сообщение поступило на сервер
1993 +|speed|Скорость
1994 +|altitude|Высота над уровнем моря
1995 +|latitude|Широта
1996 +|longitude|Долгота
1997 +|satellites|Кол-во спутников
1998 +|course|Курс
1999 +|voltage|Бортовое напряжение
2000 +|parameters|Список параметров и их значений
2001 +|photoCount|Количество фото
2002 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2003 +|protocolType|ID типа протокола
1925 1925  
1926 -(% class="box infomessage" %)
1927 -(((
1928 -**POST /api/v3/vehicles/export/history**
1929 -)))
1930 -
1931 -Метод возвращает список сообщений терминала объекта за выбранный период.
1932 -
1933 -(% style="text-align: left;" %)
1934 -Метод запроса **POST**
1935 -
1936 -(% style="text-align: left;" %)
1937 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history
1938 -
1939 -(% style="text-align: left;" %)
1940 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1941 -
1942 -{
1943 - "vehicleId": 0, ~/~/ ID объекта
1944 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать
1945 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса
1946 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса
1947 -}
1948 -
1949 -Ответ:
1950 -
1951 -Получаете файл. Сообщение: Code 200/Success
1952 -
1953 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
1954 -
1955 -(% class="box infomessage" %)
1956 -(((
1957 -**GET /api/v3/vehicles/export/history/status**
1958 -)))
1959 -
1960 -Метод возвращает список сообщений терминала объекта за выбранный период.
1961 -
1962 -(% style="text-align: left;" %)
1963 -Метод запроса **GET**
1964 -
1965 -(% style="text-align: left;" %)
1966 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status
1967 -
1968 -(% style="text-align: left;" %)
1969 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1970 -
1971 -Ответ:
1972 -
1973 -{
1974 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
1975 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%.
1976 - "message": "string" ~/~/ текст описывающий статус.
1977 -}
1978 -
1979 1979  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) =
1980 1980  
1981 1981  == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -2109,6 +2109,91 @@
2109 2109   }
2110 2110  ]
2111 2111  
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 +
2174 + "vehicleId": 0, ~/~/ ID объекта
2175 +
2176 + "vehicleName": "string", ~/~/ Имя объекта
2177 +
2178 + "moves": [ ~/~/ Событие движения
2179 +
2180 + {
2181 +
2182 + "mileage": 0, ~/~/ Пробег, км
2183 +
2184 + "eventId": 0, ~/~/ Идентификатор события
2185 +
2186 + "eventName": "string", ~/~/ Название события
2187 +
2188 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2189 +
2190 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2191 +
2192 + "duration": 0 ~/~/ Продолжительность события, секунд
2193 +
2194 + }
2195 +
2196 + ],
2197 +
2198 + "stops": [ ~/~/ События стоянок
2199 +
2200 + {
2201 +
2202 + "address": "string", ~/~/ Адрес события
2203 +
2204 + "eventId": 0, ~/~/ Идентификатор события
2205 +
2206 + "eventName": "string", ~/~/ Название события
2207 +
2208 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2209 +
2210 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2211 +
2212 + "duration": 0 ~/~/ Продолжительность события, секунд
2213 +
2214 +
2215 + }
2216 +
2217 + ]
2218 +
2219 + }
2220 +
2221 +]
2222 +
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  
3121 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) =
3122 +
3123 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) ==
3124 +
3125 +(% class="box infomessage" %)
3126 +(((
3127 +**POST /api/v3/Trailers**
3128 +)))
3129 +
3130 +Пример запроса:
3131 +
3132 +{
3133 + "startDate": "2023-11-14T10:48:03.671Z",
3134 + "endDate": "2023-11-14T10:48:03.671Z",
3135 + "ids": [ 0 ],
3136 + "timezone": 0
3137 +}
3138 +
3139 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3140 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса
3141 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса
3142 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов
3143 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC.
3144 +
3145 +Пример ответа:
3146 +
3147 +[
3148 + {
3149 + "SD": "2023-11-14T10:48:03.717Z",
3150 + "ED": "2023-11-14T10:48:03.717Z", 
3151 + "id": 0,
3152 + "SLat": 0,
3153 + "SLon": 0,
3154 + "ELat": 0,
3155 + "ELon": 0,
3156 + "mileage": 0
3157 + "Duration": 0
3158 + "Address": "string",
3159 + "Address2": "string",
3160 + "name": "string",
3161 + "rid": "string",
3162 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3163 + "trailer": {
3164 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3165 + "Number": "string",
3166 + "Description": "string",
3167 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3168 + "ExternalID": "string",
3169 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3170 + "CreateTime": "2023-11-14T10:48:03.717Z",
3171 + "UpdateTime": "2023-11-14T10:48:03.717Z",
3172 + "IsDeleted": true
3173 + },
3174 + "filesCount": 0,
3175 + }
3176 +]
3177 +
3178 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3179 +|SD|Дата и время начала события
3180 +|ED|Дата и время окончания события
3181 +|id|ID объекта
3182 +|SLat|Широта начальной координаты
3183 +|SLon|Долгота начальной координаты
3184 +|ELat|Широта конечной координаты
3185 +|ELon|Долгота конечной координаты
3186 +|mileage|Пробег
3187 +|Duration|Продолжительность
3188 +|Address|Адрес начального местоположения
3189 +|Address2|Адрес конечного местоположения
3190 +|name|Имя радиометки
3191 +|rid|Номер радиометки
3192 +|rguid|ID радиометки
3193 +|trailer|Информация об агрегате
3194 +|ModelGuid|ID агрегата
3195 +|Number|Название/номер агрегата
3196 +|Description|Текст примечания агрегата
3197 +
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, ~/~/ Частота трансляции радиометки
3219 + "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  
3225 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3226 +|parentId|ID клиента
3227 +|name|Название карты-метки
3228 +|number|Номер
3229 +|period|Период запросов в секундах (работает только для агрегатов)
3230 +|id|ID карты-метки
3231 +
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, ~/~/ Частота трансляции радиометки
3247 + "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  
3253 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3254 +|name|Название карты-метки
3255 +|number|Номер
3256 +|period|Период запросов в секундах (работает только для агрегатов)
3257 +|id|ID карты-метки
3258 +|parentId|ID клиента
3259 +
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  
3286 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3287 +|name|Название карты-метки
3288 +|number|Номер
3289 +|period|Период запросов в секундах (работает только для агрегатов)
3290 +|id|ID карты-метки
3291 +|parentId|ID клиента
3292 +
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  
3320 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3321 +|name|Название карты-метки
3322 +|number|Номер
3323 +|period|Период запросов в секундах (работает только для агрегатов)
3324 +|id|ID карты-метки
3325 +|parentId|ID клиента
3326 +
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  
3575 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3576 +
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  
3590 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3591 +
3592 +(% class="box warningmessage" %)
3593 +(((
3594 +**PUT /api/v3/billing/client/balance/deposit**
3595 +)))
3596 +
3597 +Создает операцию **Пополнение **с указанной суммой
3598 +
3599 +Тело запроса:
3600 +
3601 +{
3602 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3603 + "Balance": 0
3604 +}
3605 +
3606 +Ответ: Success
3607 +
3608 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3609 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3610 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3611 +
3612 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3613 +
3614 +Создает операцию **Списание **с указанной суммой
3615 +
3616 +(% class="box warningmessage" %)
3617 +(((
3618 +**PUT /api/v3/billing/client/balance/withdraw**
3619 +)))
3620 +
3621 +Тело запроса:
3622 +
3623 +{
3624 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3625 + "Balance": 0
3626 +}
3627 +
3628 +Ответ: Success
3629 +
3630 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3631 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3632 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3633 +
3378 3378  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3379 3379  
3380 3380  (% class="box warningmessage" %)
... ... @@ -3447,6 +3447,305 @@
3447 3447  |PeriodValue|Значение периода.
3448 3448  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3449 3449  
3706 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3707 +
3708 +(% class="box warningmessage" %)
3709 +(((
3710 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3711 +)))
3712 +
3713 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3714 +
3715 +(% class="box infomessage" %)
3716 +(((
3717 +**POST /api/v3/vehicles/import/{agentId}**
3718 +)))
3719 +
3720 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3721 +
3722 +В пути указывается **agentId** - id клиента.
3723 +
3724 +**Заголовок**
3725 +
3726 +**X-Auth: [токен авторизации]**
3727 +
3728 +**Параметры**
3729 +
3730 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3731 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3732 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3733 +
3734 +В теле использовать тип **form-data,** тип значения** file**
3735 +
3736 +**Ключи**
3737 +
3738 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3739 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3740 +|csv|В значении передаем файл датчиков, формат **csv**
3741 +
3742 +Ответ:
3743 +
3744 +{
3745 + "vehicleId": 0,
3746 + "name": "string",
3747 + "errors": ["string"]
3748 +}
3749 +
3750 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3751 +|vehicleId|ID созданного объекта
3752 +|name|Имя созданного объекта
3753 +|errors|Ошибки и их описание
3754 +
3755 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3756 +
3757 +(% class="box infomessage" %)
3758 +(((
3759 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3760 +)))
3761 +
3762 +(% class="wikigeneratedid" %)
3763 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3764 +
3765 +(% class="wikigeneratedid" %)
3766 +В пути указывается **vehicleId **- id объекта.
3767 +
3768 +**Заголовок**
3769 +
3770 +**X-Auth: [токен авторизации]**
3771 +
3772 +В теле использовать тип **form-data.**
3773 +
3774 +Ключи:
3775 +
3776 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3777 +|**history**|В значении передавать файл с историей
3778 +
3779 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3780 +
3781 +Ответ:
3782 +
3783 +{
3784 + "results": [
3785 + {
3786 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3787 + "vehicleId": 0,
3788 + "errors": [
3789 + "string"
3790 + ],
3791 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3792 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3793 + "producedCount": 0,
3794 + "msgCount": 0
3795 + }
3796 + ]
3797 +}
3798 +
3799 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3800 +|results|Результаты импорта в разрезе ТС
3801 +|vehicleGuid|Guid ТС
3802 +|vehicleId|ID ТС
3803 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3804 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3805 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3806 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3807 +|msgCount|Кол-во обработанных сообщений всего
3808 +
3809 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3810 +
3811 +(% class="box infomessage" %)
3812 +(((
3813 +**GET /api/v3/vehicles/import/history/status**
3814 +)))
3815 +
3816 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3817 +
3818 +Ответ:
3819 +
3820 +{
3821 + "activity": true,
3822 + "progress": 0,
3823 + "message": "string"
3824 +}
3825 +
3826 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3827 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3828 +|progress|Guid ТС
3829 +
3830 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3831 +
3832 +(% class="box infomessage" %)
3833 +(((
3834 +**POST /api/v3/vehicles/export**
3835 +)))
3836 +
3837 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3838 +
3839 +Тело запроса:
3840 +
3841 +[
3842 + id
3843 +]
3844 +
3845 +Ответ: Success 200, получаете файлы с настройками.
3846 +
3847 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3848 +
3849 +(% class="box infomessage" %)
3850 +(((
3851 +**POST /api/v3/vehicles/export/history**
3852 +)))
3853 +
3854 +Метод возвращает список сообщений терминала объекта за выбранный период.
3855 +
3856 +Тело запроса:
3857 +
3858 +{
3859 + "vehicleId": 0,
3860 + "asArchive": true,
3861 + "from": "2023-09-27T12:17:45.973Z",
3862 + "to": "2023-09-27T12:17:45.973Z"
3863 +}
3864 +
3865 +Ответ:
3866 +
3867 +Получаете файл. Сообщение: Code 200/Success
3868 +
3869 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3870 +|vehicleId|ID объекта
3871 +|asArchive|true - Архивировать файл, False - не архивировать
3872 +|from|Дата и время начала запроса
3873 +|to|Дата и время окончания запроса
3874 +
3875 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3876 +
3877 +(% class="box infomessage" %)
3878 +(((
3879 +**GET /api/v3/vehicles/export/history/status**
3880 +)))
3881 +
3882 +Метод возвращает список сообщений терминала объекта за выбранный период.
3883 +
3884 +Ответ:
3885 +
3886 +{
3887 + "activity": true,
3888 + "progress": 0,
3889 + "message": "string"
3890 +}
3891 +
3892 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3893 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3894 +|progress|Прогресс экспорта, от 0 до 100%
3895 +|message|Текст описывающий статус
3896 +
3897 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3898 +
3899 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3900 +
3901 +(% class="box infomessage" %)
3902 +(((
3903 +**POST /api/v3/EcoDriving/rating**
3904 +)))
3905 +
3906 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3907 +
3908 +Тело запроса:
3909 +
3910 +{
3911 + "vehicleIds": [vehicleId],
3912 + "from": "2023-11-22T09:29:48.051Z",
3913 + "to": "2023-11-22T09:29:48.051Z"
3914 +}
3915 +
3916 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3917 +|vehicleIds|Массив ID объектов
3918 +|from|Дата начала запроса
3919 +|to|Дата окончания запроса
3920 +
3921 +Ответ:
3922 +
3923 +{
3924 + "items": [
3925 + {
3926 + "from": "2023-11-22T09:29:48.052Z",
3927 + "to": "2023-11-22T09:29:48.052Z",
3928 + "vehicleId": 0,
3929 + "vehicleName": "string",
3930 + "vehicleModel": "string",
3931 + "penalty": 0,
3932 + "score": 0,
3933 + "totalViolations": 0,
3934 + "violationsByType": {
3935 + "overspeedingViolations": 0,
3936 + "accelerationViolations": 0,
3937 + "brakingViolations": 0,
3938 + "turningViolations": 0,
3939 + "dangerousDrivingViolations": 0,
3940 + "sensorViolations": 0
3941 + },
3942 + "moveTime": 0,
3943 + "mileage": 0,
3944 + "tripsCount": 0,
3945 + "trips": [
3946 + {
3947 + "penalty": 0,
3948 + "score": 0,
3949 + "violationsCount": 0,
3950 + "violationsByType": {
3951 + "overspeedingViolations": 0,
3952 + "accelerationViolations": 0,
3953 + "brakingViolations": 0,
3954 + "turningViolations": 0,
3955 + "dangerousDrivingViolations": 0,
3956 + "sensorViolations": 0
3957 + },
3958 + "moveTime": 0,
3959 + "mileage": 0,
3960 + "motohours": 0,
3961 + "maxSpeed": 0,
3962 + "startAddress": "string",
3963 + "endAddress": "string",
3964 + "drivers": [
3965 + {
3966 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3967 + "driverName": "string",
3968 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
3969 + }
3970 + ]
3971 + }
3972 + ]
3973 + }
3974 + ]
3975 +}
3976 +
3977 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3978 +|from|Дата начала запроса
3979 +|to|Дата  окончания
3980 +|vehicleId|ID объекта
3981 +|vehicleName|Имя объекта
3982 +|vehicleModel|Модель объекта
3983 +|penalty|Сумма штрафных баллов
3984 +|score|Оценка
3985 +|totalViolations|Суммарное количество нарушений
3986 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
3987 +|overspeedingViolations|Превышение скорости
3988 +|accelerationViolations|Ускорение
3989 +|brakingViolations|Торможение
3990 +|turningViolations|Резкий поворот
3991 +|dangerousDrivingViolations|Резкое вождение
3992 +|sensorViolations|Нарушение по датчику
3993 +|moveTime|Время в движении
3994 +|mileage|Пробег
3995 +|tripsCount|Количество рейсов
3996 +|motohours|Моточасы
3997 +|maxSpeed|Максимальная скорость
3998 +|startAddress|Адрес начала рейса
3999 +|endAddress|Адрес окончания рейса
4000 +|drivers|Список водителей, которые были на объекте в течениии рейса
4001 +|driverGuid|Guid водителя
4002 +|driverName|Имя водителя
4003 +|driverRfid|Номер Карты-метки
4004 +
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 г.