Skip to main content
EMS Software, LLC

API Functions - GetBookingHistory

For each booking that has changed or has been created within a specified time period, this API returns all of the changes (including a baseline record so that the calling application can figure out every change).

Request Parameters (inputs)

Name

Description

Type

Required

UserName

EMS User Name

String

Yes

Password

EMS User Password

String

Yes

StartTimeDate

Starting time and date for the changes (GMT)

DateTime

Yes

EndTimeDate

Ending time and date for the changes (GMT)

DateTime

Yes

Rooms

List of Room IDs

Array of integers

Optional

Statuses

List of Status IDs

Array of integers

Optional

EventTypes

List of Event Type IDs

Array of integers

Optional

GroupTypes

List of Group Type IDs

Array of integers

Optional

ViewComboRoomComponents

Option to see bookings in components of combo rooms if bookings are in combo rooms

Boolean

Required

Response Elements

Baseline (latest data for a booking that has changed during the time period)

Name

Description

Type

BookingDate

Booking Date based on reserved time

DateTime

StartBookingDate

Booking Date based on event time

DateTime

RoomDescription

Location Description

String

TimeEventStart

Booking Event Start Time

DateTime

TimeEventEnd

Booking Event End Time

DateTime

GroupName

Group/Customer name

String

EventName

Event Name

String

SetupTypeDescription

Setup Type Description

String

SetupCount

Setup Count

Integer

ReservationID

Reservation ID

Integer

EventCoordinator

Initials of Event Coordinator

String

GroupID

Group/Customer ID

Integer

VIP

‘VIP’ or empty string to signify a VIP event

String

VIPEvent

0 or 1 to signify a VIP event

Boolean

ClosedAllDay

0 or 1 to  signify if the Building is closed

Boolean

OpenTime

Time Building Opens

DateTime

CloseTime

Time Building Closes

DateTime

GroupTypeDescription

Group Type Description

String

EventTypeDescription

Event Type Description

String

Contact

Contact Name

String

AltContact

Alternate Contact Name

String

BookingID

Booking ID

Integer

BuildingID

Building ID

Integer

TimeBookingStart

Booking Reserved Start Time

DateTime

TimeBookingEnd

Booking Reserved End Time

DateTime

GMTStartTime

Booking Reserved GMT Start Time

DateTime

GMTEndTime

Booking Reserved GMT End Time

DateTime

TimeZone

Time Zone abbreviation

String

BuildingCode

Building Code

String

Building

Building Description

String

RoomCode

Room Code

String

Room

Room

String

RoomID

Room ID

Integer

BuildingID

Building ID

Integer

RoomTypeID

Room Type ID

Integer

RoomType

Room Type

String

HVACZone

Room HVAC Zone

String

StatusID

Status ID

Integer

StatusTypeID

Status Type: -14 = Booked Space, -11 = Info Only, -13 = Wait, -12 = Cancel

Integer

EventTypeID

Event Type ID

Integer

GroupTypeID

Group Type ID

Integer

DateAdded

Date/Time Booking Added

DateTime

AddedBy

Booking Added By

String

DateChanged

Date/Time Booking Changed

DateTime

ChangedBy

Booking Changed By

String

CheckedIn

0 or 1 to signify Checked in or not

Boolean

History

(one for each change for the above booking for the time period)

Name

Description

Type

Date

Time and date of change

DateTime

ChangedBy

Booking changed by

String

Field

Field that changed (list of field names to be provided – or just use names from the first column of the baseline?)

String

OldValue

If value has changed then this is the old value

String

NewValue

If value has changed then this is the new value

String

ID

Booking ID

Integer

Sample Code

Private Sub GetBookingHistory()

___Code sample here______________________________

End Sub

Example Response

<BookingsHistory>

<Booking>

       <Data>

<BookingDate>2009-10-04T00:00:00</BookingDate>

<StartBookingDate>2009-10-04T00:00:00</StartBookingDate>

<RoomDescription>DEN Room 101</RoomDescription>

<TimeEventStart>2009-10-04T16:00:00</TimeEventStart>

<TimeEventEnd>2009-10-04T17:00:00</TimeEventEnd>

<GroupName>ABC Company </GroupName>

<EventName>Spring Conference</EventName>

<SetupTypeDescription>U - Shape</SetupTypeDescription>

<SetupCount>50</SetupCount>

<ReservationID>6650</ReservationID>

<EventCoordinator />

<GroupID>499</GroupID>

<VIP xml:space="preserve">

</VIP>

<VIPEvent>false</VIPEvent>

<ClosedAllDay>false</ClosedAllDay>

<OpenTime>1900-01-01T00:00:00</OpenTime>

<CloseTime>1900-01-01T00:00:00</CloseTime>

<GroupTypeDescription>Corporate</GroupTypeDescription>

<EventTypeDescription>Conference</EventTypeDescription>

<Contact>Jim Smith</Contact>

<AltContact />

<BookingID>222008</BookingID>

<TimeBookingStart>2009-10-04T16:00:00</TimeBookingStart>

<TimeBookingEnd>2009-10-04T17:00:00</TimeBookingEnd>

<GMTStartTime>2009-10-04T22:00:00</GMTStartTime>

<GMTEndTime>2009-10-04T23:00:00</GMTEndTime>

<TimeZone>MT</TimeZone>

<BuildingCode>DEN</BuildingCode>

<Building>Denver</Building>

<RoomCode>RM101</RoomCode>

<Room>Room 101</Room>

<RoomID>3271</RoomID>

<BuildingID>1</BuildingID>

<RoomTypeID>1</RoomTypeID>

<RoomType>Classroom</RoomType>

<HVACZone/>

<StatusID>1</StatusID>

<StatusTypeID>-14</StatusTypeID>

<EventTypeID>4</EventTypeID>

<GroupTypeID>3</GroupTypeID>

<DateAdded>2009-10-04T16:00:00</DateAdded>

<AddedBy>User 1</AddedBy>

<DateChanged>2009-10-04T16:00:00</DateChanged>

<ChangedBy>User 1</ChangedBy>

<CheckedIn>false</CheckedIn>

       </Data>

</Booking>

<BookingHistoryItems>

<BookingHistoryItem>

<TimeDate>2009-10-04T16:00:00</TimeDate>

<ChangedBy>User 1</ChangedBy>

<Field>Room</Field>

<OldValueID>3270</OldValueID>

<NewValueID>3271</NewValueID>

<OldValueString>Room 3270</OldValueString>

<NewValueString>Room 3271</NewValueString>

</BookingHistoryItem>

<BookingHistoryItem>

<TimeDate>2009-10-04T16:00:10</TimeDate>

<ChangedBy>User 1</ChangedBy>

<Field>TimeEventStart</Field>

<OldValueString>2009-10-05T16:00:00</OldValueString>

<NewValueString>2009-10-06T16:00:00</NewValueString>

</BookingHistoryItem>

</BookingHistoryItems>

</BookingsHistory>

 

Concept: The BookingHistoryItem reflects the same data (and supporting logic) as the booking history display in the EMS Desktop Client.

Note, however, that for the following screen shot, “Booking Only” should have been selected.