Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -356,21 +356,6 @@
356	356
357	357	Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».
358	358
359		-== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) ==
360		-
361		-(% class="box warningmessage" %)
362		-(((
363		-**PUT /api/v3/agents/{id}/changeStatus/{status}**
364		-)))
365		-
366		-Метод позволяет изменить статус клиента, указанного в запросе.
367		-
368		-В пути указывается GUID клиента и статус клиента.
369		-
370		-**status **- значение 0 - заблокирован, 1 - активен.
371		-
372		-Ответ: Code 204
373		-
374	374	= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) =
375	375
376	376	== (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) ==
...	...	@@ -1887,51 +1887,6 @@
1887	1887	}
1888	1888	]
1889	1889
1890		-== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) ==
1891		-
1892		-(% class="box infomessage" style="text-align: left;" %)
1893		-(((
1894		-**POST /api/v3/terminalMessages/mapping**
1895		-)))
1896		-
1897		-Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу.
1898		-
1899		-(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping
1900		-
1901		-(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
1902		-
1903		-{
1904		- "protocolType": 0,
1905		- "params": ["string"]
1906		-}
1907		-
1908		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1909		-|protocolType|ID типа протокола
1910		-|params|(((
1911		-Массив наименований параметров в сообщении
1912		-)))
1913		-
1914		-Ответ:
1915		-
1916		-{
1917		- "protocolType": 0,
1918		- "mapping": {
1919		- "additionalProp1": {
1920		- "inputType": 0,
1921		- "inputNumber": 0
1922		- },
1923		- "additionalProp2": {
1924		- "inputType": 0,
1925		- "inputNumber": 0
1926		- }
1927		- }
1928		-}
1929		-
1930		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
1931		-|protocolType|Тип протокола
1932		-|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный
1933		-|inputNumber|Номер входа
1934		-
1935	1935	== (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) ==
1936	1936
1937	1937	(% class="box infomessage" %)
...	...	@@ -3466,8 +3466,6 @@
3466	3466	**PUT /api/v3/Billing/client/balance**
3467	3467	)))
3468	3468
3469		-Устанавливает указанное значение баланса не создавая операции пополнение/снятие.
3470		-
3471	3471	Тело запроса:
3472	3472
3473	3473	{
...	...	@@ -3481,50 +3481,6 @@
3481	3481	|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3482	3482	|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3483	3483
3484		-== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) ==
3485		-
3486		-(% class="box warningmessage" %)
3487		-(((
3488		-**PUT /api/v3/billing/client/balance/deposit**
3489		-)))
3490		-
3491		-Создает операцию **Пополнение **с указанной суммой
3492		-
3493		-Тело запроса:
3494		-
3495		-{
3496		- "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3497		- "Balance": 0
3498		-}
3499		-
3500		-Ответ: Success
3501		-
3502		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3503		-|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3504		-|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3505		-
3506		-== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) ==
3507		-
3508		-Создает операцию **Списание **с указанной суммой
3509		-
3510		-(% class="box warningmessage" %)
3511		-(((
3512		-**PUT /api/v3/billing/client/balance/withdraw**
3513		-)))
3514		-
3515		-Тело запроса:
3516		-
3517		-{
3518		- "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3519		- "Balance": 0
3520		-}
3521		-
3522		-Ответ: Success
3523		-
3524		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3525		-|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента
3526		-|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса
3527		-
3528	3528	== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) ==
3529	3529
3530	3530	(% class="box warningmessage" %)
...	...	@@ -3611,95 +3611,22 @@
3611	3611	**POST /api/v3/vehicles/import/{agentId}**
3612	3612	)))
3613	3613
3614		-Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp. **Также они могут находится в** zip-архиве.**
	3508	+Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml** или **wlp **. В формате **xml **экспортируются объекты из нашей системы.
3615	3615
3616		-В пути указывается **agentId** - id клиента.
	3510	+**agentId** - id клиента, указывается в пути запроса. (обязательный)
3617	3617
3618		-**Заголовок**
3619	3619
3620		-**X-Auth: [токен авторизации]**
3621		-
3622		-**Параметры**
3623		-
3624		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3625		-|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать.
3626		-|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: 1 - Замена, 2 - Слияние, 3 - Добавление
3627		-
3628		-В теле использовать тип **form-data,** тип значения** file**
3629		-
3630		-**Ключи**
3631		-
3632		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3633		-|data|В значении передаем файл объекта, формат **xml** или **wlp **
3634		-|csv|В значении передаем файл датчиков, формат **csv**
3635		-
3636		-Ответ:
3637		-
3638		-{
3639		- "vehicleId": 0,
3640		- "name": "string",
3641		- "errors": ["string"]
3642		-}
3643		-
3644		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3645		-|vehicleId|ID созданного объекта
3646		-|name|Имя созданного объекта
3647		-|errors|Ошибки и их описание
3648		-
3649	3649	== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) ==
3650	3650
3651	3651	(% class="box infomessage" %)
3652	3652	(((
3653		-**POST** **/api/v3/vehicles/import/history/{vehicleId}**
	3517	+**POST /api/v3/vehicles/import/history/{vehicleId}**
3654	3654	)))
3655	3655
3656	3656	(% class="wikigeneratedid" %)
3657		-Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**.
	3521	+**vehicleId **- id объекта.
3658	3658
3659		-(% class="wikigeneratedid" %)
3660		-В пути указывается **vehicleId **- id объекта.
3661	3661
3662		-**Заголовок**
3663		-
3664		-**X-Auth: [токен авторизации]**
3665		-
3666		-В теле использовать тип **form-data.**
3667		-
3668		-Ключи:
3669		-
3670		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3671		-|**history**|В значении передавать файл с историей
3672		-
3673		-В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить.
3674		-
3675		-Ответ:
3676		-
3677		-{
3678		- "results": [
3679		- {
3680		- "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3681		- "vehicleId": 0,
3682		- "errors": [
3683		- "string"
3684		- ],
3685		- "firstMessageDate": "2023-11-28T09:27:58.949Z",
3686		- "lastMessageDate": "2023-11-28T09:27:58.949Z",
3687		- "producedCount": 0,
3688		- "msgCount": 0
3689		- }
3690		- ]
3691		-}
3692		-
3693		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3694		-|results|Результаты импорта в разрезе ТС
3695		-|vehicleGuid|Guid ТС
3696		-|vehicleId|ID ТС
3697		-|errors|Список ошибок импорта истории (если пустой - нет ошибок)
3698		-|firstMessageDate|Дата первого импортированного сообщения (UTC)
3699		-|lastMessageDate|Дата последнего импортированного сообщения (UTC)
3700		-|producedCount|Кол-во успешно отправленных в шину данных сообщений
3701		-|msgCount|Кол-во обработанных сообщений всего
3702		-
3703	3703	== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) ==
3704	3704
3705	3705	(% class="box infomessage" %)
...	...	@@ -3707,20 +3707,7 @@
3707	3707	**GET /api/v3/vehicles/import/history/status**
3708	3708	)))
3709	3709
3710		-Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период.
3711	3711
3712		-Ответ:
3713		-
3714		-{
3715		- "activity": true,
3716		- "progress": 0,
3717		- "message": "string"
3718		-}
3719		-
3720		-|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание**
3721		-|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет
3722		-|progress|Guid ТС
3723		-
3724	3724	== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) ==
3725	3725
3726	3726	(% class="box infomessage" %)