Applies to Version 1.10 or later
Bookings data is summarised within the IBSS Platform to give the user and services managers clear information on the way space bookings are made within the building.
Method
The IBSS API provides access to the collated environmental zone data as daily summaries, using:
1 GET /v1/{nodeid}/BookingsDailySummary/{startDate}/{endDate}/
2 BookingsSummaryDataryParameters:
- nodeid - the identifier of the floor or building for which the bookings data should be retrieved
- startDate - the first date (inclusive) for which the bookings data should be retrieved
- endDate - the last date (inclusive) for which the bookings data should be retrieved
- spaceId - the identifier of the specific space for which the bookings data should be retrieved
- recursive - whether to return child records or not
Data Model
The returned data set contains the following columns of data (unless overridden by the $select parameter)
Field Name |
Description |
|---|---|
Summary_Date |
The date for which the summary is created, this date is always in local time |
NodeLevelName |
The level of the space in the hierarchy which will either be
- Building or
- Floor
|
Bookings_Created_Count |
The number of bookings created for that date. |
Bookings_Cancelled_Count |
The number of bookings cancelled for that date. |
Bookings_Auto_Cancelled_Count |
The number of bookings auto cancelled by the system for that date. |
Bookings_Completed_Count |
The number of bookings completed for that date. |
Bookings_No_Show_Count |
The number of bookings that were not checked in (and no auto cancel time was set) for that date. |
Bookings_Early_Checkin_Count |
The number of bookings checked in early for that date. |
Bookings_Late_Checkin_Count |
The number of bookings checked in late for that date. |
Bookings_Avg_Early_Checkin_Duration |
The average duration in seconds that a booking is checked in early. |
Bookings_Avg_Late_Checkin_Duration |
The average duration in seconds that a booking is checked in late. |
Bookings_Avg_Actual_Duration |
The average actual duration in seconds for a booking for that date. |
Bookings_Avg_Scheduled_Duration |
The average scheduled duration in seconds for a booking for that date. |
Bookings_Avg_LeadTime_Duration |
The average duration in seconds a booking is created before it's due for that date. |