Service: AvailabilityService

Version: 1_32 (other versions, change log) Latest stable version. Please base all your developments on this one.

SOAP Demo endpoint: https://secutix.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.availability.v1_32.AvailabilityService.webservice?wsdl

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

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

Methods:

getAvailableThemeAndLanguage

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

Parameters

passIdlong     
timeslotIdsList of Long     

Return value

ThemeAndLanguageResult
listThemeAndLanguageList of ThemeAndLanguage     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

ThemeAndLanguage
languageCodeString (8)     
themeIdlong     
timeslotIdlong     

getEventAvailability

Get availability data of the given event and performances

Parameters

requestIdIntegeroptional
pointOfSalesIdLongmandatory: it specifies the point of sales
eventIdsList of Long     
performanceIdsList of Longmandatory
seatCategoryIdsList of LongOptional: 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.
contingentIdsList of Longoptional: works as the categories, with the contingents.
composedProductIdLongoptional: id of the composed product allowing specific availabilities
advantageIdLong     

Return value

EventAvailabilityResult
eventAvailabilityDataEventAvailabilityData     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

EventAvailabilityData
eventAvailabilitiesList of EventAvailability     

EventAvailability
eventIdLong     
minPriceInteger     
performanceIdLong     
availabilityLong     
availabilityLevel(NONE|LIMITED|GOOD)     
compQuotaLong     
contingentIdLong     
minGroupSizeInteger     
quotaLong     
reason(NOT_ON_SALE|CLOSED|
SUSPENDED|CANCELED|
SOLD_OUT|
POS_NOT_ON_SALE)
     
resaleMinPriceLong     
seatCategoryIdLong     

getPerformanceAvailability

Get availability data of the given performance. Can be filtered by area and or block.

Parameters

requestIdIntegeroptional
pointOfSalesIdLongmandatory: it specifies the point of sales
eventIdLongmandatory: it specifies the event whose availability we want to know.
EventId is equivalent of productId, where the product is an event.
performanceIdsList of Longmandatory
seatCategoryIdsList of LongOptional: 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.
contingentIdsList of Long     
zoneBlockIdsList of AreaBlockId     
composedProductIdLongoptional: id of the composed product allowing specific availabilities
advantageIdLong     

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
areaIdLong     
blockIdLong     

Return value

PerformanceAvailabilityResult
performanceAvailabilityDataPerformanceAvailabilityData     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

PerformanceAvailabilityData
performanceAvailabilitiesList of PerformanceAvailability     

PerformanceAvailability
areaIdLong     
blockIdLong     
eventIdLong     
minPriceInteger     
performanceIdLong     
availabilityLong     
availabilityLevel(NONE|LIMITED|GOOD)     
compQuotaLong     
contingentIdLong     
minGroupSizeInteger     
quotaLong     
reason(NOT_ON_SALE|CLOSED|
SUSPENDED|CANCELED|
SOLD_OUT|
POS_NOT_ON_SALE)
     
resaleMinPriceLong     
seatCategoryIdLong     

getPerformancePlannedQuotas

This method returns planned quotas available for a given point of sales

Parameters

pointOfSalesIdLongmandatory: it specifies the point of sales The following error codes can be returned:
  • error.call.invalid_parameter: when pointOfSalesId is invalid
quotaRequestDatasList of QuotaRequestDatamandatory: it specifies the events for which planned quota is requested The following error codes can be returned:
  • error.call.missing_parameter: when quotaRequestDatas is missing;
  • error.call.invalid_parameter: when contingentIds are invalid

QuotaRequestData
contingentIdsList of LongOptional
eventIdLongMandatory
performanceIdsList of LongOptional
seatCategoryIdsList of LongOptional

Return value

PlannedQuotaResult
plannedQuotasList of PlannedQuotaData     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

PlannedQuotaData
complimentaryQuotaLong     
contingentIdLong     
performanceIdLong     
saleQuotaLong     
seatCategoryIdLong     

getProductAvailability

This method allows to determine the availability of one or more products, no matter the type. Thus, it is possible to ask at the same time the availability of an event and performance.

Parameters

