Service: ExternalOrderService

Version: 1_11 (other versions, change log, ZUMSTEIN_V4.4-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.externalorder.v1_11.ExternalOrderService.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.external order service interface v1_11 : web service exposed to external world

Methods:

• abandonMovements:
• abandonOperations:
• abandonOrder:
• applyAdvantage: Applies rulesetAdvantage on the given order.
• cancelOperations: Cancels the given operations or movements which is used for reservation/option cancellations.
• closeOrder:
• createRefundOperations:
• deleteFileAttachment: Deletes the given fileAttachmentId and return success or failure status code.
• getFileAttachment: Returns the fileAttachment of given fileAttachmentId and contactReference
• getFileDetails: Returns the details of a file which may contain several orders, some of which may be partial (only the operations of the order concerning the given file will be returned)
• getOrderDetails:
• getOrderInstallmentData:
• isExternalOrderServiceAlive: validate network connection and login/password
• manualAttributeSeats: Manual attribution for operations.
• notifyOrder: This method finalizes the order if its waiting for payment confirmation done via EPC by notifying orchestra to resume the EPC ASYNC wait.
• reopenOrder:
• setMovementContact: Assigns a contact to a movement.
• uploadFileAttachment: Uploads the given printableFileAttachmentData to given fileId and given file contact reference and return success or failure status code.
• validateOrder:

abandonMovements

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer	the request id
orderId	Long	the SecuTix order id
movementIds	List of Long	the SecuTix movement id list

Return value

OrderUpdateResult
Class representing the response of create order method in external order service.
orderUpdateData	OrderUpdateData
expectedException	boolean
statusMessage	String
requestId	Integer
statusCode	String (8)
statusDetail	String

OrderUpdateData
Class containing information of order update result. The following attributes are provided: operationDataUpdates, optional: specify the list of created or updated operations removeOperationIds, optional: specify the list of deleted operations movementDataUpdates, optional: specify the list of created or updated movements removeMovementIds, optional: specify the list of deleted movements mainOperationId, optional: specify the operation id of the given request, if existing
generatedContiguities	List of ContiguityData
mainOperationId	Long
movementDataUpdates	List of MovementData
operationDataUpdates	List of OperationData
orderId	Long
origin	OrderOriginData
removeMovementIds	List of Long
removeOperationIds	List of Long

ContiguityData
contiguous	boolean
performanceId	Long
seatCategoryId	Long
segments	List of Segment

Segment
movementIds	List of Long

MovementData
Class containing all necessary information to display a movement. The following attributes are provided: movementId, mandatory: the SecuTix movement id type, mandatory: Specify if the movement concerns a numbered seat or a not numbered area seatId, optional: the SecuTix seat id if type is SEAT seatCategoryId, mandatory: the SecuTix seat category id seatCategory, mandatory: the seat category name (language is the parameter in the request header or the favorite institution language) contingentId, mandatory: the SecuTix contingent id contingent, mandatory: the contingent name areaId, mandatory: the SecuTix area id area: the area name floor: the floor name sector: the sector name blockId: the SecuTix block id if type is SEAT block: the block name if type is SEAT alley: the alley name if type is SEAT entranceId: the SecuTix entrance id if type is SEAT entrance: the entrance name row: the row name seatNumber: the seat number seatQualityId: the SecuTix seat quality id seatQuality: the SecuTix seat quality name yCoordinate: the y coordinate in the SecuTix configuration xCoordinate: the x coordinate in the SecuTix configuration beneficiaryFirstname: the first name of the beneficiary beneficiaryLastname: the last name of the beneficiary contactReference: the id of the cultural contact resaledMovementId: when the movement correspond to a resaled ticket, this field contains the movementId of
alley	String
area	String
areaId	Long
areaKind	(INDIFFERENT|BOX)
attributionMatch	(MATCHING_EXPECTED_AREAS| MATCHING_EXPECTED_BLOCKS| NOT_MATCHING| NO_EXPECTATION)
barcode	String (8)
beneficiaryBirthdate	Date
beneficiaryCountryCode	String (8)
beneficiaryFirstname	String
beneficiaryIdNumber	String
beneficiaryLastname	String
block	String
blockId	Long
contactReference	String (20)
contingent	String
contingentId	Long
endValidityDate	Date
entrance	String
entranceId	Long
externalRemark	String
floor	String
instanceNumber	Long
movementId	Long
operationId	Long
parentMovementId	Long
resaledMovementId	Long
resumed	boolean
resumedMovementId	Long
row	String
saleAreaId	Long
saleSeatId	Long
scenePhotoLink	String
seatCategory	String
seatCategoryId	Long
seatId	Long
seatNumber	String
seatOrientation	Integer
seatQuality	String
seatQualityCode	String (8)
seatQualityId	Long
sector	String
stageVisibility	String
startValidityDate	Date
taxNumber	String
titlingVisibility	String
type	(SEAT|AREA|SIMPLE_PRODUCT| COMPOSED)
xCoordinate	Long
yCoordinate	Long

OperationData
Class containing all necessary information for an operation. The following attributes are provided: operationId, mandatory: the SecuTix operation id kind, mandatory: the operation kind quantity, mandatory: item quantity for this operation basePrice, mandatory: price as defined in SecuTix rates table, express as unity thousandth productId, mandatory: real price asked to the client, express as unity thousandth product, mandatory: the product name (language is the parameter in the request header or the favorite institution language) itemId, optional: the SecuTix item id item, optional: the item name performanceId, optional: the SecuTix performance id performance, optional: the performance name eventId, eventId: the SecuTix event Id siteId, optional: the SecuTix site id site, optional: the site name contingentId, optional: the SecuTix contingent id contingent, optional: the contingent name isNumbered, optional: identify if operation affects numbered seat or not numbered area seatCategoryId, mandatory: the SecuTix seat category id seatCategory, mandatory: the seat category name audienceSubCategoryId, mandatory: the SecuTix audience sub category id audienceSubCategory, mandatory: the audience sub category name vatRate, mandatory: the vat rate, express as milli-percent (19.6% <=> 19600) String message, optional: a message could be given to explain what happened to the operator advantageId, optional: the advantage used for this operation advantage, optional: the name of the advantage used for this operation
activityType	(LIVE_SPECT|FESTIVAL| MUSEUM|VISIT|ENTERT_PARK| FAIR|PARKING|SPORT| OTHER)
advantage	String
advantageId	Long
alternativeCategoryQuantity	Integer
audienceSubCategory	String
audienceSubCategoryId	Long
audienceSubCategoryRank	Integer
basePrice	Integer
chargesType	(OTHER|RESERVATION| CANCELLATION)
contingent	String
contingentId	Long
displayDateOnlyOfitemDate	Boolean
eventId	Long
expirationDate	Date
fileId	Long
hospitalityArea	String
hospitalityAreaId	Long
hospitalityAreaQuantity	Integer
hospitalityAreaSeatQuantity	Integer
hospitalityAreaType	(SKYBOX|PREMIUM_SEATS| BOTH)
hospitalityRoom	String
hospitalityRoomId	Long
hospitalitySession	String
hospitalitySessionCode	String (8)
hospitalitySessionDate	Date
hospitalitySessionId	Long
hospitalitySessionTime	Date
item	String
itemDate	Date	Date of timeslot pass item
itemDisplayExternalDesignation	String
itemId	Long
kind	(CHARGES|SIMPLE_PRODUCT| SINGLE_ENTRY| PRODUCT_COMPOSITION| COMPOSED_PRODUCT| OVERHEADS|SHIPPING_FEE| PAYMENT_FEE|TR_BALANCE)
locations	List of Location
match	Match
message	String
nominative	boolean
numbered	boolean
operationId	Long
operationNumber	Integer
optionState	(PRE_SALES|PRE_REQUESTED| REQUESTED|VALIDATED| REJECTED)
parentOperationId	Long
performance	String
performanceData	Map of Long, Date
performanceId	Long
performanceKind	String
physicalConfigurationId	Long
priceType	(PREDEFINED|DYNAMIC)
product	String
productDesignation	String
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)
productId	Long
quantity	Integer
seasonTicketSubject	String
seasonTicketSubjectId	Long
seatCategory	String
seatCategoryBgColor	String
seatCategoryId	Long
seatCategoryRank	Integer
site	String
siteId	Long
timeslotId	Long
totalAmount	Integer
tripType	(ONEWAY|RETURN)
unitPrice	Integer
vatRate	Integer
waitingAccountBalance	Long
withoutVatTotalAmount	Long

