Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

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

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

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)

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

Body (required)

{
  "Startdate": "2022-03-01 00:00:00",
  "Enddate": "2022-03-31 23:59:00"
}

Available request parameters

Key

Type

Explanation

Startdate
REQUIRED

datetime string

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

Enddate
REQUIRED

datetime string

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

ResourceId

Integer

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

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

Country

String

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

City

String

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

Site

String

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

Building

String

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

Floor

String

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

Zone

String

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

BookingSystem

String

To 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 the results to a chosen Space type enter the Space type name as a string.

Example Response

{
    "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
}
  • No labels