Skip to content

Peel Off Monitors

APIs to manage an Organisation's peel off monitors.

Operations

List peel off monitors

Request

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

cameraPositionIdstring, (uuid)

the ID of a camera position linked to the peel off monitors.

statestring

Peel off monitors state.

Enum:"active""deleted"
curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/peel-off-monitors?organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&siteId=497f6eca-6276-4993-bfeb-53cbbbba6f08&cameraPositionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&state=active' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
deletedAtstring or null, (date-time)read-only
idstring or null, (uuid)
namestring
openingHourobject or null
reportingEndDatestring or null, (date)
reportingStartDatestring or null, (date)
siteIdstring, (uuid)required
statestring
Enum:"active""deleted"
]
Response
[
  {
    "deletedAt": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "openingHour": {},
    "reportingEndDate": "2019-08-24",
    "reportingStartDate": "2019-08-24",
    "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
    "state": "active"
  }
]