Service: ExternalOrderService

Version: 1_33 (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.externalorder.v1_33.ExternalOrderService.webservice?wsdl

REST Demo endpoint (only POST): https://secutix.ws.secutix.com/tnseb/backend-apis/externalOrderService/v1_33/{methodName} Replace {methodName} for the desired method name as shown below.

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.external order service interface v1_33 : web service exposed to external world

Methods:

• abandonMovements: Abandons the given movements.
• abandonOperations: Abandons a given operation.
• abandonOrder: Abandons an open order.
• applyAdvantage: Applies rulesetAdvantage on the given order.
• cancelOperations: Cancels the given operations or movements which is used for reservation/option cancellations.
• closeOrder: To close an opened or validated order.
• createRefundOperations: creates refund operations from ticket infos.
• deleteFileAttachment: Deletes the given fileAttachmentId and return success or failure status code.
• getExternalReference: Return external references of Order, Operation or Movement
• getFileAttachment: Returns the fileAttachment of given fileAttachmentId and contactReference
• getFileDetails: Get the SecuTix file details.
• getFileDetailsFromOrderSecretId: Returns the file details based on an orderSecretId.
• getOrderDetails: Returns the content of an order.
• getScreenConfigGiftAidFromOrder: Return value of screen configure gift aid product on the given order.
• isExternalOrderServiceAlive: validate network connection and login/password
• linkFiles: Links a file to parent file with the given link type.
• notifyOrder: This method finalizes the order if its waiting for payment confirmation done via EPC by notifying orchestra to resume the EPC ASYNC wait.
• recomputeVat: In some countries buyer are exempt from VAT payment when buying a performance in their country.
• reopenOrder: To reopen a validated order.
• reopenSuspendedOrder: Re-open a suspended order on a point of sale
• setMovementContact: Assigns a contact to a movement.
• suspendOrder: Suspend an order on a point of sale
• transferMovementContact: Transfers a movement to a contact.
• updateExternalReferences: Update the external references for ORDER, OPERATION or MOVEMENT.
• updateFileStatus: Updates External File Status for a given file
• updateMovementTariffExternals: This method helps to update list tariff external number to specific movement of sales order to a contact.
• uploadFileAttachment: Uploads the given printableFileAttachmentData to given fileId and given file contact reference and return success or failure status code.
• validateOrder: Used to validate an order before closing it.

abandonMovements

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Abandons the given movements.

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
catalogCurrency	CurrencyCash
generatedContactQualities	Map of String, ContactQuality
generatedContiguities	List of ContiguityData
mainOperationId	Long
movementDataUpdates	List of MovementData
operationDataUpdates	List of OperationData
orderId	Long
orderSecretId	String
origin	OrderOriginData
removeMovementIds	List of Long
removeOperationIds	List of Long

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

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)

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 transferable: A movement is transferable if ticket is in NOT_PRINTED state nfcLink: link to download the NFC ticket
alley	String
area	String
areaId	Long
areaKind	(INDIFFERENT|BOX)
attributionMatch	(MATCHING_EXPECTED_AREAS| MATCHING_EXPECTED_BLOCKS| NOT_MATCHING| NO_EXPECTATION)
barcode	String (8)
beneficiaryBirthPlace	String
beneficiaryBirthRegion	String
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
entranceCode	String (8)
entranceId	Long
externalReferences	List of ExternalReference
externalRemark	String
floor	String
instanceNumber	Long
movementId	Long
nfcLink	String	Link to download the NFC ticket.
operationId	Long
parentMovementId	Long
questionnaireId	Long
resaledMovementId	Long
resumed	boolean
resumedMovementId	Long
row	String
saleAreaId	Long
saleSeatId	Long
scenePanoLink	String
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
transferable	boolean
type	(SEAT|AREA|SIMPLE_PRODUCT| COMPOSED)
xCoordinate	Long
yCoordinate	Long

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.

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 seatSelectionMode, optional: the seat selection mode of the performance 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 audienceSubCategoryRequireAttachment, mandatory: the audience sub category require justification or not 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 season, optional: the name of the season of this product tourId, optional: the id of the selected tour linked to this product tourName, optional: the name of the selected tour linked to product resumedOperationId, optional: the operation ID which resumed by this operation includedInShipmentFee, if the product should be included in the shipment fee computation of shipment fee per ticket ticketPrintingMode, optional: the ticket printing mode is only available for season ticket and packages, for other product families it will be null shipmentFeeId, optional: the Secutix shipment fee ID shipmentModeId, optional: the Secutix shipment mode ID
activityType	(LIVE_SPECT|FESTIVAL| MUSEUM|VISIT|ENTERT_PARK| FAIR|PARKING|SPORT|OTHER| TOURNAMENT_SESSION)
advantage	String
advantageId	Long
alternativeCategoryQuantity	Integer
audienceCatId	Long	The ID of the audience category of the audience sub-category that is linked to the operation.
audienceSubCategory	String
audienceSubCategoryExternalDescription	String
audienceSubCategoryId	Long
audienceSubCategoryRank	Integer
audienceSubCategoryRequireAttachment	boolean
basePrice	Long
catalogCurrency	CurrencyCash
chargesType	(OTHER|RESERVATION| CANCELLATION)
comfortVariableValues	Map of String, ExternalName
contingent	String
contingentId	Long
crossSellId	Long
crossSellParentOperationIds	List of Long
displayDateOnlyOfitemDate	Boolean
eventId	Long
exchangeable	boolean	An operation is exchangeable if both the product and tariff are exchangeable.
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
includedInShipmentFee	Boolean
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| COMMISSION)
locations	List of Location
match	Match
message	String
nominative	boolean
numbered	boolean
oneTimeCodeId	Long
operationId	Long
operationNumber	Long
optionState	(PRE_SALES|PRE_REQUESTED| REQUESTED|VALIDATED| REJECTED| REQUESTED_BY_SUBSTRUCTURE)
parentOperationId	Long
parentOperationLinkType	(SEATING_C|SEATING_T| CHARGES| PRODUCT_COMPOSITION| COMMISSION|ADD_SEATS| SEATING_M)
performance	String
performanceAddOnName	String
performanceCode	String (8)
performanceDate	Date
performanceDuration	Long
performanceId	Long
performanceKind	String
physicalConfigurationId	Long
priceComponentData	PriceComponentData
priceLevelId	Long	The ID of the price level that is linked to the operation.
priceType	(PREDEFINED|DYNAMIC)
product	String
productCode	String (8)
productDesignation	String
productFamilySubType	(SIMPLE_TICKET| SEASONTICKET|MEMBERSHIP| PACKAGE|STAY|SERVICE| VOUCHER|DONATION|GOODS| VISIT|OPEN|OPEN_PASS| DATE_SPECIFIC_PASS| SPORTING_EVENT|RAILAWAY| HOTEL|MUSEUM|ENTERT_PARK| RESTAURANT|PRODLIB| TIMESLOT_PASS|HOSPITALITY| HOSPITALITY_PACKAGE| CANCELLATION_INSURANCE| VISIT_PASS|GIFT_AID)
productFamilyType	(SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY)
productId	Long
quantity	Integer
resumedOperationId	Long	Returns the operation ID resumed by this operation data. If the operation doesn't resume another operation, null is returned. It is assumed that there is no more than one such parent operation.
season	String
seasonTicketSubject	String
seasonTicketSubjectId	Long
seatCategory	String
seatCategoryBgColor	String
seatCategoryId	Long
seatCategoryRank	Integer
seatSelectionMode	(AUTO|MANUAL| MANUAL_OR_AUTO| WITHOUT_MAP| WITHOUT_SEATING)
selfPaidVat	boolean
shipmentFeeId	Long
shipmentModeId	Long
site	String
siteAddress	PlaceAddress
siteId	Long
space	String
ticketPrintingModeEnum	(CARD|TICKETS| CARD_AND_TICKETS|BADGE| BADGE_AND_TICKETS)
timeslotDuration	Long
timeslotId	Long
totalAmount	Long
tourId	Long
tourName	String
tripType	(ONEWAY|RETURN)
type	(SALE|REFUND|PRE_SALE| RESERVATION|OPTION| RES_CANCELLATION| OPTION_CANCELLATION| REFUND_ORGANIZATION| REFUND_CLIENT| RESERVATION_FREEING| OPTION_FREEING|ABANDON| PRE_REFUND)
typeOfProduct	(SKYBOX|LOUNGE)
unitPrice	Long
validityData	ValidityData
vatCountryCode	String (8)
vatRate	Integer
visitGroupData	VisitGroupData
waitingAccountBalance	Long
withoutVatTotalAmount	Long

ExternalName
translations	List of Translation

Translation
locale	String (2)
value	String

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

PlaceAddress
countryCode	String (8)
email	String
fax	String
firstAddressLine	String
gpsLatitude	String
gpsLongitude	String
locality	String
phoneNumber	String
secondAddressLine	String
thirdAddressLine	String
website	String
zipCode	String (8)

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

PriceComponentData
externalName	String
feeTypeDescription	String
feeTypeExternalName	String
feeTypeRank	Integer
kind	(EXTERNAL_PRICE_COMPONENT| FEE_TYPE)
rank	Integer

ValidityData
Class containing all necessary information for an validity data. The following attributes are provided: validityRule, mandatory: validity rule validityDuration, optional: validity duration validityDurationUnit, optional: validity duration unit userDefineStartValidity, optional: is user define start validity
duration	Integer
durationUnit	(DAY|WEEK|MONTH|YEAR)
userDefineStartValidity	boolean
validtyRule	(SEASON|PERIOD|PURCHASE)

VisitGroupData
fileRemarks	List of String
groupCriterionElements	List of GroupCriterionElement
groupKindIC	String
groupKindName	String
groupName	String
isGuided	boolean
numberOfAccompaniers	Integer
numberOfParticipants	Integer
pricingType	(PER_PERSON| GROUP_FLAT_RATE)
ticketType	(INDIVIDUAL_TICKET| GROUP_TICKET)
visitGroupId	Long
visitLanguageCode	String (8)
visitLanguageName	String
visitThemeCode	String (8)
visitThemeName	String

