Retrieve camera snapshot

Retrieve a snapshot from the in-cab or road-facing lens, or from any paired auxiliary camera. The snapshot captures a picture of the specified current lens for the specified device. The camera must be online.

Request
Security:
bearerAuth
path Parameters
imei
required
string (IMEI)

The IMEI of the device. The IMEI number can be found on a sticker on the device itself or on the back of the device box.

Example: 357660101000198
cameraId
required
string

The ID of the in-cab or road-facing lens, or any paired auxiliary camera.

1 - road-facing lens, 2 - in-cab lens, 50+ - auxiliary cameras. Use 0 for all cameras, or with the cameraIds parameter for a list of specific cameras.

Example: 2
query Parameters
cameraIds
string

A list of the camera IDs, separated by a comma. This may include the in-cab or road-facing lens, or any paired auxiliary camera: 1 - road-facing lens, 2 - in-cab lens, 50+ - auxiliary cameras. The list of cameras can be used only if cameraId=0 is provided.

Example: cameraIds=1,2,51,52
time
string <date-time> (Time)

The time, in ISO 8601 format.

Example: time=2020-01-01T14:48:00.000Z
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

417

Expectation failed error

500

Internal server error

get/devices/{imei}/cameras/{cameraId}/snapshot
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/devices/:imei/cameras/:cameraId/snapshot?cameraIds=1%2C2%2C51%2C52&time=2020-01-01T14%3A48%3A00.000Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    2 more
    417
    500
application/json
{}