HoxtonAi
Powered by Redocly

Occupancy Monitors

APIs to manage an Organisation's occupancy monitors.

Create/Update occupancy monitor

Update an occupancy monitor if it exists, create a new one otherwise.

Securityo_auth
Request
Request Body schema: application/json
required

An occupancy monitor.

capacity
integer or null <uint64> >= 1
dailyResetMin
required
integer <uint64> [ 0 .. 1440 ]
Default: 0
id
string or null <uuid>
name
required
string
reportingEndDate
string or null <date>
reportingStartDate
string or null <date>
siteId
required
string <uuid>
state
string
Enum: "active" "deleted"
Responses
201

Created.

204

No Content.

400

Bad request.

401

Authentication failed.

403

Not allowed.

410

Gone.

422

Unprocessable entity.

500

Failed.

put/occupancy-monitors
Request samples
application/json
{
  • "capacity": 100,
  • "dailyResetMin": 0,
  • "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
{
  • "capacity": 100,
  • "dailyResetMin": 0,
  • "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 occupancy monitor

Set the state of an occupancy monitor to deleted.

Securityo_auth
Request
path Parameters
occupancyMonitorId
required
string <uuid>

the ID of the occupancy monitor.

Responses
204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

410

Gone.

422

Unprocessable entity.

500

Failed.

delete/occupancy-monitors/{occupancyMonitorId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get occupancy monitor
Get an occupancy monitor identified by the provided ID.


Securityo_auth 
Request 
path Parameters
occupancyMonitorId
required
string <uuid> 
The ID of the Occupancy Monitor.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


get/occupancy-monitors/{occupancyMonitorId}
Request samples 
Response samples 
application/json
{
  • "capacity": 100,
  • "dailyResetMin": 0,
  • "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 occupancy monitors
Get all available occupancy 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 occupancy monitors are linked to.


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


 
state
string
Occupancy monitor state.


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


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


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