Excerpt
Access All Booking report data for use in 3rd Party Applications.

Tip
The GetAllBookings public API was added in v2022.2 - April 2022

Note
You will need an AuthToken to use this API. Check out our Login API to get a valid AuthToken. POST /Login

...

Using the API

Request Type

POST

Request URL

https://<rx-server>/api/public/report/getallbookings

Headers (required)

Code Block

language	json

{
  "X-Requested-With": "com.resourcexpress.report",
  "Authorization": "<your-authToken>"
}

Note
Check out our Login API to get a valid AuthToken. POST /Login

Body (required)

Code Block

language	json

{
  "StartDate": "2022-01-01 00:00:00",
  "EndDate": "2022-01-31 23:59:00"
}

Available request parameters

Key

Type

Explanation

StartDate

Status

colour	Red
title	required

datetime string

The start of the search time range.
The datetime format should be “YYYY-MM-DD HH:mm:ss”.

EndDate

Status

colour	Red
title	required

datetime string

The end of the search time range.
The datetime format should be “YYYY-MM-DD HH:mm:ss”.

IncludeAssignedSpaces

Boolean

By default auto-created bookings for Assigned Spaces are not included in the GetAllBookings response.

To include these bookings as well you will need set
“IncludeAssignedSpaces": true

ResourceId

Integer

Limit the results to a single resource profile. Enter the ID number for the resource profile.
This ID number can be found from the Resource List page.

Panel

bgColor	#F4F5F7

Set the value to 0 (zero) when not required.

ResourceName

String

Limit the results to a single resource profile. Enter the name of the resource as a string.

Country

String

Limit the results to a chosen Country. Enter the Country name as a string.

City

String

Limit the results to a chosen City. Enter the City name as a string.

Site

String

Limit the results to a chosen Site. Enter the Site name as a string.

Building

String

Limit the results to a chosen Building. Enter the Building name as a string.

Floor

String

Limit the results to a chosen Floor. Enter the Floor name as a string.

Zone

String

Limit the results to a chosen Zone. Enter the Zone name as a string.

BookingSystem

String

Limit the results to a chosen Booking System.
These are the available options.

Local
Exchange (“Office 365” can also be used)
Google
Asure
EMS
NFS

SpaceType

String

Limit the results to a chosen Space type. Enter the Space type name as a string.

TimeZone

String

Limit the results to a chosen time zone.
Enter the time zone information as a string.

To find the available options see the Resource Time Zone dropdown from the All Bookings report page in the admin dashboard.
The string value needs to match how it is shown in the dropdown.

Image Added

Team

Status

colour	Green
title	v2022.3

String

Limit the results to booking created by members of a Team. Enter the name of the Team as a string.

Department

Status

colour	Green
title	v2022.3

String

Limit the results to booking created by members of a Department. Enter the name of the Department as a string.

RowStart

Integer

Limit the results by truncating objects from off the top of the available results.

Panel

bgColor	#F4F5F7

For example, If 100 results are returned (1 - 100), setting "RowStart": 10 will return results 10 - 100.

Info
Can be used in-conjunction with rowEnd to limit the total entries displayed in the response.

Useful when dealing with large datasets which can be slow to respond.

RowEnd

Integer

Limit the results by truncating objects from off the end of the available results.

Panel

bgColor	#F4F5F7

For example, If 100 results are returned (1 - 100), setting "RowEnd": 90 will return results 1 - 90.

Info

Can be used in-conjunction with rowStart to limit the total entries displayed in the response.

For example “RowStart": 10, "RowEnd": 90 will return results 10 - 90.

Useful when dealing with large datasets which can be slow to respond.

Example Response

Code Block

breakoutMode	wide
language	json

{
    "ErrCode": "0",
    "ErrDesc": "",
    "BookingList": [
        {
            "BookingId": 12746,
            "MeetingId": "",
            "ResourceName": "Conference Room 1",
            "SpaceTypeName": "Room",
            "BookingSystemName": "Conference.Room.1",
            "StartTime": "2022-08-25T13:00:00",
            "EndTime": "2022-08-25T15:00:00",
            "StartTimeOriginal": "2022-08-25T13:00:00",
            "EndTimeOriginal": "2022-08-25T15:00:00",
            "Subject": "Mil. Contract Review",
            "IsPrivate": false,
            "IsConfirmed": 1,
            "IsEnded": 2,
            "IsNoShow": false,
            "IsInstant": true,
            "IsAM": null,
            "IsPM": null,
            "IsEOD": null,
            "IsWorkingDay": null,
            "Organizer": "Bruce Wayne",
            "OrganizerEmail": "Bruce Wayne<bruce.wayne@wayneenterprise.org>",
            "IsAllDay": false,
            "BookingAttendees": "",
            "BookingAttendeesEmailList": "",
            "UnplannedBookingAttendees": "",
            "UnplannedBookingAttendeesEmailList": "",
            "Country": "United States",
            "City": "Gotham",
            "Site": null,
            "Building": "Wayne Enterprise",
            "Floor": "37th Floor",
            "Zone": null,
            "CheckedInFrom": "Room Screen",
            "CheckedOutFrom": "Room Screen",
            "ExtendedFrom": "",
            "BookedFrom": "Room Screen",
            "ResourceId": 2,
            "Occupancy": "12",
            "BookingSystem": "Local",
            "CheckedOutBy": "",
            "ExtendedBy": "",
            "AutoCancellation": true,
            "OrganizersDepartments": "",
            "OrganizersTeams": "",
            "CheckedOutByEmail": "",
            "CheckedInByEmail": "bruce.wayne@wayneenterprise.org",
            "ExtendedByEmail": "",
            "CheckedInBy": "Bruce Wayne",
            "Assigned": false,
            "Location": "United States | Gotham | Wayne Enterprise | 7th Floor"
        }
    ]
}