Location
siteCode	String (8)
siteExternalName	ExternalName	60 characters max for each translation
spaceCode	String (8)
spaceExternalName	ExternalName	60 characters max for each translation

ExternalName
translations	List of Translation

Translation
locale	String (2)
value	String

Match
finalDate	Boolean
hostTeam	String
hostTeamId	Long
opposingTeam	String
opposingTeamId	Long
round	String
roundCode	String (8)
roundExternalName	ExternalName	60 characters max for each translation

OrderOriginData
countryCode	String (8)
ipAddress	String
orderOriginInfoIdCode	String (8)
userAgent	String
zipCode	String (8)

abandonOperations

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer	the request id
orderId	Long	the SecuTix order id
operationIds	List of Long	the SecuTix operation id list

Return value

OrderUpdateResult

abandonOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer	the request id
orderId	Long	the SecuTix order id

Return value

WebMethodResult
requestId	Integer
statusCode	String (8)
statusDetail	String

applyAdvantage

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Applies rulesetAdvantage on the given order.

Parameters

orderId	Long
advantageId	Long
accessCode	String (8)
confirmApply	Boolean

Return value

OrderUpdateResult

cancelOperations

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Cancels the given operations or movements which is used for reservation/option cancellations.

Parameters

requestId	Integer	the request id
orderId	Long	Mandatory the SecuTix order id(Mandatory)
operationIds	List of Long	the SecuTix operation id list (Optional, if list is empty it will cancel all operations of given order )
movementIds	List of Long	the SecuTix movement id list (Optional, if list is empty it will cancel all movements of given order/operations, else it will consider only given movements so if movements are given operations are not considered ),

