HoxtonAi
Powered by Redocly

People Count Monitor Camera Positions

APIs to manage an Organisation's people count monitor camera positions.

Create/Update people count monitor camera position

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

Securityo_auth
Request
Request Body schema: application/json
required

A people count monitor camera position to put.

cameraPositionId
required
string <uuid>
direction1
required
string
Enum: "direction_1" "direction_2"
id
string or null <uuid>
peopleCountMonitorId
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/people-count-monitor-camera-positions
Request samples
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "direction1": "direction_1",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "peopleCountMonitorId": "af5c9ece-4147-4fc4-9db3-7065170e641f",
  • "state": "active"
}
Response samples
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "direction1": "direction_1",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "peopleCountMonitorId": "af5c9ece-4147-4fc4-9db3-7065170e641f",
  • "state": "active"
}

Delete people count monitor camera position

Set the state of a people count monitor camera position to deleted.

Securityo_auth
Request
path Parameters
peopleCountMonitorCameraPositionId
required
string <uuid>

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


Securityo_auth 
Request 
path Parameters
peopleCountMonitorCameraPositionId
required
string <uuid> 
The ID of the people count monitor camera position to get.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


get/people-count-monitor-camera-positions/{peopleCountMonitorCameraPositionId}
Request samples 
Response samples 
application/json
{
  • "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "direction1": "direction_1",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "peopleCountMonitorId": "af5c9ece-4147-4fc4-9db3-7065170e641f",
  • "state": "active"
}
List people count 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 people count monitor camera positions are linked to.


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


 
peopleCountMonitorId
string <uuid> 
the ID of the people count monitor the people count monitor camera position is linking.


 
state
string
People count monitor camera positions state filter.


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


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


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