Retrieve album images (BETA)

This call is currently in a restricted BETA status. Contact your Technical Account Manager for more information.

Retrieve all album images for an organization based on the specified filters.

The following profiles have permission to make this call:

  • partners
  • sub-partners
  • administrators
  • supervisors

Request
Security:
bearerAuth
path Parameters
orgId
required
string

The ID of the organization. Obtain this from GET /organizations.

Example: 62
query Parameters
status
string

Driver Recognition Status.
- Familiar: The driver is recognized and authorized to drive fleet vehicles.
- Unfamiliar: The driver is not recognized or is unauthorized to drive fleet vehicles.
- Pending Review: The system is currently processing the image for identification.

Enum: "familiar" "unfamiliar" "pendingReview"
imei
string (IMEI)

Images can be filtered using the IMEI parameter.
The IMEI represents the unique identifier of the device that captured the snapshot.
The IMEI number can be found on a sticker on the device itself or on the back of the device box.

Example: imei=357660101000198
startTime
string <date-time>

The time, in ISO 8601 format, Filter images created from this time forward.

Example: startTime=2020-01-01T14:48:00.000Z
endTime
string <date-time>

The time, in ISO 8601 format, Filter images created until this time.

Example: endTime=2020-01-01T14:48:00.000Z
limit
integer <= 2000 ^[1-9]\d*$
Default: 100

Set the maximum number of pagination results to receive.

Example: limit=56
offset
string^[0-9]\d*$
Default: "0"

Set the number of results to skip over before receiving pagination results.

Example: offset=1
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

500

Internal server error

get/organization-album/{orgId}/album
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/organization-album/:orgId/album?status=familiar&imei=357660101000198&startTime=2020-01-01T14%3A48%3A00.000Z&endTime=2020-01-01T14%3A48%3A00.000Z&limit=56&offset=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "data": [],
  • "metadata": {
    },
  • "requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37"
}