Direct API

Get the Latest Availability for a Rate Plan for the API.

GetAvailabilityResult GetAvailability(String XmlParameters)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.bookeasy.com/ws/api/2.1.0.0/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetAvailability>
         <ns:XmlParameters><![CDATA[
            <BookEasy>
              <Operator>
                <Credentials>
                  <Username></Username>
                  <Password></Password>
                </Credentials>
                <Rooms>
                  <Room>
                    <RoomID>20636</RoomID>
                  </Room>
                </Rooms>
              </Operator>
              <Options>
                <StartDate>2010-02-10</StartDate>
                <EndDate>2010-04-28</EndDate>
              </Options>
            </BookEasy>]]>
         </ns:XmlParameters>
      </ns:GetRates>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field	Data Type	Description
XmlParameters	String	A String containing XML which contains a Book Easy GetAvailabilityRequest Object

DirectApi.Service.Transformation.model.Request.GetAvailability.GetAvailabilityRequest

A String containing XML which contains a Book Easy GetAvailabilityRequest Object

Field	Data Type	Description
BookEasy	BookEasy	A Place holder Field to match the Bookeasy Interface

BookEasy

A Place holder Field to match the Bookeasy Interface

Field	Data Type	Description
Operator	Operator	The Operator Object for the Request. Operator translates to Hotel or AP in the API.
Options	Options	The Options for the Request, eg, this contains the StartDate, and EndDate for the date range you require.

Operator

The Operator Object for the Request. Operator translates to Hotel or AP in the API.

Field	Data Type	Description
Credentials	Credentials	The Credentials object for the Hotel.
Rooms	List of Room	The List of Rooms that you require to be returned.

Credentials

The Credentials object for the Hotel.

Field	Data Type	Description
Username	String	The Username for the hotel that matches the Username used on the Extranet.
Password	String	The Password for the hotel that matches the Password used on the Extranet.

Room

The List of Rooms that you require to be returned.

Field	Data Type	Description
RoomID	String	Specify Roamfree's RatePlanID for this field.

Options

The Options for the Request, eg, this contains the StartDate, and EndDate for the date range you require.

Field	Data Type	Description
StartDate	DateTime	The start Date for the Availability to be returned, (inclusive).
EndDate	DateTime	The End Date for the Availability to be returned, (inclusive).

GetAvailabilityResult

Field	Data Type	Description
BookEasy	BookEasy	The Bookeasy Field for Interface Matching purposes.

BookEasy

The Bookeasy Field for Interface Matching purposes.

Field	Data Type	Description
Operator	Operator	The Operator Object, really just a place holder to match the Bookeasy Interface.

Operator

The Operator Object, really just a place holder to match the Bookeasy Interface.

Field	Data Type	Description
OperatorID	String	The HotelID or APId. Bookeasy uses the term OperatorID to identify a Hotel.
Rooms	List of Room	The List of Rooms Returned that will contain the Availability requested.

Room

The List of Rooms Returned that will contain the Availability requested.

Field	Data Type	Description
RoomID	String	The RoomID (RatePlanID) for the RatePlan that is being returned
Availabilities	List of Availability	A List of Availability Items that match the Start and End Date(s) that you specified in the Request.

Availability

A List of Availability Items that match the Start and End Date(s) that you specified in the Request.

Field	Data Type	Description
StartDate	DateTime	The Start date of the Availability that was returned. Ie, the list returned only returns objects for rates where they have changed, and uses a date range to group them all together.
EndDate	DateTime	The End date of the Availability that was returned
NumberAvailabile	Int32	The Qty for this Room that can be sold.

Get the Latest Rates for a Rate Plan

GetRatesResult GetRates(String XmlParameters)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.bookeasy.com/ws/api/2.1.0.0/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:GetAvailability>
         <ns:XmlParameters><![CDATA[
            <BookEasy>
              <Operator>
                <Credentials>
                  <Username></Username>
                  <Password></Password>
                </Credentials>
                <Rooms>
                  <Room>
                    <RoomID>20636</RoomID>
                  </Room>
                </Rooms>
              </Operator>
              <Options>
                <StartDate>2010-02-10</StartDate>
                <EndDate>2010-04-28</EndDate>
              </Options>
            </BookEasy>]]>
        </ns:XmlParameters>
      </ns:GetRates>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field	Data Type	Description
XmlParameters	String	A String containing XML which contains a Book Easy GetRatesRequest Object

DirectApi.Service.Transformation.model.Request.GetRates.GetRatesRequest

