InterfaceMessageIn
The following operations are supported. For a formal definition, please review the Service Description.
-
SpringerMillerGeneric
Springer Miller Generic - supply required message type - eg. folioinquiry, followed by the XML message -
addGuest
Xml formatted string to be sent to the Service
Example
<?xml version = "1.0" encoding="utf-8"?>
<!--reservation number-->
<addguestresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number -->
<room>100</room>
<!--Title-->
<title>Mrs.</title>
<!--Surname-->
<last>Garner</last>
<!--Forename-->
<first>Nicola</first>
<!--Guest id-->
<guestid>3212</guestid>
<!--Language-->
<lang>EA</lang>
<!--Group-->
<group>British Airways</group>
<!--Vip Status-->
<vip>VIP</vip>
<!--Arrival Date-->
<arrival>06/04/2010</arrival>
<!--Departure Date-->
<departure>16/04/2010</departure>
<!--TV Setting -->
<tv>Standard</tv>
<!--Minibar Setting -->
<minibar>Standard</minibar>
<!--View bill T/F -->
<viewbill>True</viewbill>
<!--Express CO T/F -->
<expressco>True</expressco>
<!--Additional User Defined Fields as required 0-19
<userdefine0>1234</userdefine0>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</addguestresults>
-
chargePosting
Xml formatted string to be sent to the Service
Example Internet Posting
<?xml version = "1.0" encoding="utf - 8"?>
<!--Reservation Number-->
<chargerecord resno = "" type="callrecord"> resno sent but always blank, for future use
<!--Site-->
<site>HotelX</site>
<!--Room number -->
<room>100</room>
<!--Date time of call -->
<datetime>06/04/2010 09:00:03</datetime>
<!--Dialled -->
<dialled>01202387678</dialled>
<!--Duration-->
<duration>00:23:12</duration>
<!--Call Type O = OUTGOING I = incoming String-->
<calltype>O</calltype>
<!--Call Charge major.minor currency String-->
<charge>9.12</charge>
<!--Additional User Defined Fields as required 0-19
<userdeine0>1234</userdefine0>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</chargerecord>
-
checkIn
Xml formatted string to be sent to the Service
Example
<?xml version = "1.0" encoding="utf-8"?>
<!--reservation number-->
<checkinresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number -->
<room>100</room>
<!--Title-->
<title>Mr.</title>
<!--Surname-->
<last>Garner</last>
<!--Forename-->
<first>Peter</first>
<!--Guest id-->
<guestid>3211</guestid>
<!--Language-->
<lang>EA</lang>
<!--Group-->
<group>British Airways</group>
<!--Vip Status-->
<vip>VIP</vip>
<!--Arrival Date-->
<arrival>06/04/2010</arrival>
<!--Departure Date-->
<departure>16/04/2010</departure>
<!--TV Setting -->
<tv>Standard</tv>
<!--Minibar Setting -->
<minibar>Standard</minibar>
<!--View bill T/F -->
<viewbill>True</viewbill>
<!--Express CO T/F -->
<expressco>True</expressco>
<!--Additional User Defined Fields as required 0-19
<userdefine0>1234</userdefine0>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</checkinresults>
-
checkOut
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<checkoutresults resno="1000TD">
<!--Site-->
<site>HotelX</site>
<!--ROOM NUMBER-->
<room>100</room>
<!--GUEST ID-->
<guestid>2453</guestid>
<!--TITLE-->
<title>Mr.</title>
<!--SURNAME-->
<last>Garner</last>
<!--FORENAME-->
<first>Peter</first>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</checkoutresults> -
clearCreditLimit
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<<clearcreditlimitresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number -->
<room>101</room>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</clearcreditlimitsresults> -
dDIAllocate
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<ddiallocatetresults resno="1000TD">
<!--Site-->
<site>HotelX</site>
<!--ROOM NUMBER-->
<room>101</room>
<!--DDI-->
<ddi>4422</ddi>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</ddiallocateresults> -
dDICancel
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<ddicancelresults resno="1000TD">
<!--Site-->
<site>HotelX</site>
<!--ROOM NUMBER-->
<room>101</room>
<!--DDI-->
<ddi>4422</ddi>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</ddicancelresults> -
deleteText
Xml formatted string to be sent to the Service
Example Delete Text
<?xml version = "1.0" encoding="utf - 8"?>
<!--reservation number-->
< deletemessagetext resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!—Room Number -->
<room>101</room>
<!—Message ID --><msgid>903</msgid>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</deletemessagetext > -
editCreditLimit
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<<editcreditlimitresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number -->
<room>101</room>
<!--Credit Limit Major Currency -->
<creditlimit>20.50</creditlimit>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</editcreditlimitsresults> -
editGuest
Xml formatted string to be sent to the Service
Example
<?xml version = "1.0" encoding="utf-8"?>
<!--reservation number-->
<editguestresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number -->
<room>100</room>
<!--Title-->
<title>Mrs.</title>
<!--Surname-->
<last>Garner</last>
<!--Forename-->
<first>Nicole</first>
<!--Guest id-->
<guestid>3212</guestid>
<!--Language-->
<lang>EA</lang>
<!--Group-->
<group>British Airways</group>
<!--Vip Status-->
<vip>VIP</vip>
<!--Arrival Date-->
<arrival>06/04/2010</arrival>
<!--Departure Date-->
<departure>16/04/2010</departure>
<!--TV Setting -->
<tv>Standard</tv>
<!--Minibar Setting -->
<minibar>Standard</minibar>
<!--View bill T/F -->
<viewbill>True</viewbill>
<!--Express CO T/F -->
<expressco>True</expressco>
<!--Additional User Defined Fields as required 0-19
<userdefine0>1234</userdefine0>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</editguestresults>
-
expressCheckoutResults
Xml formatted string to be sent to the Service
Example Express Checkout Results
<?xml version="1.0" encoding="utf-8"?>
<checkoutresults resno="1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number-->
<room>100</room>
<!—Reply string -->
<reply>Complete<reply>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</checkoutresults>
-
externalInterfaceMessageIn
Xml formatted string to be sent to the Service,Any msg type sent here, called by external systems for a single method solution -
internetPosting
Xml formatted string to be sent to the Service
Example Internet Posting
<?xml version="1.0" encoding="utf-8"?>
<!--Reservation Number-->
<chargeRecord resno="1000TD" type="internet">
<!--Site-->
<site>HotelX</site>
<!--ROOM NUMBER-->
<room>101</room>
<!--Extension-->
<extension>2100</extension>
<!--Date time of charge-->
<datetime>06/04/2010 09:00:03</datetime>
<!--Call Charge major . minor currency-->
<charge>9.12</charge>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</chargeRecord>
-
messageText
Xml formatted string to be sent to the Service
Example Message Text
<?xml version = "1.0" encoding="utf - 8"?>
<!--reservation number-->
<messagetextresults resno = "1000TD" >
<!--Site-->
<site>HotelX </site>
<!—Room Number -->
<room>101</room>
><!—Message ID -->
<msgid>903</msgid>
<!—Message Text -->
<msgtext>Welcome to the Comfortable Hotel</msgtext>
<!— Date time
<datetime>06/04/2015 09:30:03</datetime>
<!—Real Time -->
<realtime>true</realtime>
<!—Error string -->
<error></error>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</messagetextresults> -
minibarPosting
Xml formatted string to be sent to the Service
Example Minibar Posting
<?xml version="1.0" encoding="utf-8"?>
<!--Reservation Number-->
<chargeRecord resno="1000TD" type="minibar">
<!--Site-->
<site>HotelX</site>
<!--ROOM NUMBER-->
<room>101</room>
<!--Extension-->
<extension>2100</extension>
<!--Date time of charge-->
<datetime>06/04/2010 09:00:03</datetime>
<!--Call Charge major . minor currency-->
<charge>10.5</charge>
<!--Item id-->
<itemid>12</itemid>
<!--Item Description-->
<itemdescription>Orange Juice</itemdescription>
<!--Item Quantity-->
<itemquantity>2</itemquantity>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</chargeRecord>
-
paymentPosting
Xml formatted string to be sent to the Service
Example Payment Posting
<?xml version="1.0" encoding="utf-8"?>
<!--Reservation Number-->
<chargeRecord resno="1000TD" type="payment">
<!--Site-->
<site>HotelX</site>
<!--ROOM NUMBER-->
<room>101</room>
<!--Extension-->
<extension>2100</extension>
<!--Date time of charge-->
<datetime>06/04/2010 09:00:03</datetime>
<!--Call Charge major . minor currency-->
<charge>432.50</charge>
<!--Item Description-->
<itemdescription>Bill Settlement 10</itemdescription>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</chargeRecord>
-
refresh
Xml formatted string to be sent to the Service
Example Refresh message
<?xml version="1.0" encoding="utf-8"?>
<!--Reservation Number-->
<refreshresults resno="1000TD">
<!--Site-->
<site>HotelX</site>
<!--Room Number-->
<room>101</room>
<!--Occupied-->
<occupied>N</occupied>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</refreshresults>
-
removeGuest
Xml formatted string to be sent to the Service
Example
<?xml version = "1.0" encoding="utf-8"?>
<!--reservation number-->
<removeguestresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
< !--Room Number -->
<room>100</room>
<!--Title-->
<title>Mrs.</title>
<!--Surname-->
<last>Garner</last>
<!--Forename-->
<first>Nicola</first>
<!--Guest id-->
<guestid>3212</guestid>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</removeguestresults>
-
requestAccountSummaryData
Xml formatted string to be sent to the Service
Example Request Account summary Data message
<?xml version="1.0" encoding="utf-8"?>
<requestaccountsummarydata>
<!--Site-->
<site>HotelX</site>
<!--Room Number-->
<room>100</room>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</requestaccountsummarydata>
-
requestBill
Xml formatted string to be sent to the Service
Example Request Bill
<?xml version="1.0" encoding="utf-8"?>
<requestbill resno="1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number-->
<room>100</room>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</requestbill>
-
requestCheckout
Xml formatted string to be sent to the Service
Example Request Refresh checkout
<?xml version="1.0" encoding="utf-8"?>
<requestcheckout resno="1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number-->
<room>100</room>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</requestcheckoutgt>
-
requestRefresh
Xml formatted string to be sent to the Service
Example Request Refresh message
<?xml version="1.0" encoding="utf-8"?>
<requestrefresh>
<!--Site-->
<site>HotelX</site>
<!--Room Number-->
<room>ALL</room>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</requestrefresh>
-
requestText
Xml formatted string to be sent to the Service
Example Request Text
<?xml version = "1.0" encoding="utf - 8"?>
<!--reservation number-->
< requestmessagetext resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!—Room Number -->
<room>101</room>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</requestmessagetext > -
requestWakeupData
Xml formatted string to be sent to the Service
Example Request Wakeup Data message
<?xml version="1.0" encoding="utf-8"?>
<requestwakeupdata>
<!--Site-->
<site>HotelX</site>
<!--Room Number-->
<room>ALL</room>
<!--Wakup Report Type-->
<reporttype>PENDING</reporttype>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</requestwakeupdata>
-
roomBill
Xml formatted string to be sent to the Service
Example roombillresults
<?xml version="1.0" encoding="utf-8"?>
<roombillresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number -->
<room>101</room>
<!--Balance major.minor currency string -->
<balance>138.50</balance>
<!--Error – If an error occurred producing results -->
<error></error>
<item>
<code>T210</code>
<description>Telephone</description>
<charge>13.50</charge>
<!--Date time of charge -->
<datetime>06/04/2012 09:30:03</datetime>
</item>
<item>
<code>R100</code>
<description>Room Rate</description>
<charge>100.00</charge>
<!--Date time of charge -->
<datetime>05/04/2012 13:45:08</datetime>
</item>
<item>
<code>L8000</code>
<description>Lobby Bar</description>
<charge>25.00</charge>
<!--Date time of charge -->
<datetime>07/04/2012 20:52:16</datetime>
</item>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</roombillresults> -
roomData
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<roomdataresults resno="1000TD">
<!--Site-->
<site>HotelX</site>
<!--ROOM NUMBER-->
<room>101</room>
<!--CLASS OF SERVICE-->
<cos>1</cosgt;
<!--DO NOT DISTURB-->
<dnd>Y;/dnd>
<!--MESSAGE WAITING LAMP-->
<mw>Y;/mw>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</roomdataresults> -
roomMove
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<roommoveresults resno="1000TD">
<!--Site-->
<site>HotelX</site>
<!--ROOM NUMBER-->
<room>101</room>
<!--OLD ROOM NUMBER-->
<roomold>100</roomold>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</roommoveresults> -
roomStatus
Xml formatted string to be sent to the Service
Example Room Status message
<?xml version="1.0" encoding="utf-8"?>
<!--Reservation Number-->
<roomstatusresults resno="1000TD">
<!--Site-->
<site>HotelX</site>
<!--Room Number-->
<room>101</room>
<!--Extension-->
<extension>2100</extension>
<!--Maid Status-->
<status>1</status>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</roomstatusresults>
-
setCreditLimit
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<<setcreditlimitresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number -->
<room>101</room>
<!--Credit Limit Major Currency -->
<creditlimit>10.50</creditlimit>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</setcreditlimitsresults> -
videoPosting
Xml formatted string to be sent to the Service
Example Video Posting
<?xml version="1.0" encoding="utf-8"?>
<!--Reservation Number-->
<chargeRecord resno="1000TD" type="video">
<!--Site-->
<site>HotelX</site>
<!--ROOM NUMBER-->
<room>101</room>
<!--Extension-->
<extension>2100</extension>
<!--Date time of charge-->
<datetime>06/04/2010 09:00:03</datetime>
<!--Call Charge major . minor currency-->
<charge>10.5</charge>
<!--Item Description-->
<itemdescription>Video Package 10</itemdescription>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</chargeRecord>
-
wakeupClear
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<wakeupclearresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number -->
<room>101</room>
<!--Wakeup Date -->
<wakeupdate>07/04/2010</wakeupdate>
<!--Wakeup Time -->
<wakeuptime>07:30:00</wakeuptime>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</wakeupclearresults> -
wakeupSet
Xml formatted string to be sent to the Service
Example
<?xml version="1.0" encoding="utf-8"?>
<!--RESERVATION NUMBER-->
<wakeupsetresults resno = "1000TD" >
<!--Site-->
<site>HotelX</site>
<!--Room Number -->
<room>101</room>
<!--Wakeup Date -->
<wakeupdate>07/04/2010</wakeupdate>
<!--Wakeup Time -->
<wakeuptime>07:30:00</wakeuptime>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</wakeupsetresults> -
wakeupStatus
Xml formatted string to be sent to the Service
Example Wakeup Status message
<?xml version="1.0" encoding="utf-8"?>
<!--Reservation Number-->
<wakeupstatusresults resno="1000TD">
<!--Site-->
<site>HotelX</site>
<!--Room Number-->
<room>101</room>
<!--Extension-->
<extension>2100</extension>
<!--Wakeup Status-->
<status>BY</status>
<!--Wakeup Info-->
<info>Extension Busy</info>
<!--VALID USER KEY (as Supplied)-->
<wsuserkey>Abc249PPP6pppk14</wsuserkey>
</wakeupstatusresults>