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

/archivefragments : Данные об интервалах записи архива🔗

GET /archivefragments : Получение списка интервалов с информацией о начале и окончании записи архива🔗

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

Примечание

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

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

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

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

GET http://localhost:8080/archivefragments?login=root&password=&channelid=a3785d7f-9259-456b-a64a-048342f22964&fromtime=14.06.2023+00:00:00&totime=14.06.2023 10:00:00

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

GET http://localhost:8080/archivefragments?login=root&password=&channelid=a3785d7f-9259-456b-a64a-048342f22964&fromtime=14.06.2023+00:00:00&totime=14.06.2023 10:00:00&responsetype=json

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

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

Параметр

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

Описание

channelid

—

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

fromtime

—

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

totime

—

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

responsetype

xml

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

Примечание

При указании параметров fromtime и totime необходимо соблюдать следующие требования:

  • Дата должна быть записана с полным указанием года («2023», но не «23»).

  • В качестве разделителя в дате может использоваться только точка («.»).

  • Порядок написания даты должен быть DD.MM.YYYY («14.06.2023»).

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

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

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

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

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

<ArchiveFragmentsList>
    <Fragments>
        <ArchiveFragment>
            <Id>50b4d1f2-10ea-4511-940c-136217f2c84f</Id>
            <FromTime>2023-06-14T02:11:25.880943Z</FromTime>
            <ToTime>2023-06-14T09:13:22.7468942Z</ToTime>
        </ArchiveFragment>
        <ArchiveFragment>
            <Id>8c92e69f-2d17-4b39-a3bf-e43e4d93bc71</Id>
            <FromTime>2023-06-14T09:20:12.880447Z</FromTime>
            <ToTime>2023-06-14T14:09:43.7434942Z</ToTime>
        </ArchiveFragment>
    </Fragments>
</ArchiveFragmentsList>

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

{
    "Fragments": [
        {
            "Id": "50b4d1f2-10ea-4511-940c-136217f2c84f ",
            "FromTime": "2023-06-14T02:11:25.880943Z ",
            "ToTime": "2023-06-14T09:13:22.7468942Z "
        },
        {
            "Id": "8c92e69f-2d17-4b39-a3bf-e43e4d93bc71",
            "FromTime": "2023-06-14T09:20:12.880447Z ",
            "ToTime": "2023-06-14T14:09:43.7434942Z "
        }

    ]
}

Где:

Параметр

Описание

Id

Уникальный идентификатор фрагмента архива

FromTime

Время начала фрагмента архива

ToTime

Время окончания фрагмента архива

Примечание

Количество отдельных фрагментов архива за заданный период определяется непрерывностью записи архива для указанного канала. Если архив ведётся непрерывно, ответ может содержать лишь один фрагмент архива даже при условии запроса данных за несколько дней.