Skip to content

List people count monitor camera positions

Request

Get all available occupancy monitor camera positions subject to filters.

Security
api_key
Query
organisationIdstring, (uuid)

the ID of the associated organisation.

siteIdstring, (uuid)

the ID of the site the people count monitor camera positions are linked to.

cameraPositionIdstring, (uuid)

the ID of a camera position linked to the people count monitor camera positions.

peopleCountMonitorIdstring, (uuid)

the ID of the people count monitor the people count monitor camera position is linking.

statestring

People count monitor camera positions state filter.

Enum:"active""deleted"
includeInactiveOrgsboolean

When true, include resources of inactive (disabled or churned) organisations. Only honoured for callers with the corresponding :all permission.

Default:false
curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/people-count-monitor-camera-positions?organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&siteId=497f6eca-6276-4993-bfeb-53cbbbba6f08&cameraPositionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&peopleCountMonitorId=497f6eca-6276-4993-bfeb-53cbbbba6f08&state=active&includeInactiveOrgs=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
cameraPositionIdstring, (uuid)required
deletedAtstring or null, (date-time)read-only
direction1stringrequired
Enum:"direction_1""direction_2"
idstring or null, (uuid)
peopleCountMonitorIdstring, (uuid)required
statestring
Enum:"active""deleted"
]
Response
[ { "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" } ]