Petra2 Java API – SjStinaInformationProviderInterface.findItinerariesLight

Method description

Klienten väljer via indata vilka förbindelser som metoden ska söka och returnera. Innan denna metod anropas bör giltiga koder för färdmedel och produkter hämtas med getAcceptableTravelMethods() eftersom dessa uppgifter behövs i ItineraryLightQuery.

Metoden returnerar ett gränssnittsobjekt för sökningen (Java interface) med hjälp av vilken man kan ställa andra frågor relaterade till sökningen. För att få tag i sökningsresultatet anropas metoden getItineraries(). Observera att när man är klar med sökningsresultatet bör man anropa metoden close().

Metoden är densamma som används i proffssäljargränssnittet (läs Stina-klienten), med de skillnaderna att användaren i detta fall inte behöver fylla i lika många strukturer och fält samt att svarsresultatet returneras filtrerat.

Input

ItineraryLightQuery

Strukturen av typen ItineraryLightQuery utgör indata för metoden. Den innehåller olika strukturer och fält för att specificera krav på förbindelserna. Om de strukturer och fält som är frivilliga i denna metod inte fylls i kommer Applikationsservern att använda sig av en komponent för att fylla i standardvärden. Standardvärden lagras per säljkanalanvändningstyp i XML-filer på Applikationsservern.

Denna metod använder alltid zonsökning för från- och tillstationen vid förbindelsefrågan för alla säljkanaler.

DepartureTime, ArrivalTime

Om klienten inte anger någon tid för avgångstid eller ankomsttid, sätter Applikationsservern denna tid till 00:00:00.

MinimumChangeDuration

Om klienten inte anger minsta bytestid på stationer sätts detta till standardvärdet för respektive station i JP oavsett säljkanal.

MaximumNoOfChanges

Max antal byten i svaret har ett maxvärde (N) för respektive sälkanal. Det innebär att klienten kan ange 0 - N. Om klienten inte anger något används N.

MaxItineraries

Max antal förbindelser i svaret har ett maxvärde (N) för respektive säljkanal. Det innebär att klienten kan ange 1 - N förbindelser. Fr o m 2011-02-12 är fältet frivilligt. Om klienten utelämnar fältet görs en sökning för hela dygnet, eller resten av dygnet om fältet DepartureTime är ifyllt. Lägg märke till att antalet förbindelser i svaret kan både understiga och överstiga det begärda antalet.

NotIncludeTravelMethodProductCodeList

Listan med färdmedel och produkter kan användas för att välja bort förbindelser med vissa färdmedel eller produkter. Exempel: Användaren vill välja bort förbindelser som innehåller nattåg. Listan ska då innehålla TravelMethodCode = "J" och ProductCode = "NT".

RequiredSectionProducerList

Listan med obligatoriska sträckproducenter används för att välja bort förbindelser som helt saknar delsträckor med en obligatorisk producent. Exempel: Användaren vill bara ha förbindelser där minst en delsträcka produceras av SJ. Listan ska då innehålla 74.

UnSalableSectionProducerList

Listan med osäljbara sträckproducenter används för att markera förbindelser som osäljbara om de innehåller minst en delsträcka med någon av de osäljbara producenterna i listan. Alla prisgrupper får StatusCode = ’N’ i strukturen AvailablePriceGroup i svaret. Exempel: Användaren har inget återförsäljaravtal med Connex och kan därför inte sälja sådana förbindelser där Connex finns med. Trots detta vill användaren se de förbindelser där Connex förekommer. Listan innehåller då 380.

ExcludedSectionProducerList

Listan med otillåtna sträckproducenter används för att välja bort förbindelser som innehåller minst en delsträcka med någon av de otillåtna producenterna i listan. Exempel: Användaren vill inte visa förbindelser där Dalatrafik förekommer. Listan innehåller då 267. Metoden getSectionProducerList kan användas för att hämta en lista med alla producentnummer.

DemandLevel

Deprecated. Fältet används inte längre. Tidigare har fältet använts för att välja bort högtrafikförbindelser.

CampaignCode

Fältet för kampanjkod kan användas för att välja bort de förbindelser där den angivna kampanjkoden inte gäller.

IncludeCampaignInformation

Om fältet har värdet true innehåller svaret en lista med de kampanjkoder som kan vara giltiga på förbindelserna i svaret.

Reviderad 2010-11-26

Output