| URL: | ||
| JWT Token | ||
| Template: | ||
| cURL: |
Version: 1_13 (other versions, change log, ZUMSTEIN_V3.12-SNAPSHOT) END OF LIFE. Please consider switching to the latest version of the webservices, because this version may be removed anytime from support.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.history.v1_13.ExternalOrderHistoryService.webservice?wsdl
To get the endpoint for your own institution, replace "myinstit" (just after https://) in the url by your own institution code.
For further documentation and examples, please check in Platform Website.
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| pointOfSalesId | Long | |
| startDate | Date | |
| endDate | Date | |
| states | List of (RUNNING|SUSPENDED| IN_OPTION|IN_RESERVATION| OPTION_RESERV|CONFIRMED| SOLDED|NOT_SOLDED| PART_SOLDED|CANCELED| ABANDONNED|TECH_ERROR) | |
| productId | Long | |
| performanceId | Long | |
| itemId | Long | |
| culturalContactReference | String | |
| paymentStates | List of (WAITING|IN_PROGRESS| AUTHORIZED|PAID| CANCELLED_BY_USER|FAILED| ABANDONED| WAITING_MANUAL_VALIDATION) | |
| fileContacts | List of FileContactData | |
| maxFileExpirationDate | Date | |
| maxInstallmentExpirationDate | Date | |
| fileSearchCriteria | (UNION_FILE_CONTACTS| INTERSECT_FILE_CONTACTS) | |
| mainAudienceCategory | (OCCASIONAL|SUBSCRIBER| INSIDE_SEASONTICKET| MEMBER|INVITED) | |
| fileOptionStates | List of (NONE|REQUESTED| PRE_REQUESTED) |
| FileContactData | ||
| fileContactType | (SALE|OWNER|FINDER| COMM_ENTITY) | |
| answerQuestionnaire | AnswerQuestionnaire | |
| birthday | Date | |
| contactId | Long | |
| contactReference | String (20) | |
| countryCode | String (8) | |
| 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) | |
| AggregatedFileHistoryResult | ||
| aggregatedFileHistories | List of AggregatedFileHistoryData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| AggregatedFileHistoryData | ||
| fileState | (RUNNING|SUSPENDED| IN_OPTION|IN_RESERVATION| OPTION_RESERV|CONFIRMED| SOLDED|NOT_SOLDED| PART_SOLDED|CANCELED| ABANDONNED|TECH_ERROR) | |
| numberOfExpiredFiles | Long | |
| numberOfFiles | Long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| pointOfSalesId | Long | |
| startDate | Date | |
| endDate | Date | |
| productId | Long | |
| performanceId | Long | |
| itemId | Long | |
| contactReference | String (20) | |
| culturalContactFilterCriteria | ContactFilterCriteria | |
| paymentStates | List of (WAITING|IN_PROGRESS| AUTHORIZED|PAID| CANCELLED_BY_USER|FAILED| ABANDONED| WAITING_MANUAL_VALIDATION) | |
| orderTypes | List of (SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING| ST_TRANSFER) |
| ContactFilterCriteria | ||
DTO used to specify order filter criteria for a given contact. Used in queries which look for orders by various
criteria.
| ||
| contactReference | String (20) | |
| salesChannelTypeString | String | |
| unionWithOtherOrders | Boolean | |
| AggregatedOrderHistoryResult | ||
| aggregatedOrderHistories | List of AggregatedOrderHistoryData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| AggregatedOrderHistoryData | ||
| numberOfOrders | Long | |
| orderState | (OPEN|VALIDATED|CLOSED| ABANDONNED|PROCESSING) | |
| orderType | (SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING| ST_TRANSFER) | |
| totalAmount | Long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
validate network connection and login/password
| WebMethodResult | ||
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Returns a list of files filtered by the given criteria. To specify a filter on the file contacts, use the fileContacts parameter. If more than one file contact is specified in the file contacts list, returns the files belonging to any of the given contacts (OR semantics). The culturalContactReference filters movement contacts.
| requestId | Integer | |
| pointOfSalesId | Long | |
| startDate | Date | |
| endDate | Date | |
| states | List of (RUNNING|SUSPENDED| IN_OPTION|IN_RESERVATION| OPTION_RESERV|CONFIRMED| SOLDED|NOT_SOLDED| PART_SOLDED|CANCELED| ABANDONNED|TECH_ERROR) | |
| productId | Long | |
| performanceId | Long | |
| itemId | Long | |
| culturalContactReference | String | |
| paymentStates | List of (WAITING|IN_PROGRESS| AUTHORIZED|PAID| CANCELLED_BY_USER|FAILED| ABANDONED| WAITING_MANUAL_VALIDATION) | |
| startPosition | Long | |
| maxResult | Long | |
| fileContacts | List of FileContactData | |
| maxFileExpirationDate | Date | |
| maxInstallmentExpirationDate | Date | if non-null, returns only files containing installments linked to non-abandoned orders which have an expiration date before the given maxInstallmentExpirationDate |
| fileSearchCriteria | (UNION_FILE_CONTACTS| INTERSECT_FILE_CONTACTS) | - applies the given searchCriteria for file contacts.This field is optional. |
| fileSortingCriteria | (LAST_UPDATED_DATE| MAX_EXPIRATION_DATE| MAX_INSTALLMENT_EXPIRATION_DATE) | - orders the result by given criteria. This field is optional, by default it sorts files by last update date of file |
| mainAudienceCategory | (OCCASIONAL|SUBSCRIBER| INSIDE_SEASONTICKET| MEMBER|INVITED) | if non-null, returns files which contain operations having the given main audience category. NOTE: If SUBSCRIBER is given as the audience category, then only files containing season tickets will be returned (those containing other products with main category SUBSCRIBER will NOT be returned) |
| fileOptionStates | List of (NONE|REQUESTED| PRE_REQUESTED) |
| FileSummaryListResult | ||
| fileSummaries | List of FileSummaryData | |
| truncated | Boolean | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| FileSummaryData | ||
| Class containing information of file. | ||
| fileContacts | List of FileContactSummaryData | |
| fileId | Long | |
| fileState | (RUNNING|SUSPENDED| IN_OPTION|IN_RESERVATION| OPTION_RESERV|CONFIRMED| SOLDED|NOT_SOLDED| PART_SOLDED|CANCELED| ABANDONNED|TECH_ERROR) | |
| lastModDate | Date | |
| maxFileExpirationDate | Date | |
| maxInstallmentExpirationDate | Date | |
| numberOfMovements | Long | |
| optionState | (PRE_REQUESTED|REQUESTED| VALIDATED|PART_VALIDATED| REJECTED|ABANDONED) | |
| referenceDate | Date | |
| waitingActionState | (PRE_SALES|PRE_REQUESTED| REQUESTED|VALIDATED| REJECTED) | |
| FileContactSummaryData | ||
| fileContactType | (SALE|OWNER|FINDER| COMM_ENTITY) | |
| contactNumber | String (20) | |
| name | String | |
| structureName | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| pointOfSalesId | Long | |
| startDate | Date | |
| endDate | Date | |
| states | List of (OPEN|VALIDATED|CLOSED| ABANDONNED|PROCESSING) | |
| productId | Long | |
| performanceId | Long | |
| itemId | Long | |
| contactReference | String (20) | |
| culturalContactFilterCriteria | ContactFilterCriteria | |
| paymentStates | List of (WAITING|IN_PROGRESS| AUTHORIZED|PAID| CANCELLED_BY_USER|FAILED| ABANDONED| WAITING_MANUAL_VALIDATION) | |
| startPosition | Long | |
| maxResult | Long | |
| orderTypes | List of (SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING| ST_TRANSFER) | |
| orderBy | OrderBy |
| OrderBy | ||
| field | (FILE_LAST_UPDATED_DATE| FILE_MAX_EXPIRATION_DATE| ORDER_CREATION_DATE) | |
| order | (ASC|DESC) | |
| OrderSummaryListResult | ||
| orderSummaries | List of OrderSummaryData | |
| truncated | Boolean | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| OrderSummaryData | ||
Class containing information of order creation result. The following attributes are provided:
| ||
| buyingContactInfo | ContactSummaryData | |
| culturalContactsInfo | List of ContactSummaryData | |
| expirationDate | Date | |
| externalReference | String | |
| fileIds | List of Long | |
| numberOfMovements | Long | |
| orderId | Long | |
| orderState | (OPEN|VALIDATED|CLOSED| ABANDONNED|PROCESSING) | |
| orderType | (SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING| ST_TRANSFER) | |
| paymentStates | List of (WAITING|IN_PROGRESS| AUTHORIZED|PAID| CANCELLED_BY_USER|FAILED| ABANDONED| WAITING_MANUAL_VALIDATION) | |
| referenceDate | Date | |
| salesChannelName | ExternalName | |
| salesChannelType | (AGENCY|BOXOFFICE| INTERNET_B2C|INTERNET_B2B| INTERNET_B2B2C) | |
| totalAmount | Integer | |
| ContactSummaryData | ||
| contactNumber | String (20) | |
| name | String | |
| structureName | String | |
| ExternalName | ||
| translations | List of Translation | |
| Translation | ||
| locale | String (2) | |
| value | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| pointOfSalesId | Long | |
| startDate | Date | |
| endDate | Date | |
| state | (CANCELLED|VALID| NOT_PRINTED|INVALIDATED) | |
| productId | Long | |
| performanceId | Long | |
| itemId | Long | |
| startPosition | Long | |
| maxResult | Long | |
| buyingContactReference | String | |
| culturalContactReference | String | |
| ticketMedium | (THERMAL|E_TICKET|MOBILE| RFID) | |
| ordersId | List of Long | |
| joinType | (UNION_FILE_CONTACTS| INTERSECT_FILE_CONTACTS) | |
| seatIds | List of Long | |
| ticketSearchCriteria | (EXCLUDE_PAST_TICKETS) | |
| ticketSortingCriteria | (CREATION_DATE| PERFORMANCE_DATE) | |
| membershipBarcode | String (8) |
| TicketSummaryListResult | ||
| ticketSummaries | List of TicketSummaryData | |
| truncated | Boolean | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| TicketSummaryData | ||
| activityType | (LIVE_SPECT|FESTIVAL| MUSEUM|VISIT|ENTERT_PARK| FAIR|PARKING|SPORT| OTHER) | |
| alley | String | |
| area | String | |
| areaId | Long | |
| areaKind | (INDIFFERENT|BOX) | |
| audienceSubCategory | String | |
| audienceSubCategoryId | Long | |
| barcode | String (8) | |
| beneficiaryBirthdate | Date | |
| beneficiaryCountryCode | String (8) | |
| beneficiaryIdNumber | String | |
| block | String | |
| blockId | Long | |
| buyingContact | ContactData | |
| buyingContactReference | String | |
| cardType | CardTypeData | |
| contactQualities | List of ContactQuality | |
| containerIdentifier | String | |
| creationDate | Date | |
| culturalContact | ContactData | |
| culturalContactReference | String | |
| displayDateOnlyOfTimeslotStart | boolean | |
| duplicate | boolean | |
| endValidityDate | Date | |
| entrance | String | |
| entranceId | Long | |
| fileId | Long | |
| firstName | String | |
| floor | String | |
| hostTeam | String | |
| isAvailableForPrint | boolean | |
| isNominativeTicket | boolean | |
| itemDescription | String | |
| itemId | Long | |
| itemName | String | |
| lastName | String | |
| matchRound | String | |
| movementId | Long | |
| operationType | (SALE|REFUND|PRE_SALE| RESERVATION|OPTION| RES_CANCELLATION| OPTION_CANCELLATION| REFUND_ORGANIZATION| REFUND_CLIENT| RESERVATION_FREEING| OPTION_FREEING|ABANDON| PRE_REFUND) | |
| opposingTeam | String | |
| orderExternalReference | String | |
| orderId | Long | |
| parentMovementId | Long | |
| parentProduct | String | |
| parentProductId | Long | |
| performanceDate | Date | |
| performanceId | Long | |
| price | Integer | |
| product | String | |
| productFamilyType | (SINGLE_ENTRY| SEASONTICKET|PASS|PACKAGE| MEMBERSHIP|SERVICE|GOODS| TRANSPORT|HOSPITALITY) | |
| productId | Long | |
| questionnaireId | Long | |
| resaleable | boolean | |
| row | String | |
| scenePanoLink | String | |
| scenePhotoLink | String | |
| season | String | |
| seatCategory | String | |
| seatCategoryId | Long | |
| seatNumber | String | |
| seatQuality | String | |
| seatQualityId | Long | |
| sector | String | |
| shipmentModeType | String | |
| site | String | |
| space | String | |
| startValidityDate | Date | |
| taxNumber | String | |
| ticketId | Long | |
| ticketMedium | (THERMAL|E_TICKET|MOBILE| RFID) | |
| ticketResaleState | (OPEN|PROCESSING|RESOLD| INVALIDATED|CANCELED) | |
| ticketState | (CANCELLED|VALID| NOT_PRINTED|INVALIDATED) | |
| ticketSupports | List of String | |
| timeslotStart | Date | |
| ContactData | ||
Class containing the beneficiary data :
| ||
| answerQuestionnaire | AnswerQuestionnaire | |
| birthday | Date | |
| contactId | Long | |
| contactReference | String (20) | |
| countryCode | String (8) | |
| 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) | |
| CardTypeData | ||
| cardTypeId | Long | |
| code | String (8) | |
| control | String | |
| externalName | String | |
| logoUrl | String (255) | |
| printable | Boolean | |
| ContactQuality | ||
| audienceCategories | List of AudienceCategoryPriceLevel | |
| contactNumber | String (20) | |
| 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) | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| orderIds | List of Long | |
| fileIds | List of Long | |
| buyerContactReference | String | |
| pointOfSalesId | Long | |
| startDate | Date | |
| endDate | Date | |
| states | List of (OPEN|VALIDATED|CLOSED| ABANDONNED|PROCESSING) | |
| productId | Long | |
| performanceId | Long | |
| itemId | Long | |
| paymentStates | List of (WAITING|IN_PROGRESS| AUTHORIZED|PAID| CANCELLED_BY_USER|FAILED| ABANDONED| WAITING_MANUAL_VALIDATION) | |
| startPosition | Long | |
| maxResult | Long | |
| orderTypes | List of (SALE|REFUND_CLIENT| REFUND_ORGANIZATION| EXCHANGE_ORGANIZATION| EXCHANGE_CLIENT| RESERVATION|RENEWAL| OPTION| RESERVATION_FREEING| OPTION_FREEING| ST_TRANSFER) |
| SearchOrdersResult | ||
| culturalContacts | List of ContactSummaryData | |
| truncated | Boolean | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |