GET /command?type=getcurrentgrid : Получение информации о текущем профиле экрана в клиенте Macroscop🔗

Доступно во всех типах лицензий.

Важно

Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.

Примечание

Доступно получение ответа в формате JSON.

Для получения информации о профиле, используемом на мониторе выбранного клиента Macroscop в настоящий момент, используется запрос к ресурсу command с типом getcurrentgrid.

Пример запроса🔗

Пример запроса данных в формате XML:

GET http://localhost:8080/command?type=getcurrentgrid&login=root&password=&clientip=192.168.1.2&monitor=0

Пример запроса данных в формате JSON:

GET http://localhost:8080/command?type=getcurrentgrid&login=root&password=&clientip=192.168.1.2&monitor=0&responsetype=json

В ответ сервер возвращает информацию о текущем профиле, типе использованной в нём сетки и его содержимом.

Дополнительные параметры запроса🔗

Параметр	Значение по умолчанию	Описание
clientip	—	IP адрес устройства, на котором запущено клиентское приложение Macroscop. Обязательный параметр
monitor	—	Номер монитора в действующей конфигурации клиентского приложения. Отсчёт начинается с 0. Обязательный параметр
responsetype	xml	Формат представления возвращаемых данных. Если не указан в запросе, используется значение по умолчанию. Опциональный параметр. Допустимые значения: xml, json

Примечание

Значение clientip должно содержать фактический адрес клиента Macroscop. Использование localhost (127.0.0.1) вызовет ошибку даже при обращении к клиенту, установленному непосредственно на сервере.

Пример ответа на запрос🔗

Пример ответа на запрос в формате XML:

<ViewInfo>
    <GridType>GridType3</GridType>
    <ViewInfoId>20db65ef-17fb-4d75-9513-acb8535d552b</ViewInfoId>
    <GridCells>
        <GridCellParameters>
            <ChannelId>a3785d7f-9259-456b-a64a-048342f22964</ChannelId>
            <CellIndex>0</CellIndex>
            <IsArchive>false</IsArchive>
            <ArchiveStartTime xsi:nil="true"/>
            <ArchivePlaySpeed>1</ArchivePlaySpeed>
        </GridCellParameters>
        <GridCellParameters>
            <ChannelId>706c4691-3d90-41e3-8789-76eb9810648f</ChannelId>
            <CellIndex>1</CellIndex>
            <IsArchive>true</IsArchive>
            <ArchiveStartTime>2023-06-09T14:09:43.7434941Z</ArchiveStartTime>
            <ArchivePlaySpeed>1</ArchivePlaySpeed>
        </GridCellParameters>
        <GridCellParameters>
            <ChannelId>00000000-0000-0000-0000-000000000000</ChannelId>
            <CellIndex>2</CellIndex>
            <IsArchive>false</IsArchive>
            <ArchiveStartTime xsi:nil="true"/>
            <ArchivePlaySpeed>0</ArchivePlaySpeed>
        </GridCellParameters>
    </GridCells>
    <ViewName>Офис</ViewName>
</ViewInfo>

Пример ответа на запрос в формате JSON:

{
    "GridType": "GridType3",
    "ViewInfoId": "20db65ef-17fb-4d75-9513-acb8535d552b",
    "GridCells": [
        {
            "ChannelId": "a3785d7f-9259-456b-a64a-048342f22964",
            "CellIndex": 0,
            "IsArchive": false,
            "ArchiveStartTime": null,
            "ArchivePlaySpeed": 1.0
        },
        {
            "ChannelId": "706c4691-3d90-41e3-8789-76eb9810648f",
            "CellIndex": 1,
            "IsArchive": true,
            "ArchiveStartTime": 2023-06-09T14:09:43.7434941Z,
            "ArchivePlaySpeed": 1.0
        },
        {
            "ChannelId": "00000000-0000-0000-0000-000000000000",
            "CellIndex": 2,
            "IsArchive": false,
            "ArchiveStartTime": null,
            "ArchivePlaySpeed": 0.0
        }
    ],
    "ViewName": "Офис"
}

Где:

Параметр	Описание
GridType	Тип сетки, использованной для выбранного профиля
ViewInfoId	Уникальный идентификатор профиля
GridCells	Вложенная секция, описывающая содержимое ячеек выбранного профиля. ChannelId – уникальный идентификатор канала, размещённого в ячейке. CellIndex – номер ячейки в виде (Отсчёт с нуля). IsArchive – состояние режима отображения архива в ячейке. Возможные значения: true – ячейка находится в режиме просмотра архива, false – отображение потока реального времени. ArchiveStartTime – текущая позиция в архиве в UTC. ArchivePlaySpeed – скорость воспроизведения видео в ячейке. Возможные значения: 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 60, 120. При отображении потока реального времени значение всегда 1
ViewName	Имя профиля в рамках действующей конфигурации

Примечание

Полученные данные можно использовать при установке профиля на клиенте.