Petra2 Java API – SjStinaInformationProviderInterface.getDetailedPaxList

Method description

Metoden hämtar en detaljerad 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.
• Klara beställningsrader (dvs inte avbeställda eller krediterade rader) 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

PaxListQuery

Strukturen av typen PaxListQuery utgör indata för metoden. Strukturen innehåller tre XOR strukturer:

EmbarkingThroughServicesSpecification

Används som indata för detaljerad eller summerad sökning för ett färdmedel

EmbarkingTransportIdListSpecification

Lista av färdmedelsbeskrivningar, används vid summerad passagerarlistfråga

EmbarkingTransportSpecification

Beskrivning av ett färdmedel, används vid summerad passagerarlistfråga

TransportId

Färdmedelsnumret för det färdmedel som resenärslistan ska innehålla, till exempel 425 för tåg 425. För de tåg, som ingår i vagnkurser och byter tågnummer längs vägen, måste separata frågor ställas för varje färdmedelsnummer för att få med alla resenärer.

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 och metoden inte kan hantera färdmedel med längre tid än 24 timmar mellan första och sista avgångstid.

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.

Reviderad 2008-12-03

Output

DetailedPaxListResult