Petra2 Java API – SjOrderFacadeInterface.addTravelServiceOrderItemsBasedOnLightSpecification

Method description

Metoden används för att boka resor.

Även poängresor, dvs sådana tjänster som betalas med SJ Prio-poäng, beställs med denna metod. Fältet KpsBurnCode ska ha värdet SJPConstants.VKpsBurnCodeYes i dessa fall. Fältet PriceGroupCode måste innehålla ett värde för en prisgrupp giltig för poängresor, i annat fall lämnar PETRA ett applikationsfel beroende på att det inte går att hitta någon tjänst som uppfyller både kravet på PriceGroupCode och KpsBurnCode. Fältet KpsBurnCode kan utelämnas om prisgruppen är definierad som en prisgrupp avsedd enbart för poängresor, se metoden calculateTravelServiceDetailedPriceBasedOnLightSpecification.

Reviderad 2009-02-04

Input

TravelServiceLightSpecification

Innehåller information om vilken resa man vill boka och vilka önskemål som valts.

VatFree

Anges om resetjänsten skall vara momsfri.

ItineraryConnectedServiceLightSpecification

Innhåller information om vilken resa som skall bokas och värden för olika valbara attribut.

ItineraryResult

Objektreferens till hela resultatobjektet från tidigare gjord tidtabellssökning.

ItineraryReference

Referens till vald förbindelse inom hela resultatobjektet från tidigare gjord tidtabellssökning.

PriceGroupCode

Vald prisgrupp (biljettyp). Valbara prisgrupper har man redan fått som svar i metoden getItineraries().

Group

Om det är en gruppresa sätts detta fält lika med sant, vilket innebär att resenärslistan nedan anger ingående gruppmedlemar.

GroupReference

Om det är en gruppresa kan detta fält innehålla en frivilig text för att hålla ihop gruppen (t ex gruppledarens namn).

TravelDocumentCode

Anger vilka resedokument som ska ingå, endast färd eller endast platsreservation eller både och, dvs bokad resa. Standardvärde är bokad resa om inget annat anges. Följande konstanter ska användas.

• SJPConstants.VTravelDocumentCodeJourney - Endast färdbiljett.
• SJPConstants.VTravelDocumentCodeSeat - Endast platsresevation.
• SJPConstants.VTravelDocumentCodeSeatAndJourney - Bokad resa. Både färdbiljett och platsreservation.
• SJPConstants.TravelDocumentCodeSeparateDocuments - Både färdbiljett och platsreservation men som egna tjänster (var sin beställningsrad).

Offer

Här anges eventuellt ett erbjudande (en fördefinierad tjänst). Erbjudanden hämtas med metoden getOfferList().

PlacementLightSpecification

Här anger man olika platsegenskaper för hela resan, dvs det som anges här gäller all delsträckor där det är tillämpligt. Möjliga värden hämtas med metoden getItineraryCharacteristics(). Det går att göra undantag per delsträcka från dessa generella platsegenskaper genom att fylla i en SectionLightSpecification.PlacementLightSpecification.

ConsumerSingleLightSpecificationList

Här anges en lista med ingående resenärer. Varje resenär har sin egen struktur ComsumerSingleLightSpecification, som innehåller resenärstyp, eventuell rabatt, samt eventuellt restypsval (t ex 10-biljett).

PayerCustomerId

Betalarkundnummer som skall gälla för beställningen.

ContractNo

Avtalsnummer som skall gälla för beställningen.

Output

AddOrderItemResult

Svar ifrån någon av bokningsmetoderna.

OrderDescription

Beskrivning av hur beställningen ser ut efter bokningen. Här ingår de nya beställningsraderna. För vissa typer av klienter filtreras delar av innehållet bort. Filtreringen kan vara olika för olika säljkanaler.

InformationList

Eventuella bokningsavvikelser då bokningen har genomförts. T ex att man fått spridda platser. Det finns olika typer av avvikelser (InformationCategory).

• SJPConstants.VBookingResultInformationCategoryReservation - Avvikelser angående platsreservation.
• SJPConstants.VBookingResultInformationCategoryNoTraveller - Avvikelse att resenärskopplingen har gått fel då man skickat in en TravellerSpecificationList.