A String containing XML which contains a Book Easy GetRatesRequest Object

Field	Data Type	Description
BookEasy	BookEasy	A Placeholder for the Request

BookEasy

A Placeholder for the Request

Field	Data Type	Description
Operator	Operator	Object to Hold the Operators details. This translates into a Hotel. Bookeasy calls hotels operators.
Options	Options	Object to Hold to Options for the Request

Operator

Object to Hold the Operators details. This translates into a Hotel. Bookeasy calls hotels operators.

Field	Data Type	Description
Credentials	Credentials	The hotels Object which contains the necessary fields to authenticate.
Rooms	List of Room	A List of Room Details to filter the Rates Returned

Credentials

The hotels Object which contains the necessary fields to authenticate.

Field	Data Type	Description
Username	String	The Hotels Username. This is the same as the Username used in the Extranet
Password	String	The Hotels Password. This is the same as the Password used in the Extranet

Room

A List of Room Details to filter the Rates Returned

Field	Data Type	Description
RoomID	String	The Hotels RoomID that you want to filter. In the api, this translates into the Hotels Rate Plan ID. Bookeasy uses a RoomID to describe this, but the api requires a RatePlanID. So, when doing your mappings, mapp to Our RatePlanID and send that value into this field.

Options

Object to Hold to Options for the Request

Field	Data Type	Description
StartDate	DateTime	Include rates Starting from and and including the specified Start Date
EndDate	DateTime	Include rates up until and including the specified End Date

GetRatesResult

Field	Data Type	Description
BookEasy	BookEasy

BookEasy

Field	Data Type	Description
Operator	Operator	The Operator Object which contains the information about the Hotel

Operator

The Operator Object which contains the information about the Hotel

Field	Data Type	Description
OperatorID	String	The APId or HotelID for Direct API.
Rooms	List of Room	A List of Room objects returned from the Request.

Room

A List of Room objects returned from the Request.

Field	Data Type	Description
RoomID	String	The Identifer for the Room. in the API, this equates to our RatePlanID.
IsLastMinuteRateAvailable	Boolean	This field is not used in the API.
DailyRates	DailyRates	The Daily Rates Object. Direct API uses Daily rates only, other types in the market place are seasonal rates. Daily rates map more closely to last minute website rate structures, like wotif for eg.

DailyRates

The Daily Rates Object. Direct API uses Daily rates only, other types in the market place are seasonal rates. Daily rates map more closely to last minute website rate structures, like wotif for eg.

Field	Data Type	Description
NumberOfGuestsIncluded	Int32	The number of guests that are included in the price(s) given. This is otherwise known as Standard Pax.
RackRate	Decimal	Direct API does not use this field that often. Somehotels use it, but its best if you don't rely on it being populated.
CostPerExtraAdult	Decimal	For every adult that is over and above the NumberOfGuestsIncluded, Add this value to the price that you quote. You should add together the adults first, and then the children. Adults take precendence.
CostPerExtraChild	Decimal	For every child that is over and above the NumberOfGuestsIncluded, Add this value to the price that you quote.
Rates	List of Rate	The List of Rates returned which are grouped together and have one item per similar rate / availability etc...

Rate

The List of Rates returned which are grouped together and have one item per similar rate / availability etc...

Field	Data Type	Description
StartDate	DateTime	The Start date of the Rate that was returned. Ie, the list returned only returns objects for rates where they have changed, and uses a date range to group them all together.
EndDate	DateTime	The End date of the Rate that was returned
NumberOfNights	Int32	The Minimum number of nights that the guest must book before they can pay for this rate.
MaximumNights	Int32	The Maximum number of nights that can be booked.
Amount	Decimal	The Actual Price for this Rate Object.
IsLastMinute	Boolean	This is not not Applicable for Direct API rates, but the field is left here to keep the interface the same as Bookeasy's interface
IsStopSell	Boolean	If this field is true, then the date(s) have been marked as 'Do not sell'

Set the Availability for a Rate Plan in the API

SetAvailabilityResult SetAvailability(String XmlParameters)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.bookeasy.com/ws/api/2.1.0.0/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:SetAvailability>
         <ns:XmlParameters><![CDATA[
            <BookEasy>
              <Operator>
                <Credentials>
                  <Username></Username>
                  <Password></Password>
                </Credentials>
                <Rooms>
                  <Room>
                    <RoomID>20636</RoomID>
                    <Availabilities>
                      <Availability>
                        <StartDate>2010-02-17</StartDate>
                        <EndDate>2010-02-18</EndDate>
                        <NumberAvailable>5</NumberAvailable>
                      </Availability>
                    </Availabilities>
                  </Room>
                </Rooms>
              </Operator>
            </BookEasy>
            ]]></ns:XmlParameters>
      </ns:SetAvailability>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field	Data Type	Description
