Sessions

Used to retrieve session information from the camera's SD card. Session is represented by sequence of files generated by a camera in certain modes (continuous photo mode, burst image, longer video recording when video files are split on 4GB boundaries...). In case of modes where only one file per recording session is generated, that one file is considered to be a session as well.

GET /api/<versionNumber>/sessions/videos[?sort=<sort>][&order=<order>][&offset=<offset>][&count=<count>]

Format:

http://<baseURL>/api/<versionNumber>/sessions/videos[?sort=<sort>][&order=<order>][&offset=<offset>][&count=<count>]

Example:

http://192.168.1.101/api/2/sessions/videos

Parameters:

Parameter 'offset' is 0-based so offset=0 will address the first session from the resource.

'offset' and 'count' are used (based on sort criteria set by 'sort' parameter and 'order') to retrieve video information for 'count' sessions, first starting at specified 'offset' from beginning of a sorted list of sessions. If 'offset' is bigger than total count of sessions, error code will be returned. However, if 'offset' falls into range but 'count' specifies more items than available, this method will return as many sessions as possible and won't return error status code.

The table below describes all of the parameters that can be used in a request. Parameters and values are case-sensitive. Required parameters must be used or the call will fail. Optional parameters, which are highlighted with [square brackets], may be used. If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.

NOTE: Offset and count works on a session boundaries, rather than file boundaries as it's the case with GET /videos.

Description:

Returns array of JSON objects containing information about the first video found in every session. Each JSON object will contain following information:

NOTE: If 'is_valid' flag is set to 'false', values of all other required attributes should not be taken into account since they might (and probably will) contain faulty data.

Response codes:

Example request 1:

GET http://192.168.1.101/api/2/sessions/videos

and example response:

{
    "total":2,
    "items": [
                {
                    "path":"/100TTCAM/M0020002.MP4",
                    "id":"7666a33a-6275-4549-836b-4f8d00281233-100-000-002-0001",
                    "created":"2012-03-05T18:34:14Z",
                    "size_bytes":2154637,
                    "length_secs":21.90,
                    "nr_highlights":6,
                    "mode":"normal",
                    "resolution":"1080p",
                    "framerate_fps":60,
                    "aspect_ratio":"16/9",
                    "is_valid":true,
                    "number_of_files":2
                 },
                 {
                    "path":"/100TTCAM/M0020005.MP4",
                    "id":"9376a883-6345-2349-966b-2a8d00281980-100-000-002-0002",
                    "created":"2012-03-04T12:05:20Z",
                    "size_bytes":3454637,
                    "length_secs":24.20,
                    "nr_highlights":4,
                    "mode":"normal",
                    "resolution":"720p",
                   &nbsp"framerate_fps":60,
                    "aspect_ratio":"16/9",
                    "is_valid":true,
                    "number_of_files":4
                 }
            ]
}

GET /api/<versionNumber>/sessions/images[?sort=<sort>][&order=<order>][&offset=<offset>][&count=<count>]

Format:

http://<baseURL>/api/<versionNumber>/sessions/images[?sort=<sort>][&order=<order>][&offset=<offset>][&count=<count>]

Example:

http://192.168.1.101/api/2/sessions/images

Parameters:

Parameter 'offset' is 0-based so offset=0 will address the first session from the resource.

'offset' and 'count' are used (based on sort criteria set by 'sort' parameter and 'order') to retrieve image information for 'count' sessions, first starting at specified 'offset' from beginning of a sorted list of sessions. If 'offset' is bigger than total count of sessions, error code will be returned. However, if 'offset' falls into range but 'count' specifies more items than available, this method will return as many sessions as possible and won't return error status code.

The table below describes all of the parameters that can be used in a request. Parameters and values are case-sensitive. Required parameters must be used or the call will fail. Optional parameters, which are highlighted with [square brackets], may be used. If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.

NOTE: Offset and count works on a session boundaries, rather than file boundaries as it's the case with GET /images.

Description:

Returns array of JSON objects containing information about the first image found in every session. Each JSON object will contain following information:

NOTE: If 'is_valid' flag is set to 'false', values of all other required attributes should not be taken into account since they might (and probably will) contain faulty data.

Response codes:

Example request 1:

GET http://192.168.1.101/api/2/sessions/images

and example response:

{
    "total":2,
    "items": [
                {
                    "path":"/100TTCAM/IMG_0001.JPG",
                    "id":"7666a33a-6275-4549-836b-4f8d00281233-100-000-002-0001",
                    "created":"2012-03-05T18:34:14Z",
                    "size_bytes":2154637,
                    "mode":"single",
                    "resolution":"16MP",
                    "aspect_ratio":"4/3",
                    "lat_deg":44.715513732021364,
                    "lon_deg":20.63232421875,
                    "is_valid":true,
                    "number_of_files":1
                 },
                 {
                    "path":"/100TTCAM/IMG_0002.JPG",
                    "id":"9376a883-6345-2349-966b-2a8d00281980-100-000-002-0002",
                    "created":"2012-03-04T12:05:20Z",
                    "size_bytes":2154637,
                    "mode":"burst",
                    "resolution":"16MP",
                    "aspect_ratio":"4/3",
                    "lat_deg":44.715637,
                    "lon_deg":20.631237,
                    "order":1,
                    "total":10,
                    "is_valid":true,
                    "number_of_files":10
                 }
            ]
}