Service: ExternalOrderFacade

Version: 1_33 (other versions, change log, ZUMSTEIN_V4.4-SNAPSHOT) Latest frozen version. Base by default all your developments on this one.

SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.externalorder.v1_33.ExternalOrderFacade.webservice?wsdl

REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnseb/backend-apis/externalOrderFacade/v1_33/{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.external order facade interface v1_33 : web service exposed to external world

Methods:

• createOrUpdateOrder: Main method to be used to create or update an order.
• createPaymentsAndCloseOrder: Used to close an order in one call.
• isExternalOrderFacadeAlive: validate network connection and login/password
• refundTicketOrder: Creates an order refunding the tickets passed in the ticketInfos parameter.
• transferOptionSeatCategories: Used to transfer quantities of PRE_REQUESTED operations from OPTION order to another seat category

createOrUpdateOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Main method to be used to create or update an order.

This method should be called only once when any kind of item is added into the cart. The parameters - operation creations lists accepts null but at least one of them should be given not-null.

Example: When a composed product item is added you should send all the operation creation details of all compositions items selected inside it, then this method will create all operation/movements of composed product and product compositions for auto-attribution of seats in case of single entries operation creation.

Parameters

requestId	Integer	-- (Optional) the requestId
pointOfSalesId	Long	Mandatory -- (Mandatory) the pointOfSalesId
orderId	Long	-- (Optional) the orderId, if orderId is given it is the one considered for updating order's contact,reference,origin info and creating operations, otherwise a new order is created with given {purchasersInfo}, {externalReference}, {origin} and operations.
fileId	Long
orderType	(SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING| ST_TRANSFER)
purchasersInfo	List of ContactData	-- (Optional) the list of purchasing contacts to be associated to order The first contact in the list is considered as main contact of the order and remaining contacts are associated to order (Example: different contacts for several season tickets in a single order)
externalReference	String	-- (Optional) the externalReference representing external distributor
composedProductOperations	List of ComposedProductOperationCreationData	-- (Optional) the composed product(PACKAGE/SEASONTICKET) operation creation details with product compositions details inside it.
singleEntryAttributionOperations	List of SingleEntryOperationAttributionData	-- (Optional) the single entry(PERFORMANCE/VISIT/MATCH) operation creation details with specifying autoAttribution,preferred areas/blocks if no precise seats are provided inside.
simpleProductOperations	List of SimpleProductOperationCreationData	-- (Optional) the simple product(SERVICE/GOODS/PASSDATED/OPENPASS/VOUCHER) operation creation details
transportProductOperations	List of TransportProductOperationCreationData	-- (Optional) the transport product operation creation details (This parameter should be used only when transport operation is created after a package operation is created as transport operation cannot be created outside a package, but anyway with this new interface this parameter will not be used anytime as composedProductOperation creation automatically creates)
chargeOperations	List of ChargeOperation	-- (Optional) the charges operations creation details
origin	OrderOriginData	-- (Optional) the charges operations creation details
fileContacts	List of FileContactData
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)	-- param to control the creation of of operations in order

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)

ComposedProductOperationCreationData
Class representing a parameter of createComposedProductOperation method of ExternalOrderService. The attributes are: orderId, mandatory: the SecuTix order id quantity, mandatory: number of seat (resp. place) to put in the cart itemId, mandatory: the SecuTix item id seatCategoryId, mandatory: the SecuTix seat category id audienceSubCategoryId, mandatory: the SecuTix audience sub category id advantageId, optional: the SecuTix advantage id, if the operation is for an advantage
advantageId	Long
itemId	Long
oneTimeCodes	Set of String
seatCategoryId	Long
simpleProductComposedOperations	List of SimpleProductOperationCreationData
singleEntryAttributionComposedOperations	List of SingleEntryOperationAttributionData
transportProductComposedOperations	List of TransportProductOperationCreationData
audienceSubCategoryId	Long
barcodes	List of String
baseProductOperationIds	Set of Long
checkPrice	boolean	if true, the price passed will be compared to the one in the catalog.
contingentId	Long
crossSellId	Long
fileId	Long
operationId	Long
orderId	Long
parentMovementIds	List of Long
priceLevelId	Long
quantity	Integer
questionnaireId	Long
resaleMovementIds	List of Long
reservationExpirationDate	Date
seasonTicketOrMembershipMovementId	Long
unitPriceAmount	Long

