Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Key

Type

Explanation

Startdate

Status
colourRed
titlerequired

datetime string

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

Enddate

Status
colourRed
titlerequired

datetime string

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

ResourceId

Integer

To limit Limit the results to a single resource profile enter . 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.

Country

String

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

City

String

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

Site

String

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

Building

String

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

Floor

String

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

Zone

String

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

BookingSystem

String

To limit 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

To limit Limit the results to a chosen Space type enter . 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

Example Response

Code Block
languagejson
{
    "ErrCode": "0",
    "ErrDesc": "",
    "BookingList": [
        {
            "BookingId": 000001,
            "ParentBookingId": null,
            "MeetingId": null,
            "StartTimePlanned": "0001-01-01T00:00:00",
            "EndTimePlanned": "0001-01-01T00:00:00",
            "ResourceName": "Conference Room",
            "BookingSystemName": "conference.room",
            "Subject": "Top Secret Military Contract",
            "Alldaybooking": null,
            "StartTime": "2022-01-06T09:00:00",
            "EndTime": "2022-01-06T11:00:00",
            "BookingStartTime": null,
            "StartTimeString": "06-01-2022 09:00:00",
            "EndTimeString": "06-01-2022 11:00:00",
            "Alert": "",
            "Description": null,
            "ResourceId": 1,
            "Members": null,
            "OtherMembers": null,
            "DurationId": null,
            "DurationMinutes": 0,
            "ShowasId": null,
            "ReminderId": null,
            "RepeatId": null,
            "Attendees": null,
            "BookingAttendees": "",
            "BookingAttendeesEmailList": "",
            "UnplannedBookingAttendees": "",
            "UnplannedBookingAttendeesEmailList": "",
            "Resourcelist": null,
            "Equipment": null,
            "Address": null,
            "Occupancy": "10",
            "Userslist": null,
            "EditOcurrence": null,
            "EditSeries": null,
            "Recurringbooking": null,
            "Obsolete": null,
            "CheckedInBy": null,
            "StartTimeOriginal": "2022-01-06T09:00:00",
            "EndTimeOriginal": "2022-01-06T11:00:00",
            "StartTimeOriginalString": "06-01-2022 09:00:00",
            "EndTimeOriginalString": "06-01-2022 11:00:00",
            "IsConfirmed": 2,
            "IsEnded": 0,
            "IsNoShow": false,
            "IsInstant": false,
            "MaxOccupancy": null,
            "ActualOccupancy": null,
            "PlannedOccupancy": null,
            "PercentageOfActualOccupancy": null,
            "PercentageOfPlannedOccupancy": null,
            "Organizer": "Bruce Wayne",
            "OrganizerEmail": "Bruce Wayne<bruce.wayne@wayneenterprise.com>",
            "OrganiserId": 0,
            "Country": "United States",
            "City": "Gotham",
            "Site": null,
            "Building": "Wayne Enterprise",
            "Floor": "40th Floor",
            "Zone": "Management",
            "Location": "United States | Gotham | Wayne Enterprise | 40th Floor | Management",
            "TimeZoneId": null,
            "EventStatus": null,
            "WorkSpaceTypeId": 0,
            "ErrorClearedTime": null,
            "TotalDownTime": null,
            "Attendeeslist": null,
            "IsPrivate": null,
            "IsAllDay": false,
            "IsAM": null,
            "IsPM": null,
            "IsEOD": null,
            "IsWorkingDay": null,
            "IsStarted": false,
            "IsReadOnly": false,
            "HasPermission": false,
            "IsRecurringEnabled": false,
            "MultiDay": 0,
            "BookingEndTime": null,
            "CheckedInFrom": "Mobile",
            "CheckedOutFrom": "",
            "ExtendedFrom": "",
            "BookedFrom": "Room Screen",
            "StartTimeWithSetup": null,
            "EndTimeWithSetup": null,
            "StartTimeWithSetupString": null,
            "EndTimeWithSetupString": null,
            "StartTimePlannedString": null,
            "EndTimePlannedString": null,
            "SetupMinutes": 0,
            "CleardownMinutes": 0,
            "HasConflict": false,
            "BookingSystem": "Local",
            "CheckedOutBy": "",
            "ExtendedBy": "",
            "AutoCancellation": true
        }
    ],
    "CancelledBookingList": null
}