Service: CatalogService

Version: 1_12 (other versions, change log) END OF LIFE. Please consider switching to the latest version of the webservices, because this version may be removed anytime from support.

SOAP Demo endpoint: https://secutix.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.catalog.v1_12.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:

getCatalog

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Extract the catalog.

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.

Return value

CatalogResult
catalogDataString     
requestStateAsynchronousMethodResult.
AsynchronousMethodState
     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

getCatalogDetailed

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Parameters

requestIdInteger     
seasonCodeString (8)     
productCodeString (8)     

Return value

CatalogResultDetailed
catalogDataCatalogData     
requestStateAsynchronousMethodResult.
AsynchronousMethodState
     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

CatalogData
externalVerificationsList of ExternalVerification     
physicalConfigurationsList of PhysicalConfiguration     
seasonsList of Season     
storefrontStorefront     
visitLanguagesList of VisitLanguage     

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     

PhysicalConfiguration
areasList of Area     
codeString (8)     
countryCodeString (8)     
externalNameExternalName60 characters max for each translation
formattedAddressString     
idLong     
imageString     
mapTypeString     
pdfViewString     
securityGaugeInteger     
siteCodeString (8)     
siteExternalNameExternalName60 characters max for each translation
spaceCodeString (8)     
spaceExternalNameExternalName60 characters max for each translation
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     
goodsFamiliesList of GoodsFamily     
goodsTopicsList of GoodsTopic     
hospitalityAreasList of HospitalityArea     
hospitalityRoomsList of HospitalityRoom     
hospitalitySessionsList of HospitalitySession     
idLong     
logicalConfigurationsList of LogicalConfiguration     
numLong     
optionLimitationLinesList of OptionLimitationLine     
optionablesList of Optionable     
priceLevelsList of PriceLevel     
productTypesList of ProductType     
productsList of Product     
questionnairesList of Questionnaire     
questionsList of Question     
rateTypesList of RateType     
ratesTablesList of RatesTable     
sitesList of Site     
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)
     
codeString (8)     
contactLimitation(LIMITED|NOT_LIMITED)     
endDate     
endRelativeLong     
externalDescriptionExternalName2000 characters max for each translation
externalNameExternalName60 characters max for each translation
idLong     
logoString     
mandatoryContactboolean     
maxOrderQuantityLong     
performanceEndDateType(NONE|TIME_TOLERANCE|
ABSOLUTE|RELATIVE)
     
productsList of Product     
startDate     
startRelativeLong     
state(PREPARING|VALIDATED|
RUNNING|SUSPENDED|
CANCELED|CLOSED|
CANCELED_CLOSED)
     

Product
audienceTypeString     
chargesTableIdLong     
codeString (8)     
crossSellProductLinksList of CrossSellProductLink     
culturalContact(MANDATORY|OPTIONAL|
NONE)
     
detailURLString (255)     
eventEvent     
externalDescriptionExternalName2000 characters max for each translation
externalNameExternalName60 characters max for each translation
goodsGoods     
hospitalityHospitality     
idLong     
logoString     
maxQuantityInteger     
membershipMembership     
minQuantityInteger     
optionAvailabilitiesList of OptionAvailability     
packPackage     
partnerContactNumberString (20)     
passPass     
productFamilySubType(SIMPLE_TICKET|
SEASONTICKET|MEMBERSHIP|
PACKAGE|STAY|SERVICE|
VOUCHER|GOODS|VISIT|OPEN|
OPEN_PASS|
DATE_SPECIFIC_PASS|
SPORTING_EVENT|RAILAWAY|
HOTEL|MUSEUM|ENTERT_PARK|
RESTAURANT|PRODLIB|
TIMESLOT_PASS|HOSPITALITY|
HOSPITALITY_PACKAGE)
     
productFamilyType(SINGLE_ENTRY|
SEASONTICKET|PASS|PACKAGE|
MEMBERSHIP|SERVICE|GOODS|
TRANSPORT|HOSPITALITY)
     
productSocialNetworkLinksList of ProductSocialNetworkLink     
productTypeIdLong     
questionnaireIdLong     
salePeriodsList of SalePeriod     
seasonTicketSeasonTicket     
serviceService     
state(PREPARING|VALIDATED|
RUNNING|SUSPENDED|
CANCELED|CLOSED|
CANCELED_CLOSED)
     
subTopicLinksList of SubTopicLink     
transportTransport     
vatCodeIdLong     
waitingListAllowedBoolean     

CrossSellProductLink
descriptionExternalName2000 characters max for each translation
endDate     
externalNameExternalName60 characters max for each translation
salesChannelIdLong     
startDate     
targetProductIdLong     
type(SUGGESTION|
CROSS_SELL_OUT|
CROSS_SELL_IN|UP_SELL)
     

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