Key	Type	Example	Explanation
BookingId	Integer	12746	The unique ID number for each booking.
MeetingId	Integer	""	The unique ID for the booking. Applicable for 3rd Party connected resources.
ResourceName	String	“Conference Room 1”	The name of the Resource for this booking. Shown in the admin console as “Resource Name - Display”.
SpaceTypeName	String	“Room”	The space type that the resource is assigned. I.E. Room, Desk etc.
BookingSystemName	String	“Conference.Room.1”	The booking system name for the booked resource. Shown in the admin console as “Resource Name”.
StartTime	Datetime	2022-08-25 13:00:00	The actual start time of the booking. (The checked in time of the booking).
EndTime	Datetime	2022-08-25 15:00:00	The actual end time of the booking. (The checked out time of the booking).
StartTimeOriginal	Datetime	2022-08-25 13:00:00	The originally booked start time of the booking.
EndTimeOriginal	Datetime	2022-08-25 15:00:00	The originally booked end time of the booking.
Subject	String	“Meeting Subject”	The subject of the booking.
IsPrivate	Boolean	FALSE	Shows true is the booking is marked as Private.
IsConfirmed	Integer	1	0 = Not checked in. 1 = Automatic check-in. (Instant booking/Check-In not required) 2 = User checked in.
IsEnded	Integer	2	0 = Booking has not ended. 1 = Automatic check-out. (Auto-cancellation/Ended at EndTimeOriginal) 2 = User checked out.
IsNoShow	Boolean	FALSE	TRUE = User did not check into book. Only valid if check-in is required.
IsInstant	Boolean	TRUE	TRUE = User created instant booking using quick options in RX.
IsAM	Boolean	null	The booking is a morning booking. AM based on Working Day values.
IsPM	Boolean	null	The booking is an afternoon booking. PM based on Working Day values.
IsEOD	Boolean	null	The booking is an All Day booking. All day bookings are 24-hour long bookings.
IsWorkingDay	Boolean	null	The booking is a Working Day booking. Working Day based on Working Day values.
Organizer	String	“Bruce Wayne”	The name of the booking organiser.
OrganizerEmail	String	“Bruce Wayne<bruce.wayne@wayneenterprise.org>”	The email address of the booking organiser.
IsAllDay	Boolean	FALSE	The booking is an All Day booking. All day bookings are 24-hour long bookings.
BookingAttendees	String	""	A comma separated list of names for users who attended the booking.
BookingAttendeesEmailList	String	""	A comma separated list of email addresses for users who attended the booking.
UnplannedBookingAttendees	String	""	A comma separated list of names for unplanned users who attended the booking.
UnplannedBookingAttendeesEmailList	String	""	A comma separated list of email addresses for unplanned users who attended the booking.
Country	String	“United States”	The country where the resource is located. (null is displayed if there is no location specified)
City	String	“Gotham”	The city where the resource is located. (null is displayed if there is no location specified)
Site	String	null	The Site where the resource is located. (null is displayed if there is no location specified)
Building	String	“Wayne Enterprise”	The Building where the resource is located. (null is displayed if there is no location specified)
Floor	String	“37th Floor”	The Floor where the resource is located. (null is displayed if there is no location specified)
Zone	String	null	The Zone where the resource is located. (null is displayed if there is no location specified)
CheckedInFrom	String	“Room Screen”	Shows which device type was used to perform this action. Options include: Room Screen Maps QKiosk Mobile Qubi External Booking System Booking Manager OutlookAddIn (for BookedFrom only) By Ring Fence (for CheckedInFrom, ExtendedFrom, CheckedOutFrom)
CheckedOutFrom	String	“Room Screen”
ExtendedFrom	String	""
BookedFrom	String	“Room Screen”
ResourceId	Integer	2	The ID number for the booked Resource. This matches the ID shown in the Admin Console.
Occupancy	String	12	The configured max occupancy for the booked resource.
BookingSystem	String	“Local”	Shows the type of connected booking system. Local Exchange/Office 365 Google Asure NFS EMS OfficeSpace
CheckedOutBy	String	""	The name of the user who performed the Check out action for this booking.
ExtendedBy	String	““	The name of the user who performed the Extend action for this booking.
AutoCancellation	Boolean	TRUE	Shows if the Auto-Cancellation option is enabled/disabled for this Resource.
OrganizersDepartments	String	""	Comma separated list of Departments which the organiser of this booking is a member.
OrganizersTeams	String	""	Comma separated list of Teams which the organiser of this booking is a member.
CheckedOutByEmail	String	""	Email address of the user who performed the Check out action for this booking.
CheckedInByEmail	String	“bruce.wayne@wayneenterprise.org”	Email address of the user who performed the Check in action for this booking.
ExtendedByEmail	String	""	Email address of the user who performed an Extend action for this booking.
CheckedInBy	String	“Bruce Wayne”	The name of the user who performed the Check in action for this booking.
Assigned	Boolean	FALSE	TRUE = This resource is an Assigned Space
Location	String	“United States \| Gotham \| Wayne Enterprise \| 7th Floor”	A single string with the full location of the booked resource.

Versions Compared

Old Version 2

New Version Current

Key

Using the API

Request Type

Request URL

Headers (required)

Body (required)

Available request parameters

Example Response

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

Using the API

Request Type

Request URL

Headers (required)

Body (required)

Available request parameters

Example Response