Documentation for Axxon Next 4.6.0. Documentation for other versions of Axxon Next is available too.

Previous page Working with bookmarks  Edit bookmarks Next page

Axxon Next 4.1.1.7766 or later


GET http://IP-address:port/prefix/archive/contents/bookmarks/{HOSTNAME}/{ENDTIME}/{BEGINTIME}

{HOSTNAME} - Server name.

Note

The ENDTIME and BEGINTIME syntax is described in Get MM archive contents section.


ParameterRequiredDescription

threshold

No

Results offset by the specified number. For example, if a query with offset=0 returned 100 results, then in order to get the next results, it is necessary to run a query with offset=100. If the second query returned 250 results, then in order to get the next results, it is necessary to run a query with offset=350, etc.

limitNoReceived bookmarks limit. The default value is 100.

Sample request:

GET http://127.0.0.1:80/archive/contents/bookmarks/Server1/future/past

Sample response: 

{
    "archives": [
        {
            "friendly_name": "AliceBlue",
            "storage": "hosts/Server1/MultimediaStorage.AliceBlue/MultimediaStorage"
        }
    ],
    "cameras": [
        {
            "endpoint": "hosts/Server1/DeviceIpint.7/SourceEndpoint.video:0:0",
            "friendly_name": "Camera"
        }
    ],
    "events": [
        {
            "archBegin": "2019-03-19T10:06:54.295Z",
            "archEnd": "2019-03-19T13:02:41.243Z",
            "begins_at": "20190319T114843.000",
            "boundary": "((0.4989775;0.4169492);(75.49898;13.41695))",
            "comment": "comment",
            "endpoint": "hosts/Server1/DeviceIpint.7/SourceEndpoint.video:0:0",
            "ends_at": "20190319T115638.000",
            "geometry": "f49fa526-c320-404a-9da2-7a090759a717;None;147",
            "group_id": "b686e57c-a4e8-44dd-b17e-8c1b805a1b6e",
            "id": "7843d488-67e2-4140-ab17-0016e4ba22bc",
            "is_protected": false,
            "storage_id": "hosts/Server1/MultimediaStorage.AliceBlue/MultimediaStorage",
            "timestamp": "20190319T130332.110491",
            "user_id": "root"
        },
        {
            "begins_at": "20190319T121747.999",
            "boundary": "((0.4989775;0.4169492);(75.49898;13.41695))",
            "comment": "protected",
            "endpoint": "hosts/Server1/DeviceIpint.7/SourceEndpoint.video:0:0",
            "ends_at": "20190319T123101.145",
            "geometry": "4cbf8979-4234-4a9a-9838-3026bd4ec496;None;147",
            "group_id": "2e184409-ed77-41bb-85d1-92d78d35c882",
            "id": "a792a895-00fd-48f9-9bd4-99e572f1579d",
            "is_protected": true,
            "storage_id": "hosts/Server1/MultimediaStorage.AliceBlue/MultimediaStorage",
            "timestamp": "20190319T130339.722000",
            "user_id": "root"
        }
]
ParameterDescription
archivesArray of archives that contain the bookmarks.
camerasArray of bookmarked cameras.
begins_atCorrespond to the bookmark beggining and ending.
ends_at
commentCommentary.
endpointSource.
is_protected

If the value is true then the record is proteced from overwriting (see Protecting video footage from FIFO overwriting).

storage_idArchive.
timestampDate of the bookmark adding.
user id

User who added the bookmark.

  • No labels