1. Search

1. Destination Search

Initiate Request:

<request version="4.0">
  <auth>
    <username>example</username>
    <password>example</password>
    <agent />
  </auth>
  <transfers-search roundTrip="true">
    <location type="origin" entityType="terminal" entityID="2165">
      <arrival date="2016-10-29" time="15:20"></arrival>
    </location>
    <location type="destination" entityType="address" longtitude="-0.1559078000000227" latitude="51.5177349">
      <departure date="2016-11-08" time="15:50"></departure>
      <description>
        <![CDATA[21 Baker St]]>
</description>
      <address>
        <![CDATA[21 Baker St, Marylebone, London W1U 8EQ, UK]]>
</address>
      <city>
        <![CDATA[London]]>
</city>
    </location>
    <pax-group customerCountryCode="GB">
      <pax>
        <adults count="2"/>
      </pax>
    </pax-group>
    <currencies default="EUR" all="true"></currencies>
  </transfers-search>
</request>
Request Parameters:

 Parameter Type Comments
 transfers-search @roundTripbooleanis the search done for one way (false) or two-ways (true)
location @typestring "origin" or "destination"
location @entityTypestring"terminal", "hotel", or "address"
location @entityIDintin case of terminal of hotel only
location @longitude/@latitudecoordinatesfor address only
arrival (or departure) @dateYYYY-MM-DD the arrival or departure date of the FLIGHT (see note #1) 
arrival (or departure) @timeHH:MMthe arrival or departure hour of the FLIGHT (see note #1) 
descriptioncdata string a description of the address (can be left blank if no description available) 
addresscdata stringfull address, as detailed as possible 
citycdata string city name
pax-groupnodesee hotels destination search  for details on how to build the pax-group
currenciesnode see hotels destination search  for details on how to build the currencies node
Notes:
1. The arrival and departure times are NOT the times your client wishes to be picked up, they are the FLIGHT departure or arrival time. The actual pick up time will change according to the flight schedule
2. in case you are searching for a transfer between terminals, or between a terminal and a hotel, you can use "entityID" instead of the longitude and latitude

Asynchronous Response:
<response success="1" session="dv.Uw8IU6CsA">
  <search status="working">
    <server>http://mishor.example.com/</server>
  </search>
</response>

The Asynchronous response consists of the following elements:
Parameter Type Comments
response @successboolean was the request successful
response @sessionstring the search id of the requested search
serverurlthe url  of the search server to use for polling and booking

2. Poll Request

Poll Request
<request version="4.0">
  <auth>
    <username>example</username>
    <password>example</password>
    <agent><![CDATA[example]]></agent>
    <language>en</language>
    <clientIp>1.2.3.4</clientIp>
    <clientUserAgent>userAgent string</clientUserAgent>
    <customfields></customfields>
  </auth>
  <transfers-poll session="dv.Uw8IU6CsA" last="0"></transfers-poll>
</request>

Parameter Type Comments
transfers-poll @sessionstringthe session id of the requested search
transfers-poll @lastintthe last @last attribute received from the previous poll

Poll Response
<response success="1" session="dv.Uw8IU6CsA">
  <job status="working"></job>
  <results last="1" count="12">
    <result token="dv.1234" on-request="0" type="arrival/return">
      <price amount="148.22" currency="EUR" final="1" commissionable="1" billable="1"></price>
      <price-details></price-details>
      <vehicleType><![CDATA[Private Luxury Transfer (1  -3 people)]]></vehicleType>
      <transferType><![CDATA[Private Luxury Transfer (1  -3 people)]]></transferType>
      <transferDescriptions></transferDescriptions>
      <origin type="terminal" id="2165">
        <locationName><![CDATA[London Heathrow Airport (LHR)]]></locationName>
        <locationInfo>
          <name><![CDATA[Heathrow]]></name>
          <city><![CDATA[London]]></city>
          <state><![CDATA[England]]></state>
          <country><![CDATA[United Kingdom]]></country>
          <latitude>51.477500</latitude>
          <longitude>-0.461388</longitude>
        </locationInfo>
      </origin>
      <destination type="coordinates" id="0">
        <locationName><![CDATA[London W1 - Oxford Street, Piccadilly, Mayfair]]></locationName>
        <locationInfo>
          <latitude>51.5177349</latitude>
          <longitude>-0.15590780000002</longitude>
          <address><![CDATA[21 Baker St, Marylebone, London W1U 8EQ, UK]]></address>
          <city><![CDATA[NONE]]></city>
          <country><![CDATA[]]></country>
          <description><![CDATA[21 Baker St]]></description>
        </locationInfo>
      </destination>
      <images>
        <image></image>
      </images>
      <cancellation>
        <frame endTime="2016-10-23 00:00:00" timezone="UTC" type="fully-refundable"></frame>
        <frame endTime="2016-10-29 00:00:00" timezone="UTC" type="non-refundable"></frame>
      </cancellation>
    </result>
    <result token="dv.2345"  n-request="0" type="arrival">
      <price amount="100" currency="GBP" final="1" commissionable="1" billable="1"></price>
      <price-details></price-details>
      <vehicleType><![CDATA[High Class Sedan]]></vehicleType>
      <transferType><![CDATA[Private hire with driver]]></transferType>
      <transferDescriptions>
        <transferDescription><![CDATA[Exclusive ride for you]]></transferDescription>
        <transferDescription><![CDATA[Door to door service]]></transferDescription>
        <transferDescription><![CDATA[Available 24/7]]></transferDescription>
        <transferDescription><![CDATA[Meet & Greet service]]></transferDescription>
        <transferDescription><![CDATA[1 piece of baggage allowed per person]]></transferDescription>
        <transferDescription><![CDATA[1 item of hand baggage allowed per person]]></transferDescription>
      </transferDescriptions>
      <origin type="terminal" id="2165">
        <locationName><![CDATA[London, Heathrow Airport]]></locationName>
        <locationInfo>
          <name><![CDATA[Heathrow]]></name>
          <city><![CDATA[London]]></city>
          <state><![CDATA[England]]></state>
          <country><![CDATA[United Kingdom]]></country>
          <latitude>51.477500</latitude>
          <longitude>-0.461388</longitude>
        </locationInfo>
      </origin>
      <destination type="coordinates" id="0">
        <locationName><![CDATA[Central London]]></locationName>
        <locationInfo>
          <latitude>51.5177349</latitude>
          <longitude>-0.15590780000002</longitude>
          <address><![CDATA[21 Baker St, Marylebone, London W1U 8EQ, UK]]></address>
          <city><![CDATA[NONE]]></city>
          <country><![CDATA[]]></country>
          <description><![CDATA[21 Baker St]]></description>
        </locationInfo>
      </destination>
      <images>
        <image>http://example.com/medium/prvt-lxr-hcb.png</image>
      </images>
    </result>
    <result token="dv.3456"  on-request="0" type="return">
      <price amount="100" currency="GBP" final="1" commissionable="1" billable="1"></price>
      <price-details></price-details>
      <vehicleType><![CDATA[High Class Sedan]]></vehicleType>
      <transferType><![CDATA[Private hire with driver]]></transferType>
      <transferDescriptions>
        <transferDescription><![CDATA[Exclusive ride for you]]></transferDescription>
        <transferDescription><![CDATA[Door to door service]]></transferDescription>
        <transferDescription><![CDATA[Available 24/7]]></transferDescription>
        <transferDescription><![CDATA[Meet & Greet service]]></transferDescription>
        <transferDescription><![CDATA[1 piece of baggage allowed per person]]></transferDescription>
        <transferDescription><![CDATA[1 item of hand baggage allowed per person]]></transferDescription>
      </transferDescriptions>
      <origin type="coordinates">
        <locationName><![CDATA[Central London]]></locationName>
        <locationInfo>
          <latitude>51.5177349</latitude>
          <longitude>-0.15590780000002</longitude>
          <address><![CDATA[21 Baker St, Marylebone, London W1U 8EQ, UK]]></address>
          <city><![CDATA[NONE]]></city>
          <country><![CDATA[]]></country>
          <description><![CDATA[21 Baker St]]></description>
        </locationInfo>
      </origin>
      <destination type="terminal" id="0">
        <locationName><![CDATA[London, Heathrow Airport]]></locationName>
        <locationInfo>
          <name><![CDATA[Heathrow]]></name>
          <city><![CDATA[London]]></city>
          <state><![CDATA[England]]></state>
          <country><![CDATA[United Kingdom]]></country>
          <latitude>51.477500</latitude>
          <longitude>-0.461388</longitude>
        </locationInfo>
      </destination>
      <images>
        <image>http://example.com/medium/prvt-lxr-hcb.png</image>
      </images>
    </result>
  </results></response>

Parameter Type Comments
result @tokenstringthe unique identifier for a specific result. this token will be used for booking later on
result @on-requestbooleanis this result on request (1) or should be immediately confirmed (0)
result @type string possible values: "arrival", "return", "arrival/return". see note #1 below
price @amountfloat the price of the result 
price @currency3 letter ISO  
price @finalbooleanis the price final or is it expected to change before the booking (added surcharges, etc)
price @commissionablebooleancan a commission be added to this price, or is it a gross price
price @billable booleanis this a direct contract (for technology clients only)
price-detailsnodealways empty, you can ignore this one 
vehicleTypestringfree text description of the vehicle that will be used for the transfer 
transferTypestringfree text description of the type of transfer (shared, public, meet & greet, etc) 
transferDescriptionsnodecontains "transferDescription" nodes with different free-text descriptions of the offer
origin @typestring where this transfer starts from. available values are "terminal", "hotel" and "coordinates" 
origin @idint the id the correlates to the @type attribute. either a terminal id or a hotel id. in case of type "coordinates" the id will be 0
locationNamestring a free-text string with the origin location name 
locationInfonode breakdown of the location information to longitude, latitude, city, state, country, address (if applicable), etc.
destinationnode same structure as origin 
imagesnode a collection of images that relates to the specific transfer, usually an image of the vehicle that will be used 

Notes
1. the type of result can vary between "arrival", "return", and "arrival/return". if you searched for a round-trip, if will need to choose either 1 arrival and 1 return, or a single arrival/return result to book.



Comments