Get

Function

This API is used to get parameter for Function > Snapshot page.

Request Message

See Function > Snapshot > Range > Parameter Description > Table 2 for parameter description.

Sample:

POST /API/Snapshot/Get
HTTP/1.1
{
    "version": "1.0",
    "data": {
        "channel":"CH1",
        "snapshot_resolution":"1280 x 720",
        "reset_session_timeout":false
    }
}

Response Message

Parameter Description

Table 1

ParameterRangeTypeDescription
channelstringchannel number
snapshot_resolutionThe maximum capture resolution should not exceed 1920 * 1080stringSnap resolution
img_timeintUTC Time
img_encodes“base64”stringcodec type
img_format"image/jpeg"stringimage type
img_datastringpicture data

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "ima_time":"1973912484",
        "img_encodes":"base64",
        "img_format":"image/jpeg",
        "ima_data":""
    }
}

Error Code

See Response Messages Body and Common error_code for more information.