Service: CatalogService

Version: 1_32 (other versions, change log) Latest stable version. Please base all your developments on this one.

SOAP Demo endpoint: https://secutix.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.catalog.v1_32.CatalogService.webservice?wsdl

To get the endpoint for your own institution, replace "secutix" (just after https://) in the url by your own institution code.

For further documentation and examples, please check in Platform Website.

Methods:

getCatalogDetailed

Extracts the catalog as defined for the sales channel linked to the account.

Only RUNNING or SUSPENDED objects are exported. This method returns the current status of the catalog.

Warning : this method may be asynchronous.

Catalog is returned as a set of objects.

Parameters

requestIdIntegeroptional request id, used to identify asynchronous requests (see {@link AsynchronousMethod}.
seasonCodeString (8)optional season code to restrict the returned data.
productCodeString (8)optional product code to restrict the returned data.
scope(ON_SALE|EXTENDED)Scope of the catalog. Not mandatory. Default value is : ON_SALE. ON_SALE: all products on sale related to sales channel. EXTENDED: catalog also includes validated, suspended and cancelled products.

Return value

CatalogResultDetailed
catalogDataCatalogData     
requestStateAsynchronousMethodResult.
AsynchronousMethodState
     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

CatalogData
contactProductLinksList of ContactProductLink     
externalVerificationsList of ExternalVerification     
groupCriterionsList of GroupCriterionData     
physicalConfigurationsList of PhysicalConfiguration     
seasonsList of Season     
storefrontStorefront     
visitGroupKindsList of VisitGroupKind     
visitLanguagesList of VisitLanguage     
visitThemesList of VisitTheme     

ContactProductLink
contactNumberString (20)     
contactProductConnectionType(RESPONSIBLE|OBSERVER|
INVOICE|ARTIST)
     
descriptionString     
idLong     
photoImage     
rankint     
stageNameString     

Image
largeString     
mediumString     
smallString     
xlargeString     

ExternalVerification
descriptionExternalName2000 characters max for each translation
externalNameExternalName60 characters max for each translation
field1NameExternalName     
field2NameExternalName     
idLong     
logoString     
numberOfTicketsPerCardLong     

ExternalName
translationsList of Translation     

Translation
localeString (2)     
valueString     

GroupCriterionData
codeString (8)     
elementsList of GroupCriterionElementData     
externalNameExternalName60 characters max for each translation
idLong     
planningRequirementboolean     
rankint     

GroupCriterionElementData
codeString (8)     
externalNameExternalName60 characters max for each translation
idlong     
rankint     

PhysicalConfiguration
areasList of Area     
codeString (8)     
countryCodeString (8)     
externalNameExternalName60 characters max for each translation
formattedAddressString     
idLong     
imageString     
mapTypeString     
panoViewUrlString (255)     
pdfViewString     
seatMapImageImage     
securityGaugeInteger     
siteCodeString (8)     
siteExternalNameExternalName60 characters max for each translation
siteIdLong     
siteKindCodeString (8)     
siteKindNameExternalName     
spaceCodeString (8)     
spaceExternalNameExternalName60 characters max for each translation
spaceIdLong     
spaceTypeString     
streetString     
townString     
zipcodeString (8)     

Area
blocksList of Block     
codeString (8)     
externalNameExternalName60 characters max for each translation
floorString     
idLong     
internalNameExternalName60 characters max for each translation
kind(INDIFFERENT|BOX)     
physicalGaugeInteger     
sectorString     
shapesList of Shape     
type(NUMBERED_SEAT|
NOT_NB_SEAT|
NOT_NB_STAND_SEAT)
     

Block
codeString (8)     
externalNameExternalName60 characters max for each translation
idLong     
internalNameExternalName60 characters max for each translation
shapesList of Shape     

Shape
xList of Integer     
yList of Integer     

Season
advantagesList of Advantage     
audienceCategoriesList of AudienceCategory     
chargesTablesList of ChargesTable     
codeString (8)     
competitionTypesList of CompetitionType     
conditionalCrossSellsList of ConditionalCrossSell     
endDate     
externalNameExternalName60 characters max for each translation
goodsFamiliesList of GoodsFamily     
goodsTopicsList of GoodsTopic     
hospitalityRoomsList of HospitalityRoom     
hospitalitySessionsList of HospitalitySession     
idLong     
logicalConfigurationsList of LogicalConfiguration     
numLong     
optionLimitationLinesList of OptionLimitationLine     
optionablesList of Optionable     
priceComponentsList of PriceComponent     
priceLevelsList of PriceLevel     
productTypesList of ProductType     
productsList of Product     
questionnairesList of Questionnaire     
questionsList of Question     
rateTypesList of RateType     
ratesTablesList of RatesTable     
sitesList of Site     
startDate     
state(PREPARING|VALIDATED|
RUNNING|SUSPENDED|
CANCELED|CLOSED|
CANCELED_CLOSED)
     
teamsList of Team     
timeslotsList of Timeslot     
topicsList of Topic     

Advantage
accessCodeString (8)     
advantageTargetType(PUBLIC|CODE|CONTACT)     
advantageType(ADVANTAGE|RULESET|
PROMO)
     
allowPurchaseCulturalContactboolean     
autoPromoteboolean     
codeString (8)     
contactLimitation(LIMITED|NOT_LIMITED)     
discountAmountLong     
discountPaymentMethodIdLong     
endDate     
endRelativeLong     
exclusiveboolean     
externalDescriptionExternalName2000 characters max for each translation
externalNameExternalName60 characters max for each translation
freeShipmentModeIdsList of LongIf this list is not empty, this is an advantage for free shipment fee. Shipment modes for which no shipment fees will be charged.
idLong     
imageImage     
largeImageUrlString (255)     
logoString     
mandatoryContactboolean     
maxOrderQuantityLong     
maxQuantityPerPerformanceInteger     
mediumImageUrlString (255)     
performanceEndDateType(NONE|TIME_TOLERANCE|
ABSOLUTE|RELATIVE)
     
productsList of Product     
singleSeatCatPerPerformanceboolean     
smallImageUrlString (255)     
startDate     
startRelativeLong     
state(PREPARING|VALIDATED|
RUNNING|SUSPENDED|
CANCELED|CLOSED|
CANCELED_CLOSED)
     

Product
additionalPartnerContactNumberString (20)     
additionalState(SOON_ON_SALE|ON_SALE|
TEMPORARY_UNAVAILABLE|
SALES_ENDED|CANCELED|
MOVED_OR_POSTPONED|
TOO_LATE_FOR_SHIPPING|
ONLY_AVAI_AT_BOXOFFICE|
SOLD_OUT)
     
allowQuestionnaireboolean     
audienceTypeString     
chargesTableIdLong     
codeString (8)     
comfortVariableValuesList of ComfortVariableValue     
contactProductLinkIdsList of Long     
crossSellProductLinksList of CrossSellProductLink     
culturalContact(MANDATORY|OPTIONAL|
NONE)
     
detailURLString (255)     
eventEvent     
exchangeablebooleanIf true product can be exchanged provided that the tariff used for the purchase is also allowed for exchange
externalDescriptionExternalName2000 characters max for each translation
externalNameExternalName60 characters max for each translation
goodsGoods     
grantedToTourPromoterboolean     
hospitalityHospitality     
idLong     
internalNameExternalName60 characters max for each translation
invoicePartnerContactNumberString (20)     
largeImageUrlString (255)     
logoString     
maxQuantityInteger     
mediaList of Media     
mediumImageUrlString (255)     
membershipMembership     
minQuantityInteger     
optionAvailabilitiesList of OptionAvailability     
packPackage     
partnerContactIdLongInternal storage field only, should not be exported in versioned DTO
partnerContactNumberString (20)     
passPass     
prevSeasonProductIdLongId of the equivalent product in previous season.
productFamilySubType(SIMPLE_TICKET|
SEASONTICKET|MEMBERSHIP|
PACKAGE|STAY|SERVICE|
VOUCHER|DONATION|GOODS|
VISIT|OPEN|OPEN_PASS|
DATE_SPECIFIC_PASS|
SPORTING_EVENT|RAILAWAY|
HOTEL|MUSEUM|ENTERT_PARK|
RESTAURANT|PRODLIB|
TIMESLOT_PASS|HOSPITALITY|
HOSPITALITY_PACKAGE|
CANCELLATION_INSURANCE|
VISIT_PASS)
     
productFamilyType(SINGLE_ENTRY|
SEASONTICKET|PASS|PACKAGE|
MEMBERSHIP|SERVICE|GOODS|
TRANSPORT|HOSPITALITY)
     
productSocialNetworkLinksList of ProductSocialNetworkLink     
productTypeIdLong     
questionnaireIdLong     
saleCloseExceptionsList of SaleCloseException     
salePeriodsList of SalePeriod     
seasonTicketSeasonTicket     
serviceService     
shortNameExternalName15 characters max for each translation
smallImageUrlString (255)     
state(PREPARING|VALIDATED|
RUNNING|SUSPENDED|
CANCELED|CLOSED|
CANCELED_CLOSED)
     
stopsList of Stop     
subTopicLinksList of SubTopicLink     
ticketModelIdLong     
transportTransport     
vatCodeIdLong     
waitingListAllowedBoolean     
xlargeImageUrlString (255)     

ComfortVariableValue
codeString (8)code of comfort variable corresponding to comfort variable value. This is mandatory parameter for updating comfortvariable values
endDateDate     
externalNameExternalNametranslations for comfort variable. - 60 characters max for each translation
startDateDate     
valueExternalNameExternalNametranslations for comfort variable value. Translation in institution's main external language is mandatory for creating/updating comfortvariable values - 60 characters max for each translation

CrossSellProductLink
baseMinQuantityInteger     
baseRestrictedPerformanceIdsList of Long     
baseRestrictedSeatCatsIdsList of Long     
descriptionExternalName2000 characters max for each translation
endDate     
externalNameExternalName60 characters max for each translation
idLong     
rankInteger     
salesChannelIdLong     
startDate     
targetAudienceSubCatIdsList of Long     
targetProductIdLong     
targetProductRankInteger     
targetQuantityInteger     
targetQuantityType(FIXED|PROPORTIONAL|ANY)     
targetRestrictedPerformanceIdsList of Long     
targetRestrictedSeatCatIdsList of Long     
targetSameDateAsBaseBoolean     
type(SUGGESTION|
CROSS_SELL_OUT|
CROSS_SELL_IN|UP_SELL|
COND_CROSS_SELL)
     

Event
activityCodeString (8)     
activityExternalNameExternalName60 characters max for each translation
activityIdLong     
activityType(LIVE_SPECT|FESTIVAL|
MUSEUM|VISIT|ENTERT_PARK|
FAIR|PARKING|SPORT|OTHER|
TOURNAMENT_SESSION)
     
alertRatioString     
competitionTypeIdLong     
languageString     
minimumAgeLong     
nameAddOnExternalName240 characters max for each translation
performancesList of Performance     
timeToleranceLong     

Performance
SalePeriodsList of SalePeriod     
additionalState(SOON_ON_SALE|ON_SALE|
TEMPORARY_UNAVAILABLE|
SALES_ENDED|CANCELED|
MOVED_OR_POSTPONED|
TOO_LATE_FOR_SHIPPING|
ONLY_AVAI_AT_BOXOFFICE|
SOLD_OUT)
     
alwaysAllowIsolatedSeatsBoolean     
blockComparisonEnabledboolean     
breaksQuantityInteger     
chargesList of Charge     
chargesTableIdLong     
codeString (8)     
comfortVariableValuesList of ComfortVariableValue     
durationInteger     
eventExternalNameExternalName60 characters max for each translation
externalDescriptionExternalName2000 characters max for each translation
externalNameExternalName60 characters max for each translation
externalShortNameExternalName15 characters max for each translation
forceNominativeTicketsBoolean     
idLong     
imageString     
internalDescriptionExternalName2000 characters max for each translation
internalNameExternalName60 characters max for each translation
itemIdsList of Long     
kindString     
kindExternalNameExternalName60 characters max for each translation
locationLocation     
logicalConfigurationIdLong     
logoString     
logoImageImage     
matchMatch     
maxSeatsPerOrderInteger     
nameAddOnExternalName240 characters max for each translation
numberedBoolean     
performanceSocialNetworkLinksList of PerformanceSocialNetworkLink     
performanceType(PERFORMANCE|VISIT|MATCH|
PARKING)
     
physicalConfigurationIdLong     
pricesList of Price     
rateTypeCodeString (8)     
rateTypeIdLong     
ratesTableIdLong     
saleCloseExceptionsList of SaleCloseException     
saleConfigurationIdLong     
seatCategoriesList of SeatCategory     
seatSelectionMode(AUTO|MANUAL|
MANUAL_OR_AUTO|
WITHOUT_MAP|
WITHOUT_SEATING)
     
siteCodeString (8)     
siteExternalNameExternalName60 characters max for each translation
spaceCodeString (8)     
spaceExternalNameExternalName60 characters max for each translation
spaceIdLong     
startDate     
state(PREPARING|VALIDATED|
RUNNING|SUSPENDED|
CANCELED|CLOSED|
CANCELED_CLOSED)
     
titlingBoolean     
venueImageImage     
visitLanguageCodeString (8)     

SalePeriod
audienceSubCatIdsList of Long     
dailyEndTimeDate     
dailyStartTimeDate     
endDate     
endRelativeLong     
quotationPossibleboolean     
reservationPossibleboolean     
salePeriodEndDateType(ABSOLUTE|RELATIVE)     
salePeriodStartDateType(ABSOLUTE|RELATIVE)     
salePossibleboolean     
salesChannelCodeString (8)     
salesChannelIdLong     
salesChannelNameString     
seatCategoryIdsList of Long     
startDate     
startRelativeLong     
type(STANDARD|DISCRETE)     
weekDaysList of (SUNDAY|MONDAY|TUESDAY|
WEDNESDAY|THURSDAY|FRIDAY|
SATURDAY)
     

Charge
amountLong     
audSubCatIdLong     
mandatoryboolean     
salesChannelIdLong     
slopeString     
thresholdAmountLongIf price amount < threshold value, then charge amount will not apply for that price.

Location
siteAddressPlaceAddress     
siteCodeString (8)     
siteExternalNameExternalName60 characters max for each translation
siteKindNameExternalName     
spaceCodeString (8)     
spaceExternalNameExternalName60 characters max for each translation

PlaceAddress
countryCodeString (8)     
emailString     
faxString     
firstAddressLineString     
gpsLatitudeString     
gpsLongitudeString     
localityString     
phoneNumberString     
secondAddressLineString     
thirdAddressLineString     
websiteString     
zipCodeString (8)     

Match
finalDateBoolean     
hostTeamString     
hostTeamIdLong     
opposingTeamString     
opposingTeamIdLong     
roundString     
roundCodeString (8)     
roundExternalNameExternalName60 characters max for each translation
roundRankInteger     

PerformanceSocialNetworkLink
externalReferenceString     
posSocialIdLong     

Price
including VAT, price in millis
amountLong     
audSubCatIdLong     
chargesAmountsList of ChargesAmount     
institutionSeatCatIdLong     
maxQtyInteger     
minQtyInteger     
priceLevelIdLong     
seatCatIdLong     

ChargesAmount
amountLong     
chargesIdLong     

SaleCloseException
dateDate     

SeatCategory
bgColorString     
catNumString     
codeString (8)     
externalNameExternalName60 characters max for each translation
idLong     
institutionCategoryIdLong     
nameString     
rankInteger     
sameBlockRestrictionMode(NONE|AUTO|
MANUAL_OR_AUTO)
Seat selection mode need to add same seat's block validation.
Available modes:
  • NONE (default - no validation)
  • AUTO (Automatically assign seat)
  • MANUAL_OR_AUTO (Automatically or manually assign seat)
  • textColorString     

    Goods
    goodsAxisListList of GoodsAxisContains all the goods axes for which the goods items in @goodsItems have values.
    goodsFamilyIdLong     
    goodsItemsList of GoodsItem     
    goodsTopicIdLong     

    GoodsAxis
    externalNameExternalName60 characters max for each translation
    idLong     
    rankInteger     

    GoodsItem
    externalNameDesignationExternalNameThe designation of a GoodsItem is a concatenation of its corresponding product name, goods axis values
    goodsAxisValuesList of GoodsAxisValue     
    goodsItemIdLong     
    itemItemThe Item corresponding to the GoodsItem for a given season
    referenceString     

    GoodsAxisValue
    externalNameExternalName60 characters max for each translation
    goodsAxisGoodsAxis     
    idLong     
    rankInteger     

    Item
    codeString (8)     
    donationAmountLong     
    donationMaxAmountLong     
    donationMinAmountLong     
    externalNameExternalName60 characters max for each translation
    itemClass(FIRST_CLASS|
    SECOND_CLASS)
         
    itemIdLong     
    itemPricesList of ItemPrice     
    kindString     
    rankInteger     
    transportTripType(ONEWAY|RETURN)     
    voucherAmountLong     
    voucherMaxAmountLong     
    voucherMinAmountLong     

    ItemPrice
    amountLong     
    audSubCatIdLong     
    chargesAmountsList of ChargesAmount     
    dateDate     
    maxQtyInteger     
    minQtyInteger     
    priceLevelIdLong     
    rateTypeIdLong     
    salePeriodsList of SalePeriod     

    Hospitality
    areaType(SKYBOX|PREMIUM_SEATS|
    BOTH)
         
    hospitalityItemsList of HospitalityItem     
    typeOfProduct(SKYBOX|LOUNGE)     

    HospitalityItem
    hospitalityRoomIdsList of Long     
    hospitalitySessionIdLong     
    siteIdLong     
    codeString (8)     
    donationAmountLong     
    donationMaxAmountLong     
    donationMinAmountLong     
    externalNameExternalName60 characters max for each translation
    itemClass(FIRST_CLASS|
    SECOND_CLASS)
         
    itemIdLong     
    itemPricesList of ItemPrice     
    kindString     
    rankInteger     
    transportTripType(ONEWAY|RETURN)     
    voucherAmountLong     
    voucherMaxAmountLong     
    voucherMinAmountLong     

    Media
    imageImage     
    rankInteger     
    urlString (255)     

    Membership
    isUserDefineStartValidityboolean     
    itemsList of Item     
    validityDurationInteger     
    validityDurationUnit(DAY|WEEK|MONTH|YEAR)     
    validityEndDateDate     
    validityRule(SEASON|PERIOD|PURCHASE)     
    validityStartDateDate     

    OptionAvailability
    endDate     
    salesChannelCodeString (8)     
    salesChannelIdLong     
    startDate     

    Package
    mandatorySeatCategoryboolean     
    packageIdLong     
    packageItemsList of PackageItem     
    packageLineList of PackageLine     
    priceType(PREDEFINED|DYNAMIC)     

    PackageItem
    institutionCategoryIdLong     
    itemIdLong     
    itemPricesList of ItemPrice     
    rankInteger     
    seatCatLinkNameExternalName     
    seatCategoryLinkList of SeatCategoryLink     

    SeatCategoryLink
    seatCategoryIdLong     

    PackageLine
    forcedAudSubCatIdLong     
    optionalboolean     
    packageLineIdLong     
    parentPackageLineIdLong     
    productProduct     
    quantityInteger     
    rankInteger     

    Pass
    consecutive(CONSECUTIVE|
    NON_CONSECUTIVE|
    INDIFFERENT)
         
    dateMandatoryboolean     
    durationUnit(DAY|WEEK|MONTH|YEAR)     
    guidedboolean     
    itemsList of Item     
    minimumGroupSizeint     
    numberOfEntriesint     
    pricingType(PER_PERSON|
    GROUP_FLAT_RATE)
         
    spaceIdsList of Long     
    ticketType(INDIVIDUAL_TICKET|
    GROUP_TICKET)
         
    timeslotIdsList of Long     
    timeslotPassDisplayType(ONLY_ONE_SLOT_DISPLAY_DATE_ONLY|ONLY_ONE_SLOT_DISPLAY_TIME|MANY_SLOTS)     
    validFromDate     
    validToDate     
    validityDateDate     
    validityDurationInteger     
    validityRule(SEASON|PERIOD|PURCHASE)     
    visitDurationIndependantOfTimeslotInteger     
    visitThemeIdsList of Long     
    visitType(GROUP_VISIT|
    INDIVIDUAL_VISIT)
         
    withoutVisibleThemeboolean     

    ProductSocialNetworkLink
    externalReferenceString     
    posSocialIdLong     

    SeasonTicket
    additionalSeatsMaxQuantityInteger     
    additionalSeatsMaxQuantityPerPerformanceInteger     
    additionalSeatsRestrictedAudienceSubCategoryIdsList of Long     
    allowAdditionalSeatboolean     
    externalAdditionalCatInfoExternalName     
    mandatorySeatCategoryboolean     
    maxEventsInteger     
    maxSeatsInteger     
    maxSeatsPerEventInteger     
    maxSeatsPerPerformanceInteger     
    minEventsInteger     
    priceType(PREDEFINED|DYNAMIC)     
    sameSeatBoolean     
    seasonTicketItemsList of SeasonTicketItem     
    seasonTicketLinesList of SeasonTicketLine     
    seasonTicketSubjectsList of SeasonTicketSubject     

    SeasonTicketItem
    institutionCategoryIdLong     
    itemIdLong     
    itemPricesList of ItemPrice     
    rankInteger     
    seatCatLinkNameExternalName     
    seatCategoryLinkList of SeatCategoryLink     

    SeasonTicketLine
    additionalSeatsOverridenMaxQuantityInteger     
    allowSeatCatUpDownGradeBoolean     
    mandatoryEventBoolean     
    multiplePerformances(ONE|MULTI|ALL)     
    productProduct     
    seasonTicketLineIdLong     

    SeasonTicketSubject
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    maxEventsInteger     
    minEventsInteger     
    rankInteger     
    seasonTicketLinesList of SeasonTicketLine     

    Service
    internetTextExternalName     
    itemsList of Item     

    Stop
    codeString (8)     
    nameString     
    rankInteger     
    type(ARRIVAL|DEPARTURE|VIA|
    UPSELLING)
         

    SubTopicLink
    idLong     

    Transport
    audiencSubCatsList of AudienceSubCategory     
    itemsList of Item     
    originDestinationAudienceSubCatDependencyboolean     
    originDestinationDependencyboolean     
    type(RETURN|ROUND_CLOSED|
    ROUND_OPEN|ONEWAY)
         
    validatyInteger     

    AudienceSubCategory
    audienceCategoryKind(FULL|REDUCED|FREE)     
    codeString (8)     
    comfortVariableValuesList of ComfortVariableValue     
    crossSeatCategoryboolean     
    exchangeablebooleanIf true, products bought with this tariff can be exchanged, provided the product is exchangeable as well
    excludeTariffFromLimitsboolean     
    externalDescriptionExternalName2000 characters max for each translation
    externalNameExternalName60 characters max for each translation
    externalVerificationIdLong     
    idLong     
    maxQuantityInteger     
    minQuantityInteger     
    minQuantityOfRequiredASCInteger     
    parentAudienceSubCategoryIdLong     
    proportionalConditionboolean     
    rankInteger     
    requireAttachmentBoolean     
    requiredAudienceSubCategoryIdsList of Long     

    AudienceCategory
    audienceSubCategoriesList of AudienceSubCategory     
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    mainCategory(OCCASIONAL|SUBSCRIBER|
    INSIDE_SEASONTICKET|
    MEMBER|INVITED)
         
    secondaryCategory(INDIVIDUAL|COMMUNITY|
    GROUP|TAXED|FREE|
    PROMOTIONAL|ERROR)
         

    ChargesTable
    chargeTypeString     
    chargesList of Charge     
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     

    CompetitionType
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    logoString     
    logoImageImage     

    ConditionalCrossSell
    productsList of Product     

    GoodsFamily
    CodeString (8)     
    externalNameExternalName60 characters max for each translation
    goodsFamiliesList of GoodsFamily     
    idLong     
    rankInteger     

    GoodsTopic
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    goodsTopicsList of GoodsTopic     
    idLong     

    HospitalityRoom
    capacityInteger     
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    floorString     
    idLong     
    locationString     
    locationNameExternalName     
    pitchViewBoolean     
    pitchViewImageImage     
    pitchViewLogoString     
    roomImageImage     
    roomLogoString     
    siteIdLong     

    HospitalitySession
    bgColorString     
    codeString (8)     
    dateDate     
    externalNameExternalName60 characters max for each translation
    idLong     
    performancePerformance     
    siteIdLong     
    textColorString     
    timeDate     

    LogicalConfiguration
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    notNumberedAreasList of NotNumberedAreaMapping     
    physicalConfigurationIdLong     
    seatCategoriesList of SeatCategory     
    securityGaugeInteger     
    selectionMapSelectionMap     

    NotNumberedAreaMapping
    physicalAreaIdLong     
    seatCategoryIdLong     

    SelectionMap
    svgFileString     
    viewString     
    visualPolygonsList of VisualPolygon     

    VisualPolygon
    externalNameExternalName60 characters max for each translation
    linkedAreaIdsList of Long     
    linkedBlockIdsList of Long     
    panoramicImageUrlString (255)     
    svgFileString     
    svgPolygonIdentifierString     

    OptionLimitationLine
    idLong     
    logicalSeatCatIdsList of Long     
    productFamilySubType(SIMPLE_TICKET|
    SEASONTICKET|MEMBERSHIP|
    PACKAGE|STAY|SERVICE|
    VOUCHER|DONATION|GOODS|
    VISIT|OPEN|OPEN_PASS|
    DATE_SPECIFIC_PASS|
    SPORTING_EVENT|RAILAWAY|
    HOTEL|MUSEUM|ENTERT_PARK|
    RESTAURANT|PRODLIB|
    TIMESLOT_PASS|HOSPITALITY|
    HOSPITALITY_PACKAGE|
    CANCELLATION_INSURANCE|
    VISIT_PASS)
         
    productFamilyType(SINGLE_ENTRY|
    SEASONTICKET|PASS|PACKAGE|
    MEMBERSHIP|SERVICE|GOODS|
    TRANSPORT|HOSPITALITY)
         
    structureCommunityTypeString     

    Optionable
    productProduct     

    PriceComponent
    codeString (8)     
    discountboolean     
    externalNameExternalName60 characters max for each translation
    fixedAmountLong     
    idLong     
    mandatoryboolean     
    percentageString     
    priceComponentType(INSIDE_COMPONENT|
    OUTSIDE_COMPONENT)
         
    rankint     
    refundableboolean     
    roundingGranularityLong     
    ticketPriceboolean     
    vatCodeString (8)     
    vatCodeIdLong     

    PriceLevel
    codeString (8)     
    idLong     
    mainCategory(OCCASIONAL|SUBSCRIBER|
    INSIDE_SEASONTICKET|
    MEMBER|INVITED)
         
    reductionInteger     

    ProductType
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    productFamilyIdLong     

    Questionnaire
    codeString (8)     
    idLong     
    questionnaireQuestionsList of QuestionnaireQuestion     

    QuestionnaireQuestion
    mandatoryAnswerboolean     
    questionIdLong     
    rankInteger     

    Question
    answerElementsList of AnswerElement     
    answerType(ADDRESS|BOOLEAN|NUMBER|
    DATE|PHONE|EMAIL|TEXT|
    LIST_SINGLE|LIST_MULTI)
         
    autoCopiedAnswerboolean     
    codeString (8)     
    defaultAnswerString     
    externalNameExternalName60 characters max for each translation
    idLong     
    internalNameExternalName60 characters max for each translation

    AnswerElement
    codeString (8)     
    defaultValueboolean     
    externalNameExternalName60 characters max for each translation
    idLong     
    internalNameExternalName60 characters max for each translation
    rankInteger     

    RateType
    bgColorString     
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    productFamilySubType(SIMPLE_TICKET|
    SEASONTICKET|MEMBERSHIP|
    PACKAGE|STAY|SERVICE|
    VOUCHER|DONATION|GOODS|
    VISIT|OPEN|OPEN_PASS|
    DATE_SPECIFIC_PASS|
    SPORTING_EVENT|RAILAWAY|
    HOTEL|MUSEUM|ENTERT_PARK|
    RESTAURANT|PRODLIB|
    TIMESLOT_PASS|HOSPITALITY|
    HOSPITALITY_PACKAGE|
    CANCELLATION_INSURANCE|
    VISIT_PASS)
         
    productFamilyType(SINGLE_ENTRY|
    SEASONTICKET|PASS|PACKAGE|
    MEMBERSHIP|SERVICE|GOODS|
    TRANSPORT|HOSPITALITY)
         
    textColorString     

    RatesTable
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    parentIdLong     
    pricesList of Price     
    ratesTableBreakdownIdLong     

    Site
    accessImageString     
    addressPlaceAddress     
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    siteAccessImageImage     
    siteKindCodeString (8)     
    siteKindNameExternalName     
    spacesList of Space     

    Space
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    siteIdLong     

    Team
    codeString (8)     
    countryCodeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    logoString     
    logoImageImage     

    Timeslot
    allVisitLanguagesboolean     
    allVisitThemesboolean     
    durationInteger     
    idLong     
    quotaInteger     
    rateTypeIdLong     
    salesToleranceInteger     
    startDateDate     
    startTimeDate     
    visitLanguagesCodesList of String     
    visitThemesIdsList of Long     

    Topic
    SubTopicsList of SubTopic     
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     

    SubTopic
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    subTopicsList of SubTopic     

    Storefront
    storefrontItemsList of StorefrontItem     

    StorefrontItem
    audSubCatIdLong     
    itemIdLong     
    performanceIdLong     
    productIdLong     
    rankInteger     

    VisitGroupKind
    defaultValueboolean     
    externalNameExternalName60 characters max for each translation
    groupKindInternalCodeString (8)     
    rankInteger     

    VisitLanguage
    codeString (8)     
    nameExternalName     

    VisitTheme
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    multilingualboolean     
    visitLanguageCodesList of String     

    getCatalogPresentation

    Return details on how the catalog should be presented to a final web user. The details are returned in the form of visual sections and product clusters. The result is dependent on the sales channel in the implicit context.

    Parameters

    requestIdInteger     

    Return value

    CatalogPresentationResult
    catalogPresentationDataCatalogPresentationData     
    requestIdInteger     
    statusCodeString (8)     
    statusDetailString     

    CatalogPresentationData
    sectionsList of Section     
    toursList of Tour     

    Section
    allProductsBoolean     
    allToursBoolean     
    aspectRatioString     
    classifyBy(FAMILY|CLUSTER|DATE|
    NONE)
         
    clusterItemSorting(SORTING_BY_DATE|
    SORTING_BY_RANK)
         
    clustersList of Cluster     
    codeString (8)     
    columnsInteger     
    displayActionBtnBoolean     
    displayDescPreviewBoolean     
    displayPriceInfoBoolean     
    displayProdNotOnSaleBoolean     
    displaySalesStartDateBoolean     
    displaySingleOccurrencesBoolean     
    displayUnaccessibleAdvBoolean     
    externalNameExternalName60 characters max for each translation
    idLong     
    layout(DEFAULT|CARD|SLIDER|
    PAGINATED_LIST)
         
    maxInSliderInteger     
    maxItemPerPageInteger     
    onlyAdvantageProductsBoolean     
    randomClusterOrderBoolean     
    rankInteger     
    tourIdsList of Long     

    Cluster
    clusterItemsList of ClusterItem     
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     

    ClusterItem
    absoluteEndDate     
    absoluteStartDate     
    clusterGrouping(PRODUCT|PERFORMANCE)     
    daysToEndInteger     
    daysToStartInteger     
    numberOfDaysInteger     
    numberOfObjectsInteger     
    performanceIdLong     
    productIdsList of Long     
    rankInteger     

    Tour
    codeString (8)     
    contactProductLinkIdsList of Long     
    detailURLString (255)     
    externalDescriptionExternalName2000 characters max for each translation
    externalNameExternalName60 characters max for each translation
    idLong     
    logoString     
    logoImageImage     
    productIdsList of Long     

    getLastSetupUpdate

    Indicates the last modification date of the catalog, in order to limit the useless calls to getCatalog.

    Parameters

    requestIdInteger     

    Return value

    LastSetupUpdateResult
    lastSetupUpdateDate     
    requestIdInteger     
    statusCodeString (8)     
    statusDetailString     

    getPOSConfig

    Returns the point of sales configuration.

    Parameters

    requestIdInteger     

    Return value

    POSConfigResult
    posConfigDataPOSConfig     
    requestIdInteger     
    statusCodeString (8)     
    statusDetailString     

    POSConfig
    allowedCharsString     
    amazonS3InstitutionBucketNameString     
    availableCurrencyCashList of CurrencyCash     
    catalogCurrenciesList of CurrencyCashList of catalog currencies supported by the point of sales
    chargesList of Charges     
    closingTimeDate     
    communityTypeString     
    contactAccountCreationAllowedBoolean     
    contactFileAccessAllowedBoolean     
    contactLoginModeString     
    countriesList of Country     
    currencyCodeString (8)ISO-4217 currency code. Example: EUR
    currencySymbolString     
    customizationFileString     
    exchangeRatesList of ExchangeRateexchangeRates a list of exchange rates for the currencies of an organization. A rate is expressed as value*10^5, for example rate between EUR and GBP 87678 means 1 EUR costs 0.87678 GBP
    guestLoginAvailableboolean     
    hardwaresList of Hardware     
    hubHub     
    iBeaconsList of IBeacon     
    idpCertificateString     
    institCodeString (8)     
    institutionCurrencyCurrencyCash     
    isInvoicingAllowedboolean     
    languageListStringList of ISO-639-2 language codes.
    loginPosition(NEVER|BEFORE_CHECKOUT|
    AT_BEGINNING)
         
    mainLanguageString     
    maxAmountForOnlinePaymentLongAmount, in 1000ths of unit.
    maxAutoSuggestedSeatsTrialsInteger     
    maxSeatsPerPerformanceInteger     
    modeOfUse(STANDARD|FLASH)     
    multiCatalogCurrencyEnabledbooleanBoolean parameter which indicates if point of sales' organization is in multi catalog currency mode.
    netPricesBoolean     
    openingTimeDate     
    orderAbandonDelayIntegerDelay (in seconds) after which an OPEN order is abandonned automatically by the backend. If null, never.
    orderOriginsList of OrderOriginInfo     
    organizationCodeString (8)     
    organizationCurrencyCurrencyCash     
    organizationIdLong     
    organizationNameExternalName     
    organizationTimeZoneString     
    overheadsList of Overheads     
    paymentFeesList of PaymentFee     
    paymentMethodsList of PaymentMethod     
    placeAddressString     
    placeAddressDataPlaceAddress     
    posActivityState(RUNNING|SUSPENDED)     
    posCodeString (8)     
    posCustomizationFileString     
    posIdLongThe pointOfSalesId that is used in sales or availabilities methods.
    posMobileThemePosMobileTheme     
    posNumberInteger     
    posParametersMap of StringString     
    posType(B2B|B2C|B2B2C|B2P|C2C|
    NEW_TVM|
    MOBILE_BOXOFFICE)
         
    productFamiliesList of ProductFamily     
    pspAccessMethod(EFT_POS|MOTO|MIXED|
    WEB_POST|WEB_REDIRECT)
         
    pspParametersMap of StringString     
    pspTerminalNumberString     
    reportVariantsList of ReportVariant     
    requireConfirmationEmailBooleanA config to show up second email field on TicketShop
    reverseVatCountriesList of Country     
    salesChannelActivityState(RUNNING|SUSPENDED)     
    salesChannelCodeString (8)     
    salesChannelIdLong     
    salesRestrictionsList of SalesRestriction     
    seatSelectionMode(AUTO|MANUAL|
    MANUAL_OR_AUTO|
    WITHOUT_MAP|
    WITHOUT_SEATING)
         
    shippingFeesList of ShippingFee     
    socialConnectionsList of PosSocialConnection     
    testInstitutionBoolean     
    virtualOperatorNameString     
    workstationIdLong     
    workstationIdentifierString     

    CurrencyCash
    availableCashList of Cash     
    currencyCodeString (8)     
    fractionDigitInteger     
    minAmountInteger     
    symbolString     

    Cash
    quantityInteger     
    type(COIN|COINS_ROLL|NOTE|
    NOTES_BUNDLE)
         
    unitAmoungInteger     

    Charges
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    modifiableBoolean     
    type(OTHER|RESERVATION|
    CANCELLATION)
         

    Country
    codeString (8)     
    currencyCodeString (8)currencyCode is optional field, it should be set for countries of an organization
    internationalPhonePrefixString     
    nameExternalName     
    phoneFormatString     

    ExchangeRate
    fromCurrencyCodeString (8)     
    rateLongrate is expressed as value*10^5, for example rate between EUR and GBP 87678 means 1 EUR costs 0.87678 GBP
    toCurrencyCodeString (8)     

    Hardware
    driverNameString     
    idLong     
    rankInteger     
    receiptPrinterReceiptPrinter     
    ticketPrinterTicketPrinter     
    tpeTPE     
    type(TICKET_PRINTER|TPE|
    RECEIPT_PRINTER)
         

    ReceiptPrinter
    comPortParameterCOMPortParameter     

    COMPortParameter
    portNumberInteger     

    TicketPrinter
    cuttingMode(NONE|AFTER_EACH_TICKET|
    AFTER_EACH_ORDER|
    AT_THE_END_OF_MASS_PRINTING)
         
    ticketSizeTicketSize     
    trayNumberInteger     
    usbPortParameterUSBPortParameter     

    TicketSize
    heightInteger     
    idLong     
    numberOfpartsInteger     
    onFiscalStockboolean     
    ticketSupportTicketSupport     
    widthInteger     

    TicketSupport
    formatRequiredboolean     
    idLong     
    modelType(THERMAL|PDF)     
    paperlessboolean     
    shipmentModeTypesList of ShipmentModeType     
    ticketSupportEnum(THERMAL|ETICKET|PAPER_A4|
    PASSBOOK|MOBILE|
    BLOCKCHAIN|BADGE|RFID|
    PR_RFID_CARD|
    DEMAT_BADGE)
         

    ShipmentModeType
    availableForDocumentsboolean     
    availableForTicketsboolean     
    externalProviderboolean     
    idLong     

    USBPortParameter
    logicalNameString     

    TPE
    comPortParameterCOMPortParameter     

    Hub
    idLong     
    pointsOfSalesList of HubPointOfSales     

    HubPointOfSales
    allCountriesAllowedboolean     
    authorizedCountriesList of String     
    codeString (8)     
    idLong     
    internetUrlString (255)     
    rankLong     
    runningboolean     

    IBeacon
    actionTextString     
    descriptionExternalName2000 characters max for each translation
    imageUrlString (255)     
    majorNumberString     
    minorNumberString     
    rangeInInteger     
    rangeOutInteger     
    uuidString     

    OrderOriginInfo
    externalNameExternalName60 characters max for each translation
    idCodeString (8)     

    Overheads
    This class includes the two different and mutually exclusive modes of configuring an overhead amount: constant or gradient.
    ceilingLongThe maximum overhead amount that will be applied to the payment. The value should be specified in 10th of cents.
    constantAmountLongConstant amount to apply as overhead for a payment. It does not change, no matter the payment amount. The value should be specified in 10th of cents.
    floorLongThe minimum overhead amount that will be applied to the payment. The value should be specified in 10th of cents.
    slopeFloatThe percentage of overhead that will be applied to the payment amount. It will change depending on this amount.
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    modifiableBoolean     
    type(OTHER|RESERVATION|
    CANCELLATION)
         

    PaymentFee
    paymentMethodIdLong     
    ceilingLongThe maximum overhead amount that will be applied to the payment. The value should be specified in 10th of cents.
    constantAmountLongConstant amount to apply as overhead for a payment. It does not change, no matter the payment amount. The value should be specified in 10th of cents.
    floorLongThe minimum overhead amount that will be applied to the payment. The value should be specified in 10th of cents.
    slopeFloatThe percentage of overhead that will be applied to the payment amount. It will change depending on this amount.
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    modifiableBoolean     
    type(OTHER|RESERVATION|
    CANCELLATION)
         

    PaymentMethod
    changeReturnAllowedBoolean     
    codeString (8)     
    defaultPaymentMethodIdLong     
    externalDescriptionExternalName2000 characters max for each translation
    externalNameExternalName60 characters max for each translation
    forPaymentBoolean     
    forReimbursementBoolean     
    idLong     
    immediateFollowupPaymentBoolean     
    inSplitPaymentAllowedBoolean     
    internetCodeString (8)Comma separated list of allowed cards (VISA,AMEX...)
    manualValidationBoolean     
    maxOrderAmountLong     
    minOrderAmountLong     
    paymentType(NUM|CHEQ|CHEQCANCEL|CB|
    CBCANCEL|PREPAY|VIR|AVR|
    COUPON|VOUCHER|CTRM|EXT|
    CA|BVR|INV|CANOAUTH|
    DEPOSIT|SAPBTRANSF|
    FIDELITY_POINT|DISCOUNT|
    CB_WITH_VALIDATION|
    DIRECT_DEBIT|PREPAYMENT|
    DIRECT_DEBIT_WITHOUT_INST)
         
    rankInteger     
    subPaymentMethodsList of SubPaymentMethod     
    tooMuchPerceivedAllowedBoolean     
    withFollowUpBoolean     

    SubPaymentMethod
    brandString     
    imageImage     
    internetCodeString (8)     
    rankInteger     

    PosMobileTheme
    accountAddressBookUrlString (255)     
    accountAdvantagesUrlString (255)     
    accountHomeUrlString (255)     
    accountOrderHistoryUrlString (255)     
    accountProfileUrlString (255)     
    accountSubscriptionsRenewalUrlString (255)     
    accountSubscriptionsUrlString (255)     
    appleAppStoreIdString     
    appleTopbarTextColorBlackboolean     
    catalogUrlString (255)     
    externalNameExternalName60 characters max for each translation
    facebookAccountString     
    googleAccountString     
    googlePlayStoreIdString     
    logoString     
    mainScreenBottomColor1String     
    mainScreenBottomColor2String     
    mainScreenTopColor1String     
    mainScreenTopColor2String     
    menuBackgroundColorString     
    menuLinksColorString     
    menuLinksUrlString (255)     
    menuNameColorString     
    menuNotificationTextColorString     
    panelRightColor1String     
    panelRightColor2String     
    twitterAccountString     
    twitterNotificationAccountString     
    twitterNotificationHashtagString     

    ProductFamily
    contactRequiredBoolean     
    defaultQuantityInteger     
    directOption(WITH|WITHOUT|NO)     
    externalNameExternalName60 characters max for each translation
    idLong     
    netPricesBoolean     
    productFamilySubType(SIMPLE_TICKET|
    SEASONTICKET|MEMBERSHIP|
    PACKAGE|STAY|SERVICE|
    VOUCHER|DONATION|GOODS|
    VISIT|OPEN|OPEN_PASS|
    DATE_SPECIFIC_PASS|
    SPORTING_EVENT|RAILAWAY|
    HOTEL|MUSEUM|ENTERT_PARK|
    RESTAURANT|PRODLIB|
    TIMESLOT_PASS|HOSPITALITY|
    HOSPITALITY_PACKAGE|
    CANCELLATION_INSURANCE|
    VISIT_PASS)
         
    productFamilyType(SINGLE_ENTRY|
    SEASONTICKET|PASS|PACKAGE|
    MEMBERSHIP|SERVICE|GOODS|
    TRANSPORT|HOSPITALITY)
         
    reservable(YES|NO|OPTIONABLE)     

    ReportVariant
    rankLong     
    reportGroup(SALES|CASHDESK|
    ACCOUNTING|AVAILABILITY|
    CONFIGURATION|ANALYTICS|
    SEAT|SHIPMENTTICKET|GOODS|
    HOSPITALITY|VISITS|
    CONTACT)
         
    reportIdLong     
    reportIdentifier(STANDARD_REPORT|
    CUSTOM_REPORT|
    EXCLUSIVE_REPORT)
         
    reportNameString     
    reportParametersList of String     

    SalesRestriction
    idLong     
    incompatibleItemsList of IncompatibleItem     

    IncompatibleItem
    idLong     
    performanceIdLong     
    productIdLong     

    ShippingFee
    shipmentModeIdLong     
    ceilingLongThe maximum overhead amount that will be applied to the payment. The value should be specified in 10th of cents.
    constantAmountLongConstant amount to apply as overhead for a payment. It does not change, no matter the payment amount. The value should be specified in 10th of cents.
    floorLongThe minimum overhead amount that will be applied to the payment. The value should be specified in 10th of cents.
    slopeFloatThe percentage of overhead that will be applied to the payment amount. It will change depending on this amount.
    codeString (8)     
    externalNameExternalName60 characters max for each translation
    idLong     
    modifiableBoolean     
    type(OTHER|RESERVATION|
    CANCELLATION)
         

    PosSocialConnection
    cookieSecretString     
    exclusiveModeboolean     
    joinEventboolean     
    loginboolean     
    loginURLString (255)     
    logoutURLString (255)     
    serviceProviderIdentifierString     
    sharePurchaseboolean     
    socialAppIdentifierString     
    socialAppSecretString     
    socialLoginIdLong     
    socialLoginType(FACEBOOK|GOOGLE|
    SECUTIX_IDP|SECUTIX_SP|
    TWITTER|UEFA|MDP|
    SWISSPASS|ACCOUNT_KIT|
    GIGYA|OIDC|
    SPORTSALLIANCE)
         

    getPhysicalConfiguration

    Extracts the details of a physical configuration.

    Parameters

    requestIdIntegeroptional request id, used to identify asynchronous requests (see {@link AsynchronousMethod}.
    physicalConfigurationIdLongmandatory : the physicalConfigurationId we want to extract.

    Return value

    PhysicalConfigurationResult
    physicalConfigurationDataString     
    requestStateAsynchronousMethodResult.
    AsynchronousMethodState
         
    requestIdInteger     
    statusCodeString (8)     
    statusDetailString     

    getSeatDetails

    This method returns detailed seat descriptions for a given set of seat definitions.

    Those values do not change often, they can be cached for a long time.

    Parameters

    requestIdInteger     
    performanceIdLong     
    seatDefinitionsList of SeatDefinition     

    SeatDefinition
    UNDEFINEDString     
    areaIdLong     
    areaKind(INDIFFERENT|BOX)     
    availableboolean     
    blockIdLong     
    classification1icString     
    classification2icString     
    contingentIdLong     
    dummySeatboolean     
    entranceIdLong     
    externalEntranceIdLong     
    freezingReasonIcString     
    frozenboolean     
    numberString     
    optimalSeatSelectionValueLong     
    physicalSeatIdLong     
    rotationint     
    rowString     
    scenePanoLinkString     
    scenePhotoLinkString     
    seatCategoryIdLong     
    seatOrderLong     
    xint     
    yint     

    Return value

    SeatsDetailResult
    seatsDetailDataSeatsDetailData     
    requestIdInteger     
    statusCodeString (8)     
    statusDetailString     

    SeatsDetailData
    seatDescriptionsList of SeatDescription     

    SeatDescription
    externalRemarkString     
    seatQualityString     
    seatQualityIdString     
    stageVisibilityString     
    stageVisibilityTypeString     
    titlingVisibilityString     
    titlingVisibilityTypeString     
    UNDEFINEDString     
    areaIdLong     
    areaKind(INDIFFERENT|BOX)     
    availableboolean     
    blockIdLong     
    classification1icString     
    classification2icString     
    contingentIdLong     
    dummySeatboolean     
    entranceIdLong     
    externalEntranceIdLong     
    freezingReasonIcString     
    frozenboolean     
    numberString     
    optimalSeatSelectionValueLong     
    physicalSeatIdLong     
    rotationint     
    rowString     
    scenePanoLinkString     
    scenePhotoLinkString     
    seatCategoryIdLong     
    seatOrderLong     
    xint     
    yint     

    identifyPublicCodeOrigin

    This method allows to find the entity relating to the code entered by a client.

    The only checks done by this method are:

    No checks are done on the fact that the client is authorized to use this code, neither on the fact that the code is still valid or can be applied on the current basket.

    Parameters

    requestIdInteger     
    publicCodesList of String     

    Return value

    PublicCodeOriginResult
    publicCodeOriginDatasList of PublicCodeOriginData     
    requestIdInteger     
    statusCodeString (8)     
    statusDetailString     

    PublicCodeOriginData
    entityIdLong     
    publicCodeString (8)     
    publicCodeOriginEntity(PARTNER_ADVANTAGE|
    ONE_TIME_CODE_ADVANTAGE|
    RULESET|PROMO|VOUCHER)
         
    resultCodeString (8)     

    isCatalogServiceAlive

    validate network connection and login/password

    Parameters

    Return value

    WebMethodResult
    requestIdInteger     
    statusCodeString (8)     
    statusDetailString