GroupCriterionElement
criterionName	String
elementName	String
rank	int

OrderOriginData
countryCode	String (8)
ipAddress	String
orderOriginInfoIdCode	String (8)
toCreateToken	boolean
tracker	String
url	String (255)
userAgent	String
zipCode	String (8)

abandonOperations

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Abandons a given operation.

Parameters

requestId	Integer	the request id
orderId	Long	the SecuTix order id
operationIds	List of Long	the SecuTix operation id list
orderCreationOptions	List of (RESUME_ALL_RESERVATION_OPERATIONS|RESUME_ALL_OPTION_OPERATIONS|NOT_CREATE_BALANCE_OPERATION_DURING_EXCHANGE|NOT_UPDATE_BALANCE_OPERATION_DURING_EXCHANGE|PARTIAL_RESUME_OPERATIONS)

Return value

OrderUpdateResult

abandonOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Abandons an open order.

Parameters

requestId	Integer	the request id
orderId	Long	the SecuTix order id
reason	(ORDER_EXPIRED| PAYMENT_TIME_OUT| PAYMENT_FAILED| TECH_ERROR)

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

To close an opened or validated order. closeOrder may take some time. If after "maxWaitingTime" milliseconds, order is not closed, the function will return an "in_progress" status. It may also be the case if the closing order is waiting from some epc information.

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 : Not optional if generatebarcode is set : this allows to associate the barcodes and taxnumbers to the movements.
externalReference	String	the external order Reference
generateBarCodes	boolean	if true : SecuTix will generate the barcodes and taxnumbers. If false, barcodes and taxnumbers must be provided through the "tickets" field.
maxWaitingTime	Long	in milliseconds.
orderType	(SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING| ST_TRANSFER)
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 (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)

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
externalReferences	List of ExternalReference
holderInfo	ContactData
startValidityDate	Date
ticketMedium	(THERMAL|E_TICKET|MOBILE| RFID|BLOCKCHAIN)
barcode	String (8)
movementId	Long
taxNumber	String

Return value

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

MovementTicketData
barcode	String (8)
beneficiaryBirthdate	Date
beneficiaryCountryCode	String (8)
beneficiaryIdNumber	String
cardTypeId	Long
cardVisualId	String
contactReference	String (20)
containerIdentifier	String
firstName	String
instanceNumber	String
isLinkedToTicketDistribution	boolean
lastName	String
mobileAppTicketData	MobileAppTicketData
movementId	Long
questionnaireId	Long
taxNumber	String
ticketId	Long
ticketState	(CONTROLLED| CONTROLLED_OUT|PRINTED| NOT_PRINTED|INVALIDATED| CANCELLED|EXPORTED)
ticketSupport	(THERMAL|ETICKET|PAPER_A4| PASSBOOK|MOBILE| BLOCKCHAIN|BADGE|RFID| PR_RFID_CARD| DEMAT_BADGE)

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

createRefundOperations

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

creates refund operations from ticket infos. use ExternalOrderFacade.refundTicketOrder instead.

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 parameter, the fileAttachmentId to delete.
contactReference	String (20)	- Mandatory parameter, the contactReference to whom the file attachment belongs.

Return value

WebMethodResult

getExternalReference

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Return external references of Order, Operation or Movement

Parameters

ids	List of Long
kind	(ORDER|OPERATION| MOVEMENT)

Return value

