Versions Compared

Old Version 6

changes.mady.by.user Elliot Dooleysmith

Saved on

compared with

New Version 7

changes.mady.by.user Elliot Dooleysmith

Saved on

Key

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

...

Note

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

The /Report/GetAllBookings API will return the raw data that can be found using the https://resourcexpress.atlassian.net/wiki/pages/resumedraft.action?draftId=68780101 Report.

...

Using the API

Request Type

POST

Request URL

https://<rx-server>/api/Public/Report/GetAllBookings

Headers (required)

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

Body (required)

Code Block
languagejson
{
  "Startdate": "2022-03-01 00:00:00",
  "Enddate": "2022-03-31 23:59:00",
  "ResourceId": 0,
  "CountryId": 0,
  "CityId": 0,
  "ZoneId": 0
}

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

Status
colourRed
titlerequired

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.

Panel
bgColor#F4F5F7

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

CountryId

Status
colourRed
titlerequired

Integer

To limit the results to chosen Country enter the Country ID number.

To find this value, use the All Booking Report from the Admin Dashboard.
Select the desired location, the ID value will be available from the URL.

Panel
bgColor#F4F5F7

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

CityId

Status
colourRed
titlerequired

Integer

To limit the results to chosen City enter the City ID number.

To find this value, use the All Booking Report from the Admin Dashboard.
Select the desired location, the ID value will be available from the URL.

Panel
bgColor#F4F5F7

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

ZoneId

Status
colourRed
titlerequired

Integer

I’m not sure what this is for honestly.

To find this value, use the All Booking Report from the Admin Dashboard.
Select the desired location, the ID value will be available from the URL.

Panel
bgColor#F4F5F7

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

Site

String

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

Building

String

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

Floor

String

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

Zone

String

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

bookingSystem

Integer

To find this value, use the All Booking Report from the Admin Dashboard.
Select the desired location, the ID value will be available from the URL.

workspaceTypeId

Integer

To find this value, use the All Booking Report from the Admin Dashboard.
Select the desired location, the ID value will be available from the URL.

Example Response

Code Block
languagejson
{
    "ErrCode": "0",
    "ErrDesc": "",
    "BookingList": [
        {
            "Id": 0,
            "BookingId": <integer>,
            "ParentBookingId": null,
            "MeetingId": null,
            "StartTimePlanned": "0001-01-01T00:00:00",
            "EndTimePlanned": "0001-01-01T00:00:00",
            "ResourceName": "Conference Room",
            "BookingSystemName": "conference.room",
            "Subject": "Team Meeting",
            "Alldaybooking": null,
            "StartTime": "2022-01-06T10:00:00",
            "EndTime": "2022-01-06T11:00:00",
            "BookingStartTime": null,
            "StartTimeString": "06-01-2022 10: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:55:58",
            "EndTimeOriginal": "2022-01-06T11:00:00",
            "StartTimeOriginalString": "06-01-2022 09:55:58",
            "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": "Elliot Smith",
            "OrganizerEmail": "Elliot Smith<elliot.smith@qedas.com>",
            "OrganiserId": 0,
            "Country": "United Kingdom",
            "City": "Bristol",
            "Site": null,
            "Building": "Secret Headquarters",
            "Floor": "First Floor",
            "Zone": "Sales",
            "Location": "United Kingdom | Bristol | Secret Headquarters | First Floor | Sales",
            "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,
            "BookingSystemName": "Local",
            "CheckedOutBy": "",
            "ExtendedBy": "",
            "AutoCancellation": true
        }
    ],
    "CancelledBookingList": null
}

Postman Examples