| URL: | ||
| JWT Token | ||
| Template: | ||
| cURL: |
Version: 1_4 (other versions, change log) Deprecated. This version is still supported.
SOAP Demo endpoint: https://secutix.ws.secutix.com/tnci/external-remoting/com.secutix.facade.control.v1_4.ExternalAccessControlService.webservice?wsdl
REST Demo endpoint (only POST): https://secutix.ws.secutix.com/tnci/backend-apis/externalAccessControlService/v1_4/{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.This service allows to access ticket data for using in an access control system.
Its main method is exportList, which allow to incrementally retrieve the tickets.
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Retrieves the tickets to be controlled, incrementally.
| requestId | Integer | |
| listType | (GREY|BLACK|WHITE) | WHITE : only valid tickets BLACK : only invalid ones GREY : valid and invalid mixed. In all the cases the order matters ! |
| ticketType | (ALL|THIRD_PARTY) | |
| seasonCode | String (8) | |
| productCodes | List of String | |
| performanceCodes | List of String | |
| paginationStart | String | This value is a string, and must be stored as a string. Must be null for the first call, then use the value paginationEnd returned in AccessControlListData for the next call. |
| nbMaxResults | Long | the number of tickets returned. Beware, if returning a grey list, a valid ticket followed by its invalid counterpart counts as 1 ticket, so the number of items in AccessControlListResult can exceed nbMaxResults. * |
| AccessControlListResult | ||
| accessControlListData | AccessControlListData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| AccessControlListData | ||
| accessControlListItems | List of AccessControlListItem | |
| paginationEnd | String | |
| AccessControlListItem | ||
| areaCode | String (8) | |
| audienceCategoryKind | String | |
| audienceSubCategoryCode | String (8) | |
| barcode | String (8) | |
| blockCode | String (8) | |
| cancellationCause | (NOT_CANCELLED|REFUNDED| LOSS|FORBIDDEN|DUPLICATA| REPRINT|THEFT|OTHER| PRINT_KO|CHANGE_RFID) | |
| categoryCode | String (8) | |
| containerIdentifier | String | |
| endValidityDate | Date | |
| entranceCode | String (8) | |
| entryQuantity | Integer | |
| holderInfo | Map of StringString | |
| holderPhoto | String | |
| loungeCode | String (8) | |
| performanceCode | String (8) | |
| performanceDateTime | Date | |
| performanceId | Long | |
| productCode | String (8) | |
| productId | Long | |
| reseller | String | |
| seatNumber | String | |
| seatQualityCode | String (8) | |
| seatRow | String | |
| taxNumber | String | |
| ticketMedium | (CONTENT|E_TICKET|THERMAL| MOBILE) | |
| ticketState | (VALID|CANCELLED) | |
| validityDate | Date | |
| validityDays | Integer | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Lists the items to be controlled.
Do not use it if you already know the productCode of the products that you and to control.
| requestId | Integer | |
| seasonCode | String (8) | |
| productCode | String (8) | |
| validityStartDate | Date | |
| validityEndDate | Date |
| CatalogResult | ||
| barcodeID | Integer | |
| internalName | String | |
| internalRequestId | Integer | |
| itemControlDatas | List of ItemControlData | |
| requestState | AsynchronousMethodResult. AsynchronousMethodState | |
| seasonCode | String (8) | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| ItemControlData | ||
| entrancesControlData | List of EntranceControlData | |
| performanceStartDateTime | Date | |
| productControlData | ProductControlData | |
| EntranceControlData | ||
| code | String (8) | |
| internalName | String | |
| ProductControlData | ||
| barcodeId | Integer | Internal SecuTix use only. |
| code | String (8) | |
| duration | Integer | |
| eventData | EventControlData | |
| internalName | String | |
| numberValidDays | Integer | |
| organizationStartDayTime | Date | |
| EventControlData | ||
| performances | List of PerformanceTreatedData | |
| PerformanceTreatedData | ||
| code | String (8) | |
| duration | TimeSpan | |
| openingTime | TimeSpan | |
| performanceId | Long | |
| space | String | |
| start | Date | |
| tolerance | long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Retrieve the timezone of request org
| requestId | Integer | |
| institutionCode | String (8) | |
| organizationCode | String (8) |
| TimeZoneResult | ||
| timeZone | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Marks the tickets as controlled in the system.
| requestId | Integer | |
| controlledTickets | List of ControlledTicket |
| ControlledTicket | ||
| acIdentifier | String | Mandatory parameter. Any value allowing to identify the control session for the external access control system. If the access control system does not provide this kind of value, we suggest to put a timestamp. |
| additionnalInfo | String | |
| barcode | String (8) | |
| checkFlow | (IN|OUT) | If you need to specify the flow of the controlled ticket, please set it here. If the ticket is controlled when people come in, then the checkFlow is IN, if it is controlled when people come out, the checkFlow will be OUT. If left empty, the default value of the checkFlow is IN |
| controlDate | Date | |
| controlResult | (OK|FAIL|OFFLINE_OK| OFFLINE_FAIL) | |
| countingProduct | boolean | |
| deviceCode | String (8) | |
| failureReason | String | The reason of the failure tu control. Should be considered as an enum, with the following possible values. OK, OFFLINE_OK, FAIL, OFFLINE_FAIL, SPECIMEN_TICKET, TICKET_ALREADY_USED, TICKET_NOT_VALID_ANYMORE, TICKET_NOT_VALID_TODAY, WRONG_ARTICLE, NO_MORE_READMISSION, TICKET_ON_BLACKLIST, INVALID_TICKET, TICKET_CANNOT_BE_CHECKED, MAX_PEOPLE_REACHED If none, put OK. |
| gateCode | String (8) | |
| multiplier | Integer | |
| productCode | String (8) | |
| seasonCode | String (8) | |
| sectorCode | String (8) | |
| WebMethodResult | ||
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |