| URL: | ||
| JWT Token | ||
| Template: | ||
| cURL: |
Version: 1_20 (other versions, change log, ZUMSTEIN_V4.4-SNAPSHOT) 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://myinstit.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.catalog.v1_20.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.
| 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.
| requestId | Integer | |
| productId | Long | |
| performance | Performance |
| Performance | ||
| SalePeriods | List of SalePeriod | |
| alwaysAllowIsolatedSeats | 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 | ||
| audCatId | Long | |
| dailyEndTime | Date | |
| dailyStartTime | Date | |
| end | Date | |
| endRelative | Long | |
| quotationPossible | boolean | |
| reservationPossible | boolean | |
| salePeriodEndDateType | (ABSOLUTE|RELATIVE) | |
| salePeriodStartDateType | (ABSOLUTE|RELATIVE) | |
| salePossible | boolean | |
| salesChannelCode | String (8) | |
| salesChannelId | Long | |
| salesChannelName | String | |
| 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 | |
| ComfortVariableValue | ||
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| valueExternalName | ExternalName | 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 |
| spaceCode | String (8) | |
| spaceExternalName | ExternalName | 60 characters max for each translation |
| PlaceAddress | ||
| countryCode | String (8) | |
| String | ||
| fax | String | |
| firstAddressLine | String | |
| gpsLatitude | String | |
| gpsLongitude | String | |
| locality | String | |
| phoneNumber | String | |
| secondAddressLine | String | |
| thirdAddressLine | String | |
| zipCode | String (8) | |
| Image | ||
| large | String | |
| medium | String | |
| small | 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 |
| 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 | |
| rank | Integer | |
| textColor | String | |
| CreateOrUpdatePerformanceResult | ||
| updatedPerformance | Performance | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| 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.
| requestId | Integer | |
| seasonId | Long | |
| product | Product |
| Product | ||
| allowQuestionnaire | boolean | |
| audienceType | String | |
| chargesTableId | Long | |
| code | String (8) | |
| crossSellProductLinks | List of CrossSellProductLink | |
| culturalContact | (MANDATORY|OPTIONAL| NONE) | |
| detailURL | String (255) | |
| event | Event | |
| externalDescription | ExternalName | 2000 characters max for each translation |
| externalName | ExternalName | 60 characters max for each translation |
| goods | Goods | |
| hospitality | Hospitality | |
| id | Long | |
| internalName | ExternalName | 60 characters max for each translation |
| 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) | |
| productFamilyType | (SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY) | |
| productSocialNetworkLinks | List of ProductSocialNetworkLink | |
| productTypeId | Long | |
| questionnaireId | Long | |
| 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) | |
| subTopicLinks | List of SubTopicLink | |
| ticketModelId | Long | |
| transport | Transport | |
| vatCodeId | Long | |
| waitingListAllowed | Boolean | |
| 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 | Integer | |
| 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 | |
| HospitalityItem | ||
| hospitalityAreaIds | List of Long | |
| 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) | |
| 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 | |
| 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 | |
| SubTopicLink | ||
| id | Long | |
| Transport | ||
| audiencSubCats | List of AudienceSubCategory | |
| items | List of Item | |
| originDestinationAudienceSubCatDependency | boolean | |
| originDestinationDependency | boolean | |
| stops | List of Stop | |
| type | (RETURN|ROUND_CLOSED| ROUND_OPEN|ONEWAY) | |
| validaty | Integer | |
| AudienceSubCategory | ||
| audienceCategoryKind | (FULL|REDUCED|FREE) | |
| code | String (8) | |
| 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 | |
| rank | Integer | |
| requireAttachment | Boolean | |
| requiredAudienceSubCategoryIds | List of Long | |
| Stop | ||
| code | String (8) | |
| name | String | |
| rank | Integer | |
| type | (ARRIVAL|DEPARTURE|VIA) | |
| CreateOrUpdateProductResult | ||
| updatedProduct | Product | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| spaceId | Long | |
| seasonId | Long | |
| timeslots | List of Timeslot |
| Timeslot | ||
| allVisitLanguages | boolean | |
| allVisitThemes | boolean | |
| duration | Integer | |
| id | Long | |
| rateTypeId | Long | |
| salesTolerance | Integer | |
| startDate | Date | |
| startTime | Date | |
| visitLanguagesCodes | List of String | |
| visitThemesIds | List of Long | |
| ListTimeslotsResult | ||
| seasonId | Long | |
| spaceId | Long | |
| timeslots | List of Timeslot | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| 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.
| requestId | Integer | |
| performanceId | Long |
| WebMethodResult | ||
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| 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.
| requestId | Integer | |
| productId | Long |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Returns the set-up details of a given performance.
| requestId | Integer | |
| performanceId | Long |
| PerformanceDetailsResult | ||
| performance | Performance | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Returns the set-up details of a given product.
| requestId | Integer | |
| productId | Long |
| ProductDetailsResult | ||
| product | Product | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
validate network connection and login/password
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the validated activities related to the given season.
| requestId | Integer | |
| seasonId | Long |
| 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 |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
List all audience categories defined for this institution.
| requestId | Integer |
| 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) | |
| 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.
| requestId | Integer | |
| audienceCategoryId | Long | optional |
| seasonId | Long | optional, the relevant season id |
| ListAudienceSubCategoriesResult | ||
| audienceSubCategories | List of AudienceSubCategory | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the validated logical configurations relative to the given season.
| requestId | Integer | |
| seasonId | Long |
| 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 | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the validated physical configurations for the institution.
| requestId | Integer |
| 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 |
| spaceCode | String (8) | |
| spaceExternalName | ExternalName | 60 characters max for each translation |
| 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 | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
List all audience categories defined for this institution.
| requestId | Integer | |
| seasonId | Long |
| 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 | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the validated rate types relative to the given season.
| requestId | Integer | |
| seasonId | Long |
| 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 | |
| textColor | String | |
| 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.
| requestId | Integer |
| 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 | |
| externalName | ExternalName | 60 characters max for each translation |
| goodsFamilies | List of GoodsFamily | |
| goodsTopics | List of GoodsTopic | |
| hospitalityAreas | List of HospitalityArea | |
| hospitalityRooms | List of HospitalityRoom | |
| hospitalitySessions | List of HospitalitySession | |
| id | Long | |
| logicalConfigurations | List of LogicalConfiguration | |
| num | Long | |
| optionLimitationLines | List of OptionLimitationLine | |
| optionables | List of Optionable | |
| 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 | |
| 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) | |
| 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 |
| id | Long | |
| image | Image | |
| largeImageUrl | String (255) | |
| logo | String | |
| mandatoryContact | boolean | |
| maxOrderQuantity | Long | |
| mediumImageUrl | String (255) | |
| performanceEndDateType | (NONE|TIME_TOLERANCE| ABSOLUTE|RELATIVE) | |
| products | List of Product | |
| 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 | |
| HospitalityArea | ||
| areaType | (SKYBOX|PREMIUM_SEATS| BOTH) | |
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| location | String | |
| logo | String | |
| pitchView | Boolean | |
| quantity | Integer | |
| seatQuantity | Integer | |
| siteId | Long | |
| HospitalityRoom | ||
| capacity | Integer | |
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| floor | String | |
| id | Long | |
| location | String | |
| pitchView | Boolean | |
| 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) | |
| productFamilyType | (SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY) | |
| structureCommunityType | String | |
| Optionable | ||
| product | Product | |
| 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|EMAIL|TEXT| LIST_SINGLE|LIST_MULTI) | |
| autoCopiedAnswer | boolean | |
| code | String (8) | |
| defaultAnswer | String | |
| 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) | |
| 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 | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the validated spaces.
| requestId | Integer |
| ListSpacesResult | ||
| spaces | List of Space | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the validated ticket models.
| requestId | Integer |
| ListTicketModelsResult | ||
| ticketModels | List of TicketModel | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| TicketModel | ||
| code | String (8) | |
| id | long | |
| name | ExternalName | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the timeslots for a given season and space.
| requestId | Integer | |
| spaceId | Long | |
| seasonId | Long |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the active vat codes.
| requestId | Integer |
| ListVatCodesResult | ||
| vatCodes | List of VatCode | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| VatCode | ||
| code | String (8) | |
| country | String | |
| currentRate | Integer | |
| id | long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the possible visit group kinds.
| requestId | Integer |
| ListVisitGroupKindsResult | ||
| visitGroupKinds | List of VisitGroupKind | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| VisitGroupKind | ||
| externalName | ExternalName | 60 characters max for each translation |
| groupKindInternalCode | String (8) | |
| rank | Integer | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the possible visit languages.
| requestId | Integer |
| ListVisitLanguagesResult | ||
| visitLanguage | List of VisitLanguage | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| VisitLanguage | ||
| code | String (8) | |
| name | ExternalName | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists all the possible visit themes.
| requestId | Integer |
| 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 | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Modifies the price of a given item in the catalog.
| requestId | Integer | |
| itemPrices | List of ItemPriceUpdate | the updated prices. |
| 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. |
| 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 |
| SaveItemPriceResult | ||
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Searches the products according to the criteria. The lower the granularity, the faster the response.
| requestId | Integer | |
| searchProductsCriteria | SearchProductsCriteria | Mandatory mandatory. |
| granularity | (ID|PRODUCT|COMPLETE) | optional. Default : PRODUCT |
| minIndex | Integer | optional. minimum index for pagination. Default : 0 |
| nbMaxResults | Integer | optional. Nb max of results. Default : 10. Max : 100. |
| SearchProductsCriteria | ||
| codes | List of String | Optional. If non empty, only products with the given codes will 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) | 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. |
| ListProductsResult | ||
| products | List of Product | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |