Petra2 Java API – SjStinaInformationProviderInterface.calculateTravelServiceTransportDetailedPriceBasedOnSpecification
Method description
Metoden användas för att ställa en prisfråga och hämta detaljerat pris för en eller flera tjänster kopplade till en förbindelse med fler delsträckor utan någon uppsökt tidtabell.
I stället för en tidtabell (ItineraryReference) används en lista av delsträckor (TransportSectionSpecificationList) som indata. Eftersom inget tidtabellssvar (Itinerary) finns som grund till prisfrågan byggs en förbindelse upp internt i StinaServer med hjälp av de delsträckor som finns i frågan. Denna förbindelse används sedan vid prisfråga mot det centrala systemet.
När en tidtabell (Itinerary) finns tillgänglig ska i stället metoden calculateTravelServiceDetailedPriceBasedOnLightSpecification användas.
For Javadoc, click here.
Input
TravelServiceTransportDetailedPriceSpecification
- TravelServiceTransportDetailedPriceSpecification
- TransportItinerarySpecificationList, sekvens av:
- TransportItinerarySpecification
- ItineraryReference:ObjectStringRef
- [JourneyConnectionReference:String]
- [Resplus:String]
- TransportSectionSpecificationList, sekvens av:
- TransportSectionSpecification
- TransportSpecification:TransportSpecification
- DepartureLocation:LocationQuery
- LocationQueryField:String
- ProducerCode:Code
- ArrivalLocation:LocationQuery
- LocationQueryField:String
- ProducerCode:Code
- DepartureDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- [DepartureTime:Time]
- TimeZone:String
- Hour:int
- Minute:int
- [Second:int]
- [ArrivalDate:Date]
- TimeZone:String
- Year:int
- Month:int
- Day:int
- [ArrivalTime:Time]
- TimeZone:String
- Hour:int
- Minute:int
- [Second:int]
- [TravelMethodCode:Code]
- [TransportId:Identity]
- ProductCode:Code
- [SectionProducer:Code]
- [TravelRoute:IntegerString]
- [Bookable:boolean]
- [BookingRule:String]
- [TransportInformationCodeList], sekvens av:
- [AvailableBookingClass:String]
- [ViaLocationList], sekvens av:
- Location
- ProducerCode:Code
- LocationId:Identity
- LocationName:String
- [LocationLongName:String]
- [HotelLocationId:Identity]
- [LocationCode:String]
- [ExistsInTimetable:boolean]
- [SectionReference:ObjectStringRef]
- [ServiceBrandInformation:ServiceBrandInformation]
- [ServiceBrandName:String]
- [PriceGroupCodeWithOptionList], sekvens av:
- PriceGroupCodeWithOption
- PriceGroupCode:Code
- [PriceQuoteState:String]
- [OptionSpecificationList], sekvens av:
- OptionSpecification
- ComponentNumber:IntegerString
- VariantNumber:IntegerString
- [SectionReference:ObjectStringRef]
- [PriceGroupCodeWithOptionList], sekvens av:
- PriceGroupCodeWithOption
- PriceGroupCode:Code
- [PriceQuoteState:String]
- [OptionSpecificationList], sekvens av:
- OptionSpecification
- ComponentNumber:IntegerString
- VariantNumber:IntegerString
- [SectionReference:ObjectStringRef]
- [TransportSectionsOrigin:String]
- [ExternalEventSpecification:ExternalEventSpecification]
- [Group:boolean]
- [GroupReference:String]
- [TravelDocumentCode:Code]
- [Offer:Identity]
- [CampaignCode:Code]
- [PlacementLightSpecification:PlacementLightSpecification]
- [SmokingDepartment:String]
- [PlacementCharacteristics:String]
- [PlacementOrientation:String]
- [CompartmentCode:Code]
- [CarriageId:Identity]
- [PlacementNumber:Identity]
- [NeighbourPlacement:boolean]
- [PlacementDirection:String]
- [CustomerId:Identity]
- [ContractNo:String]
- [VatFree:boolean]
- [IncludeDetails:boolean]
- [DetailedPriceQuote:boolean]
- ConsumerSingleLightSpecificationList, sekvens av:
- ConsumerSingleLightSpecification
- [Traveller:TravellerSpecification]
- [{CustomerId:Identity}
eller (customerXor, optionell)
- [TravellerCustomerId:Identity]
- FirstName:String
- LastName:String
- [CountryOfOrigin:String]
- [TravellerPassNumber:String]
- [BirthDate:Date]
- TimeZone:String
- Year:int
- Month:int
- Day:int
- [ExternalCustomerReference:String]
- [FormOfIdentification:ETicketCard]}
- CardType:String
- CardNumber:String
- [EncryptedCardNumber:EncryptedDataInfo]
- EncryptionRoutineId:String
- EncryptionRoutineVersion:String
- EncryptedData:ByteArray
- [MembershipIdentification:MembershipIdentification]
- CardType:String
- CardNumber:String
- [TravellerExtraInfoSpecification:TravellerExtraInfoSpecification]
- [MobilePhoneNumber:String]
- [MultiRideTicketNumber:String]
- Category:String
- [DiscountCode:Code]
- [KpsBurnCode:Code]
- [TravelType:String]
- [OptionSpecificationList], sekvens av:
- OptionSpecification
- ComponentNumber:IntegerString
- VariantNumber:IntegerString
- [SectionReference:ObjectStringRef]
- [SectionLightSpecificationList], sekvens av:
- SectionLightSpecification
- SectionReference:ObjectStringRef
- [PriceLevelCode:Code]
- [TravelDocumentCode:Code]
- [PlacementSpecification:PlacementSpecification]
- [Comfort:String]
- [PlacementType:String]
- [PlacementCharacteristics:String]
- [PlacementOrientation:String]
- [SmokingDepartment:String]
- [CompartmentCode:Code]
- [CompartmentSize:Code]
- [CarriageId:Identity]
- [PlacementNumber:Identity]
- [NeighbourPlacement:boolean]
- [PlacementDirection:String]
Output
TravelServiceTransportDetailedPriceResult
Strukturen utgör utdata för metoden och returnerar priser för den specificerade förbindelsen, resenärer och tillval.
Här beskrivs endast vissa av elementen i TravelServiceDetailedPriceLight. För de enkla fälten finns förklaringar vid respektive fält.
- TravelServiceDetailedPriceLight
-
- TravelServiceDetailedPriceLight innehåller samtliga resenärers priser i en viss prisgrupp.
- PriceGroupCode
- Aktuell prisgrupp.
- Price
- Summan av samtliga tjänsters (PriceItemLightDescription) priser inklusive alla tillvalskomponenter och alla deras varianter och därför bör fältet endast användas vid en specifik prisfråga.
- Points
- Summan av samtliga tjänsters priser inklusive alla tillvalskomponenter och alla deras varianter uttryckt i SJ Prio-poäng för poängtjänster. Detta fält används enbart för SJ-tjänster, som kan betalas med SJ Prio-poäng och bör endast användas vid en specifik prisfråga.
- PriceItemLightList
- En lista med priser för respektive resenär.
- Price
- Summan av priserna för tjänstens samtliga komponenter och alla deras varianter och därför bör fältet endast användas vid en specifik prisfråga. För att presentera ett korrekt tjänstepris ska BasePriceDescription.PriceInclVat, PlacementPriceDescription.PriceInclVat och Variant.Price för de valda tillvalskomponentvarianterna summeras.
- ExchangeVoucherAmount
- Tjänstens ombokningsvärde.
- OtherProducersFees
- Summan av av tjänstens samtliga komponentvarianters bokningsavgift och därför bör fältet endast användas vid en specifik prisfråga.
- BasePriceDescription
- Fr o m 2009-03-21 basresan, som består av färdkomponenter, obligatoriska platskomponenter och obligatoriska tillvalskomponenter inklusive de vars pris ska särredovisas som ett "varav-pris".
- PriceInclVat
- Basresans pris. Observera att även de obligatoriska tillvalskomponenter, vars pris ska särredovisas som ett "varav-pris", ingår här.
- SeparateServiceOptionList
- De obligatoriska tillvalskomponenter, vars pris ska särredovisas som ett "varav-pris", t ex Stationsavgift Arlanda C.
- TransportPriceDescription
- Summan av färdkomponenternas priser. Färdkomponenternas priser ska aldrig presenteras var för sig eftersom alla färdkomponenter måste säljas tillsammans för att bilda en komplett resa. Fr o m 2009-03-21 används inte denna struktur. Priset på färdkomponenterna ingår i stället i BasePriceDescription.
- PlacementPriceDescription
- Samtliga platskomponenter finns med i denna struktur.
- PriceInclVat
- Summan av de frivilliga platskomponenternas priser. De obligatoriska platskomponenternas priser ingår i BasePriceDescription.
- PlacementPriceSectionDescriptionList
- En lista med samtliga platskomponenter i varsin PlacementPriceSectionDescription.
- PriceInclVat
- Platskomponentens pris, om den är frivillig. En obligatorisk platskomponents pris ingår i BasePriceDescription.
- DepartureLocation
- Stationen där resan börjar, dvs första delsträckans frånstation.
- ArrivalLocation
- Stationen där resan slutar, dvs sista delsträckans tillstation.
- ServiceOptionList
- En lista med möjliga tillvalskomponenter i varsin ServiceOption och deras varianter. Om tillvalet bara finns på en delsträcka identifieras den med SectionReference. Om tillvalet gäller hela resan finns ingen SectionReference.
- OptionDescription
- En beskrivning av tillvalskomponenten.
- VariantNumber
- Fr o m 2009-03-21 används inte detta fält. I stället returneras tillvalskomponentens möjliga varianter i VariantList.
- VariantList
- Fr o m 2009-03-21 en lista med de olika varianterna av tillvalskomponenten i varsin Variant.
- Price
- Tillvalskomponentvariantens pris. De tillvalskomponenter som finns i SeparateServiceOptionList har inget pris här för att undvika felaktig summering av priser.
- Mandatory
- Fr o m 2009-03-21 markerar detta fält att tillvalskomponenten är obligatorisk.
- Price
- Fr o m 2009-03-21 finns priset för tillvalskomponenten endast i bokningssvar, aldrig i svaret på en prisfråga. Priset på respektive tillvalskomponentvariant finns i stället i VariantList.
- Points
- Tjänstens pris inklusive alla tillvalskomponenter och alla deras varianter uttryckt i SJ Prio-poäng för poängtjänster. Detta fält används enbart för SJ-tjänster, som kan betalas med SJ Prio-poäng och bör endast användas vid en specifik prisfråga.
- ServiceName
- Varunamnet är en beteckning på tjänst eller vara som ingår i försäljningsutbudet, t ex Normalbiljett.
- DiscountTypeList
- Här redovisas om någon av resenärerna i ConsumerDescription har någon form av rabatt samt hur mycket den i så fall utgör av det aktuella priset. Bör endast användas för en specifik prisfråga.
- ConsumerDescriptionList
- Innehåller en lista med alla resenärernas resenärstyp.
- PriceSectionDescriptionList
- Innehåller för vissa klientapplikationer en beskrivning av resans delsträckor.
- TravelServiceTransportDetailedPriceResult
- TravelServiceDetailedPriceLightList, sekvens av:
- TravelServiceDetailedPriceLight
- ItineraryReference:ObjectStringRef
- [JourneyConnectionReference:String]
- PriceGroupCode:Code
- [{PriceCoefficient:String}
eller (priceCoefficientXor, optionell)
- {PriceQuoteState:String}]
- [Price:PriceVat]
- PriceInclVat:Money
- CurrencyCode:Code
- Amount:DecimalString
- Vat:Money
- CurrencyCode:Code
- Amount:DecimalString
- [VatPercentage:DecimalString]
- [Points:int]
- PriceItemLightList, sekvens av:
- PriceItemLightDescription
- [Price:PriceVat]
- PriceInclVat:Money
- CurrencyCode:Code
- Amount:DecimalString
- Vat:Money
- CurrencyCode:Code
- Amount:DecimalString
- [VatPercentage:DecimalString]
- [isTrustWorthy:boolean]
- [ExchangeVoucherAmount:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [OtherProducersFees:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [BasePriceDescription:BasePriceDescription]
- PriceInclVat:Money
- CurrencyCode:Code
- Amount:DecimalString
- [OtherProducersFees:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [ExchangeVoucherAmount:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [SeparateServiceOptionList], sekvens av:
- [ServiceOption]
- OptionDescription:OptionDescription
- TypeOfOption:String
- ComponentNumber:IntegerString
- [VariantNumber:IntegerString]
- [Description:String]
- [VariantList], sekvens av:
- Variant
- VariantNumber:IntegerString
- Description:String
- [DefaultVariant:boolean]
- [Price:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [OtherProducersFees:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [ExchangeVoucherAmount:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [SummarizeAmountCode:Code]
- [PaymentInformationList], sekvens av:
- PaymentInformation
- PaymentType:Code
- [CardNumber:String]
- Amount:Money
- CurrencyCode:Code
- Amount:DecimalString
- [VariantHelpText:String]
- [OptionHelpText:String]
- [Mandatory:boolean]
- [Price:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [SectionReference:ObjectStringRef]
- [TransportPriceDescription:TransportPriceDescription]
- PriceInclVat:Money
- CurrencyCode:Code
- Amount:DecimalString
- [PlacementPriceDescription:PlacementPriceDescription]
- PriceInclVat:Money
- CurrencyCode:Code
- Amount:DecimalString
- [PlacementPriceSectionDescriptionList], sekvens av:
- [PlacementPriceSectionDescription]
- SectionReference:ObjectStringRef
- [PriceInclVat:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [OtherProducersFees:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [ExchangeVoucherAmount:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [Mandatory:boolean]
- [DefaultReservation:boolean]
- [DepartureLocation:Location]
- ProducerCode:Code
- LocationId:Identity
- LocationName:String
- [LocationLongName:String]
- [HotelLocationId:Identity]
- [LocationCode:String]
- [ExistsInTimetable:boolean]
- [ArrivalLocation:Location]
- ProducerCode:Code
- LocationId:Identity
- LocationName:String
- [LocationLongName:String]
- [HotelLocationId:Identity]
- [LocationCode:String]
- [ExistsInTimetable:boolean]
- [ServiceOptionList], sekvens av:
- ServiceOption
- OptionDescription:OptionDescription
- TypeOfOption:String
- ComponentNumber:IntegerString
- [VariantNumber:IntegerString]
- [Description:String]
- [VariantList], sekvens av:
- Variant
- VariantNumber:IntegerString
- Description:String
- [DefaultVariant:boolean]
- [Price:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [OtherProducersFees:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [ExchangeVoucherAmount:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [SummarizeAmountCode:Code]
- [PaymentInformationList], sekvens av:
- PaymentInformation
- PaymentType:Code
- [CardNumber:String]
- Amount:Money
- CurrencyCode:Code
- Amount:DecimalString
- [VariantHelpText:String]
- [OptionHelpText:String]
- [Mandatory:boolean]
- [Price:Money]
- CurrencyCode:Code
- Amount:DecimalString
- [SectionReference:ObjectStringRef]
- [Points:int]
- [ServiceName:String]
- [DiscountTypeList], sekvens av:
- DiscountType
- DiscountType:String
- DiscountList, sekvens av:
- Discount
- DiscountCode:Code
- NumberOfDiscounts:IntegerString
- Amount:Money
- CurrencyCode:Code
- Amount:DecimalString
- [ConsumerDescriptionList], sekvens av:
- [TravelType:String]
- [PriceSectionDescriptionList], sekvens av:
- PriceSectionDescription
- PriceDepartureLocation:PriceLocation
- ProducerCode:Code
- LocationId:Identity
- LocationName:String
- DepartureDateTime:DateTime
- TimeZone:String
- Year:int
- Month:int
- Day:int
- Hour:int
- Minute:int
- [Second:int]
- PriceArrivalLocation:PriceLocation
- ProducerCode:Code
- LocationId:Identity
- LocationName:String
- ArrivalDateTime:DateTime
- TimeZone:String
- Year:int
- Month:int
- Day:int
- Hour:int
- Minute:int
- [Second:int]
- ProductCode:Code
- TransportId:Identity
- [PriceTransportDescription:PriceTransportDescription]
- PriceLevelCode:Code
- TravelMethodCode:Code
- [ViaStringList], sekvens av:
- [SectionReference:ObjectStringRef]
- [ClientInformation:ClientInformation]
- ClientSessionData:ClientSessionData
- SessionId:String
- [SessionLanguageCode:String]
- [OrderNumber:String]
- [CustomerRoleCode:Code]
- [OrderCreatorCustomerId:String]
- [LockId:String]
- [ClientVersion:String]
- Protocol:Protocol
- Compressed:boolean
- [Algorithm:String]
- [Encoding:String]
- [CachePolicy:String]
- [TimeInformation], sekvens av:
- [TimeInformation]
- [CloneName:String]
- Description:String
- MethodName:String
- Time:String
- LogTime:String
- [TimeInformation:TimeInformation]
- [InitialCloneName:String]
- [ExternalEventSpecification:ExternalEventSpecification]
- [OverrideTimeLogLevel:boolean]