Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 115.1 >
edited by Илья Крайнов
on 2023/11/14 14:29
To version < 158.2 >
edited by Андрей Калиновский
on 2024/07/19 15:59
>
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
... ... @@ -60,6 +60,9 @@
60 60  |(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации
61 61  |(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя
62 62  
63 +(% class="wikigeneratedid" %)
64 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]])
65 +
63 63  == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) ==
64 64  
65 65  (% class="box infomessage" %)
... ... @@ -173,7 +173,6 @@
173 173  {
174 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  
360 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
361 +
362 +(% class="box warningmessage" %)
363 +(((
364 +**PUT /api/v3/agents/{id}/changeStatus/{status}**
365 +)))
366 +
367 +Метод позволяет изменить статус клиента, указанного в запросе.
368 +
369 +В пути указывается GUID клиента и статус клиента.
370 +
371 +**status **- значение 0 - заблокирован, 1 - активен.
372 +
373 +Ответ: Code 204
374 +
359 359  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
360 360  
361 361  == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
... ... @@ -1124,31 +1124,19 @@
1124 1124   },
1125 1125  
1126 1126  ~/~/ Характерные для произвольного:
1127 -
1128 1128  ~/~/  "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off
1129 -
1130 1130  ~/~/  "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы
1131 -
1132 1132  ~/~/  "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off
1133 -
1134 1134  ~/~/  "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний
1135 -
1136 1136  ~/~/  "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off
1137 -
1138 1138  ~/~/  "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off
1139 -
1140 1140  ~/~/  "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off
1141 -
1142 1142  ~/~/  "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область)
1143 -
1144 1144  ~/~/ Характерные для таблицы тарировки Вкл./Выкл.:
1145 -
1146 1146  ~/~/ "ValueOn": "Вкл.",
1147 -
1148 1148  ~/~/ "ValueOff": "Выкл."
1149 1149   "summaryMaxValue": 0 ~/~/ Макс. значение
1150 1150   }
1151 -
1152 1152   "drivers": [ ~/~/ Водители
1153 1153   {
1154 1154   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
... ... @@ -1193,6 +1193,58 @@
1193 1193  (% style="text-align:left" %)
1194 1194  0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется».
1195 1195  
1200 +
1201 +== **Получить ответ на отправленную на ТС команду** ==
1202 +
1203 +(% class="box infomessage" %)
1204 +(((
1205 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer**
1206 +)))
1207 +
1208 +Идентификатор команды: cmdid
1209 +
1210 +Запрос от терминала на ответ команды
1211 +
1212 +Пример ответ от терминала:
1213 +
1214 +ID= "" ~/~/ идентификатор произвольного поля
1215 +Soft="" ~/~/ версия софта
1216 +GPS=4 ~/~/ тип трекера
1217 +Time=11:05:43 28.06.24 ~/~/ время запроса
1218 +Lat=45.056221 ~/~/ широта
1219 +Lon=39.035938 ~/~/ долгота
1220 +Speed=0.0 ~/~/ скорость
1221 +Course=181.4 ~/~/направление
1222 +
1223 +(((
1224 +== **Список отправленных объекту команд с ответами** ==
1225 +
1226 +(% class="box infomessage" %)
1227 +(((
1228 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history**
1229 +)))
1230 +
1231 +Идентификатор ТС: vehicleId
1232 +
1233 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала.
1234 +
1235 +Пример ответа терминала
1236 +
1237 +[ 
1238 +{    
1239 +"id": "", ~/~/ идентификатор пользователя
1240 +"commandText": "", ~/~/Текст команды.
1241 +"templateId": "", ~/~/Идентификатор шаблона
1242 +"updated": "", ~/~/ Время отправки  
1243 +"tryCount": 0, ~/~/ Количество попыток отправки команды
1244 +"answer": "", ~/~/ Ответ терминала.
1245 +"status": "" ~/~/ Статус отправки
1246 +}
1247 +]
1248 +
1249 +
1250 +)))
1251 +
1196 1196  == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) ==
1197 1197  
1198 1198  (% class="box successmessage" %)
... ... @@ -1415,7 +1415,7 @@
1415 1415  (% lang="en-US" %)**POST /api/v3/vehicles/find**
1416 1416  )))
1417 1417  
1418 -(% style="color:#000000" %)Метод позволяет получить основные параметры объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1474 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).
1419 1419  
1420 1420  (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе:
1421 1421  
... ... @@ -1536,6 +1536,24 @@
1536 1536  (% style="text-align:left" %)
1537 1537  (% style="color:#000000" %) }
1538 1538  
1595 +(% class="wikigeneratedid" id="H41843743C43543D43543D43843544144243044244344143043E43144A43543A442430" %)
1596 +**Отправить команду на терминал**
1597 +
1598 +(% class="box successmessage" %)
1599 +(((
1600 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create**
1601 +)))
1602 +
1603 +Команда для отправки на тс.
1604 +
1605 +{  
1606 +"id": "", ~/~/идентификатор произвольного поля
1607 +"command": "", ~/~/ Текст команды
1608 +"retries": "", ~/~/ Количество попыток
1609 +"idTemplate": "" ~/~/ ID шаблона команды
1610 +}
1611 +
1612 +
1539 1539  == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) ==
1540 1540  
1541 1541  (% class="box warningmessage" %)
... ... @@ -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]]
1866 +(% 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  
... ... @@ -1822,13 +1822,10 @@
1822 1822  
1823 1823  (% style="color:#000000" %)Ответ:
1824 1824  
1825 -(% style="color:#000000" %){
1826 -
1899 +(% style="color:#000000" %){(%%)
1827 1827   "id": "", ~/~/ ID типа датчика 
1828 1828   "name": "", ~/~/ Название
1829 1829   "description": "", ~/~/ Описание
1830 -
1831 -(% style="text-align:left" %)
1832 1832  (% style="color:#000000" %)}
1833 1833  
1834 1834  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) =
... ... @@ -1872,6 +1872,56 @@
1872 1872   }
1873 1873  ]
1874 1874  
1946 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1947 +
1948 +(% class="box infomessage" style="text-align: left;" %)
1949 +(((
1950 +**POST /api/v3/terminalMessages/mapping**
1951 +)))
1952 +
1953 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1954 +
1955 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1956 +
1957 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1958 +
1959 +{
1960 + "protocolType": 0,
1961 + "params": ["string"]
1962 +}
1963 +
1964 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1965 +|protocolType|ID типа протокола
1966 +|params|(((
1967 +Массив наименований параметров в сообщении
1968 +)))
1969 +
1970 +Ответ:
1971 +
1972 +{
1973 + "protocolType": 0,
1974 + "mapping": {
1975 + "additionalProp1": {
1976 + "inputType": 0,
1977 + "inputNumber": 0
1978 + },
1979 + "additionalProp2": {
1980 + "inputType": 0,
1981 + "inputNumber": 0
1982 + }
1983 + }
1984 +}
1985 +
1986 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1987 +|protocolType|Тип протокола
1988 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1989 +|inputNumber|(((
1990 +Номер входа
1991 +)))
1992 +
1993 +(% class="wikigeneratedid" %)
1994 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]]
1995 +
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  
2020 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2021 +|vehicleId|ID объекта
2022 +|from|Дата и время начала периода запроса
2023 +|to|Дата и время окончания периода запроса
2024 +
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": { ~/~/ список параметров датчиков передаваемых терминалом
2031 + "deviceTime": "2023-11-29T07:40:44.052Z",
2032 + "serverTime": "2023-11-29T07:40:44.052Z",
2033 + "speed": 0,
2034 + "altitude": 0,
2035 + "latitude": 0,
2036 + "longitude": 0,
2037 + "satellites": 0,
2038 + "course": 0,
2039 + "voltage": 0,
2040 + "parameters": {
1914 1914   "additionalProp1": "string",
1915 1915   "additionalProp2": "string",
1916 1916   "additionalProp3": "string"
1917 1917   },
1918 - "photoCount": 0 ~/~/ Кол-во фото
2045 + "photoCount": 0,
2046 + "lbsCorrectedCoords": true,
2047 + "protocolType": 0
1919 1919   }
1920 1920   ]
1921 1921   }
1922 1922  ]
1923 1923  
1924 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
2053 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
2054 +|deviceTime|Время сообщения терминала
2055 +|serverTime|Время когда сообщение поступило на сервер
2056 +|speed|Скорость
2057 +|altitude|Высота над уровнем моря
2058 +|latitude|Широта
2059 +|longitude|Долгота
2060 +|satellites|Кол-во спутников
2061 +|course|Курс
2062 +|voltage|Бортовое напряжение
2063 +|parameters|Список параметров и их значений
2064 +|photoCount|Количество фото
2065 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы
2066 +|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,97 @@
2109 2109   }
2110 2110  ]
2111 2111  
2201 +
2202 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) ==
2203 +
2204 +(% class="box infomessage" %)
2205 +(((
2206 +**POST /api/v3/vehicles/moveStop**
2207 +)))
2208 +
2209 +Метод запроса: **POST**
2210 +
2211 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop
2212 +
2213 +В заголовках запроса: X-Auth: Токен авторизации
2214 +
2215 +
2216 +Тело запроса:
2217 +
2218 +{
2219 + "vehicleIds": [ ], ~/~/ Список ID объектов
2220 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса
2221 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса
2222 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
2223 +}
2224 +
2225 +Ответ:
2226 +
2227 +[ 
2228 + {
2229 + "vehicleId": 0, ~/~/ ID объекта
2230 + "vehicleName": "string", ~/~/ Имя объекта
2231 + "moves": [ ~/~/ Событие движения
2232 + {
2233 + "mileage": 0, ~/~/ Пробег, км
2234 + "eventId": 0, ~/~/ Идентификатор события
2235 + "eventName": "string", ~/~/ Название события
2236 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2237 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2238 + "duration": 0 ~/~/ Продолжительность события, секунд
2239 + }
2240 + ],
2241 + "stops": [ ~/~/ События стоянок
2242 + {
2243 + "address": "string", ~/~/ Адрес события
2244 + "eventId": 0, ~/~/ Идентификатор события
2245 + "eventName": "string", ~/~/ Название события
2246 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события
2247 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события
2248 + "duration": 0 ~/~/ Продолжительность события, секунд
2249 + }
2250 + ]
2251 + }
2252 +]
2253 +
2254 +
2255 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) ==
2256 +
2257 +(% class="box infomessage" %)
2258 +(((
2259 +**POST /api/v3/vehicles/getlastdata**
2260 +)))
2261 +
2262 +Метод запроса: **POST**
2263 +
2264 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata
2265 +
2266 +В заголовках запроса: X-Auth: Токен авторизации
2267 +
2268 +
2269 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую.
2270 +
2271 +Ответ:
2272 + {
2273 + "vehicleId": 0, ~/~/Идентификатор объекта.
2274 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта.
2275 + "vehicleNumber": "string",~/~/Номер объекта.
2276 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер
2277 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве.
2278 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4.
2279 + "speed": 0,~/~/Скорость объекта.
2280 + "course": 0,~/~/Курс движения [0;360]
2281 + "latitude": 0,~/~/Широта [-90°;90°].
2282 + "longitude": 0,~/~/Долгота [-180°;180°].
2283 + "address": "string",~/~/Адрес.
2284 + "geozones": [ ~/~/Сведения по геозонам.
2285 + {
2286 + "id": 0,
2287 + "name": "string"
2288 + }
2289 +
2290 +
2291 +
2112 2112  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) =
2113 2113  
2114 2114  == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) ==
... ... @@ -3084,7 +3084,6 @@
3084 3084  |Number|Название/номер агрегата
3085 3085  |Description|Текст примечания агрегата
3086 3086  
3087 -
3088 3088  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) =
3089 3089  
3090 3090  == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) ==
... ... @@ -3106,13 +3106,19 @@
3106 3106   {
3107 3107   "name": "string",
3108 3108   "number": 0,
3109 - "period": 0, ~/~/ Частота трансляции радиометки
3288 + "period": 0,
3110 3110   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3111 3111   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3112 - "deleted": true
3113 3113   }
3114 3114  ]
3115 3115  
3294 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3295 +|parentId|ID клиента
3296 +|name|Название карты-метки
3297 +|number|Номер
3298 +|period|Период запросов в секундах (работает только для агрегатов)
3299 +|id|ID карты-метки
3300 +
3116 3116  == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) ==
3117 3117  
3118 3118  (% class="box infomessage" %)
... ... @@ -3128,13 +3128,19 @@
3128 3128   {
3129 3129   "name": "string",
3130 3130   "number": 0,
3131 - "period": 0, ~/~/ Частота трансляции радиометки
3316 + "period": 0,
3132 3132   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3133 3133   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3134 - "deleted": true
3135 3135   }
3136 3136  ]
3137 3137  
3322 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3323 +|name|Название карты-метки
3324 +|number|Номер
3325 +|period|Период запросов в секундах (работает только для агрегатов)
3326 +|id|ID карты-метки
3327 +|parentId|ID клиента
3328 +
3138 3138  == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) ==
3139 3139  
3140 3140  (% class="box successmessage" %)
... ... @@ -3149,7 +3149,6 @@
3149 3149   "number": 0,
3150 3150   "period": 0,
3151 3151   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3152 - "deleted": true
3153 3153  }
3154 3154  
3155 3155  Ответ:
... ... @@ -3160,9 +3160,15 @@
3160 3160   "period": 0,
3161 3161   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3162 3162   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3163 - "deleted": true
3164 3164  }
3165 3165  
3355 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3356 +|name|Название карты-метки
3357 +|number|Номер
3358 +|period|Период запросов в секундах (работает только для агрегатов)
3359 +|id|ID карты-метки
3360 +|parentId|ID клиента
3361 +
3166 3166  == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) ==
3167 3167  
3168 3168  (% class="box warningmessage" %)
... ... @@ -3178,7 +3178,6 @@
3178 3178   "period": 0,
3179 3179   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3180 3180   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3181 - "deleted": true
3182 3182  }
3183 3183  
3184 3184  Ответ:
... ... @@ -3189,9 +3189,15 @@
3189 3189   "period": 0,
3190 3190   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3191 3191   "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3192 - "deleted": true
3193 3193  }
3194 3194  
3389 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3390 +|name|Название карты-метки
3391 +|number|Номер
3392 +|period|Период запросов в секундах (работает только для агрегатов)
3393 +|id|ID карты-метки
3394 +|parentId|ID клиента
3395 +
3195 3195  == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) ==
3196 3196  
3197 3197  (% class="box errormessage" %)
... ... @@ -3440,6 +3440,8 @@
3440 3440  **PUT /api/v3/Billing/client/balance**
3441 3441  )))
3442 3442  
3644 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3645 +
3443 3443  Тело запроса:
3444 3444  
3445 3445  {
... ... @@ -3453,6 +3453,50 @@
3453 3453  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3454 3454  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3455 3455  
3659 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3660 +
3661 +(% class="box warningmessage" %)
3662 +(((
3663 +**PUT /api/v3/billing/client/balance/deposit**
3664 +)))
3665 +
3666 +Создает операцию **Пополнение **с указанной суммой
3667 +
3668 +Тело запроса:
3669 +
3670 +{
3671 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3672 + "Balance": 0
3673 +}
3674 +
3675 +Ответ: Success
3676 +
3677 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3678 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3679 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3680 +
3681 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3682 +
3683 +Создает операцию **Списание **с указанной суммой
3684 +
3685 +(% class="box warningmessage" %)
3686 +(((
3687 +**PUT /api/v3/billing/client/balance/withdraw**
3688 +)))
3689 +
3690 +Тело запроса:
3691 +
3692 +{
3693 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3694 + "Balance": 0
3695 +}
3696 +
3697 +Ответ: Success
3698 +
3699 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3700 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3701 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3702 +
3456 3456  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3457 3457  
3458 3458  (% class="box warningmessage" %)
... ... @@ -3525,6 +3525,743 @@
3525 3525  |PeriodValue|Значение периода.
3526 3526  |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы
3527 3527  
3775 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3776 +
3777 +(% class="box warningmessage" %)
3778 +(((
3779 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3780 +)))
3781 +
3782 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3783 +
3784 +(% class="box infomessage" %)
3785 +(((
3786 +**POST /api/v3/vehicles/import/{agentId}**
3787 +)))
3788 +
3789 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3790 +
3791 +В пути указывается **agentId** - id клиента.
3792 +
3793 +**Заголовок**
3794 +
3795 +**X-Auth: [токен авторизации]**
3796 +
3797 +**Параметры**
3798 +
3799 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3800 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3801 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3802 +
3803 +В теле использовать тип **form-data,** тип значения** file**
3804 +
3805 +**Ключи**
3806 +
3807 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3808 +|data|В значении передаем файл объекта, формат **xml** или **wlp **
3809 +|csv|В значении передаем файл датчиков, формат **csv**
3810 +
3811 +Ответ:
3812 +
3813 +{
3814 + "vehicleId": 0,
3815 + "name": "string",
3816 + "errors": ["string"]
3817 +}
3818 +
3819 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3820 +|vehicleId|ID созданного объекта
3821 +|name|Имя созданного объекта
3822 +|errors|Ошибки и их описание
3823 +
3824 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3825 +
3826 +(% class="box infomessage" %)
3827 +(((
3828 +**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3829 +)))
3830 +
3831 +(% class="wikigeneratedid" %)
3832 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3833 +
3834 +(% class="wikigeneratedid" %)
3835 +В пути указывается **vehicleId **- id объекта.
3836 +
3837 +**Заголовок**
3838 +
3839 +**X-Auth: [токен авторизации]**
3840 +
3841 +В теле использовать тип **form-data.**
3842 +
3843 +Ключи:
3844 +
3845 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3846 +|**history**|В значении передавать файл с историей
3847 +
3848 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3849 +
3850 +Ответ:
3851 +
3852 +{
3853 + "results": [
3854 + {
3855 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3856 + "vehicleId": 0,
3857 + "errors": [
3858 + "string"
3859 + ],
3860 + "firstMessageDate": "2023-11-28T09:27:58.949Z",
3861 + "lastMessageDate": "2023-11-28T09:27:58.949Z",
3862 + "producedCount": 0,
3863 + "msgCount": 0
3864 + }
3865 + ]
3866 +}
3867 +
3868 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3869 +|results|Результаты импорта в разрезе ТС
3870 +|vehicleGuid|Guid ТС
3871 +|vehicleId|ID ТС
3872 +|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3873 +|firstMessageDate|Дата первого импортированного сообщения (UTC)
3874 +|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3875 +|producedCount|Кол-во успешно отправленных в шину данных сообщений
3876 +|msgCount|Кол-во обработанных сообщений всего
3877 +
3878 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3879 +
3880 +(% class="box infomessage" %)
3881 +(((
3882 +**GET /api/v3/vehicles/import/history/status**
3883 +)))
3884 +
3885 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3886 +
3887 +Ответ:
3888 +
3889 +{
3890 + "activity": true,
3891 + "progress": 0,
3892 + "message": "string"
3893 +}
3894 +
3895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3896 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3897 +|progress|Guid ТС
3898 +
3899 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3900 +
3901 +(% class="box infomessage" %)
3902 +(((
3903 +**POST /api/v3/vehicles/export**
3904 +)))
3905 +
3906 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов.
3907 +
3908 +Тело запроса:
3909 +
3910 +[
3911 + id
3912 +]
3913 +
3914 +Ответ: Success 200, получаете файлы с настройками.
3915 +
3916 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) ==
3917 +
3918 +(% class="box infomessage" %)
3919 +(((
3920 +**POST /api/v3/vehicles/export/history**
3921 +)))
3922 +
3923 +Метод возвращает список сообщений терминала объекта за выбранный период.
3924 +
3925 +Тело запроса:
3926 +
3927 +{
3928 + "vehicleId": 0,
3929 + "asArchive": true,
3930 + "from": "2023-09-27T12:17:45.973Z",
3931 + "to": "2023-09-27T12:17:45.973Z"
3932 +}
3933 +
3934 +Ответ:
3935 +
3936 +Получаете файл. Сообщение: Code 200/Success
3937 +
3938 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3939 +|vehicleId|ID объекта
3940 +|asArchive|true - Архивировать файл, False - не архивировать
3941 +|from|Дата и время начала запроса
3942 +|to|Дата и время окончания запроса
3943 +
3944 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) ==
3945 +
3946 +(% class="box infomessage" %)
3947 +(((
3948 +**GET /api/v3/vehicles/export/history/status**
3949 +)))
3950 +
3951 +Метод возвращает список сообщений терминала объекта за выбранный период.
3952 +
3953 +Ответ:
3954 +
3955 +{
3956 + "activity": true,
3957 + "progress": 0,
3958 + "message": "string"
3959 +}
3960 +
3961 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3962 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется.
3963 +|progress|Прогресс экспорта, от 0 до 100%
3964 +|message|Текст описывающий статус
3965 +
3966 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3967 +
3968 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3969 +
3970 +(% class="box infomessage" %)
3971 +(((
3972 +**POST /api/v3/EcoDriving/rating**
3973 +)))
3974 +
3975 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта.
3976 +
3977 +Тело запроса:
3978 +
3979 +{
3980 + "vehicleIds": [vehicleId],
3981 + "from": "2023-11-22T09:29:48.051Z",
3982 + "to": "2023-11-22T09:29:48.051Z"
3983 +}
3984 +
3985 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3986 +|vehicleIds|Массив ID объектов
3987 +|from|Дата начала запроса
3988 +|to|Дата окончания запроса
3989 +
3990 +Ответ:
3991 +
3992 +{
3993 + "items": [
3994 + {
3995 + "from": "2023-11-22T09:29:48.052Z",
3996 + "to": "2023-11-22T09:29:48.052Z",
3997 + "vehicleId": 0,
3998 + "vehicleName": "string",
3999 + "vehicleModel": "string",
4000 + "penalty": 0,
4001 + "score": 0,
4002 + "totalViolations": 0,
4003 + "violationsByType": {
4004 + "overspeedingViolations": 0,
4005 + "accelerationViolations": 0,
4006 + "brakingViolations": 0,
4007 + "turningViolations": 0,
4008 + "dangerousDrivingViolations": 0,
4009 + "sensorViolations": 0
4010 + },
4011 + "moveTime": 0,
4012 + "mileage": 0,
4013 + "tripsCount": 0,
4014 + "trips": [
4015 + {
4016 + "penalty": 0,
4017 + "score": 0,
4018 + "violationsCount": 0,
4019 + "violationsByType": {
4020 + "overspeedingViolations": 0,
4021 + "accelerationViolations": 0,
4022 + "brakingViolations": 0,
4023 + "turningViolations": 0,
4024 + "dangerousDrivingViolations": 0,
4025 + "sensorViolations": 0
4026 + },
4027 + "moveTime": 0,
4028 + "mileage": 0,
4029 + "motohours": 0,
4030 + "maxSpeed": 0,
4031 + "startAddress": "string",
4032 + "endAddress": "string",
4033 + "drivers": [
4034 + {
4035 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4036 + "driverName": "string",
4037 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4038 + }
4039 + ]
4040 + }
4041 + ]
4042 + }
4043 + ]
4044 +}
4045 +
4046 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
4047 +|from|Дата начала запроса
4048 +|to|Дата  окончания
4049 +|vehicleId|ID объекта
4050 +|vehicleName|Имя объекта
4051 +|vehicleModel|Модель объекта
4052 +|penalty|Сумма штрафных баллов
4053 +|score|Оценка
4054 +|totalViolations|Суммарное количество нарушений
4055 +|violationsByType|Список типов нарушений и количество нарушений для каждого типа
4056 +|overspeedingViolations|Превышение скорости
4057 +|accelerationViolations|Ускорение
4058 +|brakingViolations|Торможение
4059 +|turningViolations|Резкий поворот
4060 +|dangerousDrivingViolations|Резкое вождение
4061 +|sensorViolations|Нарушение по датчику
4062 +|moveTime|Время в движении
4063 +|mileage|Пробег
4064 +|tripsCount|Количество рейсов
4065 +|motohours|Моточасы
4066 +|maxSpeed|Максимальная скорость
4067 +|startAddress|Адрес начала рейса
4068 +|endAddress|Адрес окончания рейса
4069 +|drivers|Список водителей, которые были на объекте в течениии рейса
4070 +|driverGuid|Guid водителя
4071 +|driverName|Имя водителя
4072 +|driverRfid|Номер Карты-метки
4073 +
4074 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) =
4075 +
4076 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) ==
4077 +
4078 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам.
4079 +
4080 +(% class="box infomessage" %)
4081 +(((
4082 +POST /api/v3/fuelcards/transactions
4083 +)))
4084 +
4085 +Метод запроса: POST
4086 +
4087 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions
4088 +\\В заголовках запроса: X-Auth: Токен авторизации
4089 +
4090 +Параметры в теле запроса (JSON):
4091 +
4092 +{
4093 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/Начало периода
4094 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/Конец периода
4095 + "ids": [ 
4096 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/гуиды топливных карт
4097 + ],
4098 + "timezone": 0 ~/~/Таймзона
4099 +}
4100 +
4101 +
4102 +Ответ:
4103 + {
4104 + "date": "2024-04-11T10:41:02.265Z", ~/~/Дата и время транзакции
4105 + "driver": "string", ~/~/Водители, привязанные к ТК
4106 + "object": "string", ~/~/Наименование ТС
4107 + "amount": 0, ~/~/Количество топлива
4108 + "amountDut": 0, ~/~/Количество по ДУТ
4109 + "amountDiff": 0, ~/~/Разница, л
4110 + "amountDiffPerc": 0, ~/~/Разница, %
4111 + "summa": 0, ~/~/Стоимость, руб
4112 + "serviceName": "string", ~/~/Тип топлива
4113 + "price": 0, ~/~/Цена за литр, руб
4114 + "cardName": "string", ~/~/Наименование ТК
4115 + "cardNum": "string", ~/~/Номер ТК
4116 + "operator": "string", ~/~/Оператор ТК
4117 + "address": "string" ~/~/Адрес АЗС
4118 + }
4119 +
4120 +
4121 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** =
4122 +
4123 +
4124 +== **Получение полных данных о ретрансляторе** ==
4125 +
4126 +(% class="box infomessage" %)
4127 +(((
4128 +**GET ** **/api/v3/retranslations/{id}**
4129 +)))
4130 +
4131 +Идентификатор запроса: ID
4132 +
4133 +
4134 +Пример ответа:
4135 +
4136 +{  
4137 +"description": "", ~/~/ Определяет описание
4138 +"subscriberId": "", ~/~/ Подписчик
4139 +"protocolType": 0, ~/~/ Тип протокола
4140 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен
4141 +"address": "string", ~/~/ Адрес события
4142 +"objects": [ ~/~/Объекты для ретрансляции
4143 +{      
4144 +"id": "",  ~/~/ Идентификатор объекта ретрансляции
4145 +"name": "", ~/~/ Наименование объекта ретрансляции
4146 +"imei": "", ~/~/ IMEI объекта  
4147 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен
4148 +}
4149 + ],  
4150 +"id": "", ~/~/ идентификатор пользователя   
4151 +"parentId": "", ~/~/Guid родителя
4152 +"deleted": "" ~/~/ Признак удаления, Включен, true - включен, false - отключен
4153 +}
4154 +
4155 +
4156 +== **Удаление данных ретранслятора** ==
4157 +
4158 +(% class="box infomessage" %)
4159 +(((
4160 +**DELETE** **/api/v3/retranslations/{id}**
4161 +)))
4162 +
4163 +Параметр запроса: ID
4164 +
4165 +
4166 +== **Создание ретранслятора** ==
4167 +
4168 +(% class="box infomessage" %)
4169 +(((
4170 +**POST ** **/api/v3/retranslations/{id}**
4171 +)))
4172 +
4173 +Запрос:
4174 +
4175 +{  
4176 +"description": "", ~/~/ Описание
4177 +"subscriberId": "", ~/~/ Подписчик
4178 +"protocolType": 0, ~/~/ Тип протокола
4179 +"address": "", ~/~/ Адрес ретрансляции
4180 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4181 +"objects": [ ~/~/Объекты для ретрансляции
4182 +{      
4183 +"id": "", ~/~/ идентификатор пользователя     
4184 +"imei": "", ~/~/IMEI объекта
4185 +"isEnabled": ""  ~/~/ признак включения, Включен, true - включен, false - отключен  
4186 +}
4187 + ]
4188 +}
4189 +
4190 +
4191 +Ответ:
4192 +
4193 +{  
4194 +"description": "string", ~/~/ Определяет описание
4195 +"subscriberId": "", ~/~/ идентификатор запроса
4196 +"protocolType": 0, ~/~/ Тип протокола
4197 +"isEnabled": "", ~/~/ признак включения, Включен, true - включен, false - отключен
4198 +"address": "", ~/~/ Адрес события
4199 +"objects": [ ~/~/Объекты для ретрансляции
4200 +{      
4201 +"id": "", ~/~/ идентификатор пользователя    
4202 +"name": "string", ~/~/ Название уведомления
4203 +"imei": "string", ~/~/IMEI объекта  
4204 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4205 +}
4206 + ],  
4207 +"id": "", ~/~/ идентификатор пользователя  
4208 +"parentId": "", ~/~/ Guid идентификатор родителя
4209 +"deleted": true ~/~/ Признак удаления
4210 +}
4211 +
4212 +
4213 +== **Редактирование ретранслятора** ==
4214 +
4215 +(% class="box infomessage" %)
4216 +(((
4217 +**PUT** **/api/v3/retranslations**
4218 +)))
4219 +
4220 +Пример запроса:
4221 +
4222 +{  
4223 +"id": "", ~/~/ идентификатор пользователя   
4224 +"description": "string", ~/~/ Определяет описание
4225 +"subscriberId": "", ~/~/ идентификатор запроса
4226 +"protocolType": 0, ~/~/ Тип протокола
4227 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4228 +"address": "string", ~/~/ Адрес события
4229 +"objects": ~/~/Объекты для ретрансляции
4230 +[    
4231 +{      
4232 +"id": "",  ~/~/ идентификатор пользователя         
4233 +"imei": "", ~/~/IMEI объекта
4234 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4235 +}
4236 + ]
4237 +}
4238 +
4239 +
4240 +Пример ответа:
4241 +
4242 +{  
4243 +"description": "", ~/~/ Определяет описание
4244 +"subscriberId": "", ~/~/ идентификатор запроса
4245 +"protocolType": 0, ~/~/ Тип протокола
4246 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4247 +"address": "string", ~/~/ Адрес события
4248 +"objects": [ ~/~/Объекты для ретрансляции
4249 +{      
4250 +"id": "", ~/~/ идентификатор пользователя     
4251 +"name": "string", ~/~/ Название уведомления    
4252 +"imei": "", ~/~/IMEI объекта
4253 +"isEnabled": true ~/~/ признак включения, Включен, true - включен, false - отключен  
4254 +}
4255 + ],
4256 +"id": "", ~/~/ идентификатор пользователя   
4257 +"parentId": "", ~/~/ Guid идентификатор родителя
4258 +"deleted": true ~/~/ Признак удаления
4259 +}
4260 +
4261 +
4262 +== **Получение списка ретранслятора клиента** ==
4263 +
4264 +(% class="box infomessage" %)
4265 +(((
4266 +**POST /api/v3/retranslations/find**
4267 +)))
4268 +
4269 +Пример запроса:
4270 +
4271 +{  
4272 +"id": "", ~/~/ идентификатор пользователя   
4273 +"search": "string", ~/~/Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу
4274 +"parentId": "" ~/~/ Идентификатор агента, для которого надо получить данные.
4275 +}
4276 +
4277 +Ответ
4278 +
4279 +[ 
4280 +{    
4281 +"description": "", ~/~/ Определяет описание
4282 +"subscriberId": "", ~/~/ идентификатор запроса
4283 +"protocolType": 0, ~/~/ Тип протокола
4284 +"isEnabled": true, ~/~/ признак включения, Включен, true - включен, false - отключен  
4285 +"address": "string", ~/~/ Адрес события
4286 +"id": "", ~/~/ идентификатор пользователя   
4287 +"parentId": "", ~/~/ Guid идентификатор родителя
4288 +"deleted": true ~/~/ Признак удаления
4289 +}
4290 +]
4291 +
4292 +
4293 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Отчеты**(%%) =
4294 +
4295 +== **API для отчета по выгрузке комбайнов** ==
4296 +
4297 +(% class="box infomessage" %)
4298 +(((
4299 +POST **/api/v3/Reports/harvesterUnloading**
4300 +)))
4301 +
4302 +Пример запроса:
4303 +
4304 +{
4305 + "byTime": 0, ~/~/ Объединение событий по времени
4306 + "byDist": 0, ~/~/ Объединение событий по расстоянию
4307 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения
4308 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра
4309 + "showNearestObjects": true, ~/~/Показывать объекты рядом?
4310 + "vehicleIds": [ ~/~/ Список id объектов для анализа
4311 + 0
4312 + ],
4313 + "from": "", ~/~/ Дата и время начало запроса
4314 + "to": "", ~/~/ Дата и время окончания запроса
4315 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3
4316 +}
4317 +
4318 +Пример ответа:
4319 +
4320 +[ 
4321 + {
4322 + "harvesterName": "", ~/~/Комбайн, номер
4323 + "harvesterId": 0, ~/~/Комбайн, id
4324 +"harvesterModel": "", ~/~/ Модель комбайна
4325 +"hopperCapacity": 0, ~/~/ Объем бункера м3
4326 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек
4327 + "events": [ ~/~/Список событий в разрезе комбайна
4328 + {
4329 + "driverId": "", ~/~/Идентификатор водителя
4330 + "driverName": "", ~/~/Водитель комбайна, ФИО
4331 + "RFID": "", ~/~/ идентификатор карты-метки
4332 + "rfidName": "", ~/~/Водитель комбайна, имя метки
4333 + "vehicleId": 0, ~/~/идентификатор объекта
4334 + "vehicleName": "string", ~/~/ Имя объекта
4335 + "modelName": "string", ~/~/ Имя модели объекта
4336 + "nearestVehicles": [ ~/~/Объекты рядом
4337 + {
4338 + "vehicleId": 0, ~/~/идентификатор объекта
4339 + "vehicleName": "string" ~/~/ Имя объекта
4340 + }
4341 + ],
4342 + "fields": [ ~/~/Поля, где происходила выгрузка
4343 + {
4344 + "id": 0, ~/~/ идентификатор пользователя 
4345 + "name": "string" ~/~/ имя пользователя 
4346 + }
4347 + ],
4348 + "event": "string", ~/~/Событие
4349 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода
4350 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода
4351 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах
4352 + "cultureName": "string", ~/~/ название культуры
4353 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события)
4354 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события)
4355 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события)
4356 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события)
4357 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события)
4358 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события)
4359 + "issued": 0, ~/~/Выдано, бункеров
4360 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера)
4361 + "latitude": 0, ~/~/Широта
4362 + "longitude": 0, ~/~/ Долгота
4363 + "litresAway": 0, ~/~/Отдано, л
4364 + "m3Away": 0 ~/~/Отдано, м3
4365 + }
4366 + ]
4367 + }
4368 +]
4369 +
4370 +
4371 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) =
4372 +
4373 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) ==
4374 +
4375 +
4376 +(% class="box infomessage" %)
4377 +(((
4378 +GET api/v3/Vehicles/recyclebin/all
4379 +)))
4380 +
4381 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту
4382 +
4383 +Параметр запроса: {parentId} - идентификатор агента
4384 +
4385 +В заголовках запроса: X-Auth: Токен авторизации
4386 +
4387 +Ответ:
4388 +
4389 +[ 
4390 + {
4391 + "recordTime": "", ~/~/Время записи
4392 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4393 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4394 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4395 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4396 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4397 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4398 + "items": [ ~/~/ 
4399 +nullable: true ~/~/Детали
4400 + {
4401 + "name": "string", ~/~/наименование столбца
4402 + "value": "string" ~/~/содержание столбца
4403 + }
4404 + ]
4405 + },
4406 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4407 + "string"
4408 + ]
4409 + }
4410 +]
4411 +
4412 +
4413 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**
4414 +
4415 +(% class="box infomessage" %)
4416 +(((
4417 +POST/api/v3/Vehicles/recyclebin/erase
4418 +)))
4419 +
4420 +В заголовках запроса: X-Auth: Токен авторизации
4421 +
4422 +Пример запроса:
4423 +
4424 +[
4425 +0
4426 +]
4427 +
4428 +
4429 +Пример ответа:
4430 +
4431 +[ 
4432 +{
4433 + "recordTime": "", ~/~/Время записи
4434 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину
4435 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину
4436 + "objectId": 0, ~/~/ID объекта, помещённого в корзин
4437 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину
4438 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4439 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4440 + "items": [ ~/~/Детали
4441 + {
4442 + "name": "", ~/~/Имя свойства
4443 + "value": "" ~/~/Значение свойства
4444 + }
4445 + ]
4446 + },
4447 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4448 + ""
4449 + ]
4450 + }
4451 +]
4452 +
4453 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
4454 +
4455 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) ==
4456 +
4457 +(% class="box infomessage" %)
4458 +(((
4459 +POST/api/v3/Vehicles/recyclebin/restore
4460 +)))
4461 +
4462 +В заголовках запроса: X-Auth: Токен авторизации
4463 +
4464 +Параметры в теле запроса (JSON):
4465 +
4466 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить.
4467 +
4468 +В заголовках запроса: X-Auth: Токен авторизации
4469 +
4470 +
4471 +Пример запроса:
4472 +
4473 +(((
4474 +[
4475 +)))
4476 +
4477 +(((
4478 + 0
4479 +)))
4480 +
4481 +(((
4482 +]
4483 +)))
4484 +
4485 +
4486 +Пример ответа:
4487 +
4488 +[
4489 +{
4490 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи
4491 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину
4492 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину
4493 + "objectId": 0, ~/~/ID объекта, помещённого в корзину
4494 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину
4495 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину
4496 + "details": { ~/~/Список деталей объекта, помещённого в корзину
4497 + "items": [ ~/~/Детали
4498 + {
4499 + "name": "string", ~/~/Имя свойства
4500 + "value": "string" ~/~/Значение свойства
4501 + }
4502 + ]
4503 + },
4504 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта
4505 + "string"
4506 + ]
4507 + }
4508 +]
4509 +
4510 +
4511 +
3528 3528  (% class="box" lang="en-US" style="text-align: center;" %)
3529 3529  (((
3530 3530  (% 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 г.