requestIdIntegeroptional
pointOfSalesIdLongmandatory: it specifies the point of sales
productIdsList of Longmandatory: it specifies the list of products whose availability we want to know.
itemIdsList of LongOptional: 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.
timeslotIdsList of LongOptional: 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.
seatCategoryIdsList of LongOptional: 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.
contingentIdsList of Longoptional: works as the categories, with the contingents.
composedProductIdLongoptional: id of the composed product allowing specific availabilities
advantageIdLong     

Return value

ProductAvailabilityResult
productAvailabilityDataProductAvailabilityData     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

ProductAvailabilityData
productAvailabilitiesList of ProductAvailability     

ProductAvailability
itemIdLong     
productIdLong     
timeslotIdLong     
availabilityLong     
availabilityLevel(NONE|LIMITED|GOOD)     
compQuotaLong     
contingentIdLong     
minGroupSizeInteger     
quotaLong     
reason(NOT_ON_SALE|CLOSED|
SUSPENDED|CANCELED|
SOLD_OUT|
POS_NOT_ON_SALE)
     
resaleMinPriceLong     
seatCategoryIdLong     

getSeatsAvailability

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.

Parameters

requestIdIntegeroptional
pointOfSalesIdLongmandatory: it specifies the point of sales
performanceIdsList of Longmandatory: the related performances.
productIdLongoptional
modifiedSinceDateallows to cache the result of previous calls to obtain only the seats updated since the last call.
seatCategoryIdsList of Longoptional: limits to the seats with the given categories.
contingentIdsList of Longoptional : limits to the seats with the given contingents.
areaBlockIdsList of AreaBlockIdoptional : limits to the seats with the given areas/blocks
clippingAreaClippingArea     
availabilityType(AVAILABLE|NOT_AVAILABLE|
BOTH)
optional, allows to select only the available seats. Default:AVAILABLE
composedProductIdLongoptional: id of the composed product allowing specific availabilities
advantageIdLong     

ClippingArea
hint     
wint     
xint     
yint     

Return value

SeatsAvailabilityResult
seatsAvailabilityDataSeatsAvailabilityData     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

SeatsAvailabilityData
seatsAvailabilitiesList of SeatDefinition     
timestampDate     
truncatedBoolean     

SeatDefinition
UNDEFINEDString     
areaIdLong     
areaKind(INDIFFERENT|BOX)     
availableboolean     
blockIdLong     
classification1icString     
classification2icString     
contingentIdLong     
dummySeatboolean     
entranceIdLong     
externalEntranceIdLong     
freezingReasonIcString     
frozenboolean     
numberString     
optimalSeatSelectionValueLong     
physicalSeatIdLong     
rotationint     
rowString     
scenePanoLinkString     
scenePhotoLinkString     
seatCategoryIdLong     
seatOrderLong     
xint     
yint     

getUpdatedAvailabilities

Allows to list the products which availability have changed since a reference date. Much quicker than listing all the availabilities one by one.

Parameters

requestIdInteger     
pointOfSalesIdLong     
productIdsList of Long     
referenceDateDate     

Return value

UpdatedAvailabilitiesResult
availabilityUpdateDataList of AvailabilityUpdateData     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

AvailabilityUpdateData
advantageIdLong     
hospitalitySessionIdLong     
lastUpdateDate     
performanceIdLong     
productIdLong     
timeslotIdLong     

isAvailabilityServiceAlive

validate network connection and login/password

Parameters

Return value

WebMethodResult
requestIdInteger     
statusCodeString (8)     
statusDetailString     

updatePerformancePlannedQuotas

This method updates planned quotas available for a given point of sales.

Parameters

pointOfSalesIdLongmandatory: it specifies the point of sales
  • error.call.invalid_parameter: when pointOfSalesId is invalid
plannedQuotaDatasList of PlannedQuotaDatamandatory, it specifies the planned quotas to be updated. The following error codes can be returned:
  • error.call.missing_parameter: when plannedQuotaDatas is missing or if {@link PlannedQuotaData} eventId is missing
  • error.call.invalid_parameter: when when eventId, performanceIds, seatCategoryIds, or contingentIds are invalid
  • error.code.quota.illegalseatcategory: when the seatcategory isn’t available for the performance;
  • error.order.seat.availability: when the planned quota is less than sold item;

Return value

PlannedQuotaResult