NotificationService
Notification Service SOAP WSDL
BE_BookingNotification
BE_BookingNotification supports the functionality of updating a system with reservation data.
BookingNotification_Response BE_BookingNotification(BE_BookingNotification_Request request)
Example
<BookEasy>
<Control>
<ControlID>101</ControlID>
<Itinerary>
<ContactInformation>
<AcceptCancellationPolicy>true</AcceptCancellationPolicy>
<Address>1/26 Minchin Way</Address>
<Comments></Comments>
<Country>Australia</Country>
<Email>michael@queensberryit.com</Email>
<Facsimile>555555555</Facsimile>
<FirstName>Michael</FirstName>
<Mobile></Mobile>
<PostCode>4211</PostCode>
<ReceiveENewsletter>false</ReceiveENewsletter>
<Referrer>Website</Referrer>
<State>QLD</State>
<Surname>Savage</Surname>
<Telephone>5467891320</Telephone>
<Town>Margaret River</Town>
</ContactInformation>
<IsCancelled>false</IsCancelled>
<IsConfirmed>true</IsConfirmed>
<IsPaid>true</IsPaid>
<ItineraryID>7894561</ItineraryID>
<Operators>
<BookEasyControlItineraryOperator>
<OperatorID>33294</OperatorID>
<Rooms>
<BookEasyControlItineraryOperatorRoom>
<BookingID>5656592</BookingID>
<Cost>365</Cost>
<IsCancelled>true</IsCancelled>
<IsConfirmed>false</IsConfirmed>
<ReservationRequest>
<Adults>2</Adults>
<Children>0</Children>
<InDate>2010-08-24T12:00:00</InDate>
<Infants>0</Infants>
<Period>2</Period>
</ReservationRequest>
<RoomID>19617</RoomID>
</BookEasyControlItineraryOperatorRoom>
</Rooms>
</BookEasyControlItineraryOperator>
</Operators>
<TotalCost>365</TotalCost>
<TotalPaid>365</TotalPaid>
</Itinerary>
</Control>
</BookEasy>
<RequestType>BookEasy</RequestType>
<Control>
<ControlID>101</ControlID>
<Itinerary>
<ContactInformation>
<AcceptCancellationPolicy>true</AcceptCancellationPolicy>
<Address>1/26 Minchin Way</Address>
<Comments></Comments>
<Country>Australia</Country>
<Email>michael@queensberryit.com</Email>
<Facsimile>555555555</Facsimile>
<FirstName>Michael</FirstName>
<Mobile></Mobile>
<PostCode>4211</PostCode>
<ReceiveENewsletter>false</ReceiveENewsletter>
<Referrer>Website</Referrer>
<State>QLD</State>
<Surname>Savage</Surname>
<Telephone>5467891320</Telephone>
<Town>Margaret River</Town>
</ContactInformation>
<IsCancelled>false</IsCancelled>
<IsConfirmed>true</IsConfirmed>
<IsPaid>true</IsPaid>
<ItineraryID>7894561</ItineraryID>
<Operators>
<BookEasyControlItineraryOperator>
<OperatorID>33294</OperatorID>
<Rooms>
<BookEasyControlItineraryOperatorRoom>
<BookingID>5656592</BookingID>
<Cost>365</Cost>
<IsCancelled>true</IsCancelled>
<IsConfirmed>false</IsConfirmed>
<ReservationRequest>
<Adults>2</Adults>
<Children>0</Children>
<InDate>2010-08-24T12:00:00</InDate>
<Infants>0</Infants>
<Period>2</Period>
</ReservationRequest>
<RoomID>19617</RoomID>
</BookEasyControlItineraryOperatorRoom>
</Rooms>
</BookEasyControlItineraryOperator>
</Operators>
<TotalCost>365</TotalCost>
<TotalPaid>365</TotalPaid>
</Itinerary>
</Control>
</BookEasy>
<RequestType>BookEasy</RequestType>
Method Parameters
| Field | Data Type | Description |
| request | BE_BookingNotification_Request |
BE_BookingNotification_Request
| Field | Data Type | Description |
| RequestType | BookingRequestType | Booking notification type. |
| BookEasy | BookEasy | The BookEasy booking notification to be processed. |
| ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
| ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
| Username | String | Hotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel |
| Password | String | Hotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel |
| HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
| HotelAuthenticationKey | String | Authentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password. |
BookingRequestType
Booking notification type.
| Field | Data Type | Description |
| API | ||
| BookEasy | ||
| OTA |
BookEasy
The BookEasy booking notification to be processed.
| Field | Data Type | Description |
| Control | BookEasyControl |
BookEasyControl
| Field | Data Type | Description |
| ControlID | Int32 | |
| Itinerary | BookEasyControlItinerary |
BookEasyControlItinerary
| Field | Data Type | Description |
| ItineraryID | Int32 | |
| IsConfirmed | Boolean | |
| IsCancelled | Boolean | |
| IsPaid | Boolean | |
| TotalCost | Decimal | |
| TotalPaid | Decimal | |
| TotalRemaining | Decimal | |
| ContactInformation | ContactInformation | |
| Operators | Operator[] | |
| Payments | Payment[] |
ContactInformation
| Field | Data Type | Description |
| Salutation | String | |
| FirstName | String | |
| Surname | String | |
| Address | String | |
| Town | String | |
| State | String | |
| Country | String | |
| PostCode | String | |
| Telephone | String | |
| Facsimile | String | |
| Mobile | String | |
| String | ||
| Referrer | String | |
| Comments | String | |
| AcceptCancellationPolicy | Boolean | |
| ReceiveENewsletter | Boolean |
Operator[]
| Field | Data Type | Description |
Payment[]
| Field | Data Type | Description |
TimeSpan
| Field | Data Type | Description |
BookingNotification_Response
| Field | Data Type | Description |
| Response | List of BookingResponse | List of booking process responses |
| Timestamp | DateTime | |
| MessageId | String | |
| HotelAuthenticationKey | String |
BookingResponse
List of booking process responses
| Field | Data Type | Description |
| Success | Boolean | Indicates if the operation was successful or not. |
| ErrorCode | String | If there was an error, the error code is returned here. |
| Message | String | Success and Error Information is returned here. |
| BookingPrice | Decimal | The booking price that the bookng was saved in will be supplied here. |
BookingNotification
BookingNotification supports the functionality of updating a system with reservation data.
BookingNotification_Response BookingNotification(BookingNotification_Request request)
Example
<BookingNotification>
<ChannelManagerUsername>username</ChannelManagerUsername>
<ChannelManagerPassword>password</ChannelManagerPassword>
<Username></Username>
<Password></Password>
<HotelId>3</HotelId>
<HotelAuthenticationKey>4bacc65809bef488b5202b2612e9c76a</HotelAuthenticationKey>
<Booking>
<BookingDetails>
<Adults>2</Adults>
<CheckIn>2010-11-23T00:00:00</CheckIn>
<CheckOut>2010-11-26T00:00:00</CheckOut>
<Children>0</Children>
<Infants>0</Infants>
<OwingAmount>375</OwingAmount>
<PropertyId>62</PropertyId>
<RoomCode>240</RoomCode>
<SpecialRequests>My comments</SpecialRequests>
</BookingDetails>
<BookingRef>1500091</BookingRef>
<BookingType>Booking</BookingType>
<CreditCardDetails>
<ExpiryDate>2011-01-01T00:00:00</ExpiryDate>
<HolderFullName>test card</HolderFullName>
<Number>42424242424242</Number>
<VerificationNumber>100</VerificationNumber>
</CreditCardDetails>
<MainGuest>
<AddressFirstLine>Test Address Line</AddressFirstLine>
<AddressSecondLine>Test</AddressSecondLine>
<City>Test</City>
<CountryIso>AU</CountryIso>
<Email>test@test.com</Email>
<FirstName>testbin</FirstName>
<LastName>mirkbin</LastName>
<Mobile>989891</Mobile>
<Phone>1982</Phone>
<Postcode>29392</Postcode>
<State>QLD</State>
</MainGuest>
</Booking>
<RequestType>API</RequestType>
</BookingNotification>
<ChannelManagerUsername>username</ChannelManagerUsername>
<ChannelManagerPassword>password</ChannelManagerPassword>
<Username></Username>
<Password></Password>
<HotelId>3</HotelId>
<HotelAuthenticationKey>4bacc65809bef488b5202b2612e9c76a</HotelAuthenticationKey>
<Booking>
<BookingDetails>
<Adults>2</Adults>
<CheckIn>2010-11-23T00:00:00</CheckIn>
<CheckOut>2010-11-26T00:00:00</CheckOut>
<Children>0</Children>
<Infants>0</Infants>
<OwingAmount>375</OwingAmount>
<PropertyId>62</PropertyId>
<RoomCode>240</RoomCode>
<SpecialRequests>My comments</SpecialRequests>
</BookingDetails>
<BookingRef>1500091</BookingRef>
<BookingType>Booking</BookingType>
<CreditCardDetails>
<ExpiryDate>2011-01-01T00:00:00</ExpiryDate>
<HolderFullName>test card</HolderFullName>
<Number>42424242424242</Number>
<VerificationNumber>100</VerificationNumber>
</CreditCardDetails>
<MainGuest>
<AddressFirstLine>Test Address Line</AddressFirstLine>
<AddressSecondLine>Test</AddressSecondLine>
<City>Test</City>
<CountryIso>AU</CountryIso>
<Email>test@test.com</Email>
<FirstName>testbin</FirstName>
<LastName>mirkbin</LastName>
<Mobile>989891</Mobile>
<Phone>1982</Phone>
<Postcode>29392</Postcode>
<State>QLD</State>
</MainGuest>
</Booking>
<RequestType>API</RequestType>
</BookingNotification>
Method Parameters
| Field | Data Type | Description |
| request | BookingNotification_Request |
BookingNotification_Request
| Field | Data Type | Description |
| RequestType | BookingRequestType | Booking notification type. Possible Values = API, Bookeasy, OTA - In 99% of cases you should set this to API unless you are told otherwise. |
| Booking | Booking | The booking notification to be processed. |
| ChannelManagerUsername | String | Channel Managers Username as supplied when the Channel Manager Agreement was made |
| ChannelManagerPassword | String | Channel Managers password as supplied when the Channel Manager Agreement was made |
| Username | String | Hotels Username, if you are creating a new hotel and don't yet have this information, send in your desired Username, otherwise it must be the Username that has been allocated to this hotel |
| Password | String | Hotels Password, if you are creating a new hotel and don't yet have this information, send in your desired Password, otherwise it must be the Password that has been allocated to this hotel |
| HotelId | Int64 | The HotelID that you want to work with. This software can access more than one hotel from the same username and password. |
| HotelAuthenticationKey | String | Authentication for a hotel can also be achieved by passing in the correct HotelAuthenticationKey. If you have been informed by us how to build this key, then you can use this key instead of supplying the Hotels Username and Password. If you do not know how to build the key, then your connection hasn't been approved for this style of authentication and you should use the Hotels Username and Password to achieve authentication. Note, if you are creating a Hotel, you must supply the username and password, you cannot use the HotelAuthenticationKey field, so set this to an Empty String. Last Note. Set this to an empty string if you are supplying username and password. |
BookingRequestType
Booking notification type. Possible Values = API, Bookeasy, OTA - In 99% of cases you should set this to API unless you are told otherwise.
| Field | Data Type | Description |
| API | ||
| BookEasy | ||
| OTA |
Booking
The booking notification to be processed.
| Field | Data Type | Description |
| BookingRef | String | Unique booking identifier. |
| BookingType | BookingNotificationType | Booking type. Possible Values are Booking and Cancellation. Send in Booking for new bookings, and Cancellation for Cancelleations. For modifications, we only care about modifications if the dates or the room type has changed, so in those cases send in a Cancellation request first, and then send in a new Booking. |
| MainGuest | GuestDetails | Main guest for the current booking. |
| BookingDetails | BookingDetails | Room package details for the current booking. |
| CreditCardDetails | CreditCardDetails | Financial details for the current booking. |
BookingNotificationType
Booking type. Possible Values are Booking and Cancellation. Send in Booking for new bookings, and Cancellation for Cancelleations. For modifications, we only care about modifications if the dates or the room type has changed, so in those cases send in a Cancellation request first, and then send in a new Booking.
| Field | Data Type | Description |
| Cancellation | ||
| Booking |
GuestDetails
Main guest for the current booking.
| Field | Data Type | Description |
| FirstName | String | Main guest first name. |
| LastName | String | Main guest last name. |
| AddressFirstLine | String | Main guest address first line. |
| AddressSecondLine | String | Main guest address second line. |
| City | String | Main guest address city. |
| State | String | Main guest address state. |
| Postcode | String | Main guest address post code. |
| CountryIso | String | Main guest country iso. |
| Phone | String | Main guest contact phone number. |
| Mobile | String | Main guest contact modile number. |
| String | Main guest contact email address. |
BookingDetails
Room package details for the current booking.
| Field | Data Type | Description |
| PropertyId | Int64 | Booked property id. |
| RoomCode | String | Booked room id. |
| CheckIn | DateTime | Booking check in date. |
| CheckOut | DateTime | Booking check out date. |
| Adults | Int32 | Booking adult pax. |
| Children | Int32 | Booking children pax. |
| Infants | Int32 | Booking infants pax. |
| SpecialRequests | String | Guest specail request comments. |
| OwingAmount | Decimal | Booking total cost. |
| CurrencyISO | String | Currency of the booking. |
| Quantity | Int32 | Quantity. |
CreditCardDetails
Financial details for the current booking.
| Field | Data Type | Description |
| HolderFullName | String | Name that appears on credit card. |
| Number | String | Credit card number. |
| ExpiryDate | DateTime | Credit card expiry date. |
| VerificationNumber | String | Credit card verification number (CCV). |
TimeSpan
| Field | Data Type | Description |
BookingNotification_Response
| Field | Data Type | Description |
| Response | List of BookingResponse | List of booking process responses |
| Timestamp | DateTime | |
| MessageId | String | |
| HotelAuthenticationKey | String |
BookingResponse
List of booking process responses
| Field | Data Type | Description |
| Success | Boolean | Indicates if the operation was successful or not. |
| ErrorCode | String | If there was an error, the error code is returned here. |
| Message | String | Success and Error Information is returned here. |
| BookingPrice | Decimal | The booking price that the bookng was saved in will be supplied here. |
Direct API © Copyright 2008