1. Search

Mishor 4 Documentation‎ > ‎5. API Methods‎ > ‎8. Trains‎ > ‎

Initiate Request:

<auth>

<username>example</username>

<password>example</password>

<agent>example</agent>

</auth>

<trains-search roundTrip="true">

<dates>

</dates>

</filters>

<pax-group customerCountryCode="UK">

<pax>

</children>

</pax>

</pax-group>

</currencies>

</trains-search>

</request>

Request Parameters:

Parameter	Type	Comments
trains-search @roundTrip	boolean	is the search made for 1 way or with return
dates/departure	YYYY-mm-dd	the date of departure trip
dates/departureReturn	YYYY-mm-dd	the date of the return trip
area @type	origin/destination	origin or destination
area @entityType	location/metropolitan	location/metropolitan code
area @entityId	string	either cityid or a 3 letter terminal code
pax-group @customerCountryCode	country code	2 letter ISO code for the customer country
pax	node	the pax node describing the people who should be on the train
pax/adults @count	int	the number of adults
pax/children @count	int	the number of children
pax/children/age	int	the age of each child
currencies @default	currency	3 letter ISO code for the default currency
currencies/currency @code	currency	3 letter ISO code for the accepted currency

Notes

dates/departureReturn is mandatory only if the @roundTrip option is set to "true"
customerCountryCode is mandatory, and the same code should be used for the entire session flow. i.e. when searching for a specific country code, you must use the same country code for booking.
children are optional. if you are not search for a room with children, do not include the children node.
currencies are returned according to the list in the request. properties that use a currency that does not appear on the list will be converted to the "default" currency. to remove restrictions and return all currencies, add an attribute to the currencies node: all="true"
the "metropolitan" code is a IATA code of the city (like "LON" for london, or "PAR" for paris)

Asynchronous Response:

<response success="1" session="dv.1234">

<search status="working">

<server>http://mishor.example.com/</server>

</search>

</response>

The Asynchronous response consists of the following elements:

Parameter	Type	Comments
response @success	boolean	was the request successful
response @session	string	the search id of the requested search
server	url	the url of the search server to use for polling and booking

Initiate Poll

With the search response session id, it is now possible to start polling the results. For a description of the flow, please revert to section 3: Search Flow

Poll Request

<request version="4.0">

<auth>

<username>example</username>

<password>example</password>

<agent>example</agent>

</auth>

<trains-poll session="dv.1234" last="0"/>

</request>

Parameter	Type	Comments
trains-poll @session	string	the session id of the requested search
trains-poll @last	int	the last @last attribute received from the previous poll

Poll Response

<?xml version="1.0" encoding="UTF-8"?>

<response success="1" time="2017-07-18 08:48:37" session="dv.1234">

<job status="done"/>

<results last="1" count="67">

    <result token="dv.20572315774" providers="Trains" onrequest="0" pricingType="net" fareSource="" fareCRS="" prePaid="1">

<price amount="330" currency="EUR" final="0" commissionable="1" billable="1" minCommissionablePrice=""/>

<pricedetails/>

<outbound>

<connection id="0">

<info travelTime="P0DT3H27M"/>

<segment id="1">

<info technicalStops="4" carrierOperated=""/>

<departure terminal="AMSTERDAM CS(AMSTERDAM)" date="2017-07-30" time="06:17:00"/>

<arrival terminal="PARIS NORD(PARIS)" date="2017-07-30" time="09:44:00"/>

<tripNumber>9310</tripNumber>

</segment>

</connection>

</outbound>

</result>

    <result token="dv.205723157717" providers="Trains" onrequest="0" pricingType="net" fareSource="" fareCRS="" prePaid="1">

<price amount="440" currency="EUR" final="0" commissionable="1" billable="1" minCommissionablePrice=""/>

<pricedetails/>

<outbound>

<connection id="0">

<info travelTime="P0DT3H27M"/>

<segment id="2">

<info technicalStops="4" carrierOperated=""/>

<departure terminal="AMSTERDAM CS(AMSTERDAM)" date="2017-07-30" time="08:17:00"/>

<arrival terminal="PARIS NORD(PARIS)" date="2017-07-30" time="11:44:00"/>

<tripNumber>9322</tripNumber>

</segment>

</connection>

