Create an analytics case. Damage detection

Creating an analytics case with the type «Camera Damage Detection».

Tool for automatic localization and identification of camera damage, obstruction, or vandalism.

The business case can be applied in various use cases where there is a need for continuous monitoring of camera «health» with mandatory alerts based on specified detection thresholds for these occurrences.

Event: Camera damage detection.

POST/api/v1/analytic-case

Headers
Authorization		Bearer token
Accept		application/json
X-Client		ios-cctv\|android-cctv\|thick-legal\|web
X-UUID		unique device id

Body
json	JSON `{ "title": "Camera damage / obstruction / vandalism detection", "type": "camera-obstacle", "cameras": [ { "id": 7, "analytic_case_camera_user_status": null, "scripts": [ { "id": 23 } ] }, { "id": 10, "analytic_case_camera_user_status": null, "scripts": [ { "id": 23 } ] } ] }`
title^required	string	Analytics case name
type^required	string	For this type of case, the value «camera-obstacle» should always be sent
cameras^required	array	Array of camera objects with specified events and reactions
*cameras..id^required**	array	Camera ID
*cameras..scripts^required**	array	Array of event and reaction ID's
*cameras..scripts..id^required*	int	Event and reaction ID, see Creating an event and reaction

Response
201		Returns the analytics case
JSON { "id": 46, "title": "Camera damage / obstruction / vandalism detection", "type": "camera-obstacle", "type_pretty": "Camera damage / obstruction / vandalism detection", "status": "active", "cameras": [ { "id": 7, "group_id": 2, "status": "inactive", "type": "media_server_v2", "start_at": "", "created_at": "2022-12-16 10:25:54", "billing_id": null, "pretty_name": "Camera 1", "pretty_text": "Cameras", "short_address": "Cameras", "full_address": "Cameras", "lat": null, "lng": null, "azimuth": null, "streams": [ { "id": 13, "type": "high", "camera_id": 7, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null }, { "id": 14, "type": "low", "camera_id": 7, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null } ], "has_sound": false, "archive_ranges": [], "archive_recording_timetable": null, "is_archive_recording": false, "archive_recording_type": "fulltime", "can_change_archive_timetable": false, "scripts": [ { "id": 23, "title": "Set a label", "schedule": [], "timetable": { "days": [ { "to": "23:59:00+05:00", "from": "00:00:00+05:00", "type": "same_every_day", "breaks": [] } ], "intervals": [] }, "status": "active", "created_at": "2022-12-21 12:47:41", "updated_at": "2022-12-21 12:47:41", "users": [ { "id": 5, "login": "user", "name": "user", "parent_id": null, "created_at": "2022-12-06 20:20:58", "updated_at": "2022-12-21 10:53:45", "access_token_id": null, "can_update_password": true } ], "event": { "id": 9, "name": "camera-obstacle", "description": "Camera damage / obstruction / vandalism detection", "color": "#2542DF", "analytic_type": "camera-obstacle" }, "extra": null } ], "meta": null, "analytic_case_camera_status": "inactive", "analytic_case_camera_status_pretty": "Camera is inactive", "analytic_case_camera_user_status": "failed_to_create", "analytic_case_camera_user_status_pretty": "Creation error", "event": null, "is_bridge": false, "is_favorite": false, "user_status": "active", "name": "Camera 1" }, { "id": 10, "group_id": 2, "status": "active", "type": "media_server_v2", "start_at": "", "created_at": "2022-12-16 10:25:55", "billing_id": null, "pretty_name": "Camera 2", "pretty_text": "Cameras", "short_address": "Cameras", "full_address": "Cameras", "lat": null, "lng": null, "azimuth": null, "streams": [ { "id": 19, "type": "high", "camera_id": 10, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null }, { "id": 20, "type": "low", "camera_id": 10, "is_preview_from_server": true, "is_archive_from_server": null, "status": "active", "has_sound": false, "width": null, "height": null } ], "has_sound": false, "archive_ranges": [], "archive_recording_timetable": null, "is_archive_recording": false, "archive_recording_type": "fulltime", "can_change_archive_timetable": false, "scripts": [ { "id": 23, "title": "Set a label", "schedule": [], "timetable": { "days": [ { "to": "23:59:00+05:00", "from": "00:00:00+05:00", "type": "same_every_day", "breaks": [] } ], "intervals": [] }, "status": "active", "created_at": "2022-12-21 12:47:41", "updated_at": "2022-12-21 12:47:41", "users": [ { "id": 5, "login": "user", "name": "user", "parent_id": null, "created_at": "2022-12-06 20:20:58", "updated_at": "2022-12-21 10:53:45", "access_token_id": null, "can_update_password": true } ], "event": { "id": 9, "name": "camera-obstacle", "description": "Camera damage / obstruction / vandalism detection", "color": "#2542DF", "analytic_type": "camera-obstacle" }, "extra": null } ], "meta": null, "analytic_case_camera_status": "active", "analytic_case_camera_status_pretty": "Camera active", "analytic_case_camera_user_status": null, "analytic_case_camera_user_status_pretty": null, "event": null, "is_bridge": false, "is_favorite": false, "user_status": "active", "name": "Camera 2" } ], "created_at": "2022-12-21 12:47:57", "updated_at": "2022-12-21 12:47:57", "color": "#566197", "available_events": [], "is_fails_exists": true, "errors": [ "Error creating camera Camera 2" ] }
401		Authorization token not provided or invalid, see Obtaining a token
402		Exceeded the license limit for the selected analytics case
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 POST 'https://vms.local/api/v1/analytic-case' \
--header 'Authorization:Bearer token' \
--header 'Accept:application/json' \
--header 'X-Client:ios-cctv|android-cctv|thick-legal|web' \
--header 'X-UUID:unique device id' \
--header 'Content-Type: application/json \
--data-raw '{
    "title": "Camera damage / obstruction / vandalism detection",
    "type": "camera-obstacle",
    "cameras": [
        {
            "id": 7,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 23
                }
            ]
        },
        {
            "id": 10,
            "analytic_case_camera_user_status": null,
            "scripts": [
                {
                    "id": 23
                }
            ]
        }
    ]
}'