4. Booking

4. Booking

The booking request is done after the Booking Info request was completed, and you have collected all the customer details required for the booking.
Booking Request
<request version="4.0">
  <auth>
    <username>example</username>
    <password>example</password>
    <agent>example</agent>
  </auth>
<event-book session="dv.12345" token="dv.111111" dispatchToken="dv.222222" clientRef="123456">
  <customer>
    <title>M</title>
    <firstName>Guest</firstName>
    <lastName>Guestington</lastName>
    <phone type="home">+61 123456</phone>
    <email>guest@example.com</email>
    <address>141 Guest Road</address>
    <postCode>44445</postCode>
    <city>Guestia</city>
    <state>VIC</state>
    <countryCode>AU</countryCode>
  </customer>
  <special-request-fields>
    <field code="height">1.75 m</field>
  </special-request-fields>
  <extra-products>
    <product>dv.abc123</product>
  </extra-products>
</event-book>
</request>
Parameter Type Comments
event-book @sessionstringthe session id as returned by the search
event-book @clientRefstringyour reference
event-book @dispatchTokencstringthe dispatch token selected from the booking-info request
customernode the lead customer details, pretty self explanatory
special-request-fieldsnode the mandatory special request fields from the booking info request
extra-products/productnode the extra product id from the booking info (optional) 
Notes:
  1. the customerCountryCode should be the same country code as was passed to the search
  2. when booking a room with children, the pax node should have an additional age node specifying the child's age. the title can be left empty.
Booking Response
<?xml version="1.0"?>
<response success="1" session="m1.U3xZj6MvUA">
  <reservation id="m1.U3xaZMARsA" status="confirmed" clientReference="12345">
    <item id="1" status="confirmed" token="dv.123123">
      <source provider="innstanttravel-b2b">
        <reference>37898862</reference>
        <price amount="484.08" currency="USD" />
      </source>
      <booking billable="1">
        <price amount="550.172" currency="AUD" />
      </booking>
      <event id="2390" date="2014-06-06">
        <tickets count="4" />
        <name>
          <![CDATA[Giverny and Monet's Garden Small Group Day Trip from Paris]]>
</name>
      </event>
      <venue>
        <name>
          <![CDATA[Paris]]>
</name>
      </venue>
      <dispatch type="print">
        <description>
          <![CDATA[Self-Print Voucher]]>
</description>
        <print>
          <url>
            <![CDATA[http://www.example.com/path-to-ticket-print.pdf]]>
</url>
        </print>
      </dispatch>
      <cancellation>
        <frame endTime="2014-06-02 00:00:00" timezone="UTC" type="fully-refundable" />
        <frame endTime="2014-06-06 00:00:00" timezone="UTC" type="fully-refundable" />
      </cancellation>
    </item>
  </reservation>
</response>
Parameter Type Comments
response @successbooleanwas the request successful - note that this is NOT the booking status response
reservation @idstringthe reservation identifier
reservation @statusstringsee "lookups" for possible returned statuses
reservation @clientReferencestring your reference as received during the booking request
item @tokenstring the room token that was booked
item @statusstring see "lookups" for possible returned statuses
item @idintan incremental counter 
source @providerstringthe provider from which this ticket is from
source/referencestring the provider reference number
source/price @amountfloatthe price received from the provider
source/price @currencycurrency3 letter currency code
booking @billablebooleanis the booking coming from a direct provider
booking/price @amountfloatthe price of the ticket 
booking/price @currencycurrency3 letter currency code
event @idstring the id of the booked event
event @datedateYYYY-MM-DD format of the selected date
event @timetimeHH:mm:ss format of the  event, if all day event it is not returned
event/tickets @countintthe number of tickets booked
event/tickets/namenode the name of the booked event

venue/namenode the name of the venue 
dispatch @typestring the type of the dispatch option 
dispatch/descriptionnode the description of the dispatch option 
dispatch/print/urlnode in case of "print" method, the url of the actual ticket
cancellationnode the terms of the cancellation 
Notes
1. the source node will appear only if the provider is a direct provider (billable=0)
2. the print node will only be returned in case the booking is made using a self-print dispatch option

Comments