Service: ExternalOrderHistoryService

Version: 1_34 (other versions, change log, ZUMSTEIN_V3.12-SNAPSHOT) Active version. This version can be subject to minor retro-compatible changes without warnings.

SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.history.v1_34.ExternalOrderHistoryService.webservice?wsdl

REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnseb/backend-apis/externalOrderHistoryService/v1_34/{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.

Methods:

countFilesByCriteria:
countOrdersByCriteria:
countTicketPerProductByCriteria: Returns a list of tickets per product filtered by the given ticket filter criteria.
getProductRevenueByCriteria: Return the number of sales and revenue for only one product/performance.
getStreamingProductsByContact: Get a list of streaming product/performance with detail value of contact number
getVisitGroupDetails: Get a list of visit groups with extended details
getVisitGroups: Get a list of visit groups
isExternalOrderHistoryServiceAlive: validate network connection and login/password
listFilesByCriteria: Returns a list of files filtered by the given criteria.
listOrdersByCriteria: Returns a list of orders filtered by the given criteria.
listSaleContactsByCriteria:
listSuspendedFiles: Get list of SUSPENDED files for all or a specific operator on an input sale channel
listTicketsByCriteria: Returns a list of tickets filtered by the given ticket filter criteria.
searchCulturalContactsOfOrdersByCriteria:

countFilesByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer
pointOfSalesId	Long
startDate	Date
endDate	Date
states	List of (RUNNING\|SUSPENDED\| IN_OPTION\|IN_RESERVATION\| OPTION_RESERV\|CONFIRMED\| SOLDED\|NOT_SOLDED\| PART_SOLDED\|CANCELED\| ABANDONNED\|TECH_ERROR)
productId	Long
performanceId	Long
itemId	Long
culturalContactReference	String
paymentStates	List of (WAITING\|IN_PROGRESS\| AUTHORIZED\|PAID\| CANCELLED_BY_USER\|FAILED\| ABANDONED\| WAITING_MANUAL_VALIDATION\| FAILED_REJECTED)
fileContacts	List of FileContactData
maxFileExpirationDate	Date
maxInstallmentExpirationDate	Date
fileSearchCriteria	(UNION_FILE_CONTACTS\| INTERSECT_FILE_CONTACTS)
mainAudienceCategory	(OCCASIONAL\|SUBSCRIBER\| INSIDE_SEASONTICKET\| MEMBER\|INVITED)
fileOptionStates	List of (NONE\|REQUESTED\| PRE_REQUESTED)
orderOriginators	List of (SALE\|DESK\| DESK_WITHOUT_PLAN\| TICKETSHOP\|FLASH\| ADMINISTRATION\| SALE_COMPLEMENT\| EXTERNAL_SALE\|EBO\|BORNES\| CREDIT_NOTE\|TOUCHSCREEN\| ST_RENEWAL\|ST_TRANSFER\| RESALE_PLATFORM\|SEATING\| BATCH\|SEATING_M\| REQUEST_ARBITRATION\| CENTRAL_PLANNING\| PARTIAL_REFUND\| OPTION_DISTRIBUTION)

FileContactData

fileContactType	(SALE\|OWNER\|FINDER\| COMM_ENTITY)
answerQuestionnaire	AnswerQuestionnaire
birthPlace	String
birthRegion	String
birthday	Date
contactId	Long
contactReference	String (20)
countryCode	String (8)
email	String
firstAddressLine	String
firstName	String
firstNamePhonetic	String
idNumber	String
invoiceAddressId	Long
lastName	String
lastNamePhonetic	String
locality	String
mobilePhone	String
phone	String
secondAddressLine	String
structureOfficialName	String
thirdAddressLine	String
zipCode	String (8)

AnswerQuestionnaire

answerQuestions	List of AnswerQuestion
ticketId	Long

AnswerQuestion

answerCodes	List of String
questionCode	String (8)

Return value

AggregatedFileHistoryResult

aggregatedFileHistories	List of AggregatedFileHistoryData
requestId	Integer
statusCode	String (8)
statusDetail	String

AggregatedFileHistoryData

fileState	(RUNNING\|SUSPENDED\| IN_OPTION\|IN_RESERVATION\| OPTION_RESERV\|CONFIRMED\| SOLDED\|NOT_SOLDED\| PART_SOLDED\|CANCELED\| ABANDONNED\|TECH_ERROR)
numberOfExpiredFiles	Long
numberOfFiles	Long

countOrdersByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer
pointOfSalesId	Long
startDate	Date
endDate	Date
productId	Long
performanceId	Long
itemId	Long
contactReference	String (20)
culturalContactFilterCriteria	ContactFilterCriteria
paymentStates	List of (WAITING\|IN_PROGRESS\| AUTHORIZED\|PAID\| CANCELLED_BY_USER\|FAILED\| ABANDONED\| WAITING_MANUAL_VALIDATION\| FAILED_REJECTED)
orderTypes	List of (SALE\|REFUND_CLIENT\| REFUND_ORGANIZATION\| EXCHANGE_ORGANIZATION\| EXCHANGE_CLIENT\| RESERVATION\|RENEWAL\| OPTION\| RESERVATION_FREEING\| OPTION_FREEING\| ST_TRANSFER)

ContactFilterCriteria
DTO used to specify order filter criteria for a given contact. Used in queries which look for orders by various criteria. salesChannelType: the type of sales channel the contact's orders should come from unionWithOtherOrders: define how to treat this contact's orders in relation to other orders of the query: union or intersection
contactReferences	List of String
salesChannelTypeString	String
unionWithOtherOrders	Boolean

Return value

AggregatedOrderHistoryResult

aggregatedOrderHistories	List of AggregatedOrderHistoryData
requestId	Integer
statusCode	String (8)
statusDetail	String

AggregatedOrderHistoryData

numberOfOrders	Long
orderState	(OPEN\|VALIDATED\|CLOSED\| ABANDONNED\|CLOSED_SEATING\| PROCESSING)
orderType	(SALE\|REFUND_CLIENT\| REFUND_ORGANIZATION\| EXCHANGE_ORGANIZATION\| EXCHANGE_CLIENT\| RESERVATION\|RENEWAL\| OPTION\| RESERVATION_FREEING\| OPTION_FREEING\| ST_TRANSFER)
totalAmount	Long

countTicketPerProductByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns a list of tickets per product filtered by the given ticket filter criteria. List of tickets returned by the service is paginated if pagination Parameter are specified in the request. Otherwise, first 5000 items are returned by default.

Parameters

requestId	Integer
ticketFilterCriteria	TicketPerProductFilterCriteria
ticketPerProductGranularity	(NONE)
paginationParameter	PaginationParameter

TicketPerProductFilterCriteria

buyingContactReference	String
culturalContactReference	String
endDate	Date
joinType	(UNION_FILE_CONTACTS\| INTERSECT_FILE_CONTACTS)
pointOfSalesId	Long
startDate	Date
states	List of (CANCELLED\|VALID\| NOT_PRINTED\|INVALIDATED)
ticketSearchCriteria	(EXCLUDE_PAST_TICKETS)

PaginationParameter
DTO used to paginated if startPosition and maxResult are specified in the request. Otherwise, first 5000 items are returned by default. startPosition : the start position for current pagination maxResult: the maximum number result return for current pagination control
maxResult	Long
startPosition	Long

Return value

TicketPerProductSummaryListResult

ticketPerProductSummaryData	List of TicketPerProductSummaryData
requestId	Integer
statusCode	String (8)
statusDetail	String

TicketPerProductSummaryData

activityType	(LIVE_SPECT\|FESTIVAL\| MUSEUM\|VISIT\|ENTERT_PARK\| FAIR\|PARKING\|SPORT\|OTHER\| TOURNAMENT_SESSION)
displayDateOnlyOfTimeslotStart	boolean
endValidityDate	Date
hostTeam	String
matchRank	Integer
matchRound	String
numberOfTickets	Integer
opposingTeam	String
parentProduct	String
parentProductFamilyType	(SINGLE_ENTRY\| SEASONTICKET\|PASS\|PACKAGE\| MEMBERSHIP\|SERVICE\|GOODS\| TRANSPORT\|HOSPITALITY)
parentProductId	Long
performanceAddOnName	String
performanceCode	String (8)
performanceDate	Date
performanceDuration	Long
performanceId	Long
performanceName	String
product	String
productFamilyType	(SINGLE_ENTRY\| SEASONTICKET\|PASS\|PACKAGE\| MEMBERSHIP\|SERVICE\|GOODS\| TRANSPORT\|HOSPITALITY)
productId	Long
season	String
startValidityDate	Date
ticketType	(INDIVIDUAL_TICKET\| GROUP_TICKET)
timeslotId	Long
timeslotStart	Date

getProductRevenueByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Return the number of sales and revenue for only one product/performance.

Rules for date parameter, if it is passed from:

- Ticketshop: it is should be a date with the organization's timezone.

- Third party:

	 Case 1: without timezone, it will be understood as a date with the server's timezone,
 		then it will be converted to organization's timezone.

	 Case 2: input date's timezone is the same as the organization's timezone, it's normal case.

	 Case 3: input date's timezone is different from the organization's timezone,
 		then it will be converted to organization's timezone.

	 Example: assuming organization timezone is +02:00 (Europe/Paris), server timezone is +00:00 (UTC)

	 - Input (Case 1):  2023-07-24T22:00:00
 			--> 2023-07-24T22:00:00+00:00 (auto converted to server timezone)
 			--> 2023-07-25T00:00:00+02:00 (final result will be used)

	 - Input (Case 2):  2023-07-24T22:00:00+02:00
 			--> 2023-07-24T20:00:00+00:00 (auto converted to server timezone)
 			--> 2023-07-24T22:00:00+02:00 (final result will be used)

	 - Input (Case 3):  2023-07-24T22:00:00+01:00
 			--> 2023-07-24T21:00:00+00:00 (auto converted to server timezone)
 			--> 2023-07-24T23:00:00+02:00 (final result will be used)

Note: This API returns the data used for a real-time dashboard. Thus, the performance is very important, so it should support for only one product/performance.

Parameters

productRevenueFilterCriteria

ProductRevenueFilterCriteria

Mandatory
includes parameters below:

- contactNumber: Mandatory parameter. It is contact number of a relay contact.

- productId: Mandatory parameter.

- performanceId: Optional parameter.

- dateFilter: Mandatory parameter. It is expected to be a date with the organization's timezone.

ProductRevenueFilterCriteria

contactNumber	String (20)
dateFilter	Date
performanceId	Long
productId	Long

Return value

ProductRevenueResult

productRevenueData	ProductRevenueData
requestId	Integer
statusCode	String (8)
statusDetail	String

ProductRevenueData

catalogCurrency	CurrencyCash
performanceId	Long
priceComponentInfos	List of PriceComponentInfo
productId	Long
soldTicketByTimes	List of SoldTicketByTime
totalOfReservationTickets	Integer
totalOfSoldTickets	Integer
totalReservationRevenue	Long
totalRevenue	Long
totalRevenuePerSeatCats	List of TotalRevenuePerSeatCat

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

PriceComponentInfo

audSubCatId	Long
bgColor	String
logSeatCatId	Long
numberOfReservationTickets	Integer
numberOfSoldTickets	Integer
priceId	Long
priceName	String
priceRank	Integer
seatCatName	String
seatCatRank	Integer
tariffName	String
tariffRank	Integer
textColor	String
totalReservationRevenue	Long
totalRevenue	Long
unitAmount	Long

SoldTicketByTime

createdTime	Integer
numberOfReservationTickets	Integer
numberOfSoldTickets	Integer

TotalRevenuePerSeatCat

bgColor	String
logSeatCatId	Long
seatCatName	String
seatCatRank	Integer
textColor	String
totalReservationRevenue	Long
totalRevenue	Long

getStreamingProductsByContact

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Get a list of streaming product/performance with detail value of contact number

Parameters

streamingProductSearchCriteria	StreamingProductSearchCriteria	Mandatory - Mandatory parameter, streamingProductSearchCriteria
paginationParameter	PaginationParameter	- Optional parameter, paginationParameter

StreamingProductSearchCriteria

contactReference	String (20)
performanceIds	List of Long
productIds	List of Long

Return value

StreamingProductListResult

streamingProductData	List of StreamingProductData
requestId	Integer
statusCode	String (8)
statusDetail	String

StreamingProductData

performanceId	Long
productId	Long
streamingContent	Map of StringString

getVisitGroupDetails

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Get a list of visit groups with extended details

Parameters

pointOfSalesId	Long	Mandatory - Mandatory parameter, Point of Sales Id
dateFrom	Date	- Optional parameter, start point to search, set to current date if empty
dateTo	Date	- Optional parameter, end point to search
productIds	List of Long	- Optional parameter, Visit Pass product Ids to filter

Return value

VisitGroupListResult

visitGroups	List of VisitGroup
requestId	Integer
statusCode	String (8)
statusDetail	String

VisitGroup

contact	ContactData
criterionsElementIds	List of Long
duration	Integer
estimatedArrivalTime	Date
fileId	Long
fileIds	List of Long
fileRemarks	List of FileRemarkData	All the file remarks related to this visit group.
groupKindInternalCode	String (8)
groupName	String
guides	List of Guide
numberOfAccompaniers	Integer
numberOfParticipants	Integer
productId	Long
remark	String	The first (in date) Contact remark related to this Visit group
spaceId	Long
startFrom	Date
state	(RESERVED\|SOLD\|CANCELLED\| ABANDONNED)
visitGroupId	Long
visitLanguageCode	String (8)
visitThemeId	Long

ContactData
Class containing the beneficiary data : contactReference, optional: the secutix contact number firstName, optional: beneficiary first name lastName, optional: beneficiary last name email, optional: beneficiary email birthday, optional: beneficiary birthday firstAddressLine, optional: first address line secondAddressLine, optional: second address line thirdAddressLine, optional: third address line zipCode, optional: address zip code locality, optional: address locality countryCode, optional: address country code phone, optional: beneficary phone number mobilePhone, optional: beneficary mobile phone number contactId, optional: the contact internal id (for internal use by SecuTix only) invoiceAddressId, optional: the contact address internal id idNumber, optional: To store beneficiary id number like passport number. birthRegion, optional: beneficiary birth region birthPlace, optional: beneficiary birth place
answerQuestionnaire	AnswerQuestionnaire
birthPlace	String
birthRegion	String
birthday	Date
contactId	Long
contactReference	String (20)
countryCode	String (8)
email	String
firstAddressLine	String
firstName	String
firstNamePhonetic	String
idNumber	String
invoiceAddressId	Long
lastName	String
lastNamePhonetic	String
locality	String
mobilePhone	String
phone	String
secondAddressLine	String
structureOfficialName	String
thirdAddressLine	String
zipCode	String (8)

FileRemarkData

fileRemarkType	(CONTACT\|INTERNAL\| EXTERNAL)
remark	String
remarkDate	Date
remarkedBy	String

Guide

contactId	Long
firstName	String
guideId	Long
lastName	String

getVisitGroups

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Get a list of visit groups

Parameters

visitGroupIds

List of Long

Mandatory
- Mandatory parameter, list of visit group ids

Return value

VisitGroupListResult

isExternalOrderHistoryServiceAlive

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

validate network connection and login/password

Parameters

Return value

WebMethodResult

requestId	Integer
statusCode	String (8)
statusDetail	String

listFilesByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns a list of files filtered by the given criteria. To specify a filter on the file contacts, use the fileContacts parameter. If more than one file contact is specified in the file contacts list, returns the files belonging to any of the given contacts (OR semantics). The culturalContactReference filters movement contacts.

Parameters

requestId	Integer
pointOfSalesId	Long
startDate	Date
endDate	Date
states	List of (RUNNING\|SUSPENDED\| IN_OPTION\|IN_RESERVATION\| OPTION_RESERV\|CONFIRMED\| SOLDED\|NOT_SOLDED\| PART_SOLDED\|CANCELED\| ABANDONNED\|TECH_ERROR)
productId	Long
performanceId	Long
itemId	Long
culturalContactReference	String
paymentStates	List of (WAITING\|IN_PROGRESS\| AUTHORIZED\|PAID\| CANCELLED_BY_USER\|FAILED\| ABANDONED\| WAITING_MANUAL_VALIDATION\| FAILED_REJECTED)
startPosition	Long
maxResult	Long
fileContacts	List of FileContactData
maxFileExpirationDate	Date
maxInstallmentExpirationDate	Date	if non-null, returns only files containing installments linked to non-abandoned orders which have an expiration date before the given maxInstallmentExpirationDate
fileSearchCriteria	(UNION_FILE_CONTACTS\| INTERSECT_FILE_CONTACTS)	- applies the given searchCriteria for file contacts.This field is optional.
fileSortingCriteria	(LAST_UPDATED_DATE\| MAX_EXPIRATION_DATE\| MAX_INSTALLMENT_EXPIRATION_DATE)	- orders the result by given criteria. This field is optional, by default it sorts files by last update date of file
mainAudienceCategory	(OCCASIONAL\|SUBSCRIBER\| INSIDE_SEASONTICKET\| MEMBER\|INVITED)	if non-null, returns files which contain operations having the given main audience category. NOTE: If SUBSCRIBER is given as the audience category, then only files containing season tickets will be returned (those containing other products with main category SUBSCRIBER will NOT be returned)
fileOptionStates	List of (NONE\|REQUESTED\| PRE_REQUESTED)
orderOriginators	List of (SALE\|DESK\| DESK_WITHOUT_PLAN\| TICKETSHOP\|FLASH\| ADMINISTRATION\| SALE_COMPLEMENT\| EXTERNAL_SALE\|EBO\|BORNES\| CREDIT_NOTE\|TOUCHSCREEN\| ST_RENEWAL\|ST_TRANSFER\| RESALE_PLATFORM\|SEATING\| BATCH\|SEATING_M\| REQUEST_ARBITRATION\| CENTRAL_PLANNING\| PARTIAL_REFUND\| OPTION_DISTRIBUTION)
movementReferences	List of ExternalReference	Unique reference of the movement in caller's system. Return files where at lease one movement meets those conditions. This field is optional

ExternalReference
Contains an external reference for the object. This external reference is linked to a key, which is unique for a given object. This reference is for tagging purposes only, and will not be involved in any internal process of SecuTix
key	String	Max length 50 chars. Cannot be null.
value	String	Max length 2000 chars.

Return value

FileSummaryListResult

fileSummaries	List of FileSummaryData
truncated	Boolean
requestId	Integer
statusCode	String (8)
statusDetail	String

FileSummaryData
Class containing information of file.
ballotId	Long
fileContacts	List of FileContactSummaryData
fileId	Long
fileState	(RUNNING\|SUSPENDED\| IN_OPTION\|IN_RESERVATION\| OPTION_RESERV\|CONFIRMED\| SOLDED\|NOT_SOLDED\| PART_SOLDED\|CANCELED\| ABANDONNED\|TECH_ERROR)
lastModDate	Date
maxFileExpirationDate	Date
maxInstallmentExpirationDate	Date
numberOfMovements	Long
optionState	(PRE_REQUESTED\|REQUESTED\| VALIDATED\|PART_VALIDATED\| REJECTED\|ABANDONED\| REQUESTED_BY_SUBSTRUCTURE)
referenceDate	Date
waitingActionState	(PRE_SALES\|PRE_REQUESTED\| REQUESTED\|VALIDATED\| REJECTED\| REQUESTED_BY_SUBSTRUCTURE)

FileContactSummaryData

fileContactType	(SALE\|OWNER\|FINDER\| COMM_ENTITY)
contactNumber	String (20)
name	String
structureName	String

listOrdersByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns a list of orders filtered by the given criteria.

Parameters

requestId	Integer
pointOfSalesId	Long
startDate	Date
endDate	Date
states	List of (OPEN\|VALIDATED\|CLOSED\| ABANDONNED\|CLOSED_SEATING\| PROCESSING)
productId	Long
performanceId	Long
itemId	Long
contactReference	String (20)
culturalContactFilterCriteria	ContactFilterCriteria
paymentStates	List of (WAITING\|IN_PROGRESS\| AUTHORIZED\|PAID\| CANCELLED_BY_USER\|FAILED\| ABANDONED\| WAITING_MANUAL_VALIDATION\| FAILED_REJECTED)
startPosition	Long
maxResult	Long
orderTypes	List of (SALE\|REFUND_CLIENT\| REFUND_ORGANIZATION\| EXCHANGE_ORGANIZATION\| EXCHANGE_CLIENT\| RESERVATION\|RENEWAL\| OPTION\| RESERVATION_FREEING\| OPTION_FREEING\| ST_TRANSFER)
externalReferences	List of String	References of the order in the caller's system. 1000 of them maximum can be passed. This field is optional.
movementReferences	List of ExternalReference	Unique reference of the movement in caller's system. Return orders where at lease one movement meets those conditions. This field is optional
orderBy	OrderBy

OrderBy

field	(FILE_LAST_UPDATED_DATE\| FILE_MAX_EXPIRATION_DATE\| ORDER_CREATION_DATE)
order	(ASC\|DESC)

Return value

OrderSummaryListResult

orderSummaries	List of OrderSummaryData
truncated	Boolean
requestId	Integer
statusCode	String (8)
statusDetail	String

OrderSummaryData
Class containing information of order creation result. The following attributes are provided: orderId, mandatory: specify the SecuTix order id orderState, mandatory: specify the order state referenceDate, mandatory: specify the date when order will be count totalAmount, mandatory: total amount of the order, express as unity thousandth numberOfMovements, mandatory: specify the list of deleted movements externalReference, optional: specify the operation id of the given request, if existing
buyingContactInfo	ContactSummaryData
catalogCurrency	CurrencyCash
culturalContactsInfo	List of ContactSummaryData
expirationDate	Date
externalReference	String
fileIds	List of Long
numberOfMovements	Long
orderId	Long
orderOriginator	String
orderSecretId	String
orderState	(OPEN\|VALIDATED\|CLOSED\| ABANDONNED\|CLOSED_SEATING\| PROCESSING)
orderType	(SALE\|REFUND_CLIENT\| REFUND_ORGANIZATION\| EXCHANGE_ORGANIZATION\| EXCHANGE_CLIENT\| RESERVATION\|RENEWAL\| OPTION\| RESERVATION_FREEING\| OPTION_FREEING\| ST_TRANSFER)
paymentStates	List of (WAITING\|IN_PROGRESS\| AUTHORIZED\|PAID\| CANCELLED_BY_USER\|FAILED\| ABANDONED\| WAITING_MANUAL_VALIDATION\| FAILED_REJECTED)
referenceDate	Date
salesChannelName	ExternalName
salesChannelType	(AGENCY\|BOXOFFICE\| INTERNET_B2C\|INTERNET_B2B\| INTERNET_B2B2C\|NEW_TVM\| I_MOBILE_BOXOFFICE)
totalAmount	Long

ContactSummaryData

contactNumber	String (20)
name	String
structureName	String

ExternalName

translations	List of Translation

Translation

locale	String (2)
value	String

listSaleContactsByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

contactFilterCriteria	SaleContactFilterCriteria	Mandatory
granularity	(ALL)

SaleContactFilterCriteria

barcodeOrTaxNumbers	List of String
movementIds	List of Long
ticketIds	List of Long

Return value

SaleContactListResult

saleContactData	List of SaleContactData
requestId	Integer
statusCode	String (8)
statusDetail	String

SaleContactData

contactNumber	String (20)
role	(CULTURAL_CONTACT\| MAIN_CONTACT\|SALE_CONTACT\| OWNER_CONTACT\|GROUP_LEAD\| MAIN_STRUCTURE\| OWNER_STRUCTURE)
ticketInfos	List of TicketInfo

TicketInfo

barcode	String (8)
movementId	Long
taxNumber	String
ticketId	Long

listSuspendedFiles

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Get list of SUSPENDED files for all or a specific operator on an input sale channel

Parameters

saleChannelId	Long	Mandatory - Mandatory parameter
operator	String	- Optional parameter If operator is NULL then return all files of input sale channel. If specific operator is provided the return list suspended files of input sale channel belonging to the input operator

Return value

SuspendedFileListResult

suspendedFiles	List of SuspendedFile
requestId	Integer
statusCode	String (8)
statusDetail	String

SuspendedFile

currentOrderId	Long
fileId	Long
lastOrderRemark	String
orderType	(SALE\|REFUND_CLIENT\| REFUND_ORGANIZATION\| EXCHANGE_ORGANIZATION\| EXCHANGE_CLIENT\| RESERVATION\|RENEWAL\| OPTION\| RESERVATION_FREEING\| OPTION_FREEING\| ST_TRANSFER)
purchaseContact	String
suspendedDate	Date
suspendedOperator	String
totalAmount	Long

listTicketsByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns a list of tickets filtered by the given ticket filter criteria. List of tickets returned by the service is paginated if pagination Parameter are specified in the request. Otherwise, first 5000 items are returned by default.

Parameters

requestId	Integer
ticketFilterCriteria	TicketFilterCriteria
paginationParameter	PaginationParameter

TicketFilterCriteria
DTO used to specify tickets filter criteria. Used in queries which look for tickets by various criteria. pointOfSalesId startDate endDate states - allows search with multiple ticket states as criteria productId performanceId buyingContactReference culturalContactReference ticketMedium ordersId joinType seatIds ticketSearchCriteria - applies the given searchCriteria for tickets.This field is optional. ticketSortingCriteria - orders the result by given criteria. This field is optional. membershipBarcode fileIds - This field is optional, allow to search tickets by multiple fileId ticketBarCodes - This field is optional, allow to search tickets by multiple ticket barcode fileStates - This field is optional, allow to search tickets by multiple file states
buyingContactReference	String
culturalContactReference	String
endDate	Date
fileIds	List of Long
fileStates	List of (RUNNING\|SUSPENDED\| IN_OPTION\|IN_RESERVATION\| OPTION_RESERV\|CONFIRMED\| SOLDED\|NOT_SOLDED\| PART_SOLDED\|CANCELED\| ABANDONNED\|TECH_ERROR)
itemId	Long
joinType	(UNION_FILE_CONTACTS\| INTERSECT_FILE_CONTACTS)
membershipBarcode	String (8)
ordersId	List of Long
performanceId	Long
pointOfSalesId	Long
productId	Long
seatIds	List of Long
startDate	Date
states	List of (CANCELLED\|VALID\| NOT_PRINTED\|INVALIDATED)
ticketBarCodes	List of String
ticketIds	List of Long
ticketMedium	(THERMAL\|E_TICKET\|MOBILE\| RFID\|BLOCKCHAIN)
ticketSearchCriteria	(EXCLUDE_PAST_TICKETS)
ticketSortingCriteria	(CREATION_DATE\| PERFORMANCE_DATE)

Return value

TicketSummaryListResult

ticketSummaries	List of TicketSummaryData
truncated	Boolean
requestId	Integer
statusCode	String (8)
statusDetail	String

TicketSummaryData

activityType	(LIVE_SPECT\|FESTIVAL\| MUSEUM\|VISIT\|ENTERT_PARK\| FAIR\|PARKING\|SPORT\|OTHER\| TOURNAMENT_SESSION)
advantageId	Long
alley	String
area	String
areaId	Long
areaKind	(INDIFFERENT\|BOX)
audienceSubCatCode	String (8)
audienceSubCategory	String
audienceSubCategoryId	Long
audienceSubCategoryRank	Integer
barcode	String (8)
beneficiaryBirthdate	Date
beneficiaryCountryCode	String (8)
beneficiaryIdNumber	String
block	String
blockId	Long
buyingContact	ContactData
buyingContactReference	String
cardType	CardTypeData
catalogCurrency	CurrencyCash
comfortVariableValues	Map of StringString
contactQualities	List of ContactQuality
containerIdentifier	String
creationDate	Date
culturalContact	ContactData
culturalContactReference	String
displayDateOnlyOfTimeslotStart	boolean
duplicate	boolean
endValidityDate	Date
entrance	String
entranceId	Long
exchangeable	boolean	A ticket is exchangeable if both the product and tariff are exchangeable.
externalEntranceCode	String (8)
externalEntranceId	Long
fileId	Long
finalDate	boolean
firstName	String
fiscalProgressiveNumber	String
fiscalSSTKCode	String (8)
floor	String
hostTeam	String
isAvailableForPrint	boolean
isChampionship	boolean	The flag to show if the ticket is of a composition product inside a championship season ticket.
isNominativeTicket	boolean
itemDescription	String
itemId	Long
itemName	String
lastName	String
matchRank	Integer
matchRound	String
mobileAppTicketData	MobileAppTicketData
movementId	Long
nfcLink	String	Link to download the NFC ticket.
numberOfAccompaniers	Integer
numberOfParticipants	Integer
operationId	Long
operationType	(SALE\|REFUND\|PRE_SALE\| RESERVATION\|OPTION\| RES_CANCELLATION\| OPTION_CANCELLATION\| REFUND_ORGANIZATION\| REFUND_CLIENT\| RESERVATION_FREEING\| OPTION_FREEING\|ABANDON\| PRE_REFUND)
opposingTeam	String
orderExternalReference	String
orderId	Long
parentAdvantageId	Long
parentMovementId	Long
parentOperationId	Long
parentProduct	String
parentProductFamilyType	(SINGLE_ENTRY\| SEASONTICKET\|PASS\|PACKAGE\| MEMBERSHIP\|SERVICE\|GOODS\| TRANSPORT\|HOSPITALITY)
parentProductId	Long
performanceAddOnName	String
performanceCode	String (8)
performanceDate	Date
performanceDuration	Long
performanceId	Long
performanceName	String
previousInvalidatedTicketIds	List of Long
price	Long
priceLevelId	Long
priceType	(PREDEFINED\|DYNAMIC)	The price type of the operation linked to the ticket.
printingDate	Date
product	String
productFamilyType	(SINGLE_ENTRY\| SEASONTICKET\|PASS\|PACKAGE\| MEMBERSHIP\|SERVICE\|GOODS\| TRANSPORT\|HOSPITALITY)
productId	Long
questionnaireId	Long
resaleable	boolean
row	String
scenePanoLink	String
scenePhotoLink	String
season	String
seatCategoryData	TicketSeatCategoryData
seatNumber	String
seatQuality	String
seatQualityId	Long
sector	String
shipmentModeType	String
shipmentState	(UNSENT\|SENT\|CANCELLED\| REFERENCE\|REPROCESS)
site	String
siteAddressWebsite	String
siteKind	String
space	String
startValidityDate	Date
tariffRequiresAttachment	Boolean
taxNumber	String
ticketId	Long
ticketKind	(EBO\|PRODUCER\|SECUTIX\| THIRD_PARTY\|SECUTIX_EXT\| IMPORTED_ITR\|UNDEFINED)
ticketMedium	(THERMAL\|E_TICKET\|MOBILE\| RFID\|BLOCKCHAIN)
ticketPrintingMode	(CARD\|CARD_AND_TICKETS\| TICKETS\|BADGE\| BADGE_AND_TICKETS\|NONE)
ticketResaleState	(OPEN\|PROCESSING\|RESOLD\| INVALIDATED\|CANCELED)
ticketSeatInfo	TicketSeatInfo
ticketState	(CANCELLED\|VALID\| NOT_PRINTED\|INVALIDATED)
ticketSupport	(THERMAL\|ETICKET\|PAPER_A4\| PASSBOOK\|MOBILE\| BLOCKCHAIN\|BADGE\|RFID\| PR_RFID_CARD\| DEMAT_BADGE)
ticketSupports	List of String
ticketType	(INDIVIDUAL_TICKET\| GROUP_TICKET)
timeslotId	Long
timeslotStart	Date
visitGroupId	Long

CardTypeData

cardTypeId	Long
code	String (8)
control	String
externalName	String
logoUrl	String (255)
printable	Boolean

ContactQuality

audienceCategories	List of AudienceCategoryPriceLevel
seasonId	Long

AudienceCategoryPriceLevel

audienceCatId	Long
instanceNumber	String
mainCategory	(OCCASIONAL\|SUBSCRIBER\| MEMBER\|INVITED\| INSIDE_SEASONTICKET)
movementId	Long
priceLevelId	Long
productId	Long
secondaryCategory	(INDIVIDUAL\|COMMUNITY\| GROUP\|TAXED\|FREE\| PROMOTIONAL)

MobileAppTicketData
Class containing status, owner and assignee of the a ticket when we synchronize mobile App with Secutix Status, Ticket Status in mobile App Owner, Ticket Owner in mobile App Assignee, Ticket Assignee in mobile App
assigneeBirthdate	Date
assigneeFirstName	String
assigneeIdNumber	String
assigneeLastName	String
assigneeNationality	String
ownerEmail	String
ownerFirstName	String
ownerLastName	String
status	(INJECTED\|RECEIVED\| TRANSFER_PENDING\| TRANSFERRED\|ACTIVATED\| DELETION_PENDING\|DELETED\| CONTROLLED\|DOWNLOADED\| ASSIGNED\|DEFAULT\|INVALID\| PENDING_TRANSFER\| FAILURE_TRANSFER\|PENDING\| FAILURE\|BT_ACTIVATED\| MANUAL_ACTIVATED\| OFFLINE_ACTIVATED\| ONLINE_ACTIVATED\| DEACTIVATED)

TicketSeatCategoryData

companion	boolean
companionSeatCategoryId	Long
seatCategory	String
seatCategoryId	Long
seatCategoryRank	Integer
ticketHolderDeadlinePassed	boolean

TicketSeatInfo

companionLogicalSeatId	Long
saleSeatId	Long

searchCulturalContactsOfOrdersByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

orderIds	List of Long
fileIds	List of Long
buyerContactReference	String
pointOfSalesId	Long
startDate	Date
endDate	Date
states	List of (OPEN\|VALIDATED\|CLOSED\| ABANDONNED\|CLOSED_SEATING\| PROCESSING)
productId	Long
performanceId	Long
itemId	Long
paymentStates	List of (WAITING\|IN_PROGRESS\| AUTHORIZED\|PAID\| CANCELLED_BY_USER\|FAILED\| ABANDONED\| WAITING_MANUAL_VALIDATION\| FAILED_REJECTED)
startPosition	Long
maxResult	Long
orderTypes	List of (SALE\|REFUND_CLIENT\| REFUND_ORGANIZATION\| EXCHANGE_ORGANIZATION\| EXCHANGE_CLIENT\| RESERVATION\|RENEWAL\| OPTION\| RESERVATION_FREEING\| OPTION_FREEING\| ST_TRANSFER)

Return value

SearchOrdersResult

culturalContacts	List of ContactSummaryData
truncated	Boolean
requestId	Integer
statusCode	String (8)
statusDetail	String