StartRouting Request

 XML Field  Description
 CommandList The surrounding tag
 -StartRouting  The command name
 --XmlLoginId  The xml customer login id. See the Login guide
 --LoginId  The end user login id. See the Login guide
 --Mode  The type of routing. Must have value plane
 --ProductType(new)

 This field is purely Optional and required only if the request to be made on any  particular type of suppliers ignoring the other type of suppliers. It is case sensitive i.e  plane, train, hotel etc.

 It is a strategy to request search only trains or only plane suppliers. However the  mandatory xml field -Mode is always plane for both train and flight suppliers.

 --Origin  The start location of the journey. Please read the related guidelines
 ---Descriptor  The location name/code/identifier/coordinate. Currently only the following are accepted:
  • City TLA (e.g. LON) (uppercase)
  • Airport TLA (e.g. LHR) (uppercase)
  • Travelfusion location id (e.g. as returned by the ResolveLocation request) A coordinate of the format lat,long where lat and long are decimal degrees
If a Travelfusion location id is submitted, the Type element below must have value locationid
 ---Type  This field describes how the Descriptor is to be interpreted. Possible values are:
airportcode States that the Descriptor is an airport code - e.g. Descriptor AMS with Type airportcode will signify Amsterdam Schiphol airport
citycode States that the Descriptor is a city code - e.g. Descriptor AMS with Type citycode will signify Amsterdam city
airportgroup States that the Descriptor represents a set of airports. e.g. Descriptor LON with Type airportgroup signifies the London airports. Airport groups currently can only be city codes, but custom groups may later be introduced
auto Requests that Travelfusion should automatically determine the Type of the Descriptor
locationid Specifies that the Descriptor is a location Id (for example, if the Location Resolution feature is utilised, locations can be specified using their id)
coordinate States that the Descriptor is a coordinate (latitude/ longitude)
trainstationcodeSee the guidelines for trains or contact Travelfusion

 ---ResolutionTypeList
    [Optional]
 This will be ignored unless the Type is auto. In this case, the ResolutionTypeList describes the order in which Travelfusion should assess the descriptor-type. For example, if the Descriptor is AMS (which is both a city and an airport code) and the Type is auto, and the ResolutionTypeList has airportcode before citycode or it contains airportcode but not citycode, Travelfusion will treat the location as Amsterdam airport. If the ResolutionTypeList is omitted, then Travelfusion will use an unspecified sequence containing all types. However if a ResolutionTypeList is supplied, only the types in the list will be considered.
 ----ResolutionType
    [Optional]
 Contains any one of the possible values for Type above
 ---Radius
    [Optional]
 The distance in metres to search for relevant airports. If the Type is airportgroup, the radius will be ignored if supplied. Otherwise, the radius will be used to search around the specified location for relevant airports. All airports within the search radius will be considered. Any outside the radius will not be considered. If omitted, an unspecified default radius will be selected by Travelfusion.
 --Destination  The destination location of the journey. Similar to Origin above
 --OutwardDates  Specifies the outward journey date parameters
 ---DateOfSearch  The date and time of departure that will be requested from the supplier. Format is dd/mm/yyyy-hh:mm  If the specified date/ time cannot be specifically requested using the supplier's interface, the best approximation will be chosen. In general, Travelfusion guarantee to return all the flights returned by the supplier on the specified day unless the supplier does not return an entire day's flights, in which case Travelfusion will request the specified time of day from the supplier. Travelfusion will not make multiple requests to the supplier for a particular route. In some cases, Travelfusion may not be able to return all the flights that the supplier returns due to processing time constraints. Please ask Travelfusion for more details of these cases.
 ---DepartDateFilter
    [Optional]
Specifies a range of allowed dates. If omitted, no flight results will be discarded. These filters are only used after the supplier has returned results.

