| URL: | ||
| JWT Token | ||
| Template: | ||
| cURL: |
Version: 1_12 (other versions, change log, ZUMSTEIN_V3.12-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_12.CatalogService.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 |
Extract the catalog.
| 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. |
| CatalogResult | ||
| catalogData | String | |
| requestState | AsynchronousMethodResult. AsynchronousMethodState | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| seasonCode | String (8) | |
| productCode | String (8) |
| CatalogResultDetailed | ||
| catalogData | CatalogData | |
| requestState | AsynchronousMethodResult. AsynchronousMethodState | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| CatalogData | ||
| externalVerifications | List of ExternalVerification | |
| physicalConfigurations | List of PhysicalConfiguration | |
| seasons | List of Season | |
| storefront | Storefront | |
| visitLanguages | List of VisitLanguage | |
| 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 | |
| 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 | |
| pdfView | String | |
| 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 | |
| Season | ||
| advantages | List of Advantage | |
| audienceCategories | List of AudienceCategory | |
| chargesTables | List of ChargesTable | |
| code | String (8) | |
| competitionTypes | List of CompetitionType | |
| 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) | |
| code | String (8) | |
| contactLimitation | (LIMITED|NOT_LIMITED) | |
| end | Date | |
| endRelative | Long | |
| externalDescription | ExternalName | 2000 characters max for each translation |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| logo | String | |
| mandatoryContact | boolean | |
| maxOrderQuantity | Long | |
| performanceEndDateType | (NONE|TIME_TOLERANCE| ABSOLUTE|RELATIVE) | |
| products | List of Product | |
| start | Date | |
| startRelative | Long | |
| state | (PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED) | |
| Product | ||
| 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 | |
| logo | String | |
| maxQuantity | Integer | |
| membership | Membership | |
| minQuantity | Integer | |
| optionAvailabilities | List of OptionAvailability | |
| pack | Package | |
| partnerContactNumber | String (20) | |
| pass | Pass | |
| productFamilySubType | (SIMPLE_TICKET| SEASONTICKET|MEMBERSHIP| PACKAGE|STAY|SERVICE| VOUCHER|GOODS|VISIT|OPEN| OPEN_PASS| DATE_SPECIFIC_PASS| SPORTING_EVENT|RAILAWAY| HOTEL|MUSEUM|ENTERT_PARK| RESTAURANT|PRODLIB| TIMESLOT_PASS|HOSPITALITY| HOSPITALITY_PACKAGE) | |
| productFamilyType | (SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY) | |
| productSocialNetworkLinks | List of ProductSocialNetworkLink | |
| productTypeId | Long | |
| questionnaireId | Long | |
| salePeriods | List of SalePeriod | |
| seasonTicket | SeasonTicket | |
| service | Service | |
| state | (PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED) | |
| subTopicLinks | List of SubTopicLink | |
| transport | Transport | |
| vatCodeId | Long | |
| waitingListAllowed | Boolean | |
| CrossSellProductLink | ||
| description | ExternalName | 2000 characters max for each translation |
| end | Date | |
| externalName | ExternalName | 60 characters max for each translation |
| salesChannelId | Long | |
| start | Date | |
| targetProductId | Long | |
| type | (SUGGESTION| CROSS_SELL_OUT| CROSS_SELL_IN|UP_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) | |
| alertRatio | String | |
| competitionTypeId | Long | |
| language | String | |
| minimumAge | Long | |
| nameAddOn | ExternalName | 240 characters max for each translation |
| performances | List of Performance | |
| timeTolerance | Long | |
| Performance | ||
| breaksQuantity | Integer | |
| code | String (8) | |
| comfortVariableValues | List of ComfortVariableValue | |
| duration | Integer | |
| eventExternalName | ExternalName | 60 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 | |
| itemIds | List of Long | |
| kind | String | |
| kindExternalName | ExternalName | 60 characters max for each translation |
| location | Location | |
| logicalConfigurationId | Long | |
| logo | String | |
| 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 | |
| saleConfigurationId | Long | |
| salePeriods | List of SalePeriod | |
| seatCategories | List of SeatCategory | |
| seatSelectionMode | (AUTO|MANUAL| MANUAL_OR_AUTO| WITHOUT_MAP| WITHOUT_SEATING) | |
| spaceId | Long | |
| start | Date | |
| state | (PREPARING|VALIDATED| RUNNING|SUSPENDED| CANCELED|CLOSED| CANCELED_CLOSED) | |
| titling | Boolean | |
| visitLanguageCode | String (8) | |
| ComfortVariableValue | ||
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| valueExternalName | ExternalName | 60 characters max for each translation |
| Location | ||
| siteCode | String (8) | |
| siteExternalName | ExternalName | 60 characters max for each translation |
| spaceCode | String (8) | |
| spaceExternalName | ExternalName | 60 characters max for each translation |
| 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 | |
| SalePeriod | ||
| audCatId | Long | |
| end | Date | |
| endRelative | Long | |
| salePeriodEndDateType | (ABSOLUTE|RELATIVE) | |
| salePeriodStartDateType | (ABSOLUTE|RELATIVE) | |
| salesChannelCode | String (8) | |
| salesChannelId | Long | |
| salesChannelName | String | |
| start | Date | |
| startRelative | Long | |
| 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 | |
| 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) | |
| 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) | |
| 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 | |
| Membership | ||
| 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) | |
| items | List of Item | |
| locations | List of Location | |
| numberOfEntries | int | |
| spaceIds | List of Long | |
| 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) | |
| ProductSocialNetworkLink | ||
| externalReference | String | |
| posSocialId | Long | |
| SeasonTicket | ||
| 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 | ||
| 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 | |
| minQuantityOfRequiredASC | Integer | |
| rank | Integer | |
| requiredAudienceSubCategoryIds | List of Long | |
| Stop | ||
| code | String (8) | |
| name | String | |
| rank | Integer | |
| type | (ARRIVAL|DEPARTURE|VIA) | |
| 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 | |
| Charge | ||
| amount | Long | |
| audSubCatId | Long | |
| mandatory | boolean | |
| salesChannelId | Long | |
| slope | String | |
| CompetitionType | ||
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| logo | String | |
| GoodsFamily | ||
| Code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| goodsFamilies | List of GoodsFamily | |
| id | Long | |
| 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 | |
| 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 | |
| svgPolygonIdentifier | String | |
| OptionLimitationLine | ||
| id | Long | |
| logicalSeatCatIds | List of Long | |
| productFamilySubType | (SIMPLE_TICKET| SEASONTICKET|MEMBERSHIP| PACKAGE|STAY|SERVICE| VOUCHER|GOODS|VISIT|OPEN| OPEN_PASS| DATE_SPECIFIC_PASS| SPORTING_EVENT|RAILAWAY| HOTEL|MUSEUM|ENTERT_PARK| RESTAURANT|PRODLIB| TIMESLOT_PASS|HOSPITALITY| HOSPITALITY_PACKAGE) | |
| productFamilyType | (SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY) | |
| structureCommunityType | String | |
| Optionable | ||
| product | Product | |
| 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 | |
| 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 | |
| spaces | List of Space | |
| PlaceAddress | ||
| countryCode | String (8) | |
| String | ||
| fax | String | |
| firstAddressLine | String | |
| locality | String | |
| phoneNumber | String | |
| secondAddressLine | String | |
| thirdAddressLine | String | |
| zipCode | String (8) | |
| 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 | |
| Timeslot | ||
| duration | Integer | |
| id | Long | |
| rateTypeId | Long | |
| startDate | Date | |
| startTime | Date | |
| 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 | |
| VisitLanguage | ||
| code | String (8) | |
| name | ExternalName | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer |
| LastSetupUpdateResult | ||
| lastSetupUpdate | Date | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Deprecated Use {@link OpenCatalogService#getPOSConfigFromURL(Integer, String)} instead
| requestId | Integer |
| POSConfigResult | ||
| posConfigData | POSConfig | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| POSConfig | ||
| allowedChars | String | |
| availableCurrencyCash | List of CurrencyCash | |
| charges | List of Charges | |
| communityType | String | |
| contactAccountCreationAllowed | Boolean | |
| contactFileAccessAllowed | Boolean | |
| contactLoginMode | String | |
| countries | List of Country | |
| currencyCode | String (8) | |
| currencySymbol | String | |
| customizationFile | String | |
| iBeacons | List of IBeacon | |
| idpCertificate | String | |
| institCode | String (8) | |
| institutionCurrency | CurrencyCash | |
| isInvoicingAllowed | boolean | |
| languageList | String | |
| loginPosition | (NEVER|BEFORE_CHECKOUT| AT_BEGINNING) | |
| maxAmountForOnlinePayment | Long | |
| maxAutoSuggestedSeatsTrials | Integer | |
| maxSeatsPerPerformance | Integer | |
| netPrices | Boolean | |
| orderAbandonDelay | Integer | |
| orderOrigins | List of OrderOriginInfo | |
| organizationCode | String (8) | |
| organizationCurrency | CurrencyCash | |
| organizationId | Long | |
| 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 | |
| posMobileTheme | PosMobileTheme | |
| posNumber | Integer | |
| posParameters | Map of StringString | |
| posType | (B2B|B2C|B2B2C|B2P|C2C) | |
| productFamilies | List of ProductFamily | |
| pspAccessMethod | (EFT_POS|MOTO|MIXED| WEB_POST|WEB_REDIRECT) | |
| pspTerminalNumber | String | |
| salesChannelActivityState | (RUNNING|SUSPENDED) | |
| salesChannelCode | String (8) | |
| salesChannelId | Long | |
| seatSelectionMode | (AUTO|MANUAL| MANUAL_OR_AUTO| WITHOUT_MAP| WITHOUT_SEATING) | |
| shippingFees | List of ShippingFee | |
| socialConnections | List of PosSocialConnection | |
| testInstitution | Boolean | |
| virtualOperatorName | 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) | |
| internationalPhonePrefix | String | |
| name | ExternalName | |
| 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 | ||
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| modifiable | Boolean | |
| type | (OTHER|RESERVATION| CANCELLATION) | |
| PaymentFee | ||
| paymentMethodId | Long | |
| 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) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| inSplitPaymentAllowed | Boolean | |
| internetCode | String (8) | |
| paymentType | (NUM|CHEQ|CHEQCANCEL|CB| CBCANCEL|PREPAY|VIR|AVR| COUPON|VOUCHER|CTRM|EXT| CA|BVR|INV|CANOAUTH| DEPOSIT|SAPBTRANSF| FIDELITY_POINT) | |
| tooMuchPerceivedAllowed | Boolean | |
| withFollowUp | Boolean | |
| 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 | |
| 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 |
| netPrices | Boolean | |
| productFamilySubType | (SIMPLE_TICKET| SEASONTICKET|MEMBERSHIP| PACKAGE|STAY|SERVICE| VOUCHER|GOODS|VISIT|OPEN| OPEN_PASS| DATE_SPECIFIC_PASS| SPORTING_EVENT|RAILAWAY| HOTEL|MUSEUM|ENTERT_PARK| RESTAURANT|PRODLIB| TIMESLOT_PASS|HOSPITALITY| HOSPITALITY_PACKAGE) | |
| productFamilyType | (SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY) | |
| reservable | (YES|NO|OPTIONABLE) | |
| ShippingFee | ||
| shipmentModeId | Long | |
| code | String (8) | |
| externalName | ExternalName | 60 characters max for each translation |
| id | Long | |
| modifiable | Boolean | |
| type | (OTHER|RESERVATION| CANCELLATION) | |
| PosSocialConnection | ||
| cookieSecret | String | |
| 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) | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| identifier | String |
| 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 |
| 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 | |
| seatCategoryId | Long | |
| x | int | |
| y | int | |
| SeatsDetailResult | ||
| seatsDetailData | SeatsDetailData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| SeatsDetailData | ||
| seatDescriptions | List of SeatDescription | |
| SeatDescription | ||
| externalRemark | String | |
| scenePanoLink | String | |
| scenePhotoLink | 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 | |
| seatCategoryId | Long | |
| x | int | |
| y | int | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| 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 | |