Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
https://[IP address or hostname]:[port]/video/

WILL BE DEPRECATED IN NEXT RELEASE, USE /channels

Returns stored video from the camera with the given camera number and options (start time, end time, length, framerate, and/or resolution). Note: Datetime values are formatted according to the ISO 8601 specification: YYYY-MM-DDTHH:MM:SS For example, 2012-12-05T13:40:27. For more information, see this article from the W3C W3.org: Date and Time Formats.

...

To perform the query, the client POSTs the predicate XML to the URL https://[host name]:8080/rss/ where the XML is passed as the URL encoded argument "queryxml" in the request body. (Your programming environment probably has helper functions to perform this POST operation for you. See the sample and helper code for some examples.) The predicate XML will look something like this (the details of each element will be explained in later sections):

...

Images and videos associated with the event can also be retrieved by their URL as referenced by the <FilePath> elements.

Predicate Shortcuts with Query Feed

For convenience, the 3VR Query API includes a feature called "Query Feed' that offers set of built-in predicates for certain common queries. This allows client programs to bypass the predicate definition step and obtain a list of matching events with a simple GET request.

Developers familiar with the API for 3VR Software Version 6.0 will recognize the URL paths below, which formerly belonged to an API called the "3VR Event Syndication API." Although these queries still exist in 7.X, in the new software version the 3VR Live Query API was developed to permit continous, real-time event streams. Refer to the "3VR Live Query API" section for more information.

The following built-in queries are available as Query Feeds:

Query

URL

Description

ALL EVENTS

https://[IP address or hostname]:8080/feed/events/all

Returns the most recent events of any type.

MOTION EVENTS

https://[IP address or hostname]:8080/feed/events/motion

Returns the most recent motion events.

FACE EVENTS

https://[IP address or hostname]:8080/feed/events/face

For VIP Appliances with the Facial Surveillance analytic enabled, returns the recent faces captured by the system.