If you'd agreed with Travelfusion to get alternative days, then this filter can be used to obtain results matching a specific time window. Travelfusion will endeavor to provide all the supplier's data within the requested time range, but cannot always guarantee to do so. Please contact Travelfusion before making use of this functionality.

 ----DiscardBefore
    [Optional]
 Format is dd/mm/yyyy-hh:mm  If supplied, any results found that depart at a time before this date will be discarded by Travelfusion.
 ----DiscardAfter
    [Optional]
 Format is dd/mm/yyyy-hh:mm  If supplied, any results found that depart at a time after this date will be discarded by Travelfusion.
 ---ArriveDateFilter
    [Optional]
 Similar to DepartDateFilter, but applied to the arrival dates of the flights.
 --ReturnDates
    [Optional]
 ReturnDates has the same structure as OutwardDates. Specifies the return journey date parameters. If Omitted the journey will be assumed to be one-way (single)
 --MaxChanges  The maximum number of changes acceptable in a single leg (i.e. this limit will be applied to the outward leg and return leg separately). This value will be submitted to the supplier if they offer this functionality. Otherwise an appropriate request will be made to the supplier. Any results returned by the supplier that include more changes than the specified number will normally be discarded by Travelfusion. However in some circumstances results may still be returned that contain more changes than requested. Please contact Travelfusion for more information.
 --MaxHops  This will be handled similarly to MaxChanges. See the 'Travel Terminology guide for definitions of 'changes' and 'hops'.
 --BookingChange
    [Optional]
 Defines the parameters of a booking change. If this element is included, this StartRouting request will start a search for the flight(s) that will replace the previously booked one(s)
 ---TFBookingReference  Defines the Travelfusion reference of the booking to be changed.
 ---ChangeAttributeList  Defines the attributes of the booking that are to be changed.
 ----ChangeOutwardDate  Specifies whether the outward date of the booking is to be changed. Format is true or false
 ----ChangeReturnDate  Specifies whether the return date of the booking is to be changed. Format is true or false
 --SupplierList
    [Optional]
 The list of suppliers to query. If omitted, all available suppliers will be queried. Contains 0 or more Supplier items. In general, it is recommended that you do not supply this list unless you are certain that only a specific subset of suppliers is required for this user search.
 ---Supplier
    [Optional]
 A supplier identifier. Please contact Travelfusion for a list of possible identifiers
 --RealOperatorFilter
    [Optional]
 Specifies a list of Operator codes (see CheckRouting Results Response specifications) to allow / discard. If omitted, all results will be returned. Outward and return legs will be filtered separately.
 ---Type  If the value is select, the operators listed will be the only ones returned. If the value is reject, the operators listed will not be returned.
 ---AllowPartial  Has value true or false. In cases where a leg has multiple segments where there is a mix of allowed operators (allowed by this filter) and non-allowed operators, the allowPartial flag will define whether to return these or not. (If the flag is set to true, these results will be returned.)
 ---OperatorList  Specifies the list of operators to select / reject.
 ----Operator  Specifies an operator as a two letter operator code
 --VendingOperatorFilter
    [Optional]
 Similar to RealOperatorFilter except that the filtering is based on the VendingOperator instead of the Operator.
 --Timeout  Specifies the maximum time (in seconds) that suppliers should be allowed to respond in. Any supplier queries taking longer than this will be cancelled. This should be equal to the customer polling timeout - i.e. the time at which the customer stops polling for results even if some Routers are still incomplete. It will help to minimise the load on the Travelfusion system and the suppliers.
 --TravelClass
    [Optional]
 Must be one of the following values: Economy With Restrictions, Economy Without Restrictions, Economy Premium, Business, First. If omitted, an appropriate default value will be used. Travelfusion will request this class or the best approximation from the supplier where possible, but may not filter the response from the supplier, so any flights returned by the supplier, but not matching the requested class may still be returned by Travelfusion.
 --TravellerList  Describes the travellers that will be making the journey
 ---Traveller  A traveller description
 ----Age  The age of the traveller. This is required because suppliers do not all use the same age boundaries to define adults / children etc. If the traveller's age is not known then an age should be submitted that will always give the required passenger type. e.g. 30 for adults, 7 for children, 0 for infants, 90 for senior citizen. Please contact Travelfusion for more details
 --NumberOfBags
    [Optional]
 Specifies the number of bags to be bundled together with the price of the flight at the availability step. The value cannot be higher than the number of passengers (excluding infants).
 --ShowCardCharges
 Submission of this element with the value true, will return all the card types and theircharges that a supplier supports in the CheckRouting response.  In order to activate it, along with specifying 'ShowCardCharges' in StartRouting, you would need to send us a custom supplier parameter 'UseNewCardChargesFormat' with value 'true'.  See example below. Please contact Travelfusion before making use of this functionality.

<CommandList>
  <StartRouting>
..........
</TravellerList>
  <ShowCardCharges>true</ShowCardCharges>
..........
<BookingProfile>
  <CustomSupplierParameterList>
..........
<CustomSupplierParameter>
    <Name>UseNewCardChargesFormat</Name>
    <Value>true</Value>
  </CustomSupplierParameter>
..........
</CustomSupplierParameterList>
</BookingProfile>
</StartRouting>
</CommandList>
 --ShowLuggageCharges(new)
[Optional]
 Submission of this element with the value true, will return all the luggage charges that a supplier supports in the CheckRouting response.Please contact Travelfusion before making use of this functionality.
 --ShowCheckInCharges
(new)
[Optional]
 Submission of this element with the value true, will return all the check in charges that a supplier supports in the CheckRouting response.Please contact Travelfusion before making use of this functionality.
 --ShowSpeedyBoardingCharges
(new)
[Optional]
 Submission of this element with the value true, will return all the speedy boarding charges that a supplier supports in the CheckRouting response.Please contact Travelfusion before making use of this functionality.
 --MinimumCardChargeTypeList
[Optional] DEPRECATED
 Defines a list of card types that you will be offering to your end user. Later, in the CheckRouting response, Travelfusion will calculate and return the cheapest card charge applied by the supplier for this specific set of cards (see 'MinimumCardChargeList' in the CheckRouting response specification for more info on why this is useful). Please contact Travelfusion before making use of this functionality.
 ---MinimumCardChargeType Specifies one card type. It's value is a string and must take one of the card-type values accepted by the Travelfusion API. These are listed in the response to the 'GetSupportedCardTypeList' API request.
 --IncrementalResults  Must be submitted and must have value true. This will save processing and bandwidth usage. Each time the ResultsRequest is submitted (polled), only new results will be returned in full detail - i.e. any results that have become available since the last poll. More details of how results will be returned can be found in the specification for the RouterList element in the results response.
 --BookingProfile
    [Optional]
 Any customer profile information can optionally be supplied here. See the ProcessTerms Request specifications for the structure of this element. All sub-elements are optional at this stage even if stated otherwise in the ProcessTerms Request specifications. However some of the CustomSupplierParameters may affect the results that are obtained from this search. Please see RequiredParameterList in the CheckRouting Response specifications for more information.
 --PerformSearch
    [Optional]
 If has value true then a search will actually be performed. Will be assumed true if omitted. In special circumstances a customer may want to submit a search request only to get a search response - i.e. no Results Request will be made. In this case the value should be set to false. For example, the customer may wish to check the value of RequiredParameters in the Search Response, and then resubmit the search request including the appropriate parameters. The customer may also use this feature to investigate exactly which routes and suppliers would be searched for this request, without actually requesting that the flight data be obtained from the suppliers.