Performance
breaksQuantityInteger     
codeString (8)     
comfortVariableValuesList of ComfortVariableValue     
durationInteger     
eventExternalNameExternalName60 characters max for each translation
externalNameExternalName60 characters max for each translation
externalShortNameExternalName15 characters max for each translation
forceNominativeTicketsBoolean     
idLong     
imageString     
itemIdsList of Long     
kindString     
kindExternalNameExternalName60 characters max for each translation
locationLocation     
logicalConfigurationIdLong     
logoString     
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     
saleConfigurationIdLong     
salePeriodsList of SalePeriod     
seatCategoriesList of SeatCategory     
seatSelectionMode(AUTO|MANUAL|
MANUAL_OR_AUTO|
WITHOUT_MAP|
WITHOUT_SEATING)
     
spaceIdLong     
startDate     
state(PREPARING|VALIDATED|
RUNNING|SUSPENDED|
CANCELED|CLOSED|
CANCELED_CLOSED)
     
titlingBoolean     
visitLanguageCodeString (8)     

ComfortVariableValue
codeString (8)     
externalNameExternalName60 characters max for each translation
valueExternalNameExternalName60 characters max for each translation

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

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

PerformanceSocialNetworkLink
externalReferenceString     
posSocialIdLong     

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

ChargesAmount
amountLong     
chargesIdLong     

SalePeriod
audCatIdLong     
endDate     
endRelativeLong     
salePeriodEndDateType(ABSOLUTE|RELATIVE)     
salePeriodStartDateType(ABSOLUTE|RELATIVE)     
salesChannelCodeString (8)     
salesChannelIdLong     
salesChannelNameString     
startDate     
startRelativeLong     

SeatCategory
bgColorString     
catNumString     
codeString (8)     
externalNameExternalName60 characters max for each translation
idLong     
institutionCategoryIdLong     
nameString     
rankInteger     
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)     
externalNameExternalName60 characters max for each translation
itemClass(FIRST_CLASS|
SECOND_CLASS)
     
itemIdLong     
itemPricesList of ItemPrice     
kindString     
rankInteger     
transportTripType(ONEWAY|RETURN)     
voucherAmountLong     
voucherMaxAmountLong     
voucherMinAmountLong     

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

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

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

Membership
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)     
itemsList of Item     
locationsList of Location     
numberOfEntriesint     
spaceIdsList of Long     
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)     

ProductSocialNetworkLink
externalReferenceString     
posSocialIdLong     

SeasonTicket
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
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     

SubTopicLink
idLong     

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

AudienceSubCategory
audienceCategoryKind(FULL|REDUCED|FREE)     
codeString (8)     
externalDescriptionExternalName2000 characters max for each translation
externalNameExternalName60 characters max for each translation
externalVerificationIdLong     
idLong     
minQuantityOfRequiredASCInteger     
rankInteger     
requiredAudienceSubCategoryIdsList of Long     

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

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     

Charge
amountLong     
audSubCatIdLong     
mandatoryboolean     
salesChannelIdLong     
slopeString     

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

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

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

HospitalityArea
areaType(SKYBOX|PREMIUM_SEATS|
BOTH)
     
codeString (8)     
externalNameExternalName60 characters max for each translation
idLong     
locationString     
logoString     
pitchViewBoolean     
quantityInteger     
seatQuantityInteger     
siteIdLong     

HospitalityRoom
capacityInteger     
codeString (8)     
externalNameExternalName60 characters max for each translation
floorString     
idLong     
locationString     
pitchViewBoolean     
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     
svgPolygonIdentifierString     

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

Optionable
productProduct     

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     
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     
spacesList of Space     

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

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

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

Timeslot
durationInteger     
idLong     
rateTypeIdLong     
startDateDate     
startTimeDate     

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     

VisitLanguage
codeString (8)     
nameExternalName     

getLastSetupUpdate

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Parameters

requestIdInteger     

Return value

LastSetupUpdateResult
lastSetupUpdateDate     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

