Petra2 Java API – SjStinaInformationProviderInterface.findOrder

Method description

Metoden söker efter beställningar som matchar angivet sökkriterium. Det går att söka på en rad olika attribut:

TicketId – Biljettnummer
PayerCustomerId – Betalarens eller Orderskaparens (OrderCreator) kundnummer
TravellerCustomerId – Resenärens kundnummer
ReferenceQuery – En struktur för ange en referens till en beställning i stället för kundnummer. OBS! FirstName och LastName alternativt Telephone måste vara ifyllt. Detta styrs med affärsregler. Referensadress är frivilligt och lagras i orderboken.
TorgetId – Deprecated.
OccasionalTravellerQuery – Data för sökning av tillfällig resenär med namn och ev betalande kundnummer
TravellerCustomerQuery
OrderCreatorQuery

Sökningen returnerar en lista med matchande OrderElements. Man kan ange ett "från och med"-uthämtningsdatum om man vill begränsa sökningen, se FromRetrievalDate. Man kan också begränsa sökningen med hjälp av OrderStatusCategory. Möjliga värden där är:

Code: 0 - Alla

Code: 1 - Ej uthämtade

Code: 2 - Endast uthämtade

För att hämta beställningen används metoden getOrderDescription.

Reviderad 2009-04-27

For Javadoc, click here.

Input

OrderQuery

OrderQuery

[{TicketId:Identity}
eller (orderQueryXor, optionell)

(beskrivning av TicketId)

{PayerCustomerId:Identity}
eller (orderQueryXor, optionell)

(beskrivning av PayerCustomerId)

{TravellerCustomerId:Identity}
eller (orderQueryXor, optionell)

(beskrivning av TravellerCustomerId)

{ReferenceQuery:ReferenceQuery}

[OrderReferenceSpecification:ReferenceSpecification]

[FirstName:String]

(beskrivning av FirstName)

[LastName:String]

(beskrivning av LastName)

[Telephone:Telephone]

[CountryPart:IntegerString]

(beskrivning av CountryPart)

AreaPart:IntegerString

(beskrivning av AreaPart)

MainPart:IntegerString

(beskrivning av MainPart)

[ExtensionPart:IntegerString]

[EmailAddress:String]

(beskrivning av EmailAddress)

[ReferenceAddress:Address]

StreetName:String

(beskrivning av StreetName)

[StreetNameExtra:String]

(beskrivning av StreetNameExtra)

ZipCode:String

(beskrivning av ZipCode)

CityName:String

(beskrivning av CityName)

[CountryName:String]

(beskrivning av CountryName)

[CountryCode:String]

(beskrivning av CountryCode)

[RegionName:String]
[CareOf:String]

(beskrivning av CareOf)

{TravelAgentCustomerId:Identity}
eller (referenceQueryTravelAgentXor)

(beskrivning av TravelAgentCustomerId)

{OnlyCurrentSalesUnit:boolean}

eller (orderQueryXor, optionell)

{TorgetId:Identity}
eller (orderQueryXor, optionell)

(beskrivning av TorgetId)

{OccasionalTravellerQuery:OccasionalTravellerQuery}

OccasionalTraveller:OccasionalTraveller

FirstName:String

(beskrivning av FirstName)

LastName:String

(beskrivning av LastName)

[PayerCustomerId:Identity]

(beskrivning av PayerCustomerId)

eller (orderQueryXor, optionell)

{TravellerCustomerQuery:TravellerCustomerQuery}

TravellerCustomerId:Identity

(beskrivning av TravellerCustomerId)

[PayerCustomerId:Identity]

(beskrivning av PayerCustomerId)

eller (orderQueryXor, optionell)

{OrderCreatorQuery:OrderCreatorQuery}

OrderCreator:Identity

(beskrivning av OrderCreator)

[PayerCustomerId:Identity]

(beskrivning av PayerCustomerId)

eller (orderQueryXor, optionell)

{DepartureDateQuery:DepartureDateQuery}

NumberOfDaysToDeparture:IntegerString

eller (orderQueryXor, optionell)

{SpecialMailDistributionQuery:SpecialMailDistributionQuery}]

RetrievalDate:Date

TimeZone:String
Year:int
Month:int
Day:int

MaximumNumberOfOrders:IntegerString
[SalesUnitId:String]

(beskrivning av SalesUnitId)

[OrderId:Identity]

(beskrivning av OrderId)

[FromRetrievalDate:Date]

TimeZone:String
Year:int
Month:int
Day:int

[ToRetrievalDate:Date]

TimeZone:String
Year:int
Month:int
Day:int

[OrderStatusCategory:Code]

(beskrivning av OrderStatusCategory)

[OrderStatusCategoryList], sekvens av:

Code

Output

FindOrderResult

FindOrderResult

OrderElementList, sekvens av:

OrderElement

OrderId:Identity

(beskrivning av OrderId)

OrderStatus:OrderStatus

(beskrivning av OrderStatus)

[RetrievalDate:Date]

TimeZone:String
Year:int
Month:int
Day:int

[PayerCustomerId:Identity]

(beskrivning av PayerCustomerId)

[OrderReference:ReferenceSpecification]

[FirstName:String]

(beskrivning av FirstName)

[LastName:String]

(beskrivning av LastName)

[Telephone:Telephone]

[CountryPart:IntegerString]

(beskrivning av CountryPart)

AreaPart:IntegerString

(beskrivning av AreaPart)

MainPart:IntegerString

(beskrivning av MainPart)

[ExtensionPart:IntegerString]

[EmailAddress:String]

(beskrivning av EmailAddress)

[ReferenceAddress:Address]

StreetName:String

(beskrivning av StreetName)

[StreetNameExtra:String]

(beskrivning av StreetNameExtra)

ZipCode:String

(beskrivning av ZipCode)

CityName:String

(beskrivning av CityName)

[CountryName:String]

(beskrivning av CountryName)

[CountryCode:String]

(beskrivning av CountryCode)

[RegionName:String]
[CareOf:String]

(beskrivning av CareOf)

[TravelAgentCustomerId:Identity]

(beskrivning av TravelAgentCustomerId)

[TravelAgentCustomerName:String]

(beskrivning av TravelAgentCustomerName)

[PaymentDate:Date]

TimeZone:String
Year:int
Month:int
Day:int

[OrderCreator:Identity]

(beskrivning av OrderCreator)

[DepartureDate:Date]

TimeZone:String
Year:int
Month:int
Day:int

[ClientInformation:ClientInformation]

ClientSessionData:ClientSessionData

SessionId:String
[SessionLanguageCode:String]
[OrderNumber:String]

(beskrivning av OrderNumber)

[CustomerRoleCode:Code]

(beskrivning av CustomerRoleCode)

[OrderCreatorCustomerId:String]
[LockId:String]
[ClientVersion:String]

Protocol:Protocol

Compressed:boolean
[Algorithm:String]
[Encoding:String]
[CachePolicy:String]

[TimeInformation], sekvens av:

[TimeInformation]

[CloneName:String]
Description:String

(beskrivning av Description)

MethodName:String
Time:String
LogTime:String

(beskrivning av LogTime)

[TimeInformation:TimeInformation]

[InitialCloneName:String]
[ExternalEventSpecification:ExternalEventSpecification]

[SalesUnitId:String]

(beskrivning av SalesUnitId)

[OverrideTimeLogLevel:boolean]