Service: SetupService

Version: 1_33 (other versions, change log, ZUMSTEIN_V4.4-SNAPSHOT) Latest frozen version. Base by default all your developments on this one.

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

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

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

Methods:

• activateTimeslots: Changes the state of the aimed timeslots from VALIDATED or PREPARING to RUNNING.
• createOrUpdatePerformance: Creates (if no id specified) or updates a performance in the destination catalog.
• createOrUpdateProduct: Creates (if no id specified) or updates a product in the destination catalog.
• createOrUpdateTimeslots: Create or update the timeslots passed in parameters.
• deleteNonValidatedPerformance: Deletes a performance in state preparing (a product created through the method createOrUpdatePerformance).
• deleteNonValidatedProduct: Deletes a product in state preparing (a product created through the method createOrUpdateProduct).
• deleteTimeslots: Deletes timeslots in state preparing (a timeslot created through the method createOrUpdatePerformance not yet validated in backoffice).
• freezeSeats: Freeze seats with reason.
• getLimitsForPasses: Get the limits for the passes.
• getPerformanceDetails: Returns the set-up details of a given performance.
• getProductDetails: Returns the set-up details of a given product.
• getTimeslots: Gets some timeslots.
• isSetupServiceAlive: validate network connection and login/password
• listActivities: Lists all the validated activities related to the given season.
• listAudienceCategories: List all audience categories defined for this institution.
• listAudienceSubCategories: List all audience sub categories defined for an audience category (optional) and an audience sub category.
• listLogicalConfigurations: Lists all the validated logical configurations relative to the given season.
• listOrganizationVariableValues:
• listPhysicalConfigurations: Lists all the validated physical configurations for the institution.
• listPriceLevels: List all audience categories defined for this institution.
• listRateTypes: Lists all the validated rate types relative to the given season.
• listSeasons: Lists all the active seasons in the organisation related to the sales channel linked the virtual operator used to connect.
• listSpaces: Lists all the validated spaces.
• listTicketModels: Lists all the validated ticket models.
• listTimeslots: Lists all the timeslots for a given season and space.
• listTopics: Lists all the validated topics related to the given season.
• listVatCodes: Lists all the active vat codes.
• listVisitGroupKinds: Lists all the possible visit group kinds.
• listVisitLanguages: Lists all the possible visit languages.
• listVisitThemes: Lists all the possible visit themes.
• saveItemPrice: Modifies the price of a given item in the catalog.
• searchProductsByCriteria: Searches the products according to the criteria.
• setLimitsForPasses: Set the limits for the passes.
• unfreezeSeats: Unfreeze frozen seats
• updateOrganizationVariableValues: Updates the values for the organization variables.

activateTimeslots

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Changes the state of the aimed timeslots from VALIDATED or PREPARING to RUNNING.

Parameters

requestId	Integer
timeslotIds	List of Long	ids of the timeslots

Return value

WebMethodResult
requestId	Integer
statusCode	String (8)
statusDetail	String

createOrUpdatePerformance

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Creates (if no id specified) or updates a performance in the destination catalog. Performance will be created in state 'PREPARING' and will have to be validated by the catalog owner in order to appear in the getCatalogDetailed method.
Minimum fields : start date, rateTypeId, logicalConfigurationId.
the state of a performance cannot be updated, whatever the value passed as "state" parameter. No error will arise if a value is passed, it will simply be ignored.
if the product is not related to the organization linked to the calling account, the following message arises: "Product " + productId + " is not related to organization :"
if productId is not consistent with previously entered productId, the following error message is returned : "It is not possible to change the product linked to a performance"
if logicalConfigurationId of a performances changes while the performance has been validated, the following error message is returned : "It is not possible to change the logical configuration linked to a validated performance"
if the logical configuration does not belong to the season of the product, the following error message is returned : "Logical configuration of the performance must belong to season: "

Parameters

requestId	Integer
productId	Long
performance	Performance

Performance
SalePeriods	List 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)
alwaysAllowIsolatedSeats	Boolean
blockComparisonEnabled	boolean
breaksQuantity	Integer
charges	List of Charge
chargesTableId	Long
code	String (8)
comfortVariableValues	List of ComfortVariableValue
duration	Integer
eventExternalName	ExternalName	60 characters max for each translation
externalDescription	ExternalName	2000 characters max for each translation
externalName	ExternalName	60 characters max for each translation
externalShortName	ExternalName	15 characters max for each translation
forceNominativeTickets	Boolean
id	Long
image	String
internalDescription	ExternalName	2000 characters max for each translation
internalName	ExternalName	60 characters max for each translation
itemIds	List of Long
kind	String
kindExternalName	ExternalName	60 characters max for each translation
location	Location
logicalConfigurationId	Long
logo	String
logoImage	Image
match	Match
maxSeatsPerOrder	Integer
nameAddOn	ExternalName	240 characters max for each translation
numbered	Boolean
performanceSocialNetworkLinks	List of PerformanceSocialNetworkLink
performanceType	(PERFORMANCE|VISIT|MATCH| PARKING)
physicalConfigurationId	Long
prices	List of Price
rateTypeCode	String (8)
rateTypeId	Long
ratesTableId	Long
saleCloseExceptions	List of SaleCloseException
saleConfigurationId	Long
seatCategories	List of SeatCategory
seatSelectionMode	(AUTO|MANUAL| MANUAL_OR_AUTO| WITHOUT_MAP| WITHOUT_SEATING)
siteCode	String (8)
siteExternalName	ExternalName	60 characters max for each translation
spaceCode	String (8)
spaceExternalName	ExternalName	60 characters max for each translation
spaceId	Long
start	Date
state	(PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED)
titling	Boolean
venueImage	Image
visitLanguageCode	String (8)

SalePeriod
audienceSubCatIds	List of Long
dailyEndTime	Date
dailyStartTime	Date
end	Date
endRelative	Long
postingResalePossible	boolean
quotationPossible	boolean
reservationPossible	boolean
salePeriodEndDateType	(ABSOLUTE|RELATIVE)
salePeriodStartDateType	(ABSOLUTE|RELATIVE)
salePossible	boolean
salesChannelCode	String (8)
salesChannelId	Long
salesChannelName	String
seatCategoryIds	List of Long
start	Date
startRelative	Long
type	(STANDARD|DISCRETE)
weekDays	List of (SUNDAY|MONDAY|TUESDAY| WEDNESDAY|THURSDAY|FRIDAY| SATURDAY)

Charge
amount	Long
audSubCatId	Long
mandatory	boolean
salesChannelId	Long
slope	String
thresholdAmount	Long	If price amount < threshold value, then charge amount will not apply for that price.

ComfortVariableValue
code	String (8)	code of comfort variable corresponding to comfort variable value. This is mandatory parameter for updating comfortvariable values
endDate	Date
externalName	ExternalName	translations for comfort variable. - 60 characters max for each translation
startDate	Date
valueExternalName	ExternalName	translations for comfort variable value. Translation in institution's main external language is mandatory for creating/updating comfortvariable values - 60 characters max for each translation

ExternalName
translations	List of Translation

Translation
locale	String (2)
value	String

Location
siteAddress	PlaceAddress
siteCode	String (8)
siteExternalName	ExternalName	60 characters max for each translation
siteKindName	ExternalName
spaceCode	String (8)
spaceExternalName	ExternalName	60 characters max for each translation

PlaceAddress
countryCode	String (8)
email	String
fax	String
firstAddressLine	String
gpsLatitude	String
gpsLongitude	String
locality	String
phoneNumber	String
secondAddressLine	String
thirdAddressLine	String
website	String
zipCode	String (8)

Image
large	String
medium	String
small	String
xlarge	String

Match
finalDate	Boolean
hostTeam	String
hostTeamId	Long
opposingTeam	String
opposingTeamId	Long
round	String
roundCode	String (8)
roundExternalName	ExternalName	60 characters max for each translation
roundRank	Integer

PerformanceSocialNetworkLink
externalReference	String
posSocialId	Long

Price
including VAT, price in millis
amount	Long
audSubCatId	Long
chargesAmounts	List of ChargesAmount
institutionSeatCatId	Long
maxQty	Integer
minQty	Integer
priceLevelId	Long
seatCatId	Long

ChargesAmount
amount	Long
chargesId	Long

SaleCloseException
date	Date

SeatCategory
bgColor	String
catNum	String
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
institutionCategoryId	Long
name	String
preRequestLogicalSeatCatIds	Set of Long
rank	Integer
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)
textColor	String

Return value

CreateOrUpdatePerformanceResult
updatedPerformance	Performance
requestId	Integer
statusCode	String (8)
statusDetail	String

createOrUpdateProduct

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Creates (if no id specified) or updates a product in the destination catalog. Product will be created in state 'PREPARING' and will have to be validated by the catalog owner in order to appear in the getCatalogDetailed method. As for now, only events can be created. Passes and other simple products will be allowed in a second time. Composed products are not allowed.
The minimal fields to set in the product are : code, name, vatCodeId and rateTypeId.
it is possible to directly create the performances from this call.
It is not possible to set up the logo and all images associated to the event from this call.
the state of a product cannot be updated, whatever the value passed as "state" parameter. No error will arise if a value is passed, it will simply be ignored.
if the season is not related to the organization linked to the calling account, the following message arises: "Season" + seasonId + " is not related to organization :"
if seasonId is not consistent with previously entered seasonId , the following error message is returned : "It is not possible to change the season linked to a product"

Parameters

requestId	Integer
seasonId	Long
product	Product

Product
additionalPartnerContactNumber	String (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)
allowQuestionnaire	boolean
audienceType	String
chargesTableId	Long
code	String (8)
comfortVariableValues	List of ComfortVariableValue
contactProductLinkIds	List of Long
crossSellProductLinks	List of CrossSellProductLink
culturalContact	(MANDATORY|OPTIONAL| NONE)
detailURL	String (255)
event	Event
exchangeable	boolean	If true product can be exchanged provided that the tariff used for the purchase is also allowed for exchange
externalDescription	ExternalName	2000 characters max for each translation
externalName	ExternalName	60 characters max for each translation
goods	Goods
grantedToTourPromoter	boolean
hospitality	Hospitality
id	Long
internalName	ExternalName	60 characters max for each translation
invoicePartnerContactNumber	String (20)
largeImageUrl	String (255)
logo	String
maxQuantity	Integer
media	List of Media
mediumImageUrl	String (255)
membership	Membership
minQuantity	Integer
optionAvailabilities	List of OptionAvailability
pack	Package
partnerContactId	Long	Internal storage field only, should not be exported in versioned DTO
partnerContactNumber	String (20)
pass	Pass
prevSeasonProductId	Long	Id 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|GIFT_AID)
productFamilyType	(SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY)
productSocialNetworkLinks	List of ProductSocialNetworkLink
productTypeId	Long
questionnaireId	Long
remark	String
saleCloseExceptions	List of SaleCloseException
salePeriods	List of SalePeriod
seasonTicket	SeasonTicket
service	Service
shortName	ExternalName	15 characters max for each translation
smallImageUrl	String (255)
state	(PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED)
stops	List of Stop
subTopicLinks	List of SubTopicLink
ticketModelId	Long
transport	Transport
vatCodeId	Long
waitingListAllowed	Boolean
xlargeImageUrl	String (255)

CrossSellProductLink
baseMinQuantity	Integer
baseRestrictedPerformanceIds	List of Long
baseRestrictedSeatCatsIds	List of Long
description	ExternalName	2000 characters max for each translation
end	Date
externalName	ExternalName	60 characters max for each translation
id	Long
rank	Integer
salesChannelId	Long
start	Date
targetAudienceSubCatIds	List of Long
targetProductId	Long
targetProductRank	Integer
targetQuantity	Integer
targetQuantityType	(FIXED|PROPORTIONAL|ANY)
targetRestrictedPerformanceIds	List of Long
targetRestrictedSeatCatIds	List of Long
targetSameDateAsBase	Boolean
type	(SUGGESTION| CROSS_SELL_OUT| CROSS_SELL_IN|UP_SELL| COND_CROSS_SELL)

Event
activityCode	String (8)
activityExternalName	ExternalName	60 characters max for each translation
activityId	Long
activityType	(LIVE_SPECT|FESTIVAL| MUSEUM|VISIT|ENTERT_PARK| FAIR|PARKING|SPORT|OTHER| TOURNAMENT_SESSION)
alertRatio	String
competitionTypeId	Long
language	String
minimumAge	Long
nameAddOn	ExternalName	240 characters max for each translation
performances	List of Performance
timeTolerance	Long

Goods
goodsAxisList	List of GoodsAxis	Contains all the goods axes for which the goods items in @goodsItems have values.
goodsFamilyId	Long
goodsItems	List of GoodsItem
goodsTopicId	Long

GoodsAxis
externalName	ExternalName	60 characters max for each translation
id	Long
rank	Integer

GoodsItem
externalNameDesignation	ExternalName	The designation of a GoodsItem is a concatenation of its corresponding product name, goods axis values
goodsAxisValues	List of GoodsAxisValue
goodsItemId	Long
item	Item	The Item corresponding to the GoodsItem for a given season
reference	String

GoodsAxisValue
externalName	ExternalName	60 characters max for each translation
goodsAxis	GoodsAxis
id	Long
rank	Integer

Item
code	String (8)
donationAmount	Long
donationMaxAmount	Long
donationMinAmount	Long
externalName	ExternalName	60 characters max for each translation
itemClass	(FIRST_CLASS| SECOND_CLASS)
itemId	Long
itemPrices	List of ItemPrice
kind	String
rank	Integer
transportTripType	(ONEWAY|RETURN)
voucherAmount	Long
voucherMaxAmount	Long
voucherMinAmount	Long

ItemPrice
amount	Long
audSubCatId	Long
chargesAmounts	List of ChargesAmount
date	Date
maxQty	Integer
minQty	Integer
priceLevelId	Long
rateTypeId	Long
salePeriods	List of SalePeriod

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

HospitalityItem
hospitalityRoomIds	List of Long
hospitalitySessionId	Long
siteId	Long
code	String (8)
donationAmount	Long
donationMaxAmount	Long
donationMinAmount	Long
externalName	ExternalName	60 characters max for each translation
itemClass	(FIRST_CLASS| SECOND_CLASS)
itemId	Long
itemPrices	List of ItemPrice
kind	String
rank	Integer
transportTripType	(ONEWAY|RETURN)
voucherAmount	Long
voucherMaxAmount	Long
voucherMinAmount	Long

Media
image	Image
rank	Integer
url	String (255)

Membership
isUserDefineStartValidity	boolean
items	List of Item
validityDuration	Integer
validityDurationUnit	(DAY|WEEK|MONTH|YEAR)
validityEndDate	Date
validityRule	(SEASON|PERIOD|PURCHASE)
validityStartDate	Date

OptionAvailability
end	Date
salesChannelCode	String (8)
salesChannelId	Long
start	Date

Package
mandatorySeatCategory	boolean
packageId	Long
packageItems	List of PackageItem
packageLine	List of PackageLine
priceType	(PREDEFINED|DYNAMIC)
ticketPrintingMode	(CARD|TICKETS| CARD_AND_TICKETS|BADGE| BADGE_AND_TICKETS)

