GET /command?type=getgrids : Получение списка доступных сеток на клиенте Macroscop🔗

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

Важно

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

Примечание

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

Для получения списка сеток, которые может использовать пользователь, от чьего имени в настоящий момент выполнено подключение клиентского приложения к серверу Macroscop, используется запрос к ресурсу command с типом getgrids.

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

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

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

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

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

В ответ сервер возвращает список доступных сеток на указанном клиенте.

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

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

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

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

<ArrayOfString>
    <string>1</string>
    <string>4</string>
    <string>6_1</string>
    <string>7</string>
    <string>8_1</string>
    <string>9</string>
    <string>10</string>
    <string>13</string>
    <string>16</string>
    <string>25</string>
</ArrayOfString>

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

[
    "1",
    "4",
    "6_1",
    "7",
    "8_1",
    "9",
    "10",
    "13",
    "16",
    "25"
]

Где:

Параметр	Описание
Значение до «_»	Число ячеек в сетке
Значение после «_»	Номер конфигурации

Примечание

Номер конфигурации введен только для сеток, обладающих одинаковым числом ячеек, но отличающихся размером и расположением ячеек.

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