SimpleProductOperationCreationData
Class representing a parameter of createSimpleProductOperation method of ExternalOrderService. The attributes are: orderId, mandatory: the SecuTix order id quantity, mandatory: number of seat (resp. place) to put in the cart itemId, optional: the SecuTix item id audienceSubCategoryId, mandatory: the SecuTix audience sub category id parentOperationId, mandatory: the SecuTix parent operation id productCompositionLineId: the SecuTix product composition line id contingentId: optional: the SecuTix contingent id (used for goods, never needed for services) advantageId, optional: the SecuTix advantage id, if the operation is for an advantage movementId: optional: the movementId of composed product operation created already.
advantageId	Long
date	Date
hospRoomId	Long
hospitalityAreaId	Long	(optional) hospitality area id of hospitality item chosen
itemId	Long
minSizeInPackage	Integer
oneTimeCodes	Set of String
parentOperationId	Long
productCompositionLineId	Long
productDesignation	String
timeslotId	Long	(optional) TimeslotId of timeslot pass item corresponds to specific time slot
tourId	Long	(optional) tourId of of linked product item
visitGroupDefinition	VisitGroup
audienceSubCategoryId	Long
barcodes	List of String
baseProductOperationIds	Set of Long
checkPrice	boolean	if true, the price passed will be compared to the one in the catalog.
contingentId	Long
crossSellId	Long
fileId	Long
operationId	Long
orderId	Long
parentMovementIds	List of Long
priceLevelId	Long
quantity	Integer
questionnaireId	Long
resaleMovementIds	List of Long
reservationExpirationDate	Date
seasonTicketOrMembershipMovementId	Long
unitPriceAmount	Long

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

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

Guide
contactId	Long
firstName	String
guideId	Long
lastName	String

SingleEntryOperationAttributionData
Class representing a parameter of createAutoAllocSingleEntryOrder method of ExternalOrderFacade. The attributes are: operationAttributions, mandatory: the list of the single entry operation to create preferedAreas, optional: the list of prefered area SecuTix id preferedBlock, optional: the list of prefered block SecuTix id mandatoryPreferences, optional: the boolean to indicate whether autoAttribution or manualAttribution of seats should strictly follow given preferences - (areas or blocks or seat definitions). By default, value is false.
forceSnakeOrderAttribution	boolean	normally, in "seated" venues, SecuTix tries to find the best seat according to the setup done by the institution. If true, this setup will be ignored and seats will be attributed 1st rank first, 2nd rank then, etc. ("Snake order")
mandatoryPreferences	boolean	means that the preferedAreas and preferedBlock passed are mandatory.
operationAttributions	List of SingleEntryOperationCreationData
preferedAreas	List of Long
preferedBlock	List of Long

SingleEntryOperationCreationData
Class representing a parameter of createSingleEntryOperation method of ExternalOrderService. The attributes are: orderId, mandatory: the SecuTix order id quantity, mandatory: number of seat (resp. place) to put in the cart performanceId, mandatory: the SecuTix performance id seatCategoryId, mandatory: the SecuTix seat category id audienceSubCategoryId, mandatory: the SecuTix audience sub category id contingentId, optional: the SecuTix contingent id parentOperationId, optional: the SecuTix parent operation id productCompositionLineId, optional: the SecuTix product composition line id advantageId, optional: the SecuTix advantage id, if the operation is for an advantage seasonTicketOrMembershipMovementId: optional : the movementId of season ticket or membership product bought by a contact.This field is mandatory to send when a contact who is "Abonné" or "Adherent" category is logged in to buy any product to prove that contact is really a subscriber or member. selling of composed product then pass the movementId of composed product operation created already identifies the composed product to complete. parentMovementIds: optional : the list of parent movementIds - which are required at the time of child operation creation. And note that caller should send number of parent movementIds equal to operation quantity. In case of fixed price season ticket completion, parent movements list can contain same elements if child operation quantity chosen > 1
advantageId	Long
alternativeCategoryQuantity	Integer
contactId	Long
currencyCode	String (8)
iteration	Integer
nnSeatDefinitions	List of NotNumberedSeatDefinition
oneTimeCodes	Set of String
parentOperationId	Long
performanceId	Long
priceUpdateNeeded	boolean
productCompositionLineId	Long
seatCategoryId	Long
seatDefinitions	List of SeatDefinition
seatingStrategy	(MANUAL_SEATING| AA_MANDATORY_PREFERENCES| AA_OPTIONAL_PREFERENCES| NO_AUTO_ALLOC)
tourId	Long
audienceSubCategoryId	Long
barcodes	List of String
baseProductOperationIds	Set of Long
checkPrice	boolean	if true, the price passed will be compared to the one in the catalog.
contingentId	Long
crossSellId	Long
fileId	Long
operationId	Long
orderId	Long
parentMovementIds	List of Long
priceLevelId	Long
quantity	Integer
questionnaireId	Long
resaleMovementIds	List of Long
reservationExpirationDate	Date
seasonTicketOrMembershipMovementId	Long
unitPriceAmount	Long

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

SeatDefinition
UNDEFINED	String
areaId	Long
areaKind	(INDIFFERENT|BOX)
available	boolean
blockId	Long
classification1ic	String
classification2ic	String
contingentId	Long
dummySeat	boolean
entranceId	Long
externalEntranceId	Long
freezingReasonIc	String
frozen	boolean
number	String
optimalSeatSelectionValue	Long
physicalSeatId	Long
rotation	int
row	String
scenePanoLink	String
scenePhotoLink	String
seatCategoryId	Long
seatOrder	Long
x	int
y	int

TransportProductOperationCreationData
Class representing a parameter of createTransportProductOperation method of ExternalOrderService. The attributes are: orderId, mandatory: the SecuTix order id quantity, mandatory: number of seat (resp. place) to put in the cart itemId, optional: the SecuTix item id audienceSubCategoryId, mandatory: the SecuTix audience sub category id parentOperationId, mandatory: the SecuTix parent operation id productCompositionLineId, mandatory: the SecuTix product composition line id unitPriceAmount, mandatory: indicate the actual unit price. This price maybe zero offerId_1, mandatory: Identifier of the first selected offer offerId_2, optional: Identifier of the first selected offer dateOutwardTrip, mandatory: date of the journey dateReturnTrip, optional: date of return journey transportDescription, optional: description of transport passengers, mandatory: passenger's information movementId: optional: the movementId of composed product operation created already.
dateOutwardTrip	Date
dateReturnTrip	Date
destinationCode	String (8)
itemId	Long
offerId_1	String
offerId_2	String
originCode	String (8)
parentOperationId	Long
passengers	List of PassengerData
productCompositionLineId	Long
transportDescription	String
audienceSubCategoryId	Long
barcodes	List of String
baseProductOperationIds	Set of Long
checkPrice	boolean	if true, the price passed will be compared to the one in the catalog.
contingentId	Long
crossSellId	Long
fileId	Long
operationId	Long
orderId	Long
parentMovementIds	List of Long
priceLevelId	Long
quantity	Integer
questionnaireId	Long
resaleMovementIds	List of Long
reservationExpirationDate	Date
seasonTicketOrMembershipMovementId	Long
unitPriceAmount	Long

PassengerData
birthdate	Date
firstName	String
lastName	String
offerPrice_1	Long
offerPrice_2	Long
passengerNumber	Long

ChargeOperation
chargesId	Long
orderId	Long
unitPriceAmount	Long

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

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)

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

createPaymentsAndCloseOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Used to close an order in one call.

Validates given order, creates payment and closes the order.

This acts as a facade wrapping these three calls into one.

{@link ExternalOrderService#validateOrder(Integer, Long, String, OrderType)} {@link ExternalPaymentService#createPayment(Integer, Long, String, List, PaymentParameters)} and {@link ExternalOrderService#closeOrder(Integer, ContactData, Long, List, String, boolean, Long, OrderType)}

Parameters

requestId	Integer
orderId	Long
payments	List of PaymentInfo
paymentParams	PaymentParameters
externalReference	String
orderType	(SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING| ST_TRANSFER)
maxWaitingTime	Long
purchasersInfo	List of ContactData
tickets	List of TicketData
externalRemark	String
fileContacts	List of FileContactData
oneTimeCodes	List of String
fileData	FileData
cancellationInsuranceData	CancellationInsuranceData	TODO
isConvertedReservation	boolean	Mandatory
createToken	boolean	Mandatory
contactRemark	String

PaymentInfo
amount	Long
cardAlias	String
cardExpirationDate	Date
cardMaskedNumber	String
contactReference	String (20)
paymentAdditionalData	Map of StringString
paymentIdentifier	String
paymentMethodId	Long
pspAdditionalReturnedData	String
valueDate	Date

PaymentParameters
contactId	Long
contactNumber	String (20)
creditCreditNotePayment	boolean
creditWaitingAccountPayment	boolean
operationIds	List of Long
orderId	Long
paymentParametersMap	Map of (RETURN_URL| ORDER_IDENTIFIER| CONTACT_EMAIL), String
pointOfSalesId	Long
remark	String
totalAmount	Long

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

FileData
acceptAlternateCategories	Boolean

CancellationInsuranceData
insuranceAmount	Long
insuranceId	Long

Return value

PaymentAndCloseOrderResult
Class representing the response of createPaymentAndcloseOrder method in external order facade.
movementTicketDatas	List of MovementTicketData
orderUpdateData	OrderUpdateData
paymentDetails	List of PaymentDetail
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

PaymentDetail
amount	Long
bankCardOwnerName	String
cardAlias	String
cardExpirationDate	Date
cardMaskedNumber	String
cardType	String
catalogCurrency	CurrencyCash
contactId	Long
contactName	String
contactNumber	String (20)
contactStructureName	String
epcTransactionData	EpcTransactionData
externalUrl	String (255)
isInstallment	boolean
orderId	Long
payerContact	boolean
paymentDate	Date
paymentId	Long
paymentIdentifier	String
paymentLastUpdated	Date
paymentMethod	PaymentMethod
paymentStatus	(WAITING|IN_PROGRESS| AUTHORIZED|PAID| CANCELLED_BY_USER|FAILED| ABANDONED| WAITING_MANUAL_VALIDATION| FAILED_REJECTED)
pspAdditionalReturnedData	String
referenceDate	Date
valueDate	Date
voucherPaymentKind	(REUSABLE_VOUCHER| NOT_REUSABLE_VOUCHER)

EpcTransactionData
aliasPaymentDetails	List of EpcAliasPaymentDetails
isUsingPaymentWidget	boolean
paymentWidgetUrl	String (255)
postPaymentDetails	EpcPostPaymentDetails
redirectPaymentDetails	List of EpcRedirectPaymentDetails
transactionId	int

EpcAliasPaymentDetails
cardExpMonth	EpcPaymentField
cardExpYear	EpcPaymentField
cardHolder	EpcPaymentField
cardNumber	EpcPaymentField
cvv	EpcPaymentField
paymentMethod	EpcPaymentMethod
hiddenFields	List of EpcField
url	String (255)

EpcPaymentField
definedValues	String
editable	boolean
mandatory	boolean
name	String
value	String

EpcPaymentMethod
cardValidationRegex	String
cvvLength	int
isCvvMandatory	boolean
code	String (8)
description	String

EpcField
name	String
value	String

EpcPostPaymentDetails
cardExpMonth	EpcPaymentField
cardExpYear	EpcPaymentField
cardHolder	EpcPaymentField
cardNumber	EpcPaymentField
cardType	EpcPaymentField
cvv	EpcPaymentField
isUsingPaymentWidget	boolean
javascriptLibDetails	List of EpcJavascriptLibDetail
paymentMethods	List of EpcPaymentMethod
paymentWidgetUrl	String (255)
storeAlias	EpcPaymentField
transactionId	Integer
hiddenFields	List of EpcField
url	String (255)

EpcJavascriptLibDetail
id	String
url	String (255)

EpcRedirectPaymentDetails
paymentMethod	EpcPaymentMethod
hiddenFields	List of EpcField
url	String (255)

PaymentMethod
authorizationMode	(NONE|CONTACT_MANDATE)
changeReturnAllowed	Boolean
code	String (8)
defaultPaymentMethodId	Long
externalDescription	ExternalName	2000 characters max for each translation
externalName	ExternalName	60 characters max for each translation
forPayment	Boolean
forReimbursement	Boolean
id	Long
immediateFollowupPayment	Boolean
inSplitPaymentAllowed	Boolean
internetCode	String (8)	Comma separated list of allowed cards (VISA,AMEX...)
manualValidation	Boolean
maxOrderAmount	Long
minOrderAmount	Long
paymentType	(NUM|CHEQ|CHEQCANCEL|CB| CBCANCEL|PREPAY|VIR|AVR| COUPON|VOUCHER|CTRM|EXT| CA|BVR|INV|CANOAUTH| DEPOSIT|SAPBTRANSF| FIDELITY_POINT|DISCOUNT| CB_WITH_VALIDATION| DIRECT_DEBIT|PREPAYMENT| DIRECT_DEBIT_WITHOUT_INST)
rank	Integer
subPaymentMethods	List of SubPaymentMethod
tooMuchPerceivedAllowed	Boolean
withFollowUp	Boolean

SubPaymentMethod
brand	String
image	Image
internetCode	String (8)
rank	Integer

Image
large	String
medium	String
small	String
xlarge	String

isExternalOrderFacadeAlive

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

refundTicketOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Creates an order refunding the tickets passed in the ticketInfos parameter.

Parameters

requestId	Integer
pointOfSalesId	Long	Mandatory Mandatory.
orderType	(SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING| ST_TRANSFER)	REFUND_CLIENT or REFUND_ORGANIZATION
orderId	Long
externalReference	String
ticketInfos	List of TicketInfo
autoClose	Boolean
refundReason	String

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

transferOptionSeatCategories

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Used to transfer quantities of PRE_REQUESTED operations from OPTION order to another seat category

Parameters

requestId	Integer
pointOfSalesId	Long
fileId	Long
singleEntryAttributionOperations	List of SingleEntryOperationAttributionData
origin	OrderOriginData

Return value

OrderUpdateResult