Skip to content

Create/Update occupancy monitor

Request

Update an occupancy monitor if it exists, create a new one otherwise.

Security
api_key
Bodyapplication/jsonrequired

An occupancy monitor.

capacityinteger or null, (uint64), >= 1
Example:100
dailyResetTimestring^([01]\d|2[0-3]):[0-5]\d$required
Default:"00:00"
idstring or null, (uuid)
namestringrequired
openingHourobject or null
reportingEndDatestring or null, (date)
reportingStartDatestring or null, (date)
siteIdstring, (uuid)required
statestring
Enum:"active""deleted"
curl -i -X PUT \
  https://coreapi.hoxton.ai/_mock/v1/occupancy-monitors \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "capacity": 100,
    "dailyResetTime": "00:00",
    "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"
  }'

Responses

Created.

Bodyapplication/json
capacityinteger or null, (uint64), >= 1
Example:100
dailyResetTimestring^([01]\d|2[0-3]):[0-5]\d$required
Default:"00:00"
deletedAtstring or null, (date-time)read-only
idstring or null, (uuid)
namestringrequired
openingHourobject or null
reportingEndDatestring or null, (date)
reportingStartDatestring or null, (date)
siteIdstring, (uuid)required
statestring
Enum:"active""deleted"
Response
{
  "capacity": 100,
  "dailyResetTime": "00:00",
  "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"
}