Skip to content

Create live occupancy report

Request

Create a report of live occupancies for a list of occupancy monitors.

Security
api_key
Bodyapplication/json

request live occupancies for a list of occupancy monitors.

occupancyMonitorIdsArray of strings or null, (uuid)

List of occupancy monitor ids in the report.

organisationIdsArray of strings or null, (uuid)

List of organisation ids in the report.

siteIdsArray of strings or null, (uuid)

List of site ids in the report.

curl -i -X POST \
  https://coreapi.hoxton.ai/_mock/v1/live-occupancy \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "occupancyMonitorIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "organisationIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "siteIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

OK.

Bodyapplication/json
Array [
occupancyintegerread-only
occupancyMonitorIdstring, (uuid)read-only
timestring, (date-time)read-only
]
Response
[
  {
    "occupancy": 0,
    "occupancyMonitorId": "51bf4310-39f9-49d3-99c1-c643ff9c2f04",
    "time": "2019-08-24T14:15:22Z"
  }
]