ExternalReferenceResult
externalReferences	List of ExternalReferenceData
requestId	Integer
statusCode	String (8)
statusDetail	String

ExternalReferenceData
externalReferences	List of ExternalReference
id	Long

getFileAttachment

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns the fileAttachment of given fileAttachmentId and contactReference

Parameters

requestId	Integer
fileAttachmentId	Long	- Mandatory parameter, the fileAttachmentId to find.
contactReference	String (20)	- 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

Get the SecuTix file details. Expects that exactly one of the three parameters is non-null and valid.

Parameters

requestId	Integer
fileId	Long	optional, the SecuTix file id
operationId	Long	optional, the SecuTix operationId
movementId	Long	optional, the SecuTix movementId
currentView	Boolean	if true, returns the order/operation/movement data of the file filtered to show the current status of the file, else returns all data unfiltered
granularity	(ALL_ORDERS| NO_SEATING_ORDERS)	optional
orderDetailGranularity	(ORDER|OPERATION|MOVEMENT| TICKET| TICKET_OR_OPERATION)	optional, if specified, the FileDetailResult object returned is filled with info at the specified granularity. If not provided, all info is set in the FileDetailResult returned

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
orderDetailGranularity	(ORDER|OPERATION|MOVEMENT| TICKET| TICKET_OR_OPERATION)
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 promotionalCode, optional: specify promotional code this field will be used by e-commerce Google Tracking Manager
catalogCurrency	CurrencyCash
contactReference	String (20)
creationDateTime	Date
expirationDate	Date
externalReference	String
externalRemark	String
generatedContiguities	List of ContiguityData
movementDatas	List of MovementData
movementTicketDatas	List of MovementTicketData
multicurrency	boolean
numberTickets	Long
operationDatas	List of OperationData
optionAmount	Long
orderId	Long
orderInstallmentsToCreate	List of InstallmentData
orderOriginData	OrderOriginData
orderOriginator	(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)
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)
organizationCode	String (8)
organizationName	ExternalName
preSaleAmount	Long
promotionalCode	String (8)
referenceDate	Date
refundReasonCode	String (8)
refundReasonName	String
reservationAmount	Long
saleAmount	Long
salesChannelCode	String (8)
salesChannelName	ExternalName
salesChannelType	(AGENCY|BOXOFFICE| INTERNET_B2C|INTERNET_B2B| INTERNET_B2B2C|NEW_TVM| I_MOBILE_BOXOFFICE)
waitingAccountBalanceAmount	Long

InstallmentData
dueAmount	Long
dueDate	Date
lastPaymentDate	Date
orderId	Long
paidAmount	Long

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

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

FileAttachmentData
fileAttachmentId	Long
name	String
uploadDate	Date

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)

FileLinkDataDetailed
fileContactName	String
fileContactNumber	String (20)
parentFileContactName	String
parentFileContactNumber	String (20)
fileId	Long	Mandatory fileId
fileLinkType	(SEATING|PARKING| SUB_REQUEST|RELATING)	Mandatory, fileId will be linked to parentFileId with the given link type
parentFileId	Long	Optional parentFileId (mandatory when manual linking)

getFileDetailsFromOrderSecretId

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns the file details based on an orderSecretId. If many files can be linked to the referred order, only the most recent one will be returned.

Parameters

requestId	Integer
orderSecretId	String	a secret string identifying an order (for use with guest-login features)
currentView	Boolean
granularity	(ALL_ORDERS| NO_SEATING_ORDERS)
orderDetailGranularity	(ORDER|OPERATION|MOVEMENT| TICKET| TICKET_OR_OPERATION)

Return value

FileDetailResult

getOrderDetails

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Returns the content of an order. Can be used to check the status an order at any moment of the process.

Parameters

requestId	Integer	the request id
orderId	Long	the SecuTix order id
operationId	Long
movementId	Long
orderToken	String	A secret token identifying the order. Allows direct access to the order without orderId.
movementReferences	List of ExternalReference	Unique reference of the movement in caller's system. Return order where at lease one movement meets those conditions. This field is optional
granularity	(ORDER|OPERATION|MOVEMENT| TICKET| TICKET_OR_OPERATION)	specifies the granularity of the result.

Return value

OrderDetailResult
Class representing the response of getOrderDetails method in external order service.
fileDetailsData	FileDetailsData
orderDetailGranularity	(ORDER|OPERATION|MOVEMENT| TICKET| TICKET_OR_OPERATION)
orderDetailsData	OrderDetailsData
requestId	Integer
statusCode	String (8)
statusDetail	String

getScreenConfigGiftAidFromOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Return value of screen configure gift aid product on the given order.

Parameters

orderId

Long

Return value

GiftAidResult
giftAidId	Long	Id of gift aid product available for season
orderId	Long
suggestByDefault	Boolean	Gift Aid is always checked by default if the return value is true, and unchecked if the return value is false.
suggestByPopup	Boolean	Gift Aid displays a confirmation popup when the return value is true and does not display if the return value is false.
valueDisplay	(FALSE|OPTIONAL|MANDATORY| MANDATORY_NOEDIT| MANDATORY_BY_GROUP| MANDATORY_BY_GROUP_NOEDIT| TRUE|TRUE_UNCHECK| TRUE_CHECK|NOT_VISIBLE)	return values are OPTIONAL, MANDATORY, NOT_VISIBLE
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

linkFiles

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Links a file to parent file with the given link type. If the parentFileId is a child in another link, then file id will be linked to the parent of parentFileId If the file id passed has some linked child files, all the child files will also be linked to parentFileId

Parameters

requestId	Integer
fileLinkData	FileLinkData

FileLinkData
fileId	Long	Mandatory fileId
fileLinkType	(SEATING|PARKING| SUB_REQUEST|RELATING)	Mandatory, fileId will be linked to parentFileId with the given link type
parentFileId	Long	Optional parentFileId (mandatory when manual linking)

Return value

FileLinkResult
fileLinkDataList	List of FileLinkDataDetailed
requestId	Integer
statusCode	String (8)
statusDetail	String

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 parameter )
maxWaitingTime	Long	( Optional, if given then this method executes until this maxWaitingTime and returns "InProgres" if its not done)

Return value

CloseOrderResult

recomputeVat

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

In some countries buyer are exempt from VAT payment when buying a performance in their country. Eg. a contact living in Hungary will be exempted from payment VAT for a match happening in Budapest Based on the country of the contact's billing address VAT will be removed or added based on the Point of sales reverse VAT countries configuration

Parameters

requestId	Integer
orderId	Long
billingContactAddressId	Long
billingContactId	Long

Return value

OrderDetailResult

reopenOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

To reopen a validated order.

Parameters

requestId	Integer
orderId	Long	the SecuTix order id

Return value

WebMethodResult

reopenSuspendedOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Re-open a suspended order on a point of sale

Parameters

pointOfSalesData	PointOfSalesData	- contain point of sales information
orderId	Long	- Mandatory parameter

PointOfSalesData
operator	String
pointOfSalesId	Long

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

suspendOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Suspend an order on a point of sale

Parameters

pointOfSalesData	PointOfSalesData	- contain point of sales information
orderId	Long	- Mandatory parameter

Return value

WebMethodResult

transferMovementContact

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Transfers a movement to a contact. This method helps to transfer to specific movement of a sales order to a contact; It will fill the cultural contact, update ticket holder and update related tickets.

Parameters

requestId	Integer	the request id
movementContacts	List of MovementContact	The movement with its contact info
postTransferAction	(NONE| NOTIFY_CONTACT_BY_EMAIL)	to specify the post transfer action - after transferring movement, an email will be sent to contact to notify this change if NOTIFY_CONTACT_BY_EMAIL specified; Otherwise, do nothing.

Return value

MovementTransferResult
Class representing the response of transfer movement contact method in external order service.
movementContacts	List of MovementContact
requestId	Integer
statusCode	String (8)
statusDetail	String

updateExternalReferences

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Update the external references for ORDER, OPERATION or MOVEMENT.

Parameters

id	Long
kind	(ORDER|OPERATION| MOVEMENT)
externalReferences	List of ExternalReference

Return value

WebMethodResult

updateFileStatus

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Updates External File Status for a given file

Parameters

fileId	Long	Identification of file
fileStatusIC	String	Internal Code for External File Status. The available codes are configurable per institution.

Return value

WebMethodResult

updateMovementTariffExternals

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method helps to update list tariff external number to specific movement of sales order to a contact.

Parameters

movementTariffExternals

List of MovementTariffExternalData

list tariff external number with specific movement

MovementTariffExternalData
movementId	Long
tariffExternalNumber	String

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 parameter, the fileId
printableFileAttachmentData	List of PrintableFileAttachmentData	- Mandatory parameter, the file attachment data
contactReference	String (20)	- Optional parameter, the contactReference to whom the file attachment belongs.

Return value

WebMethodResult

validateOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Used to validate an order before closing it. A validated order will not be abandoned after its expiration time.

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| ST_TRANSFER)

Return value

WebMethodResult