HoxtonAi
Powered by Redocly

Peel Off Monitors

APIs to manage an Organisation's peel off monitors.

Create/Update peel off monitor

Update a peel off monitor if it exists, create a new one otherwise.

Securityo_auth
Request
Request Body schema: application/json
required

A peel off monitor to put.

id
string or null <uuid>
name
string
reportingEndDate
string or null <date>
reportingStartDate
string or null <date>
siteId
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-monitors
Request samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "reportingEndDate": "2019-08-24",
  • "reportingStartDate": "2019-08-24",
  • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  • "state": "active"
}
Response samples
application/json
{
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "reportingEndDate": "2019-08-24",
  • "reportingStartDate": "2019-08-24",
  • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  • "state": "active"
}

Delete peel off monitor

Set the state of a peel off monitor to deleted.

Securityo_auth
Request
path Parameters
peelOffMonitorId
required
string <uuid>

the ID of the peel off monitor to delete.

Responses
204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

410

Gone.

422

Unprocessable entity.

500

Failed.

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


Securityo_auth 
Request 
path Parameters
peelOffMonitorId
required
string <uuid> 
The ID of the peel off monitor.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


get/peel-off-monitors/{peelOffMonitorId}
Request samples 
Response samples 
application/json
{
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "reportingEndDate": "2019-08-24",
  • "reportingStartDate": "2019-08-24",
  • "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
  • "state": "active"
}
List peel off monitors
Get all available peel off monitors 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 monitors are linked to.


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


 
state
string
Peel off monitors state.


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


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


get/peel-off-monitors
Request samples 
Response samples 
application/json
[
  • {
    }
]