Skip to content

List peel off monitor camera positions

Request

Get all available peel off 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 peel off monitor camera positions are linked to.

cameraPositionIdstring, (uuid)

the ID of a camera position linked to the peel off monitor camera positions.

peelOffMonitorIdstring, (uuid)

the ID of the peel off monitor the peel off monitor camera position is linking.

statestring

Peel off 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/peel-off-monitor-camera-positions?organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&siteId=497f6eca-6276-4993-bfeb-53cbbbba6f08&cameraPositionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&peelOffMonitorId=497f6eca-6276-4993-bfeb-53cbbbba6f08&state=active&includeInactiveOrgs=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
cameraPositionIdstring, (uuid)required
countDirectionstringrequired
Enum:"direction_1""direction_2""direction_both"
countTypestringrequired
Enum:"base""peel_off"
deletedAtstring or null, (date-time)read-only
idstring or null, (uuid)
peelOffMonitorIdstring, (uuid)required
statestring
Enum:"active""deleted"
]
Response
[
  {
    "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
    "countDirection": "direction_1",
    "countType": "base",
    "deletedAt": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "peelOffMonitorId": "cc189a22-8e7f-4749-b5e7-b00a5382d436",
    "state": "active"
  }
]