XmlParameters	String	A String containing XML which contains a Book Easy SetAvailabilityRequest Object

DirectApi.Service.Transformation.model.Request.SetAvailability.SetAvailabilityRequest

A String containing XML which contains a Book Easy SetAvailabilityRequest Object

Field	Data Type	Description
BookEasy	BookEasy	Placeholder Field to contain the Request in order to maintain compatibility with the Bookeasy Interface

BookEasy

Placeholder Field to contain the Request in order to maintain compatibility with the Bookeasy Interface

Field	Data Type	Description
Operator	Operator	Placeholder object to contain the Operator Portion of the Request in order to maintain compatibility with the Bookeasy Interface

Operator

Placeholder object to contain the Operator Portion of the Request in order to maintain compatibility with the Bookeasy Interface

Field	Data Type	Description
Credentials	Credentials	Credentials object which contains the necessary fields required for Authentication to Direct API
Rooms	List of Room	Contains a List of Room Objects which are used to filter which rooms will be affected by the Request

Credentials

Credentials object which contains the necessary fields required for Authentication to Direct API

Field	Data Type	Description
Username	String	Direct API Username for the Hotel to have its availability changed
Password	String	Direct API Password for the Hotel to have its availability changed

Room

Contains a List of Room Objects which are used to filter which rooms will be affected by the Request

Field	Data Type	Description
RoomID	String	Direct API's RatePlanID to be looked up for the change
Availabilities	List of Availability	This Object contains the List of Availaibility Records that will specify what changes will be made for this Room Object.

Availability

This Object contains the List of Availaibility Records that will specify what changes will be made for this Room Object.

Field	Data Type	Description
StartDate	DateTime	The StartDate for the update (inclusive)
EndDate	DateTime	The EndDate for the update (inclusive)
NumberAvailable	Int32	The Number of Rooms Availability that should be set for the DateRange specified.

SetAvailabilityResult

Field	Data Type	Description
BookEasy	BookEasy	Placeholder field for compatibility with Bookeasy's interface.

BookEasy

Placeholder field for compatibility with Bookeasy's interface.

Field	Data Type	Description
Success	Boolean	If your update was successful, this field will contain True.
Exception	SetAvailabilityException	If your update was successful, this field will not be present, otherwise it will be populated.

SetAvailabilityException

If your update was successful, this field will not be present, otherwise it will be populated.

Field	Data Type	Description
ErrorGUID	Guid	A Unique id to identify the error.
WellKnownExceptionType	String	This Field can be coded against, as it will not change over time.
Message	String	Used to describe the detail of the exception. We would not recommend hard coding filters against this field, as it may change over time as we work out better ways to describe an error.

Set the Rates for a Rate Plan in the api

SetRatesResult SetRates(String XmlParameters)

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.bookeasy.com/ws/api/2.1.0.0/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:SetRates>
         <ns:XmlParameters><![CDATA[
            <BookEasy>
              <Operator>
              <Credentials>
                  <Username></Username>
                  <Password></Password>
              </Credentials>
              <Rooms>
                <Room>
                  <RoomID>20636</RoomID>
                  <IsLastMinuteRateAvailable>false</IsLastMinuteRateAvailable>
                  <DailyRates>
                    <NumberOfGuestsIncluded>2</NumberOfGuestsIncluded>
                    <RackRate>150.00</RackRate>
                    <CostPerExtraAdult>50.00</CostPerExtraAdult>
                    <CostPerExtraChild>20.00</CostPerExtraChild>
                    <Rates>
                      <Rate>
                        <StartDate>2010-02-17</StartDate>
                        <EndDate>2010-02-18</EndDate>
                        <NumberOfNights>1</NumberOfNights>
                        <Amount>120.00</Amount>
                        <IsLastMinute>false</IsLastMinute>
                        <IsStopSell>false</IsStopSell>
                      </Rate>
                    </Rates>
                  </DailyRates>
                </Room>
              </Rooms>
              </Operator>
            </BookEasy>]]>
         </ns:XmlParameters>
      </ns:SetRates>
   </soapenv:Body>
</soapenv:Envelope>

Method Parameters

Field	Data Type	Description
XmlParameters	String	A String containing XML which contains a Book Easy SetRatesRequest Object

