HoxtonAi
Powered by Redocly

Occupancy Monitor Camera Positions

APIs to manage an Organisation's occupancy monitor camera positions.

Create/Update occupancy monitor camera position

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

Securityo_auth
Request
Request Body schema: application/json
required

An occupancy monitor camera position.

cameraPositionId
required
string <uuid>
id
string or null <uuid>
inDirection
required
string
Enum: "direction_1" "direction_2"
occupancyMonitorId
required
string <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.

put/occupancy-monitor-camera-positions
Request samples
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inDirection": "direction_1",
  • "occupancyMonitorId": "51bf4310-39f9-49d3-99c1-c643ff9c2f04",
  • "state": "active"
}
Response samples
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inDirection": "direction_1",
  • "occupancyMonitorId": "51bf4310-39f9-49d3-99c1-c643ff9c2f04",
  • "state": "active"
}

Delete occupancy monitor camera position

Set the state of an occupancy monitor camera position to deleted.

Securityo_auth
Request
path Parameters
occupancyMonitorCameraPositionId
required
string <uuid>

the ID of the occupancy 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/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get occupancy monitor camera position
Get an occupancy monitor camera position identified by the provided ID.


Securityo_auth 
Request 
path Parameters
occupancyMonitorCameraPositionId
required
string <uuid> 
The ID of the occupancy monitor camera position.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


get/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}
Request samples 
Response samples 
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inDirection": "direction_1",
  • "occupancyMonitorId": "51bf4310-39f9-49d3-99c1-c643ff9c2f04",
  • "state": "active"
}
List occupancy monitor camera positions
Get all available occupancy 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 occupancy monitor camera positions are linked to.


 
cameraId
string <uuid> 
the ID of a camera linked to the occupancy monitor camera positions.


 
occupancyMonitorId
string <uuid> 
the ID of the occupancy monitor the occupancy monitor camera position is linking.


 
state
string
Occupancy monitor camera position state.


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


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


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