PackageItem
institutionCategoryId	Long
itemId	Long
itemPrices	List of ItemPrice
rank	Integer
seatCatLinkName	ExternalName
seatCategoryLink	List of SeatCategoryLink

SeatCategoryLink
seatCategoryId	Long

PackageLine
forcedAudSubCatId	Long
optional	boolean
packageLineId	Long
parentPackageLineId	Long
product	Product
quantity	Integer
rank	Integer

Pass
consecutive	(CONSECUTIVE| NON_CONSECUTIVE| INDIFFERENT)
dateMandatory	boolean
durationUnit	(DAY|WEEK|MONTH|YEAR)
guided	boolean
items	List of Item
minimumGroupSize	int
numberOfEntries	int
pricingType	(PER_PERSON| GROUP_FLAT_RATE)
spaceIds	List of Long
ticketType	(INDIVIDUAL_TICKET| GROUP_TICKET)
timeslotIds	List of Long
timeslotPassDisplayType	(ONLY_ONE_SLOT_DISPLAY_DATE_ONLY|ONLY_ONE_SLOT_DISPLAY_TIME|MANY_SLOTS)
validFrom	Date
validTo	Date
validityDate	Date
validityDuration	Integer
validityRule	(SEASON|PERIOD|PURCHASE)
visitDurationIndependantOfTimeslot	Integer
visitThemeIds	List of Long
visitType	(GROUP_VISIT| INDIVIDUAL_VISIT)
withoutVisibleTheme	boolean

ProductSocialNetworkLink
externalReference	String
posSocialId	Long

SeasonTicket
additionalSeatsMaxQuantity	Integer
additionalSeatsMaxQuantityPerPerformance	Integer
additionalSeatsRestrictedAudienceSubCategoryIds	List of Long
allowAdditionalSeat	boolean
externalAdditionalCatInfo	ExternalName
mandatorySeatCategory	boolean
maxEvents	Integer
maxSeats	Integer
maxSeatsPerEvent	Integer
maxSeatsPerPerformance	Integer
minEvents	Integer
priceType	(PREDEFINED|DYNAMIC)
sameSeat	Boolean
seasonTicketItems	List of SeasonTicketItem
seasonTicketLines	List of SeasonTicketLine
seasonTicketSubjects	List of SeasonTicketSubject
ticketPrintingMode	(CARD|TICKETS| CARD_AND_TICKETS|BADGE| BADGE_AND_TICKETS)

SeasonTicketItem
institutionCategoryId	Long
itemId	Long
itemPrices	List of ItemPrice
rank	Integer
seatCatLinkName	ExternalName
seatCategoryLink	List of SeatCategoryLink

SeasonTicketLine
additionalSeatsOverridenMaxQuantity	Integer
allowSeatCatUpDownGrade	Boolean
mandatoryEvent	Boolean
multiplePerformances	(ONE|MULTI|ALL)
product	Product
seasonTicketLineId	Long

SeasonTicketSubject
code	String (8)
externalName	ExternalName	60 characters max for each translation
maxEvents	Integer
minEvents	Integer
rank	Integer
seasonTicketLines	List of SeasonTicketLine

Service
internetText	ExternalName
items	List of Item

Stop
code	String (8)
name	String
rank	Integer
type	(ARRIVAL|DEPARTURE|VIA| UPSELLING)

SubTopicLink
id	Long

Transport
audiencSubCats	List of AudienceSubCategory
items	List of Item
originDestinationAudienceSubCatDependency	boolean
originDestinationDependency	boolean
type	(RETURN|ROUND_CLOSED| ROUND_OPEN|ONEWAY)
validaty	Integer

AudienceSubCategory
audienceCategoryKind	(FULL|REDUCED|FREE)
childRatio	Integer
code	String (8)
comfortVariableValues	List of ComfortVariableValue
crossSeatCategory	boolean
exchangeable	boolean	If true, products bought with this tariff can be exchanged, provided the product is exchangeable as well
excludeTariffFromLimits	boolean
externalDescription	ExternalName	2000 characters max for each translation
externalName	ExternalName	60 characters max for each translation
externalVerificationId	Long
id	Long
maxQuantity	Integer
minQuantity	Integer
minQuantityOfRequiredASC	Integer
parentAudienceSubCategoryId	Long
parentThreshold	Integer
preselectMaxQuantity	boolean
proportionalCondition	boolean
rank	Integer
requireAttachment	Boolean
requiredAudienceSubCategoryIds	List of Long

Return value

CreateOrUpdateProductResult
updatedProduct	Product
requestId	Integer
statusCode	String (8)
statusDetail	String

createOrUpdateTimeslots

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Create or update the timeslots passed in parameters. The timeslots are created in state PREPARING. They can be activated by using method activateTimeslots. Once in state RUNNING, they cannot be deleted.

Parameters

requestId	Integer
spaceId	Long
seasonId	Long
timeslots	List of Timeslot

Timeslot
allVisitLanguages	boolean
allVisitThemes	boolean
duration	Integer
id	Long
quota	Integer
rateTypeId	Long
salesTolerance	Integer
startDate	Date
startTime	Date
visitLanguagesCodes	List of String
visitThemesIds	List of Long

