Last modified by Андрей Калиновский on 2025/01/28 12:59
<
From version < 130.1 >
edited by Михаил Жучков
on 2023/12/26 17:47
To version < 119.1 >
edited by Илья Крайнов
on 2023/11/23 10:14
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.SupportZhuchkov
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" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) ==
... ... @@ -3487,8 +3487,6 @@
3487 3487  **PUT /api/v3/Billing/client/balance**
3488 3488  )))
3489 3489  
3490 -Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3491 -
3492 3492  Тело запроса:
3493 3493  
3494 3494  {
... ... @@ -3502,50 +3502,6 @@
3502 3502  |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3503 3503  |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3504 3504  
3505 -== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3506 -
3507 -(% class="box warningmessage" %)
3508 -(((
3509 -**PUT /api/v3/billing/client/balance/deposit**
3510 -)))
3511 -
3512 -Создает операцию **Пополнение **с указанной суммой
3513 -
3514 -Тело запроса:
3515 -
3516 -{
3517 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3518 - "Balance": 0
3519 -}
3520 -
3521 -Ответ: Success
3522 -
3523 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3524 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3525 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3526 -
3527 -== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3528 -
3529 -Создает операцию **Списание **с указанной суммой
3530 -
3531 -(% class="box warningmessage" %)
3532 -(((
3533 -**PUT /api/v3/billing/client/balance/withdraw**
3534 -)))
3535 -
3536 -Тело запроса:
3537 -
3538 -{
3539 - "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3540 - "Balance": 0
3541 -}
3542 -
3543 -Ответ: Success
3544 -
3545 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3546 -|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3547 -|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3548 -
3549 3549  == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3550 3550  
3551 3551  (% class="box warningmessage" %)
... ... @@ -3620,11 +3620,6 @@
3620 3620  
3621 3621  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) =
3622 3622  
3623 -(% class="box warningmessage" %)
3624 -(((
3625 -Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса.
3626 -)))
3627 -
3628 3628  == (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) ==
3629 3629  
3630 3630  (% class="box infomessage" %)
... ... @@ -3632,95 +3632,20 @@
3632 3632  **POST /api/v3/vehicles/import/{agentId}**
3633 3633  )))
3634 3634  
3635 -Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
3503 +**agentId** - id клиента.
3636 3636  
3637 -В пути указывается **agentId** - id клиента.
3638 3638  
3639 -**Заголовок**
3640 -
3641 -**X-Auth: [токен авторизации]**
3642 -
3643 -**Параметры**
3644 -
3645 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3646 -|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3647 -|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3648 -
3649 -В теле использовать тип **form-data,** тип значения** file**
3650 -
3651 -**Ключи**
3652 -
3653 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3654 -|data|В значении передаем файл объекта, формат **xml** или **wlp **
3655 -|csv|В значении передаем файл датчиков, формат **csv**
3656 -
3657 -Ответ:
3658 -
3659 -{
3660 - "vehicleId": 0,
3661 - "name": "string",
3662 - "errors": ["string"]
3663 -}
3664 -
3665 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3666 -|vehicleId|ID созданного объекта
3667 -|name|Имя созданного объекта
3668 -|errors|Ошибки и их описание
3669 -
3670 3670  == (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3671 3671  
3672 3672  (% class="box infomessage" %)
3673 3673  (((
3674 -**POST** **/api/v3/vehicles/import/history/{vehicleId}**
3510 +**POST /api/v3/vehicles/import/history/{vehicleId}**
3675 3675  )))
3676 3676  
3677 3677  (% class="wikigeneratedid" %)
3678 -Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
3514 +**vehicleId **- id объекта.
3679 3679  
3680 -(% class="wikigeneratedid" %)
3681 -В пути указывается **vehicleId **- id объекта.
3682 3682  
3683 -**Заголовок**
3684 -
3685 -**X-Auth: [токен авторизации]**
3686 -
3687 -В теле использовать тип **form-data.**
3688 -
3689 -Ключи:
3690 -
3691 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3692 -|**history**|В значении передавать файл с историей
3693 -
3694 -В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3695 -
3696 -Ответ:
3697 -
3698 -{
3699 - "results": [
3700 - {
3701 - "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3702 - "vehicleId": 0,
3703 - "errors": [
3704 - "string"
3705 - ],
3706 - "firstMessageDate": "2023-11-28T09:27:58.949Z",
3707 - "lastMessageDate": "2023-11-28T09:27:58.949Z",
3708 - "producedCount": 0,
3709 - "msgCount": 0
3710 - }
3711 - ]
3712 -}
3713 -
3714 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3715 -|results|Результаты импорта в разрезе ТС
3716 -|vehicleGuid|Guid ТС
3717 -|vehicleId|ID ТС
3718 -|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3719 -|firstMessageDate|Дата первого импортированного сообщения (UTC)
3720 -|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3721 -|producedCount|Кол-во успешно отправленных в шину данных сообщений
3722 -|msgCount|Кол-во обработанных сообщений всего
3723 -
3724 3724  == (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3725 3725  
3726 3726  (% class="box infomessage" %)
... ... @@ -3728,20 +3728,7 @@
3728 3728  **GET /api/v3/vehicles/import/history/status**
3729 3729  )))
3730 3730  
3731 -Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3732 3732  
3733 -Ответ:
3734 -
3735 -{
3736 - "activity": true,
3737 - "progress": 0,
3738 - "message": "string"
3739 -}
3740 -
3741 -|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3742 -|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3743 -|progress|Guid ТС
3744 -
3745 3745  == (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3746 3746  
3747 3747  (% class="box infomessage" %)
... ... @@ -3811,7 +3811,7 @@
3811 3811  
3812 3812  = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) =
3813 3813  
3814 -== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) ==
3594 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинша качества вождения**(%%) ==
3815 3815  
3816 3816  (% class="box infomessage" %)
3817 3817  (((

Меню

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