Get the list of all cameras
Get the list of all cameras
Paginated list of all cameras available to the user. The camera field is_set_on_maps
returns only with the filter=map
parameter.
GET /api/v1/cameras |
Parameters
int
search, Search by camera address and name
int
group_id, Filtering by camera location
array
statuses, Filtering by status
int
per_page, Number of elements in one pagination page.
int
page, Pagination page number
string
filter, Filtering the list of cameras ( analytics || map )
array
exclude_ids, List of cameras that are not needed in the response
array
top_list_ids, List of cameras that should be displayed at the top of the list
string
cluster_key, Filtering cameras by location in a cluster on the map
boolean
has_location, Filtering cameras, whether they have a location set or not.
boolean
is_set_on_maps, Filtering cameras, added they on map and/or plan.
200 |
Returns cameras on the i pagination page
JSON
|
401 |
Authorization token not sent or not valid |
422 |
Returns a JSON object with an error.
JSON
|
curl -k --request POST \
--url 'https://your-domain/api/v1/cameras' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"search": 0,
"group_id": 0,
"statuses": [],
"per_page": 0,
"page": 0,
"filter": "string",
"exclude_ids": [],
"top_list_ids": [],
"cluster_key": "string",
"has_location": "boolean",
"is_set_on_maps": "boolean"
}'
$data = array (
'search' => 0,
'group_id' => 0,
'statuses' =>
array (
),
'per_page' => 0,
'page' => 0,
'filter' => 'string',
'exclude_ids' =>
array (
),
'top_list_ids' =>
array (
),
'cluster_key' => 'string',
'has_location' => 'boolean',
'is_set_on_maps' => 'boolean',
);
$context = stream_context_create([
'ssl'=>['verify_peer' => false],
'http' => [
'method' => 'GET',
'header' => "Content-Type: application/json\r
Accept: application/json",
'content'=>json_encode($data)
]
]);
$result = file_get_contents('https://your-domain/api/v1/cameras', false, $context);