Return value

ListTimeslotsResult
seasonId	Long
spaceId	Long
timeslots	List of Timeslot
requestId	Integer
statusCode	String (8)
statusDetail	String

deleteNonValidatedPerformance

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Deletes a performance in state preparing (a product created through the method createOrUpdatePerformance). Does not allow to delete a validated performance.

Parameters

requestId	Integer
performanceId	Long

Return value

WebMethodResult

deleteNonValidatedProduct

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Deletes a product in state preparing (a product created through the method createOrUpdateProduct). Does not allow to delete any kind of product.

Parameters

requestId	Integer
productId	Long

Return value

WebMethodResult

deleteTimeslots

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Deletes timeslots in state preparing (a timeslot created through the method createOrUpdatePerformance not yet validated in backoffice). Does not allow to delete a validated or running timeslot.

Parameters

requestId	Integer
timeslotIds	List of Long	ids of the timeslots to be deleted

Return value

WebMethodResult

freezeSeats

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Freeze seats with reason.

Parameters

performanceId	Long	Mandatory the performanece ID (mandatory param)
physicalSeatIds	List of Long	Mandatory the physical seats IDs to freeze(mandatory param)
freezeReasonIc	String	internal code for the freeze reason

Return value

SeatsDetailResult
seatsDetailData	SeatsDetailData
requestId	Integer
statusCode	String (8)
statusDetail	String

SeatsDetailData
seatDescriptions	List of SeatDescription

SeatDescription
externalRemark	String
seatQuality	String
seatQualityId	String
stageVisibility	String
stageVisibilityType	String
titlingVisibility	String
titlingVisibilityType	String
UNDEFINED	String
areaId	Long
areaKind	(INDIFFERENT|BOX)
available	boolean
blockId	Long
classification1ic	String
classification2ic	String
contingentId	Long
dummySeat	boolean
entranceId	Long
externalEntranceId	Long
freezingReasonIc	String
frozen	boolean
number	String
optimalSeatSelectionValue	Long
physicalSeatId	Long
rotation	int
row	String
scenePanoLink	String
scenePhotoLink	String
seatCategoryId	Long
seatOrder	Long
x	int
y	int

getLimitsForPasses

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Get the limits for the passes.

Parameters

passIds	List of Long	Mandatory the pass IDs (mandatory param)
timeslotIds	List of Long	Mandatory the timeslot IDs (mandatory param)

Return value

PassLimitResult
passTimeslotLimitsData	List of PassTimeslotLimitData	The information about the found passes.
requestId	Integer
statusCode	String (8)
statusDetail	String

PassTimeslotLimitData
Pass timeslot limit data.
limit	Integer	Limit/quota of the pass-timeslot.
passId	Long	Dated Pass ID.
timeslotId	Long	Timeslot ID.

getPerformanceDetails

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns the set-up details of a given performance.

Parameters

requestId	Integer
performanceId	Long

Return value

PerformanceDetailsResult
performance	Performance
requestId	Integer
statusCode	String (8)
statusDetail	String

getProductDetails

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns the set-up details of a given product.

Parameters

requestId	Integer
productId	Long

Return value

ProductDetailsResult
product	Product
requestId	Integer
statusCode	String (8)
statusDetail	String

getTimeslots

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Gets some timeslots. This method can be used to retrieve timeslots that are not in sale anymore (like past timeslots). For actual timeslots, please use the catalog service

Parameters

requestId	Integer
timeslotIds	List of Long

Return value

GetTimeslotsResult
timeslots	List of Timeslot
requestId	Integer
statusCode	String (8)
statusDetail	String

isSetupServiceAlive

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

validate network connection and login/password

Parameters

Return value

WebMethodResult

listActivities

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the validated activities related to the given season.

Parameters

requestId	Integer
seasonId	Long

Return value

ListActivitiesResult
activities	List of Activity
requestId	Integer
statusCode	String (8)
statusDetail	String

Activity
code	String (8)
comfortVariables	List of ComfortVariable
id	long
name	ExternalName
state	(PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED)
type	(LIVE_SPECT|FESTIVAL| MUSEUM|VISIT|ENTERT_PARK| FAIR|PARKING|SPORT|OTHER| TOURNAMENT_SESSION)

ComfortVariable
code	String (8)
externalName	ExternalName	60 characters max for each translation
internalName	ExternalName	60 characters max for each translation

listAudienceCategories

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

List all audience categories defined for this institution.

Parameters

requestId

Integer

Return value

ListAudienceCategoriesResult
audienceCategories	List of AudienceCategory
requestId	Integer
statusCode	String (8)
statusDetail	String

AudienceCategory
audienceSubCategories	List of AudienceSubCategory
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
mainCategory	(OCCASIONAL|SUBSCRIBER| INSIDE_SEASONTICKET| MEMBER|INVITED)
secondaryCategory	(INDIVIDUAL|COMMUNITY| GROUP|TAXED|FREE| PROMOTIONAL|ERROR)

listAudienceSubCategories

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

List all audience sub categories defined for an audience category (optional) and an audience sub category.

Parameters

requestId	Integer
audienceCategoryId	Long
seasonId	Long