getPOSConfig

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Deprecated Use {@link OpenCatalogService#getPOSConfigFromURL(Integer, String)} instead

Parameters

requestIdInteger     

Return value

POSConfigResult
posConfigDataPOSConfig     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

POSConfig
allowedCharsString     
availableCurrencyCashList of CurrencyCash     
chargesList of Charges     
communityTypeString     
contactAccountCreationAllowedBoolean     
contactFileAccessAllowedBoolean     
contactLoginModeString     
countriesList of Country     
currencyCodeString (8)     
currencySymbolString     
customizationFileString     
iBeaconsList of IBeacon     
idpCertificateString     
institCodeString (8)     
institutionCurrencyCurrencyCash     
isInvoicingAllowedboolean     
languageListString     
loginPosition(NEVER|BEFORE_CHECKOUT|
AT_BEGINNING)
     
maxAmountForOnlinePaymentLong     
maxAutoSuggestedSeatsTrialsInteger     
maxSeatsPerPerformanceInteger     
netPricesBoolean     
orderAbandonDelayInteger     
orderOriginsList of OrderOriginInfo     
organizationCodeString (8)     
organizationCurrencyCurrencyCash     
organizationIdLong     
overheadsList of Overheads     
paymentFeesList of PaymentFee     
paymentMethodsList of PaymentMethod     
placeAddressString     
placeAddressDataPlaceAddress     
posActivityState(RUNNING|SUSPENDED)     
posCodeString (8)     
posCustomizationFileString     
posIdLong     
posMobileThemePosMobileTheme     
posNumberInteger     
posParametersMap of StringString     
posType(B2B|B2C|B2B2C|B2P|C2C)     
productFamiliesList of ProductFamily     
pspAccessMethod(EFT_POS|MOTO|MIXED|
WEB_POST|WEB_REDIRECT)
     
pspTerminalNumberString     
salesChannelActivityState(RUNNING|SUSPENDED)     
salesChannelCodeString (8)     
salesChannelIdLong     
seatSelectionMode(AUTO|MANUAL|
MANUAL_OR_AUTO|
WITHOUT_MAP|
WITHOUT_SEATING)
     
shippingFeesList of ShippingFee     
socialConnectionsList of PosSocialConnection     
testInstitutionBoolean     
virtualOperatorNameString     

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)     
internationalPhonePrefixString     
nameExternalName     

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
codeString (8)     
externalNameExternalName60 characters max for each translation
idLong     
modifiableBoolean     
type(OTHER|RESERVATION|
CANCELLATION)
     

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

PaymentMethod
changeReturnAllowedBoolean     
codeString (8)     
externalNameExternalName60 characters max for each translation
idLong     
inSplitPaymentAllowedBoolean     
internetCodeString (8)     
paymentType(NUM|CHEQ|CHEQCANCEL|CB|
CBCANCEL|PREPAY|VIR|AVR|
COUPON|VOUCHER|CTRM|EXT|
CA|BVR|INV|CANOAUTH|
DEPOSIT|SAPBTRANSF|
FIDELITY_POINT)
     
tooMuchPerceivedAllowedBoolean     
withFollowUpBoolean     

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     
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
netPricesBoolean     
productFamilySubType(SIMPLE_TICKET|
SEASONTICKET|MEMBERSHIP|
PACKAGE|STAY|SERVICE|
VOUCHER|GOODS|VISIT|OPEN|
OPEN_PASS|
DATE_SPECIFIC_PASS|
SPORTING_EVENT|RAILAWAY|
HOTEL|MUSEUM|ENTERT_PARK|
RESTAURANT|PRODLIB|
TIMESLOT_PASS|HOSPITALITY|
HOSPITALITY_PACKAGE)
     
productFamilyType(SINGLE_ENTRY|
SEASONTICKET|PASS|PACKAGE|
MEMBERSHIP|SERVICE|GOODS|
TRANSPORT|HOSPITALITY)
     
reservable(YES|NO|OPTIONABLE)     

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

PosSocialConnection
cookieSecretString     
joinEventboolean     
loginboolean     
loginURLString (255)     
logoutURLString (255)     
serviceProviderIdentifierString     
sharePurchaseboolean     
socialAppIdentifierString     
socialAppSecretString     
socialLoginIdLong     
socialLoginType(FACEBOOK|GOOGLE|
SECUTIX_IDP|SECUTIX_SP|
TWITTER|UEFA)
     

getPOSConfigFromPhysicalDeskIdentifier

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Parameters

requestIdInteger     
identifierString     

Return value

POSConfigResult

getPhysicalConfiguration

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

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

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Parameters

requestIdInteger     
performanceIdLong     
seatDefinitionsList of SeatDefinition     

SeatDefinition
UNDEFINEDString     
areaIdLong     
areaKind(INDIFFERENT|BOX)     
availableboolean     
blockIdLong     
contingentIdLong     
numberString     
physicalSeatIdLong     
rotationint     
rowString     
seatCategoryIdLong     
xint     
yint     

Return value

SeatsDetailResult
seatsDetailDataSeatsDetailData     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

SeatsDetailData
seatDescriptionsList of SeatDescription     

SeatDescription
externalRemarkString     
scenePanoLinkString     
scenePhotoLinkString     
seatQualityString     
seatQualityIdString     
stageVisibilityString     
stageVisibilityTypeString     
titlingVisibilityString     
titlingVisibilityTypeString     
UNDEFINEDString     
areaIdLong     
areaKind(INDIFFERENT|BOX)     
availableboolean     
blockIdLong     
contingentIdLong     
numberString     
physicalSeatIdLong     
rotationint     
rowString     
seatCategoryIdLong     
xint     
yint     

identifyPublicCodeOrigin

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

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

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

validate network connection and login/password

Parameters

Return value

WebMethodResult
requestIdInteger     
statusCodeString (8)     
statusDetailString