Продукты
Решения
Поддержка
Стать партнером
Новости
Получить Демо

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

GET /command?type=findarchive : Получение информации о наличии архива в указанный момент времени🔗

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

Важно

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

Примечание

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

Для получения информации о наличии данных в архиве за определённый момент времени используется запрос к ресурсу command с типом findarchive.

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

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

GET http://localhost:8080/command?type=findarchive&login=root&password=&channelid=a3785d7f-9259-456b-a64a-048342f22964&searchTime=14.06.2023 10:10:10

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

GET http://localhost:8080/command?type=findarchive&login=root&password=&channelid=a3785d7f-9259-456b-a64a-048342f22964&searchTime=14.06.2023+10:10:10&responsetype=json

В ответ сервер возвращает сведения о наличии архива за указанное время и временную метку ближайшего к заданному времени видеокадра.

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

Параметр

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

Описание

channelid

—

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

searchTime

—

Дата и время, для которых необходимо найти архивные записи. Время должно указываться в часовом поясе UTC. Обязательный параметр

responsetype

xml

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

accept

application/json или application/xml

Выбор формата ответа

Примечание

Параметр searchTime поддерживает несколько форматов записи даты и времени:

  • Дата может записываться как с полным обозначением года («YYYY» или «2023»), так и с сокращённым («YY» или «23»).

  • Для разделения числа, месяца и года в дате можно использовать как точку («.»), так и дефис («-»).

  • Допускается написание даты, начиная как с числа («DD.MM.YYYY» или «14.06.2023»), так и с года («YYYY.MM.DD» или «2023.06.14»).

  • Разделение даты и времени может осуществляться как пробелом (« ») или его кодом («%20»), так и плюсом («+»).

Предупреждение

Несмотря на то, что ответ от сервера содержит разделитель «T» между датой и временем, этот разделитель не поддерживается в теле запроса.

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

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

<CheckArchiveResult>
    <HasArchive>true</HasArchive>
    <NearestFrameTimestamp>2023-06-14T10:10:00.0988432Z</NearestFrameTimestamp>
</CheckArchiveResult>

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

{
    "HasArchive": true,
    "NearestFrameTimestamp": "2023-06-14T10:10:00.0988432Z"
}

Где:

Параметр

Описание

HasArchive

Флаг наличия архива за указанное время. Возможные значения: true – архив за указанное время существует, false – не существует

NearestFrameTimestamp

Временная метка ближайшего видеокадра в формате UTC. Если HasArchive=false, параметр примет значение null