</outbound>

</result>

    <result token="dv.205723157757" providers="Trains" onrequest="0" pricingType="net" fareSource="" fareCRS="" prePaid="1">

<price amount="380" currency="EUR" final="0" commissionable="1" billable="1" minCommissionablePrice=""/>

<pricedetails/>

<outbound/>

<inbound>

<connection id="0">

<info travelTime="P0DT3H17M"/>

<segment id="3">

<info technicalStops="4" carrierOperated=""/>

<departure terminal="PARIS NORD(PARIS)" date="2017-08-07" time="06:25:00"/>

<arrival terminal="AMSTERDAM CS(AMSTERDAM)" date="2017-08-07" time="09:42:00"/>

<tripNumber>9303</tripNumber>

</segment>

</connection>

</inbound>

</result>

    <result token="dv.205723157788" providers="Trains" onrequest="0" pricingType="net" fareSource="" fareCRS="" prePaid="1">

<price amount="696" currency="EUR" final="0" commissionable="1" billable="1" minCommissionablePrice=""/>

<pricedetails/>

<outbound/>

<inbound>

<connection id="0">

<info travelTime="P0DT3H59M"/>

<segment id="1">

<info technicalStops="0" carrierOperated=""/>

<departure terminal="PARIS NORD(PARIS)" date="2017-08-07" time="11:55:00"/>

<arrival terminal="BRUXELLES MIDI(BRUSSELS)" date="2017-08-07" time="13:17:00"/>

<tripNumber>9337</tripNumber>

</segment>

<segment id="2">

<info technicalStops="1" carrierOperated=""/>

<departure terminal="BRUXELLES MIDI(BRUSSELS)" date="2017-08-07" time="14:02:00"/>

<arrival terminal="AMSTERDAM CS(AMSTERDAM)" date="2017-08-07" time="15:54:00"/>

<tripNumber>9126</tripNumber>

</segment>

</connection>

</inbound>

</result>

</results>

</response>

Parameter	Type	Comments
response @success	boolean	was the request successfull
job @status	string	"working" or "done"
results @last	int	keep this number for the next poll (see request)
results @count	int	how many results were returned in this specific poll response
result @id	int	the identifier of the specific result
result @providers	string	comma separated string of providers available for this property
result @pricingType	net/gross
result @fareSource	string	the source of the fare (which system)
result @fareCRS	string	the CRS of the fare (code)
result @prePaid	boolean	is the ticket pre-paid or should be paid by the client
result @onrequest	boolean
result/price	node	availablity coming from innstant.travel
result/price @currency	currency	3 letter ISO currency code
result/price @minCommissionablePrice	double	the minimum commissionable price - appears only if such result is available
result/price @minNonCommissionablePrice	double	the minimum non-commissionable price - appears only if such result is available
outbound	node	the outbound trip information
outbound/connection	node	connection is an "option" for a trip plan between the departure and arrival terminals
outbound/connection @id	int	an identifier for the connected
outbound/connection/info @travelTime	date interval string	ISO 8601 time interval string to show the duration of the entire flight
outbound/connection/segment	node	a segment is one "leg" of a trip plan
outbound/connection/segment/ tripNumber	integer	the trip number
outbound/connection/segment/ departure @terminal	terminal code	3 letter ISO code of the departure terminal
outbound/connection/segment/ departure @date	date	departure date in the terminal local time zone
outbound/connection/segment/ departure @time	time	departure time in the terminal local time zone
outbound/connection/segment/ arrival @terminal	terminal code	3 letter ISO code of the arrival terminal
outbound/connection/segment/ arrival @date	date	arrival date in the terminal local time zone
outbound/connection/segment/ arrival @time	time	arrival time in the terminal local time zone

Notes

The first poll request should be sent at least 3 seconds after the search response. You also need to wait at least 3 seconds between poll requests. If you have direct providers set up you need to consult with your account manager regarding the timing.
If there are no results from your direct providers, the non-billable-price node will not be returned
it is not allowed to add commission on top of non-commissionable items
Dates and Times are returned in the local terminal timezone
the @travelTime format is based on the ISO 8601 standard. for example, "P3DT4H15M" means 3 days, 4 hours and 15 mintues. "P" is the prefix, "T" means the time.

Comments