Service: ExternalOrderHistoryService

Version: 1_28 (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.history.v1_28.ExternalOrderHistoryService.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.

Methods:

• countFilesByCriteria:
• countOrdersByCriteria:
• 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.
• listTicketsByCriteria: Returns a list of tickets filtered by the given 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)

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

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)
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.
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)
referenceDate	Date
waitingActionState	(PRE_SALES|PRE_REQUESTED| REQUESTED|VALIDATED| REJECTED)

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

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

ExternalName
translations	List of Translation

Translation
locale	String (2)
value	String

listTicketsByCriteria

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns a list of tickets filtered by the given criteria. List of tickets returned by the service is paginated if startPosition and maxResult are specified in the request. Otherwise, first 5000 items are returned by default.

Parameters

requestId	Integer
pointOfSalesId	Long
startDate	Date
endDate	Date
states	List of (CANCELLED|VALID| NOT_PRINTED|INVALIDATED)	- allows search with multiple states as criteria
productId	Long
performanceId	Long
itemId	Long
startPosition	Long
maxResult	Long
buyingContactReference	String
culturalContactReference	String
ticketMedium	(THERMAL|E_TICKET|MOBILE| RFID|BLOCKCHAIN)
ordersId	List of Long
joinType	(UNION_FILE_CONTACTS| INTERSECT_FILE_CONTACTS)
seatIds	List of Long
ticketSearchCriteria	(EXCLUDE_PAST_TICKETS)	- applies the given searchCriteria for tickets.This field is optional.
ticketSortingCriteria	(CREATION_DATE| PERFORMANCE_DATE)	- orders the result by given criteria. This field is optional.
membershipBarcode	String (8)

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)
alley	String
area	String
areaId	Long
areaKind	(INDIFFERENT|BOX)
audienceSubCatCode	String (8)
audienceSubCategory	String
audienceSubCategoryId	Long
barcode	String (8)
beneficiaryBirthdate	Date
beneficiaryCountryCode	String (8)
beneficiaryIdNumber	String
block	String
blockId	Long
buyingContact	ContactData
buyingContactReference	String
cardType	CardTypeData
catalogCurrency	CurrencyCash
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.
fileId	Long
firstName	String
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
matchRound	String
movementId	Long
numberOfAccompaniers	Integer
numberOfParticipants	Integer
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
parentMovementId	Long
parentProduct	String
parentProductId	Long
performanceAddOnName	String
performanceCode	String (8)
performanceComfortVariableValues	Map of StringString
performanceDate	Date
performanceDuration	Long
performanceId	Long
performanceName	String
price	Integer
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
seatCategory	String
seatCategoryId	Long
seatNumber	String
seatQuality	String
seatQualityId	Long
sector	String
shipmentModeType	String
site	String
siteAddressWebsite	String
siteKind	String
space	String
startValidityDate	Date
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)
ticketState	(CANCELLED|VALID| NOT_PRINTED|INVALIDATED)
ticketSupports	List of String
ticketType	(INDIVIDUAL_TICKET| GROUP_TICKET)
timeslotStart	Date

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)

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)

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