⌂ > ⎘ Открытый REST API

GET /command?type=getprofiles : Получение списка серверных профилей экрана (видов)🔗

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

Важно

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

Примечание

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

Для получения списка профилей экрана (более известных как виды), созданных на сервере, используется запрос к ресурсу command с типом getprofiles.

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

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

GET http://localhost:8080/command?type=getprofiles&login=root&password=

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

GET http://localhost:8080/command?type=getprofiles&login=root&password=&responsetype=json

В ответ сервер возвращает список серверных профилей, доступных для пользователя, отправившего запрос.

Примечание

Вид считается недоступным если не содержит камер, доступных пользователю для просмотра, а также при отсутствии у пользователя прав на использование этого вида.

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

Параметр

Значение по умолчанию

Описание

responsetype

xml

Формат представления возвращаемых данных. Если не указан в запросе, используется значение по умолчанию. Опциональный параметр. Допустимые значения: xml, json

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

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

<ArrayOfMapInfo>
    <MapInfo>
        <Id>22ab7b5e-a8e0-48f9-80ff-a48217baa21f</Id>
        <Name>Офис</Name>
    </MapInfo>
    <MapInfo>
        <Id>f2294ff9-783c-4b49-b5ab-a8fd0529da99</Id>
        <Name>Склад</Name>
    </MapInfo>
</ArrayOfMapInfo>

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

[
    {
        "Id": "22ab7b5e-a8e0-48f9-80ff-a48217baa21f",
        "Name": "Офис"
    },
    {
        "Id": "f2294ff9-783c-4b49-b5ab-a8fd0529da99",
        "Name": "Склад"
    }
]

Где:

Параметр

Описание

Id

Уникальный идентификатор профиля. Может быть использован при отправке запроса на установку профиля на клиенте

Name

Имя профиля в рамках действующей конфигурации