HoxtonAi
Powered by Redocly

Peel Off Monitor Camera Positions

APIs to manage an Organisation's peel off monitor camera positions.

Create/Update peel off monitor camera position

Update a peel off monitor's camera position if it exists, create a new object linking the given peel off monitor to the given camera position otherwise.

Securityo_auth
Request
Request Body schema: application/json
required

A peel off monitor camera position to put.

cameraPositionId
required
string <uuid>
countDirection
required
string
Enum: "direction_1" "direction_2" "direction_both"
countType
required
string
Enum: "base" "peel_off"
id
string or null <uuid>
peelOffMonitorId
required
string <uuid>
state
string
Enum: "active" "deleted"
Responses
201

Created.

204

Updated.

400

Bad request.

401

Authentication failed.

403

Not allowed.

410

Gone.

422

Unprocessable entity.

500

Failed.

put/peel-off-monitor-camera-positions
Request samples
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "countDirection": "direction_1",
  • "countType": "base",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "peelOffMonitorId": "cc189a22-8e7f-4749-b5e7-b00a5382d436",
  • "state": "active"
}
Response samples
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "countDirection": "direction_1",
  • "countType": "base",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "peelOffMonitorId": "cc189a22-8e7f-4749-b5e7-b00a5382d436",
  • "state": "active"
}

Delete peel off monitor camera position

Set the state of a peel off monitor camera position to deleted.

Securityo_auth
Request
path Parameters
peelOffMonitorCameraPositionId
required
string <uuid>

the ID of the peel off monitor camera position to delete.

Responses
204

OK.

401

Authentication failed.

403

Not allowed.

404

Not found.

410

Gone.

422

Unprocessable entity.

500

Failed.

delete/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get peel off monitor camera position
Get a peel off monitor camera position identified by the provided ID.


Securityo_auth 
Request 
path Parameters
peelOffMonitorCameraPositionId
required
string <uuid> 
The ID of the peel off monitor camera position to get.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


get/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}
Request samples 
Response samples 
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "countDirection": "direction_1",
  • "countType": "base",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "peelOffMonitorId": "cc189a22-8e7f-4749-b5e7-b00a5382d436",
  • "state": "active"
}
List peel off monitor camera positions
Get all available peel off monitor camera positions subject to filters.


Securityo_auth 
Request 
query Parameters
organisationId
string <uuid> 
the ID of the associated organisation.


 
siteId
string <uuid> 
the ID of the site the peel off monitor camera positions are linked to.


 
cameraPositionId
string <uuid> 
the ID of a camera position linked to the peel off monitor camera positions.


 
peelOffMonitorId
string <uuid> 
the ID of the peel off monitor the peel off monitor camera position is linking.


 
state
string
Peel off monitor camera positions state filter.


 Enum: "active" "deleted"  
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


get/peel-off-monitor-camera-positions
Request samples 
Response samples 
application/json
[
  • {
    }
]