Petra2 Java API – SjStinaInformationProviderInterface.getEmbarkingTravellersItineraryList

Method description

Deprecated. Använd i stället getDetailedPaxList.

Metoden hämtar en resenärslista från orderboken för ett specifikt färdmedel (tåg) en viss dag.

Innehållet i resenärslistan består av:

• Uppgifter om färdmedlet med det angivna producentnumret, färdmedelsnumret och datumet.
• Beställningsrader där avgångstiden >= FromDateTime.
• Om ToDateTime anges, så ingår endast beställningsrader där avgångstiden <= ToDateTime.
• Sträckor där det finns bokade resenärer, vilket innebär att det inte nödvändigtvis finns en komplett beskrivning av färdmedlets väg i svaret.
• Beställningen behöver inte vara betald eller uthämtad när resenärslistan framställs. Därför finns OrderStatus med i listan.

Reviderad 2008-11-17

Input

EmbarkingTravellersItineraryListQuery

Strukturen av typen EmbarkingTravellersItineraryListQuery utgör indata för metoden.

ProducerCode

Producenten för det färdmedel som resenärslistan ska innehålla, till exempel 74 för SJ eller 380 för Connex.

TransportId

Färdmedelsnumret för det färdmedel som resenärslistan ska innehålla, till exempel 425 för tåg 425.

FromDateTime

Avgångsdatum och avgångstid är obligatoriskt att ange. Om klienten inte känner till avgångstiden bör den sättas till 00.00.00.

ToDateTime

Sista avgångsdatum och avgångstid är frivilligt att ange och bör endast användas för färdmedel som passerar midnatt. Om klienten inte anger något datum, sätter servern detta till samma datum som i FromDateTime, eftersom de flesta färdmedel inte passerar midnatt. Om klienten inte anger någon sista avgångstid, sätter servern denna tid till 24:00:00. Sista avgångsdatum bör aldrig vara senare än en dag efter första avgångsdatum eftersom resultatet endast kan innehålla uppgifter för en avgång.

TearTicket

E-klippning är frivilligt att ange och bör endast användas då man helt säkert vill e-klippa alla beställningsrader som är e-biljetter. Efter e-klippning är det inte möjligt att återköpa beställningsraden.

För att söka efter ett tåg som avgår 2006-07-01 kl 10.00 och ankommer kl 13.00 samma dag så räcker det med att ange FromDateTime.Year = 2006, Month = 7, Day = 1, Hour = 0, Minute = 0. Sökning görs då efter alla resor som har avgångstid mellan 2006-07-01 kl 00.00 och 2006-07-01 kl 24.00.

För att söka efter ett tåg som avgår 2006-07-01 kl 21.00 och ankommer kl 09.00 nästa dag så måste både första avgångstid FromDateTime.Year = 2006, Month = 7, Day = 1, Hour = 21, Minute = 0 och sista avgångstid ToDateTime.Year = 2006, Month = 7, Day = 2, Hour = 9, Minute = 0 anges. Sökning görs då efter alla resor som har avgångstid mellan 2006-07-01 kl 21.00 och 2006-07-02 kl 09.00.

Output

EmbarkingTravellersItineraryListResult