Return value

OrderUpdateResult

closeOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer	the request id
purchaserInfo	ContactData	the external purchaser information
orderId	Long	the SecuTix order id
tickets	List of TicketData	the tickets data
externalReference	String	the external order Reference
generateBarCodes	boolean	Mandatory TODO
maxWaitingTime	Long	TODO
orderType	(SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING)
externalRemark	String

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 invoiceAddressId, optional: the contact address internal id idNumber, optional: To store beneficiary id number like passport number.
answerQuestionnaire	AnswerQuestionnaire
birthday	Date
contactId	Long
contactReference	String (20)
countryCode	String (8)
email	String
firstAddressLine	String
firstName	String
idNumber	String
invoiceAddressId	Long
lastName	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)

TicketData
Class containing the ticket data : ticketMedium, optional: specify the ticket medium additionalInfo, optional: additional info for DataWareHouse beneficiaryData, optional: beneficary data (name...)
additionnalInfo	String
containerIdentifier	String
holderInfo	ContactData
ticketMedium	(THERMAL|E_TICKET|MOBILE| RFID)
barcode	String (8)
movementId	Long
taxNumber	String

Return value

CloseOrderResult
Class representing the response of closeOrder method in external order service.
movementTicketDatas	List of MovementTicketData
requestId	Integer
statusCode	String (8)
statusDetail	String

MovementTicketData
barcode	String (8)
beneficiaryBirthdate	Date
beneficiaryCountryCode	String (8)
beneficiaryIdNumber	String
contactReference	String (20)
firstName	String
instanceNumber	String
isLinkedToTicketDistribution	boolean
lastName	String
movementId	Long
questionnaireId	Long
taxNumber	String
ticketId	Long

createRefundOperations

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer	the request id
orderId	Long	the SecuTix order id
ticketsInfo	List of TicketInfo

TicketInfo
Class containing the ticket info : movementId, mandatory: the SecuTix movement id barcode, mandatory: the ticket bar code, used for access control taxNumber, mandatory: the ticket tax number
barcode	String (8)
movementId	Long
taxNumber	String

Return value

OrderUpdateResult

deleteFileAttachment

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Deletes the given fileAttachmentId and return success or failure status code.

Parameters

requestId	Integer
fileAttachmentId	Long	Mandatory - Mandatory parameter, the fileAttachmentId to delete.
contactReference	String (20)	Mandatory - Mandatory parameter, the contactReference to whom the file attachment belongs.

Return value

WebMethodResult

getFileAttachment

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns the fileAttachment of given fileAttachmentId and contactReference

Parameters

requestId	Integer
fileAttachmentId	Long	Mandatory - Mandatory parameter, the fileAttachmentId to find.
contactReference	String (20)	Mandatory - Mandatory parameter, the contactReference to whom the file attachment belongs.

Return value

PrintableFileAttachmentResult
fileAttachment	PrintableFileAttachmentData
requestId	Integer
statusCode	String (8)
statusDetail	String

PrintableFileAttachmentData
data	byte
fileName	String
mimetype	String
uploadDate	Date

getFileDetails

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns the details of a file which may contain several orders, some of which may be partial (only the operations of the order concerning the given file will be returned)

Parameters

requestId	Integer
fileId	Long
operationId	Long
movementId	Long
currentView	Boolean

Return value

FileDetailResult
Class representing the response of getFileDetails method in external order service which has Secutix file details with corresponding order details.
currentViewOrderDetailsDatas	List of OrderDetailsData
fileDetailsData	FileDetailsData
installments	List of InstallmentData
orderDetailsDatas	List of OrderDetailsData
requestId	Integer
statusCode	String (8)
statusDetail	String