DirectApi.Service.Transformation.model.Request.SetRates.SetRatesRequest

A String containing XML which contains a Book Easy SetRatesRequest Object

Field	Data Type	Description
BookEasy	BookEasy	Placeholder Field to contain the Request in order to maintain compatibility with the Bookeasy Interface

BookEasy

Placeholder Field to contain the Request in order to maintain compatibility with the Bookeasy Interface

Field	Data Type	Description
Operator	Operator	Placeholder object to contain the Operator Portion of the Request in order to maintain compatibility with the Bookeasy Interface

Operator

Placeholder object to contain the Operator Portion of the Request in order to maintain compatibility with the Bookeasy Interface

Field	Data Type	Description
Credentials	Credentials	Credentials object which contains the necessary fields required for Authentication to Direct API
Rooms	List of Room	Contains a List of Room Objects which are used to filter which rooms will be affected by the Request

Credentials

Credentials object which contains the necessary fields required for Authentication to Direct API

Field	Data Type	Description
Username	String	Direct API Username for the Hotel to have its rates changed
Password	String	Direct API Password for the Hotel to have its rates changed

Room

Contains a List of Room Objects which are used to filter which rooms will be affected by the Request

Field	Data Type	Description
RoomID	String	Direct API's RatePlanID to be looked up for the change
IsLastMinuteRateAvailable	Boolean	Not applicable for Direct API, but kept in the message to maintain compatibility with Bookeasy's interface.
DailyRates	DailyRates	This Object contains the Actual changes that will be made for this Room Object.

DailyRates

This Object contains the Actual changes that will be made for this Room Object.

Field	Data Type	Description
NumberOfGuestsIncluded	Int32	The Number of guests that are included in the price being sent. This is also known as Standard PAX
CostPerExtraAdult	Decimal	For every extra Adult that is over and above the NumberOfGuestsIncluded, this value should be added to the price.
CostPerExtraChild	Decimal	For ever Child that is over and above the NumberOfGuestsIncluded, this value should be added to the price.
Rates	List of Rate	A List of Rate objects to be applied to the update.

Rate

A List of Rate objects to be applied to the update.

Field	Data Type	Description
StartDate	DateTime	The StartDate for the update (inclusive)
EndDate	DateTime	The EndDate for the update (inclusive)
NumberOfNights	Int32	Minimum number of nights that the guest must book before they can book a room for this rate.
MaximumNights	Int32	Maximum number of nights that can be booked.
Amount	Decimal	The Actual Rate to be applied
IsLastMinute	Boolean	Not required for Direct API
IsStopSell	Boolean	If set to True, this means 'Do not sell this room'. Ie, make it Sold or Unavailable.

SetRatesResult

Field	Data Type	Description
BookEasy	BookEasy	Placeholder field for compatibility with Bookeasy's interface.

BookEasy

Placeholder field for compatibility with Bookeasy's interface.

Field	Data Type	Description
Success	Boolean	If your update was successful, this field will contain True.
Exception	SetRatesException	If your update was successful, this field will not be present, otherwise it will be populated.

SetRatesException

If your update was successful, this field will not be present, otherwise it will be populated.

Field	Data Type	Description
ErrorGUID	Guid	A Unique id to identify the error.
WellKnownExceptionType	String	This Field can be coded against, as it will not change over time.
Message	String	Used to describe the detail of the exception. We would not recommend hard coding filters against this field, as it may change over time as we work out better ways to describe an error.

TransformationService

GetAvailability

Example

Method Parameters

DirectApi.Service.Transformation.model.Request.GetAvailability.GetAvailabilityRequest

BookEasy

Operator

Credentials

Room

Options

GetAvailabilityResult

BookEasy

Operator

Room

Availability

GetRates

Example

Method Parameters

DirectApi.Service.Transformation.model.Request.GetRates.GetRatesRequest

BookEasy

Operator

Credentials

Room

Options

GetRatesResult

BookEasy

Operator

Room

DailyRates

Rate

SetAvailability

Example

Method Parameters

DirectApi.Service.Transformation.model.Request.SetAvailability.SetAvailabilityRequest

BookEasy

Operator

Credentials

Room

Availability

SetAvailabilityResult

BookEasy

SetAvailabilityException

SetRates

Example

Method Parameters

DirectApi.Service.Transformation.model.Request.SetRates.SetRatesRequest

BookEasy

Operator

Credentials

Room

DailyRates

Rate

SetRatesResult

BookEasy

SetRatesException