Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 131.1 >
edited by Андрей Калиновский
on 2024/01/30 15:09
To version < 120.1 >
edited by Илья Крайнов
on 2023/11/27 09:31
>
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,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" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -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" %)
... ... @@ -3718,95 +3718,22 @@
3718 3718  **POST /api/v3/vehicles/import/{agentId}**
3719 3719  )))
3720 3720  
3721 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3508 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp **. В формате **xml **экспортируются объекты из нашей системы.
3722 3722  
3723 -В пути указывается **agentId** - id клиента.
3510 +**agentId** - id клиента, указывается в пути запроса. (обязательный)
3724 3724  
3725 -**Заголовок**
3726 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 3756  == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3757 3757  
3758 3758  (% class="box infomessage" %)
3759 3759  (((
3760 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3517 +**POST /api/v3/vehicles/import/history/{vehicleId}**
3761 3761  )))
3762 3762  
3763 3763  (% class="wikigeneratedid" %)
3764 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3521 +**vehicleId **- id объекта.
3765 3765  
3766 -(% class="wikigeneratedid" %)
3767 -В пути указывается **vehicleId **- id объекта.
3768 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 3810  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3811 3811  
3812 3812  (% class="box infomessage" %)
... ... @@ -3814,20 +3814,7 @@
3814 3814  **GET /api/v3/vehicles/import/history/status**
3815 3815  )))
3816 3816  
3817 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3818 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 3831  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3832 3832  
3833 3833  (% class="box infomessage" %)
... ... @@ -3897,7 +3897,7 @@
3897 3897  
3898 3898  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3899 3899  
3900 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3601 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3901 3901  
3902 3902  (% class="box infomessage" %)
3903 3903  (((

Меню

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