OrderDetailsData
Class containing information of order detail result. The following attributes are provided: orderId, mandatory: specify the SecuTix order id orderState, mandatory: specify the order state creationDateTime, mandatory: specify the date when order was created 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
contactReference	String (20)
creationDateTime	Date
expirationDate	Date
externalReference	String
externalRemark	String
generatedContiguities	List of ContiguityData
movementDatas	List of MovementData
movementTicketDatas	List of MovementTicketData
numberTickets	Long
operationDatas	List of OperationData
optionAmount	Integer
orderId	Long
orderInstallmentsToCreate	List of InstallmentData
orderOriginData	OrderOriginData
orderState	(OPEN|VALIDATED|CLOSED| ABANDONNED|PROCESSING)
orderType	(SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING)
preSaleAmount	Integer
referenceDate	Date
reservationAmount	Integer
saleAmount	Integer
salesChannelName	ExternalName
salesChannelType	(AGENCY|BOXOFFICE| INTERNET_B2C|INTERNET_B2B| INTERNET_B2B2C)
waitingAccountBalanceAmount	Integer

InstallmentData
dueAmount	Long
dueDate	Date
lastPaymentDate	Date
orderId	Long
paidAmount	Long

FileDetailsData
acceptAlternativeCategories	Boolean
contactReference	String (20)
creationDateTime	Date
currentOrderId	Long
fileAttachments	List of FileAttachmentData
fileContacts	List of FileContactData
fileId	Long
fileState	(RUNNING|SUSPENDED| IN_OPTION|IN_RESERVATION| OPTION_RESERV|CONFIRMED| SOLDED|NOT_SOLDED| PART_SOLDED|CANCELED| ABANDONNED|TECH_ERROR)
lastModDateTime	Date
optionState	(PRE_REQUESTED|REQUESTED| VALIDATED|PART_VALIDATED| REJECTED|ABANDONED)

FileAttachmentData
fileAttachmentId	Long
name	String
uploadDate	Date

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

getOrderDetails

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer	the request id
orderId	Long	the SecuTix order id
operationId	Long
movementId	Long

Return value

OrderDetailResult
Class representing the response of getOrderDetails method in external order service.
fileDetailsData	FileDetailsData
orderDetailsData	OrderDetailsData
requestId	Integer
statusCode	String (8)
statusDetail	String

getOrderInstallmentData

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

orderId	Long
dueAmount	Long

Return value

OrderInstallmentDetailResult
Class representing the response of getInstallmentData method in external order service.
installments	List of InstallmentData
orderId	Long
requestId	Integer
statusCode	String (8)
statusDetail	String

isExternalOrderServiceAlive

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

validate network connection and login/password

Parameters

Return value

WebMethodResult

manualAttributeSeats

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Manual attribution for operations. Provided seats must match operations expectations. If operations cover many performances, seatDefininitions are supposed to be applied to ALL performances at once.

Parameters

requestId	Integer
orderId	Long
operationIds	List of Long
seatDefinitions	List of SeatDefinition
areaAttributions	List of NotNumberedSeatDefinition

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

NotNumberedSeatDefinition
Class containing all necessary information to manually attribute seats. The following attributes are provided: areaId, mandatory: the SecuTix area id quantity, mandatory: specify quantity of places needed in this area
areaId	Long
quantity	Integer

Return value

OrderUpdateResult

notifyOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method finalizes the order if its waiting for payment confirmation done via EPC by notifying orchestra to resume the EPC ASYNC wait. Note: This method must be called after calling {@link #closeOrder(Integer, ContactData, Long, List, String, boolean, Long)}

Parameters

requestId	Integer
orderId	Long	Mandatory ( mandatory parameter )
maxWaitingTime	Long	( Optional, if given then this method executes until this maxWaitingTime and returns "InProgres" if its not done)

Return value

CloseOrderResult

reopenOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer
orderId	Long	the SecuTix order id

Return value

WebMethodResult

setMovementContact

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Assigns a contact to a movement. This method helps to associate a contact to specific movement of a sales order to fill the cultural contact. If this call is not done explicitly, movement are not assigned yet will automatically assigned with the purchase contact when closing order.

Parameters

requestId	Integer	the request id
movementContacts	List of MovementContact	The movement with its contact info

MovementContact
holderInfo	ContactData
movementId	Long

Return value

WebMethodResult

uploadFileAttachment

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Uploads the given printableFileAttachmentData to given fileId and given file contact reference and return success or failure status code.

Parameters

requestId	Integer
fileId	Long	Mandatory - Mandatory parameter, the fileId
printableFileAttachmentData	PrintableFileAttachmentData	Mandatory - Mandatory parameter, the file attachment data
contactReference	String (20)	Mandatory - Mandatory parameter, the contactReference to whom the file attachment belongs.

Return value

WebMethodResult

validateOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

requestId	Integer	the request id
orderId	Long	the SecuTix order id
externalReference	String
orderType	(SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING)

Return value

WebMethodResult