Petra2 Java API – SjCustomerInterface.getCustomerData
Method description
Metoden hämtar data för en viss kund enligt specifikation angiven i metodens indata, CustomerSpecification.
Kunden måste vara juridisk (företag) för att få söka resenärer, så en kontroll görs att kunden är juridisk. Om Kunden ej är juridisk och resenärer har begärts, skickas ett felmeddelande tillbaka.
Två möjliga sökningar kan göras vad gäller resenärer:
- Om AllTravellers i CustomerSpecification är true, hämtas data för samtliga resenärer.
- Om AllTravellers i CustomerSpecification är false och en TravellerQuery finns (not null), hämtas data för kunder enligt sökbegrepp definierade i TravellerQuery.
For Javadoc, click here.
Input
CustomerSpecification
Sökbegrepp för getCustomerData
- CustomerData
- Flagga som anger om man vill ha tillbaka grundinformation om kunden i svaret
- OfficialAddress
- Flagga som anger om man vill ha tillbaka kundens officiella address i svaret
- CommunicationAddress
- Flagga som anger om man vill ha tillbaka kundens kontaktaddress i svaret
- DeliveryAddress
- Flagga som anger om man vill ha tillbaka kundens leveransaddress i svaret
- PowerOfAttorney
- Flagga som anger om man vill ha tillbaka information om kundens eventuella fullmakter
- SjCard
- Flagga som anger om man vill ha tillbaka information om kundens eventuella SJ kort
- Contract
- Flagga som anger om man vill ha tillbaka information om kundens avtal
- AllTravellers
- Flagga som anger om man vill ha tillbaka information om resenärer kopplad till ett företag. Kunden man frågar på måste då vara en juridisk person
- AllTravellers
- Frågestruktur för sökning av resenärer. Denna struktur innehåller en XOR struktur där man kan välja antingen sökbegrepp som ger unik träff eller sökbegrepp som kan ge flera träffar.
- CustomerSpecification
- CustomerData:boolean
- OfficialAddress:boolean
- CommunicationAddress:boolean
- DeliveryAddress:boolean
- PowerOfAttorney:boolean
- {SjCard:boolean}
eller (sjCardXor)
- {SjCardInfo:boolean}
- Contract:boolean
- AllTravellers:boolean
- [TravellerQuery:TravellerQuery]
- {TravellerQueryUnique:TravellerQueryUnique}
- {Id:String}
eller (travellerQueryUniqueXor)
- {SocialSecurityNumber:String}
eller (travellerQueryUniqueXor)
- {CreditCardNumber:String}
eller (travellerQueryUniqueXor)
- {CustomerIdCard:String}
eller (travellerQueryXor)
- {TravellerQueryNotUnique:TravellerQueryNotUnique}
- [AreaCode:String]
- [SubscriberTelephoneNumber:String]
- [BirthDate:Date]
- TimeZone:String
- Year:int
- Month:int
- Day:int
- [FirstName:String]
- [LastName:String]
- [OverrideMaximumResult:boolean]
Output
CustomerAll
Utdata från getCustomerData
- CustomerData
- Struktur med grundinformation om kunden, den som är gemensam för fysiska och juridiska personer samt specifik information om den
juridiska kunden om den är juridisk eller fysisk om kunden är fysisk
- CommunicationAddress
- kundens kontaktaddress
- OfficialAddress
- kundens officiella address
- DeliveryAddressList
- Lista med kundens leveransaddresser
- PowerOfAttorneyList
- Lista med kundens eventuella fullmakter
- SjCardList
- Lista med kundens eventuella SJ kort
- FoundTravellers
- Struktur som innehåller information om de resenärer som sökts ut om detta begärts
- Contract
- Kundens avtalsinformation
- CustomerAll
- [CustomerData:CustomerData]
- CommonCustomer:CommonCustomer
- Id:String
- Type:String
- RegisterDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- ChangeDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- ChangeType:String
- LastClearDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- RestrictionCodeSPAR:String
- RestrictionDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- RestrictionCodeCredit:String
- RestrictionCodeCreditDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- TypeOfCommunication:String
- CountryNumber:String
- AreaCode:String
- SubscriberTelephoneNumber:String
- Email:String
- PowerOfAttorneyDeliveryAddressExists:String
- Campaign:String
- [HotelCustomerId:Identity]
- [CustomerNoteList], sekvens av:
- [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]
- {PrivateCustomer:PrivateCustomer}
- SocialSecurityNumber:String
- FirstName:String
- LastName:String
- BirthDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- Priority:String
- Position:String
- PaymentMethod:String
- [UserId:String]
- [PassWord:String]
- MemberDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- Sex:String
- VIPExists:String
- [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]
eller (customerDataXor)
- {CompanyCustomer:CompanyCustomer}
- OrganisationNumber:String
- Name:String
- CompanyName:String
- CompanyForm:String
- AllowedCredit:String
- PaymentConditions:String
- IdRequirement:String
- AgrementExist:String
- SecrecyExist:String
- RekvRequirement:String
- PayerAccountMandatory:Code
- [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]
- [CommunicationAddress:CustomerAddress]
- [AddressNumber:String]
- [StreetNameExtra:String]
- [CountryName:String]
- [CountryCode:String]
- [CareOf:String]
- StreetName:String
- ZipCode:String
- CityName:String
- StartDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- ExpirationDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- AddressType:String
- [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]
- [OfficialAddress:CustomerAddress]
- [AddressNumber:String]
- [StreetNameExtra:String]
- [CountryName:String]
- [CountryCode:String]
- [CareOf:String]
- StreetName:String
- ZipCode:String
- CityName:String
- StartDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- ExpirationDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- AddressType:String
- [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]
- [DeliveryAddressList], sekvens av:
- CustomerAddress
- [AddressNumber:String]
- [StreetNameExtra:String]
- [CountryName:String]
- [CountryCode:String]
- [CareOf:String]
- StreetName:String
- ZipCode:String
- CityName:String
- StartDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- ExpirationDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- AddressType:String
- [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]
- [PowerOfAttorneyList], sekvens av:
- PowerOfAttorney
- [ExpirationDate:Date]
- TimeZone:String
- Year:int
- Month:int
- Day:int
- ExpireDate:IntegerString
- CreditCardNumber:String
- ShortCreditCardName:String
- CareOf:String
- StreetNameExtra:String
- StreetName:String
- ZipCode:String
- CityName:String
- CountryCode:String
- CountryName:String
- [{SjCardList}, sekvens av:
- SjCard
- CardNumber:String
- StartDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- ExpirationDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- CardType:String
- [DiscountCode:String]
- [CardDataTransferenceDate:Date]
- TimeZone:String
- Year:int
- Month:int
- Day:int
eller (sjCardListXor, optionell)
- {SjCardInfoList}], sekvens av:
- SjCardInfo
- SjCard:SjCard
- CardNumber:String
- StartDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- ExpirationDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- CardType:String
- [DiscountCode:String]
- [CardDataTransferenceDate:Date]
- TimeZone:String
- Year:int
- Month:int
- Day:int
- [KpsInfo:KpsInfo]
- [Points:int]
- [Priority:String]
- [KpsCampaignList], sekvens av:
- [KpsCampaign]
- KpsCampaignName:String
- KpsCampaignDescription:String
- KpsCampaignStartDate:String
- [FoundTravellers:FoundTravellers]
- TravellerShortList, sekvens av:
- [TravellerShort]
- Id:String
- FirstName:String
- LastName:String
- BirthDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- Priority:String
- [ReferenceInformation:String]
- [FromDate:Date]
- TimeZone:String
- Year:int
- Month:int
- Day:int
- [TomDate:Date]
- TimeZone:String
- Year:int
- Month:int
- Day:int
- [CustomerRoleCode:Code]
- [AreaCode:String]
- [SubscriberTelephoneNumber:String]
- [MobilePhoneNumber:String]
- MoreToGet:boolean
- [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]
- [Contract:Contract]
- contractNo:String
- contractType:String
- contractHasNetDiscounts:boolean
- salesDepHasNetDiscounts:boolean
- [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]
- [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]