| URL: | ||
| JWT Token | ||
| Template: | ||
| cURL: |
Version: 1_31 (other versions, change log, ZUMSTEIN_V3.12-SNAPSHOT) Deprecated. This version is frozen and still supported.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.catalog.v1_31.CatalogService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnseb/backend-apis/catalogService/v1_31/{methodName} Replace {methodName} for the desired method name as shown below.
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 |
Extracts the catalog as defined for the sales channel linked to the account.
Only RUNNING or SUSPENDED objects are exported. This method returns the current status of the catalog.
Warning : this method may be asynchronous.
Catalog is returned as a set of objects.
| requestId | Integer | optional request id, used to identify asynchronous requests (see {@link AsynchronousMethod}. |
| seasonCode | String (8) | optional season code to restrict the returned data. |
| productCode | String (8) | optional product code to restrict the returned data. |
| scope | (ON_SALE|EXTENDED) | Mandatory Scope of the catalog. Not mandatory. Default value is : ON_SALE. ON_SALE: all products on sale related to sales channel. EXTENDED: catalog also includes validated, suspended and cancelled products. |
| CatalogResultDetailed | ||
| catalogData | CatalogData | |
| requestState | AsynchronousMethodResult. AsynchronousMethodState | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| CatalogData | ||
| contactProductLinks | List of ContactProductLink | |
| externalVerifications | List of ExternalVerification | |
| groupCriterions | List of GroupCriterionData | |
| physicalConfigurations | List of PhysicalConfiguration | |
| seasons | List of Season | |
| storefront | Storefront | |
| visitGroupKinds | List of VisitGroupKind | |
| visitLanguages | List of VisitLanguage | |
| visitThemes | List of VisitTheme | |
| ContactProductLink | ||
| contactNumber | String (20) | |
| contactProductConnectionType | (RESPONSIBLE|OBSERVER| INVOICE|ARTIST) | |
| description | String | |
| id | Long | |
| photo | Image | |
| rank | int | |
| stageName | String | |
| Image | ||
| large | String | |
| medium | String | |
| small | String | |
| xlarge | String | |
| ExternalVerification | ||
| description | ExternalName | 2000 characters max for each translation |
| externalName | ExternalName | 60 characters max for each translation |
| field1Name | ExternalName | |
| field2Name | ExternalName | |
| id | Long | |
| logo | String | |
| numberOfTicketsPerCard | Long | |
| ExternalName | ||
| translations | List of Translation | |
| Translation | ||
| locale | String (2) | |
| value | String | |
| GroupCriterionData | ||
| code | String (8) | |
| elements | List of GroupCriterionElementData | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| planningRequirement | boolean | |
| rank | int | |
| GroupCriterionElementData | ||
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | long | |
| rank | int | |
| 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 | |
| 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) | |
| 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 | |
| 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) | |
| 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) | |
| 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) | |
| stops | List of Stop | |
| subTopicLinks | List of SubTopicLink | |
| ticketModelId | Long | |
| transport | Transport | |
| vatCodeId | Long | |
| waitingListAllowed | Boolean | |
| xlargeImageUrl | String (255) | |
| 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 |
| 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 | |
| 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 | ||
| 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 | |
| thresholdAmount | Long | If price amount < threshold value, then charge amount will not apply for that price. |
| 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) | |
| String | ||
| fax | String | |
| firstAddressLine | String | |
| gpsLatitude | String | |
| gpsLongitude | String | |
| locality | String | |
| phoneNumber | String | |
| secondAddressLine | String | |
| thirdAddressLine | String | |
| website | String | |
| zipCode | String (8) | |
| 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 | |
| rank | Integer | |
| sameBlockRestrictionMode | (NONE|AUTO| MANUAL_OR_AUTO) | Seat selection mode need to add same seat's block validation.
Available modes: |
| textColor | String | |
| 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) | |
| 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 | |
| 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) | |
| 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 | |
| proportionalCondition | boolean | |
| rank | Integer | |
| requireAttachment | Boolean | |
| requiredAudienceSubCategoryIds | List of Long | |
| 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) | |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| PriceLevel | ||
| code | String (8) | |
| id | Long | |
| mainCategory | (OCCASIONAL|SUBSCRIBER| INSIDE_SEASONTICKET| MEMBER|INVITED) | |
| reduction | Integer | |
| 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 | |
| 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) | |
| productFamilyType | (SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY) | |
| textColor | String | |
| 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 | |
| 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 | |
| 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 | |
| Storefront | ||
| storefrontItems | List of StorefrontItem | |
| StorefrontItem | ||
| audSubCatId | Long | |
| itemId | Long | |
| performanceId | Long | |
| productId | Long | |
| rank | Integer | |
| VisitGroupKind | ||
| defaultValue | boolean | |
| externalName | ExternalName | 60 characters max for each translation |
| groupKindInternalCode | String (8) | |
| rank | Integer | |
| VisitLanguage | ||
| code | String (8) | |
| name | ExternalName | |
| 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 |
Return details on how the catalog should be presented to a final web user. The details are returned in the form of visual sections and product clusters. The result is dependent on the sales channel in the implicit context.
| requestId | Integer |
| CatalogPresentationResult | ||
| catalogPresentationData | CatalogPresentationData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| CatalogPresentationData | ||
| sections | List of Section | |
| tours | List of Tour | |
| Section | ||
| allProducts | Boolean | |
| allTours | Boolean | |
| aspectRatio | String | |
| classifyBy | (FAMILY|CLUSTER|DATE| NONE) | |
| clusterItemSorting | (SORTING_BY_DATE| SORTING_BY_RANK) | |
| clusters | List of Cluster | |
| code | String (8) | |
| columns | Integer | |
| displayActionBtn | Boolean | |
| displayDescPreview | Boolean | |
| displayPriceInfo | Boolean | |
| displayProdNotOnSale | Boolean | |
| displaySalesStartDate | Boolean | |
| displaySingleOccurrences | Boolean | |
| displayUnaccessibleAdv | Boolean | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| layout | (DEFAULT|CARD|SLIDER| PAGINATED_LIST) | |
| maxInSlider | Integer | |
| maxItemPerPage | Integer | |
| onlyAdvantageProducts | Boolean | |
| randomClusterOrder | Boolean | |
| rank | Integer | |
| tourIds | List of Long | |
| Cluster | ||
| clusterItems | List of ClusterItem | |
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| ClusterItem | ||
| absoluteEnd | Date | |
| absoluteStart | Date | |
| clusterGrouping | (PRODUCT|PERFORMANCE) | |
| daysToEnd | Integer | |
| daysToStart | Integer | |
| numberOfDays | Integer | |
| numberOfObjects | Integer | |
| performanceId | Long | |
| productIds | List of Long | |
| rank | Integer | |
| Tour | ||
| code | String (8) | |
| contactProductLinkIds | List of Long | |
| detailURL | String (255) | |
| externalDescription | ExternalName | 2000 characters max for each translation |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| logo | String | |
| logoImage | Image | |
| productIds | List of Long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Indicates the last modification date of the catalog, in order to limit the useless calls to getCatalog.
| requestId | Integer |
| LastSetupUpdateResult | ||
| lastSetupUpdate | Date | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Returns the point of sales configuration.
| requestId | Integer |
| POSConfigResult | ||
| posConfigData | POSConfig | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| POSConfig | ||
| allowedChars | String | |
| amazonS3InstitutionBucketName | String | |
| availableCurrencyCash | List of CurrencyCash | |
| catalogCurrencies | List of CurrencyCash | List of catalog currencies supported by the point of sales |
| charges | List of Charges | |
| closingTime | Date | |
| communityType | String | |
| contactAccountCreationAllowed | Boolean | |
| contactFileAccessAllowed | Boolean | |
| contactLoginMode | String | |
| countries | List of Country | |
| currencyCode | String (8) | ISO-4217 currency code. Example: EUR |
| currencySymbol | String | |
| customizationFile | String | |
| exchangeRates | List of ExchangeRate | exchangeRates a list of exchange rates for the currencies of an organization. A rate is expressed as value*10^5, for example rate between EUR and GBP 87678 means 1 EUR costs 0.87678 GBP |
| guestLoginAvailable | boolean | |
| hardwares | List of Hardware | |
| hub | Hub | |
| iBeacons | List of IBeacon | |
| idpCertificate | String | |
| institCode | String (8) | |
| institutionCurrency | CurrencyCash | |
| isInvoicingAllowed | boolean | |
| languageList | String | List of ISO-639-2 language codes. |
| loginPosition | (NEVER|BEFORE_CHECKOUT| AT_BEGINNING) | |
| mainLanguage | String | |
| maxAmountForOnlinePayment | Long | Amount, in 1000ths of unit. |
| maxAutoSuggestedSeatsTrials | Integer | |
| maxSeatsPerPerformance | Integer | |
| modeOfUse | (STANDARD|FLASH) | |
| multiCatalogCurrencyEnabled | boolean | Boolean parameter which indicates if point of sales' organization is in multi catalog currency mode. |
| netPrices | Boolean | |
| openingTime | Date | |
| orderAbandonDelay | Integer | Delay (in seconds) after which an OPEN order is abandonned automatically by the backend. If null, never. |
| orderOrigins | List of OrderOriginInfo | |
| organizationCode | String (8) | |
| organizationCurrency | CurrencyCash | |
| organizationId | Long | |
| organizationName | ExternalName | |
| organizationTimeZone | String | |
| overheads | List of Overheads | |
| paymentFees | List of PaymentFee | |
| paymentMethods | List of PaymentMethod | |
| placeAddress | String | |
| placeAddressData | PlaceAddress | |
| posActivityState | (RUNNING|SUSPENDED) | |
| posCode | String (8) | |
| posCustomizationFile | String | |
| posId | Long | The pointOfSalesId that is used in sales or availabilities methods. |
| posMobileTheme | PosMobileTheme | |
| posNumber | Integer | |
| posParameters | Map of StringString | |
| posType | (B2B|B2C|B2B2C|B2P|C2C| NEW_TVM| MOBILE_BOXOFFICE) | |
| productFamilies | List of ProductFamily | |
| pspAccessMethod | (EFT_POS|MOTO|MIXED| WEB_POST|WEB_REDIRECT) | |
| pspParameters | Map of StringString | |
| pspTerminalNumber | String | |
| reportVariants | List of ReportVariant | |
| requireConfirmationEmail | Boolean | A config to show up second email field on TicketShop |
| reverseVatCountries | List of Country | |
| salesChannelActivityState | (RUNNING|SUSPENDED) | |
| salesChannelCode | String (8) | |
| salesChannelId | Long | |
| salesRestrictions | List of SalesRestriction | |
| seatSelectionMode | (AUTO|MANUAL| MANUAL_OR_AUTO| WITHOUT_MAP| WITHOUT_SEATING) | |
| shippingFees | List of ShippingFee | |
| socialConnections | List of PosSocialConnection | |
| testInstitution | Boolean | |
| virtualOperatorName | String | |
| workstationId | Long | |
| workstationIdentifier | String | |
| CurrencyCash | ||
| availableCash | List of Cash | |
| currencyCode | String (8) | |
| fractionDigit | Integer | |
| minAmount | Integer | |
| symbol | String | |
| Cash | ||
| quantity | Integer | |
| type | (COIN|COINS_ROLL|NOTE| NOTES_BUNDLE) | |
| unitAmoung | Integer | |
| Charges | ||
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| modifiable | Boolean | |
| type | (OTHER|RESERVATION| CANCELLATION) | |
| Country | ||
| code | String (8) | |
| currencyCode | String (8) | currencyCode is optional field, it should be set for countries of an organization |
| internationalPhonePrefix | String | |
| name | ExternalName | |
| phoneFormat | String | |
| ExchangeRate | ||
| fromCurrencyCode | String (8) | |
| rate | Long | rate is expressed as value*10^5, for example rate between EUR and GBP 87678 means 1 EUR costs 0.87678 GBP |
| toCurrencyCode | String (8) | |
| Hardware | ||
| driverName | String | |
| id | Long | |
| rank | Integer | |
| receiptPrinter | ReceiptPrinter | |
| ticketPrinter | TicketPrinter | |
| tpe | TPE | |
| type | (TICKET_PRINTER|TPE| RECEIPT_PRINTER) | |
| ReceiptPrinter | ||
| comPortParameter | COMPortParameter | |
| COMPortParameter | ||
| portNumber | Integer | |
| TicketPrinter | ||
| cuttingMode | (NONE|AFTER_EACH_TICKET| AFTER_EACH_ORDER| AT_THE_END_OF_MASS_PRINTING) | |
| ticketSize | TicketSize | |
| trayNumber | Integer | |
| usbPortParameter | USBPortParameter | |
| TicketSize | ||
| height | Integer | |
| id | Long | |
| numberOfparts | Integer | |
| onFiscalStock | boolean | |
| ticketSupport | TicketSupport | |
| width | Integer | |
| 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 | |
| USBPortParameter | ||
| logicalName | String | |
| TPE | ||
| comPortParameter | COMPortParameter | |
| Hub | ||
| id | Long | |
| pointsOfSales | List of HubPointOfSales | |
| HubPointOfSales | ||
| allCountriesAllowed | boolean | |
| authorizedCountries | List of String | |
| code | String (8) | |
| id | Long | |
| internetUrl | String (255) | |
| rank | Long | |
| running | boolean | |
| IBeacon | ||
| actionText | String | |
| description | ExternalName | 2000 characters max for each translation |
| imageUrl | String (255) | |
| majorNumber | String | |
| minorNumber | String | |
| rangeIn | Integer | |
| rangeOut | Integer | |
| uuid | String | |
| OrderOriginInfo | ||
| externalName | ExternalName | 60 characters max for each translation |
| idCode | String (8) | |
| Overheads | ||
| This class includes the two different and mutually exclusive modes of configuring an overhead amount: constant or gradient. | ||
| ceiling | Long | The maximum overhead amount that will be applied to the payment. The value should be specified in 10th of cents. |
| constantAmount | Long | Constant amount to apply as overhead for a payment. It does not change, no matter the payment amount. The value should be specified in 10th of cents. |
| floor | Long | The minimum overhead amount that will be applied to the payment. The value should be specified in 10th of cents. |
| slope | Float | The percentage of overhead that will be applied to the payment amount. It will change depending on this amount. |
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| modifiable | Boolean | |
| type | (OTHER|RESERVATION| CANCELLATION) | |
| PaymentFee | ||
| paymentMethodId | Long | |
| ceiling | Long | The maximum overhead amount that will be applied to the payment. The value should be specified in 10th of cents. |
| constantAmount | Long | Constant amount to apply as overhead for a payment. It does not change, no matter the payment amount. The value should be specified in 10th of cents. |
| floor | Long | The minimum overhead amount that will be applied to the payment. The value should be specified in 10th of cents. |
| slope | Float | The percentage of overhead that will be applied to the payment amount. It will change depending on this amount. |
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| modifiable | Boolean | |
| type | (OTHER|RESERVATION| CANCELLATION) | |
| PaymentMethod | ||
| changeReturnAllowed | Boolean | |
| code | String (8) | |
| defaultPaymentMethodId | Long | |
| externalDescription | ExternalName | 2000 characters max for each translation |
| externalName | ExternalName | 60 characters max for each translation |
| forPayment | Boolean | |
| forReimbursement | Boolean | |
| id | Long | |
| immediateFollowupPayment | Boolean | |
| inSplitPaymentAllowed | Boolean | |
| internetCode | String (8) | Comma separated list of allowed cards (VISA,AMEX...) |
| manualValidation | Boolean | |
| maxOrderAmount | Long | |
| minOrderAmount | Long | |
| paymentType | (NUM|CHEQ|CHEQCANCEL|CB| CBCANCEL|PREPAY|VIR|AVR| COUPON|VOUCHER|CTRM|EXT| CA|BVR|INV|CANOAUTH| DEPOSIT|SAPBTRANSF| FIDELITY_POINT|DISCOUNT| CB_WITH_VALIDATION| DIRECT_DEBIT|PREPAYMENT| DIRECT_DEBIT_WITHOUT_INST) | |
| rank | Integer | |
| subPaymentMethods | List of SubPaymentMethod | |
| tooMuchPerceivedAllowed | Boolean | |
| withFollowUp | Boolean | |
| SubPaymentMethod | ||
| brand | String | |
| image | Image | |
| internetCode | String (8) | |
| rank | Integer | |
| PosMobileTheme | ||
| accountAddressBookUrl | String (255) | |
| accountAdvantagesUrl | String (255) | |
| accountHomeUrl | String (255) | |
| accountOrderHistoryUrl | String (255) | |
| accountProfileUrl | String (255) | |
| accountSubscriptionsRenewalUrl | String (255) | |
| accountSubscriptionsUrl | String (255) | |
| appleAppStoreId | String | |
| appleTopbarTextColorBlack | boolean | |
| catalogUrl | String (255) | |
| externalName | ExternalName | 60 characters max for each translation |
| facebookAccount | String | |
| googleAccount | String | |
| googlePlayStoreId | String | |
| logo | String | |
| mainScreenBottomColor1 | String | |
| mainScreenBottomColor2 | String | |
| mainScreenTopColor1 | String | |
| mainScreenTopColor2 | String | |
| menuBackgroundColor | String | |
| menuLinksColor | String | |
| menuLinksUrl | String (255) | |
| menuNameColor | String | |
| menuNotificationTextColor | String | |
| panelRightColor1 | String | |
| panelRightColor2 | String | |
| twitterAccount | String | |
| twitterNotificationAccount | String | |
| twitterNotificationHashtag | String | |
| ProductFamily | ||
| contactRequired | Boolean | |
| defaultQuantity | Integer | |
| directOption | (WITH|WITHOUT|NO) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| netPrices | Boolean | |
| productFamilySubType | (SIMPLE_TICKET| SEASONTICKET|MEMBERSHIP| PACKAGE|STAY|SERVICE| VOUCHER|DONATION|GOODS| VISIT|OPEN|OPEN_PASS| DATE_SPECIFIC_PASS| SPORTING_EVENT|RAILAWAY| HOTEL|MUSEUM|ENTERT_PARK| RESTAURANT|PRODLIB| TIMESLOT_PASS|HOSPITALITY| HOSPITALITY_PACKAGE| CANCELLATION_INSURANCE| VISIT_PASS) | |
| productFamilyType | (SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY) | |
| reservable | (YES|NO|OPTIONABLE) | |
| ReportVariant | ||
| rank | Long | |
| reportGroup | (SALES|CASHDESK| ACCOUNTING|AVAILABILITY| CONFIGURATION|ANALYTICS| SEAT|SHIPMENTTICKET|GOODS| HOSPITALITY|VISITS| CONTACT) | |
| reportId | Long | |
| reportIdentifier | (STANDARD_REPORT| CUSTOM_REPORT| EXCLUSIVE_REPORT) | |
| reportName | String | |
| reportParameters | List of String | |
| SalesRestriction | ||
| id | Long | |
| incompatibleItems | List of IncompatibleItem | |
| IncompatibleItem | ||
| id | Long | |
| performanceId | Long | |
| productId | Long | |
| ShippingFee | ||
| shipmentModeId | Long | |
| ceiling | Long | The maximum overhead amount that will be applied to the payment. The value should be specified in 10th of cents. |
| constantAmount | Long | Constant amount to apply as overhead for a payment. It does not change, no matter the payment amount. The value should be specified in 10th of cents. |
| floor | Long | The minimum overhead amount that will be applied to the payment. The value should be specified in 10th of cents. |
| slope | Float | The percentage of overhead that will be applied to the payment amount. It will change depending on this amount. |
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| modifiable | Boolean | |
| type | (OTHER|RESERVATION| CANCELLATION) | |
| PosSocialConnection | ||
| cookieSecret | String | |
| exclusiveMode | boolean | |
| joinEvent | boolean | |
| login | boolean | |
| loginURL | String (255) | |
| logoutURL | String (255) | |
| serviceProviderIdentifier | String | |
| sharePurchase | boolean | |
| socialAppIdentifier | String | |
| socialAppSecret | String | |
| socialLoginId | Long | |
| socialLoginType | (FACEBOOK|GOOGLE| SECUTIX_IDP|SECUTIX_SP| TWITTER|UEFA|MDP| SWISSPASS|ACCOUNT_KIT| GIGYA|OIDC) | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Extracts the details of a physical configuration.
| requestId | Integer | optional request id, used to identify asynchronous requests (see {@link AsynchronousMethod}. |
| physicalConfigurationId | Long | Mandatory mandatory : the physicalConfigurationId we want to extract. |
| PhysicalConfigurationResult | ||
| physicalConfigurationData | String | |
| requestState | AsynchronousMethodResult. AsynchronousMethodState | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method returns detailed seat descriptions for a given set of seat definitions.
Those values do not change often, they can be cached for a long time.
| requestId | Integer | |
| performanceId | Long | |
| seatDefinitions | List of SeatDefinition |
| SeatDefinition | ||
| UNDEFINED | String | |
| areaId | Long | |
| areaKind | (INDIFFERENT|BOX) | |
| available | boolean | |
| blockId | Long | |
| contingentId | Long | |
| number | String | |
| physicalSeatId | Long | |
| rotation | int | |
| row | String | |
| scenePanoLink | String | |
| scenePhotoLink | String | |
| seatCategoryId | Long | |
| x | int | |
| y | int | |
| 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 | |
| contingentId | Long | |
| number | String | |
| physicalSeatId | Long | |
| rotation | int | |
| row | String | |
| scenePanoLink | String | |
| scenePhotoLink | String | |
| seatCategoryId | Long | |
| x | int | |
| y | int | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method allows to find the entity relating to the code entered by a client.
The only checks done by this method are:
No checks are done on the fact that the client is authorized to use this code, neither on the fact that the code is still valid or can be applied on the current basket.
| requestId | Integer | |
| publicCodes | List of String |
| PublicCodeOriginResult | ||
| publicCodeOriginDatas | List of PublicCodeOriginData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| PublicCodeOriginData | ||
| entityId | Long | |
| publicCode | String (8) | |
| publicCodeOriginEntity | (PARTNER_ADVANTAGE| ONE_TIME_CODE_ADVANTAGE| RULESET|PROMO|VOUCHER) | |
| resultCode | String (8) | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
validate network connection and login/password
| WebMethodResult | ||
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |