HoxtonAi
Powered by Redocly

Alert Camera Position Mappings

APIs to manage an organisation's alert camera position mappings.

Create/Update alert camera position mapping

Update a link between an alert and a camera position if it exists, create a new one otherwise.

Securityo_auth
Request
Request Body schema: application/json
required

The link between an alert and a camera position to store.

alertId
required
string <uuid>
cameraPositionId
required
string <uuid>
id
string or null <uuid>
state
string
Enum: "active" "deleted"
Responses
201

OK.

204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

put/alert-camera-position-mappings
Request samples
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "active"
}
Response samples
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "active"
}

Delete alert camera position mapping

Delete a link between an alert and a camera position.

Securityo_auth
Request
path Parameters
alertCameraPositionMappingId
required
string <uuid>

The ID of the link between an alert and a camera position to be deleted.

Responses
204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

delete/alert-camera-position-mappings/{alertCameraPositionMappingId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get alert camera position mapping
Get a link between an alert and a camera position
identified by its id.


Securityo_auth 
Request 
path Parameters
alertCameraPositionMappingId
required
string <uuid> 
The ID of the link between an alert and a camera position to get.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/alert-camera-position-mappings/{alertCameraPositionMappingId}
Request samples 
Response samples 
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "active"
}
List alert camera position mappings
Get all available links between alters and camera positions subject
to filters.


Securityo_auth 
Request 
query Parameters
cameraId
string <uuid> 
The ID of a camera linked to the alerts.


 
alertId
string <uuid> 
The ID of an alert being linked to the camera positions.


 
cameraPositionId
string <uuid> 
The ID of a camera position linked to the alerts.


 
notificationGroupId
string <uuid> 
The ID of the notification group the linked alert notifies.


 
organisationId
string <uuid> 
The ID of the associated organisation.


 
state
string
Alert camera position state.


 Enum: "active" "deleted"  
alertType
string
The ID of a camera linked to the Alerts.


 Enum: "offline_alert" "occupancy_alert" "camera_health_summary_alert"  
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/alert-camera-position-mappings
Request samples 
Response samples 
application/json
[
  • {
    }
]