Skip to main content
Skip table of contents

List of analytics cameras

Paginated list of all cameras with analytics cases.

GET/api/v1/analytic-case/cameras-with-cases

Headers

Authorization

Bearer token

Accept

application/json

X-Client

ios-cctv|android-cctv|thick-legal|web

X-UUID

unique device id

Body

per_pagerequired

int

Number of items per pagination page. Default is 25 items

pagerequired

int

Pagination page number

typesrequired

array

Search by analytics case type

statusrequired

int

Search by analytics case status

Response

200

Returns the list of cameras with analytics cases on the i-th pagination page

JSON
{
    "data": [
        {
            "camera": {
                "id": 1,
                "group_id": 1,
                "status": "active",
                "type": "type",
                "start_at": "2022-03-24 17:49:55",
                "created_at": "2022-01-27 18:55:48",
                "billing_id": null,
                "pretty_name": "pretty_name",
                "lat": null,
                "lng": null,
                "azimuth": null,
                "streams": [
                    {
                        "id": 1,
                        "type": "high",
                        "camera_id": 1,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 1920,
                        "height": 1080
                    },
                    {
                        "id": 2,
                        "type": "low",
                        "camera_id": 1,
                        "is_preview_from_server": true,
                        "is_archive_from_server": null,
                        "status": "active",
                        "has_sound": false,
                        "width": 640,
                        "height": 480
                    }
                ],
                "has_sound": false,
                "is_archive_recording": true,
                "is_bridge": false,
                "is_favorite": false,
                "user_status": "active",
                "name": "name"
            },
            "analytic_case": {
                "id": 1,
                "title": "title",
                "type": "type",
                "type_pretty": "type_pretty",
                "status": "active",
                "created_at": "2022-04-08 13:30:34",
                "updated_at": "2022-04-08 13:30:34",
                "color": "#F027DC"
            },
            "analytic_status": "processed",
            "analytic_status_pretty": "Active"
        }
    ],
    "links": {
        "first": "https://vms.local/api/v1/analytic-case/cameras-with-cases?page=1",
        "last": "https://vms.local/api/v1/analytic-case/cameras-with-cases?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://vms.local/api/v1/analytic-case/cameras-with-cases?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "path": "https://vms.local/api/v1/analytic-case/cameras-with-cases",
        "per_page": 25,
        "to": 1,
        "total": 1
    }
}
401

Authorization token not provided or invalid, see Obtaining a token

422

Returns a JSON object with an error, see Validation

JSON
{
    "message": "There won't be any informative message here",
    "errors": {
        "any_key": [
            "Here the error cause will be described"
        ]
    }
}

Example

JSON
curl -k --location --request GET 'https://vms.local/api/v1/analytic-case/cameras-with-cases?per_page=int&page=int&types=array&status=int' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id'
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.