getImageSequence

Get a list with historical image definitions. From version 1.10.2, reverse search.

This command is used to obtain a list of timestamps of recorded images between given dates. The result is a limited list starting with records from starttime to endtime. Optional filters (e.q. motion) can be included in later releases. A maximum of 100 records is returned by default if limit is not supplied.

As of version 1.10.2, the endtime can lie before the starttime and the limit can be negative. Refer to chapter Result Lists for an explanation of these parameters.

Request

command=getImageSequence&serverid=[UID]&cameraid=[UID]&starttime=[timestamp]&endtime=[timestamp]&limit=[number]
parameter type remarks
serverid [UID] unique server id.
cameraid [UID] unique camera id
starttime [timestamp] images at or past this timestamp are returned
endtime [timestamp] images before or at this timestamp are returned
limit [number] determines the limit of the resulting record count

Response

<result errorcode="0">
  <imagesequence count="[number]">
    <img>
      <time>[timestamp]</time>

    ...
  </imagesequence>
 </result>
node value remarks
/result
@errorcode [number] See error codes below
/result/imagesequence
@count [number] The number of images.
/result/imagesequence/image
time [timestamp] local time of this image
error code description remarks
0 Ok Ok, no error
-2 No device No device found for the supplied cameraid/deviceid.
-4 Invalid timestamp Invalid datetime format. See Timestamp.

See Also

Changelog

  • 2.1.1    – Added serverid
  • 1.12.3  – Documented if timestamps are local or UTC timestamps
  • 1.11.3  – Strict checking on starttime and endtime parameter format. Returns -4 on error (see Result Codes).
  • 1.11.3  – Default values are taken for starttime (earliest possible time) and endtime (current time).
  • 1.10.2  – Allows negative limit and endtime before starttime to reverse the ordering of the result list.
  • 1.3.9    – Limited the returning record count to 100 records by default. Can be adjusted by parameter limit.
  • 1.3.6    – Added.