| URL: | ||
| JWT Token | ||
| Template: | ||
| cURL: |
Version: 1_33 (other versions, change log, ZUMSTEIN_V4.4-SNAPSHOT) Latest frozen version. Base by default all your developments on this one.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.availability.v1_33.AvailabilityService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnseb/backend-apis/availabilityService/v1_33/{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 |
This method return list selected theme and language for each timeslot already have visit group, and this method should only use for visit pass individual with multiple themes/languages
| passId | long | Mandatory |
| timeslotIds | List of Long |
| ThemeAndLanguageResult | ||
| listThemeAndLanguage | List of ThemeAndLanguage | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| ThemeAndLanguage | ||
| languageCode | String (8) | |
| themeId | long | |
| timeslotId | long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Get availability data of the given event and performances
| requestId | Integer | optional |
| pointOfSalesId | Long | Mandatory mandatory: it specifies the point of sales |
| eventIds | List of Long | |
| performanceIds | List of Long | Mandatory mandatory |
| seatCategoryIds | List of Long | Optional: it allows refining the results by dividing the result per seat category. If the field is an empty list, the result does sum for all the categories. If the field is -1, all the possible seat categories are returned. If the field contains a list of seat categories id, only those seat categories are returned. |
| contingentIds | List of Long | optional: works as the categories, with the contingents. |
| composedProductId | Long | optional: id of the composed product allowing specific availabilities |
| advantageId | Long |
| EventAvailabilityResult | ||
| eventAvailabilityData | EventAvailabilityData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| EventAvailabilityData | ||
| eventAvailabilities | List of EventAvailability | |
| EventAvailability | ||
| eventId | Long | |
| minPrice | Integer | |
| performanceId | Long | |
| availability | Long | |
| availabilityLevel | (NONE|LIMITED|GOOD) | |
| compQuota | Long | |
| contingentId | Long | |
| minGroupSize | Integer | |
| quota | Long | |
| reason | (NOT_ON_SALE|CLOSED| SUSPENDED|CANCELED| SOLD_OUT| POS_NOT_ON_SALE) | |
| resaleMinPrice | Long | |
| seatCategoryId | Long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Get availability data of the given performance. Can be filtered by area and or block.
| requestId | Integer | optional |
| pointOfSalesId | Long | Mandatory mandatory: it specifies the point of sales |
| eventId | Long | Mandatory mandatory: it specifies the event whose availability we want to know. EventId is equivalent of productId, where the product is an event. |
| performanceIds | List of Long | Mandatory mandatory |
| seatCategoryIds | List of Long | Optional: it allows refining the results by dividing the result per seat category. If the value of the field is an empty list, the result does sum for all the categories. If the field is -1, all the possible seat categories are returned. If the field contains a list of seat categories id, only those seat categories are returned. |
| contingentIds | List of Long | |
| zoneBlockIds | List of AreaBlockId | |
| composedProductId | Long | optional: id of the composed product allowing specific availabilities |
| advantageId | Long |
| AreaBlockId | ||
| Create a wrapper class to avoid having problem with JAXB since it required a no-arg default constructor. given areaId and blockId correspond to SecuTix Physical Ids | ||
| areaId | Long | |
| blockId | Long | |
| PerformanceAvailabilityResult | ||
| performanceAvailabilityData | PerformanceAvailabilityData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| PerformanceAvailabilityData | ||
| performanceAvailabilities | List of PerformanceAvailability | |
| PerformanceAvailability | ||
| areaId | Long | |
| blockId | Long | |
| eventId | Long | |
| minPrice | Integer | |
| performanceId | Long | |
| availability | Long | |
| availabilityLevel | (NONE|LIMITED|GOOD) | |
| compQuota | Long | |
| contingentId | Long | |
| minGroupSize | Integer | |
| quota | Long | |
| reason | (NOT_ON_SALE|CLOSED| SUSPENDED|CANCELED| SOLD_OUT| POS_NOT_ON_SALE) | |
| resaleMinPrice | Long | |
| seatCategoryId | Long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method returns planned quotas available for a given point of sales
| pointOfSalesId | Long | Mandatory mandatory: it specifies the point of sales The following error codes can be returned:
|
| quotaRequestDatas | List of QuotaRequestData | Mandatory mandatory: it specifies the events for which planned quota is requested The following error codes can be returned:
|
| QuotaRequestData | ||
| contingentIds | List of Long | Optional |
| eventId | Long | Mandatory |
| performanceIds | List of Long | Optional |
| seatCategoryIds | List of Long | Optional |
| PlannedQuotaResult | ||
| plannedQuotas | List of PlannedQuotaData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| PlannedQuotaData | ||
| complimentaryQuota | Long | |
| contingentId | Long | |
| performanceId | Long | |
| saleQuota | Long | |
| seatCategoryId | Long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method allows to determine the availability of one or more products, no matter the type.
| requestId | Integer | optional |
| pointOfSalesId | Long | Mandatory mandatory: it specifies the point of sales |
| productIds | List of Long | Mandatory mandatory: it specifies the list of products whose availability we want to know. |
| itemIds | List of Long | Optional: it indicates a list of items linked to this product. If the field is -1, all the items of the product are returned. If the field contains a list of items id, only those items are returned. If the field is not given, the availability of the product itself (sum of all its items) is returned. |
| timeslotIds | List of Long | Optional: used for timeslot passes and visit passes. If the field is -1, all the timeslots of the product are returned. If the field contains a list of items id, only those items are returned. |
| seatCategoryIds | List of Long | Optional: it allows refining the results by dividing the result per seat category. If the field is an empty list, the result does sum for all the categories. If the field is -1, all the possible seat categories are returned. If the field contains a list of seat categories id, only those seat categories are returned. |
| contingentIds | List of Long | optional: works as the categories, with the contingents. |
| composedProductId | Long | optional: id of the composed product allowing specific availabilities |
| advantageId | Long |
| ProductAvailabilityResult | ||
| productAvailabilityData | ProductAvailabilityData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| ProductAvailabilityData | ||
| productAvailabilities | List of ProductAvailability | |
| ProductAvailability | ||
| itemId | Long | |
| productId | Long | |
| timeslotId | Long | |
| availability | Long | |
| availabilityLevel | (NONE|LIMITED|GOOD) | |
| compQuota | Long | |
| contingentId | Long | |
| minGroupSize | Integer | |
| quota | Long | |
| reason | (NOT_ON_SALE|CLOSED| SUSPENDED|CANCELED| SOLD_OUT| POS_NOT_ON_SALE) | |
| resaleMinPrice | Long | |
| seatCategoryId | Long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method lists the exhaustive list of seats in a given area/block or in a given clipping area of the map, with their respective status. It is basically limited to return 5000 seats max, and must not be used to obtain the full status of a venue.
| requestId | Integer | optional |
| pointOfSalesId | Long | Mandatory mandatory: it specifies the point of sales |
| performanceIds | List of Long | Mandatory mandatory: the related performances. |
| productId | Long | optional |
| modifiedSince | Date | allows to cache the result of previous calls to obtain only the seats updated since the last call. |
| seatCategoryIds | List of Long | optional: limits to the seats with the given categories. |
| contingentIds | List of Long | optional : limits to the seats with the given contingents. |
| areaBlockIds | List of AreaBlockId | optional : limits to the seats with the given areas/blocks |
| clippingArea | ClippingArea | |
| availabilityType | (AVAILABLE|NOT_AVAILABLE| BOTH) | optional, allows to select only the available seats. Default:AVAILABLE |
| composedProductId | Long | optional: id of the composed product allowing specific availabilities |
| advantageId | Long |
| ClippingArea | ||
| h | int | |
| w | int | |
| x | int | |
| y | int | |
| SeatsAvailabilityResult | ||
| seatsAvailabilityData | SeatsAvailabilityData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| SeatsAvailabilityData | ||
| seatsAvailabilities | List of SeatDefinition | |
| timestamp | Date | |
| truncated | Boolean | |
| SeatDefinition | ||
| UNDEFINED | String | |
| areaId | Long | |
| areaKind | (INDIFFERENT|BOX) | |
| available | boolean | |
| blockId | Long | |
| classification1ic | String | |
| classification2ic | String | |
| contingentId | Long | |
| dummySeat | boolean | |
| entranceId | Long | |
| externalEntranceId | Long | |
| freezingReasonIc | String | |
| frozen | boolean | |
| number | String | |
| optimalSeatSelectionValue | Long | |
| physicalSeatId | Long | |
| rotation | int | |
| row | String | |
| scenePanoLink | String | |
| scenePhotoLink | String | |
| seatCategoryId | Long | |
| seatOrder | Long | |
| x | int | |
| y | int | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Allows to list the products which availability have changed since a reference date. Much quicker than listing all the availabilities one by one. By default this method adds also all availabilities that changed linked to every product linked to an advantage which changed since referenceDate.
| requestId | Integer | |
| pointOfSalesId | Long | |
| productIds | List of Long | |
| referenceDate | Date |
| UpdatedAvailabilitiesResult | ||
| availabilityUpdateData | List of AvailabilityUpdateData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| AvailabilityUpdateData | ||
| advantageId | Long | |
| hospitalitySessionId | Long | |
| lastUpdate | Date | |
| performanceId | Long | |
| productId | Long | |
| timeslotId | Long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
validate network connection and login/password
| WebMethodResult | ||
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
This method updates planned quotas available for a given point of sales.
| pointOfSalesId | Long | Mandatory mandatory: it specifies the point of sales
|
| plannedQuotaDatas | List of PlannedQuotaData | Mandatory mandatory, it specifies the planned quotas to be updated. The following error codes can be returned:
|