Return value

ListAudienceSubCategoriesResult
audienceSubCategories	List of AudienceSubCategory
requestId	Integer
statusCode	String (8)
statusDetail	String

listLogicalConfigurations

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the validated logical configurations relative to the given season.

Parameters

requestId	Integer
seasonId	Long

Return value

ListLogicalConfigurationsResult
logicalConfigurations	List of LogicalConfiguration
requestId	Integer
statusCode	String (8)
statusDetail	String

LogicalConfiguration
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
notNumberedAreas	List of NotNumberedAreaMapping
physicalConfigurationId	Long
seatCategories	List of SeatCategory
securityGauge	Integer
selectionMap	SelectionMap

NotNumberedAreaMapping
physicalAreaId	Long
seatCategoryId	Long

SelectionMap
svgFile	String
view	String
visualPolygons	List of VisualPolygon

VisualPolygon
externalName	ExternalName	60 characters max for each translation
linkedAreaIds	List of Long
linkedBlockIds	List of Long
panoramicImageUrl	String (255)
svgFile	String
svgPolygonIdentifier	String

listOrganizationVariableValues

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId

Integer

Return value

ListOrganizationVariableValuesResult
organizationVariableValues	List of OrganizationVariableValue
requestId	Integer
statusCode	String (8)
statusDetail	String

OrganizationVariableValue
A custom value associated to an organization.
endValueDate	Date
id	Long	Not mandatory for new value.
key	String	Max 100 chars
startValueDate	Date
value	String	Max 4000 chars.

listPhysicalConfigurations

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the validated physical configurations for the institution.

Parameters

requestId

Integer

Return value

ListPhysicalConfigurationsResult
physicalConfigurations	List of PhysicalConfiguration
requestId	Integer
statusCode	String (8)
statusDetail	String

PhysicalConfiguration
areas	List of Area
code	String (8)
countryCode	String (8)
externalName	ExternalName	60 characters max for each translation
formattedAddress	String
id	Long
image	String
mapType	String
panoViewUrl	String (255)
pdfView	String
seatMapImage	Image
securityGauge	Integer
siteCode	String (8)
siteExternalName	ExternalName	60 characters max for each translation
siteId	Long
siteKindCode	String (8)
siteKindName	ExternalName
spaceCode	String (8)
spaceExternalName	ExternalName	60 characters max for each translation
spaceId	Long
spaceType	String
street	String
town	String
zipcode	String (8)

Area
blocks	List of Block
code	String (8)
externalName	ExternalName	60 characters max for each translation
floor	String
id	Long
internalName	ExternalName	60 characters max for each translation
kind	(INDIFFERENT|BOX)
physicalGauge	Integer
sector	String
shapes	List of Shape
type	(NUMBERED_SEAT| NOT_NB_SEAT| NOT_NB_STAND_SEAT)

Block
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
internalName	ExternalName	60 characters max for each translation
shapes	List of Shape

Shape
x	List of Integer
y	List of Integer

listPriceLevels

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

List all audience categories defined for this institution.

Parameters

requestId	Integer
seasonId	Long

Return value

ListPriceLevelsResult
priceLevels	List of PriceLevel
requestId	Integer
statusCode	String (8)
statusDetail	String

PriceLevel
code	String (8)
id	Long
mainCategory	(OCCASIONAL|SUBSCRIBER| INSIDE_SEASONTICKET| MEMBER|INVITED)
reduction	Integer

listRateTypes

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the validated rate types relative to the given season.

Parameters

requestId	Integer
seasonId	Long

Return value

ListRateTypesResult
rateTypes	List of RateType
requestId	Integer
statusCode	String (8)
statusDetail	String

RateType
bgColor	String
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	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|GIFT_AID)
productFamilyType	(SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY)
textColor	String

listSeasons

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the active seasons in the organisation related to the sales channel linked the virtual operator used to connect.

Parameters

requestId

Integer

Return value

ListSeasonsResult
seasons	List of Season
requestId	Integer
statusCode	String (8)
statusDetail	String

Season
advantages	List of Advantage
audienceCategories	List of AudienceCategory
chargesTables	List of ChargesTable
code	String (8)
competitionTypes	List of CompetitionType
conditionalCrossSells	List of ConditionalCrossSell
end	Date
externalName	ExternalName	60 characters max for each translation
goodsFamilies	List of GoodsFamily
goodsTopics	List of GoodsTopic
hospitalityRooms	List of HospitalityRoom
hospitalitySessions	List of HospitalitySession
id	Long
logicalConfigurations	List of LogicalConfiguration
num	Long
optionLimitationLines	List of OptionLimitationLine
optionables	List of Optionable
priceComponents	List of PriceComponent
priceLevels	List of PriceLevel
productTypes	List of ProductType
products	List of Product
questionnaires	List of Questionnaire
questions	List of Question
rateTypes	List of RateType
ratesTables	List of RatesTable
sites	List of Site
start	Date
state	(PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED)
teams	List of Team
timeslots	List of Timeslot
topics	List of Topic

Advantage
accessCode	String (8)
advantageTargetType	(PUBLIC|CODE|CONTACT)
advantageType	(ADVANTAGE|RULESET|PROMO| RESALE)
allowPurchaseCulturalContact	boolean
autoPromote	boolean
code	String (8)
contactLimitation	(LIMITED|NOT_LIMITED)
discountAmount	Long
discountPaymentMethodId	Long
end	Date
endRelative	Long
exclusive	boolean
externalDescription	ExternalName	2000 characters max for each translation
externalName	ExternalName	60 characters max for each translation
freeShipmentModeIds	List of Long	If this list is not empty, this is an advantage for free shipment fee. Shipment modes for which no shipment fees will be charged.
id	Long
image	Image
isQuotaPerTimeslot	Boolean
largeImageUrl	String (255)
logo	String
mandatoryContact	boolean
maxOrderQuantity	Long
maxQuantityPerPerformance	Integer
mediumImageUrl	String (255)
performanceEndDateType	(NONE|TIME_TOLERANCE| ABSOLUTE|RELATIVE)
products	List of Product
singleSeatCatPerPerformance	boolean
smallImageUrl	String (255)
start	Date
startRelative	Long
state	(PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED)

ChargesTable
chargeType	String
charges	List of Charge
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long

CompetitionType
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
logo	String
logoImage	Image

ConditionalCrossSell
products	List of Product

GoodsFamily
Code	String (8)
externalName	ExternalName	60 characters max for each translation
goodsFamilies	List of GoodsFamily
id	Long
rank	Integer

GoodsTopic
code	String (8)
externalName	ExternalName	60 characters max for each translation
goodsTopics	List of GoodsTopic
id	Long

HospitalityRoom
capacity	Integer
code	String (8)
externalName	ExternalName	60 characters max for each translation
floor	String
id	Long
location	String
locationName	ExternalName
pitchView	Boolean
pitchViewImage	Image
pitchViewLogo	String
roomImage	Image
roomLogo	String
siteId	Long

HospitalitySession
bgColor	String
code	String (8)
date	Date
externalName	ExternalName	60 characters max for each translation
id	Long
performance	Performance
siteId	Long
textColor	String
time	Date

OptionLimitationLine
id	Long
logicalSeatCatIds	List 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|GIFT_AID)
productFamilyType	(SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY)
structureCommunityType	String

Optionable
product	Product

PriceComponent
code	String (8)
discount	boolean
externalName	ExternalName	60 characters max for each translation
fixedAmount	Long
id	Long
mandatory	boolean
percentage	String
priceComponentType	(INSIDE_COMPONENT| OUTSIDE_COMPONENT)
rank	int
refundable	boolean
roundingGranularity	Long
ticketPrice	boolean
vatCode	String (8)
vatCodeId	Long

ProductType
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
productFamilyId	Long

Questionnaire
code	String (8)
id	Long
questionnaireQuestions	List of QuestionnaireQuestion

QuestionnaireQuestion
mandatoryAnswer	boolean
questionId	Long
rank	Integer

Question
answerElements	List of AnswerElement
answerType	(ADDRESS|BOOLEAN|NUMBER| DATE|PHONE|COUNTRY|EMAIL| TEXT|LIST_SINGLE| LIST_MULTI)
autoCopiedAnswer	boolean
code	String (8)
defaultAnswer	String
externalDescription	ExternalName	This field is described more information about a question. - 2000 characters max for each translation
externalName	ExternalName	60 characters max for each translation
id	Long
internalName	ExternalName	60 characters max for each translation

AnswerElement
code	String (8)
defaultValue	boolean
externalName	ExternalName	60 characters max for each translation
id	Long
internalName	ExternalName	60 characters max for each translation
rank	Integer

RatesTable
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
parentId	Long
prices	List of Price
ratesTableBreakdownId	Long

Site
accessImage	String
address	PlaceAddress
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
siteAccessImage	Image
siteKindCode	String (8)
siteKindName	ExternalName
spaces	List of Space

Space
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
siteId	Long

Team
code	String (8)
countryCode	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
logo	String
logoImage	Image

Topic
SubTopics	List of SubTopic
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long

SubTopic
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
subTopics	List of SubTopic

listSpaces

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the validated spaces.

Parameters

requestId

Integer

Return value

ListSpacesResult
spaces	List of Space
requestId	Integer
statusCode	String (8)
statusDetail	String

listTicketModels

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the validated ticket models.

Parameters

requestId

Integer

Return value

ListTicketModelsResult
ticketModels	List of TicketModel
requestId	Integer
statusCode	String (8)
statusDetail	String

TicketModel
code	String (8)
id	long
modelVariants	List of ModelVariant
name	ExternalName

ModelVariant
Created by lkl on 24.09.2018.
cartTypeId	Long
id	long
ticketSupport	TicketSupport

TicketSupport
formatRequired	boolean
id	Long
modelType	(THERMAL|PDF)
paperless	boolean
shipmentModeTypes	List of ShipmentModeType
ticketSupportEnum	(THERMAL|ETICKET|PAPER_A4| PASSBOOK|MOBILE| BLOCKCHAIN|BADGE|RFID| PR_RFID_CARD| DEMAT_BADGE)

ShipmentModeType
availableForDocuments	boolean
availableForTickets	boolean
externalProvider	boolean
id	Long

listTimeslots

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the timeslots for a given season and space.

Parameters

requestId	Integer
spaceId	Long
seasonId	Long

Return value

ListTimeslotsResult

listTopics

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the validated topics related to the given season.

Parameters

requestId	Integer
seasonId	Long

Return value

ListTopicsResult
topics	List of Topic
requestId	Integer
statusCode	String (8)
statusDetail	String

listVatCodes

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the active vat codes.

Parameters

requestId

Integer

Return value

ListVatCodesResult
vatCodes	List of VatCode
requestId	Integer
statusCode	String (8)
statusDetail	String

VatCode
code	String (8)
country	String
currentRate	Integer
id	long

listVisitGroupKinds

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the possible visit group kinds.

Parameters

requestId

Integer

Return value

ListVisitGroupKindsResult
visitGroupKinds	List of VisitGroupKind
requestId	Integer
statusCode	String (8)
statusDetail	String

VisitGroupKind
defaultValue	boolean
externalName	ExternalName	60 characters max for each translation
groupKindInternalCode	String (8)
rank	Integer

listVisitLanguages

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the possible visit languages.

Parameters

requestId

Integer

Return value

ListVisitLanguagesResult
visitLanguage	List of VisitLanguage
requestId	Integer
statusCode	String (8)
statusDetail	String

VisitLanguage
code	String (8)
name	ExternalName

listVisitThemes

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Lists all the possible visit themes.

Parameters

requestId

Integer

Return value

ListVisitThemesResult
visitThemes	List of VisitTheme
requestId	Integer
statusCode	String (8)
statusDetail	String

VisitTheme
code	String (8)
externalName	ExternalName	60 characters max for each translation
id	Long
multilingual	boolean
visitLanguageCodes	List of String

saveItemPrice

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Modifies the price of a given item in the catalog.

Parameters

requestId	Integer
itemPrices	List of ItemPriceUpdate

ItemPriceUpdate
amount	Long	Optional, price in millis, eg 25500 means 25.5 €. When provided, sets the price, if sent as “null” then this item cannot be sold any more (allowing to open/close some categories or audienceSubCategories).
audienceSubCategoryId	Long	Mandatory.
currencyCode	String (8)	Optional, to choose the rates table which will be updated. If it is not specified then the organization currency code will be applied. ISO-4217 currency code. Example: EUR
forceUpdate	boolean	Optional, false by default which means the rates table will be duplicated when it is shared among matches/packages/advantages instead of be updated for all of then. True to avoid duplicating and update all.
itemId	Long	to provide when the product is a Service, a Membership, a Goods or a Pass
performanceId	Long	to provide when the product is an event
pricelevelId	Long	Optional, to provide when the product is sold at a different price if the purchaser is holding a Membership or a SeasonTicket
productId	Long	Mandatory
seatCategoryId	Long	To provide when the product is an event. Either itemId or performanceId+seatCategoryId must be provided

Return value

SaveItemPriceResult
requestId	Integer
statusCode	String (8)
statusDetail	String

searchProductsByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Searches the products according to the criteria. The lower the granularity, the faster the response.

Parameters

requestId	Integer
searchProductsCriteria	SearchProductsCriteria	Mandatory mandatory.
granularity	(ID|PRODUCT|COMPLETE)	optional. Default : PRODUCT
minIndex	Integer	TODO
nbMaxResults	Integer	TODO

SearchProductsCriteria
codes	List of String	Optional. If non empty, only products with the given codes will be returned.
performanceStates	List of (PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED)	Optional. If non empty, only products linked to performances with the given states will be returned. Passing a value in this parameter will automatically filter event products. Non event products won't be returned.
productFamilySubTypes	List of (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|GIFT_AID)	Optional. If non empty, only products with the given family sub types will be returned.
productFamilyTypes	List of (SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY)	Optional. If non empty, only products with the given family types will be returned.
productIds	List of Long	Optional. If non empty, only products with the given ids will be returned.
seasonIds	List of Long	Optional. If non empty, only products linked to the given seasons will be returned.
states	List of (PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED)	Optional. If non empty, only products with the given states will be returned.

Return value

ListProductsResult
products	List of Product
requestId	Integer
statusCode	String (8)
statusDetail	String

setLimitsForPasses

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Set the limits for the passes.

Parameters

passIds	List of Long	Mandatory the pass IDs (mandatory param)
timeslotIds	List of Long	Mandatory the timeslot IDs (mandatory param)
limit	Integer	Mandatory the limit to set into the passes (mandatory param and must be in the range 0 to 999999)

Return value

PassLimitResult

unfreezeSeats

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Unfreeze frozen seats

Parameters

performanceId	Long	Mandatory the performanece ID (mandatory param)
physicalSeatIds	List of Long	Mandatory the physical seats IDs to unfreeze (mandatory param)

Return value

SeatsDetailResult

updateOrganizationVariableValues

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Updates the values for the organization variables.

Parameters

requestId	Integer
comfortVariableValues	List of OrganizationVariableValue	the values to be updated. The whole list need to be passed, replacing the existing set of values. Any variable not present in the list will be deleted.

Return value

ListOrganizationVariableValuesResult