| URL: | ||
| JWT Token | ||
| Template: | ||
| cURL: |
Version: 1_6 (other versions, change log, null) Latest frozen version. Base by default all your developments on this one.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnci/external-remoting/com.secutix.facade.control.v1_6.ExternalAccessControlService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnci/backend-apis/externalAccessControlService/v1_6/{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.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) | Mandatory WHITE : only valid tickets BLACK : only invalid ones GREY : valid and invalid mixed. In all the cases the order matters ! |
| ticketType | (ALL|THIRD_PARTY) | Mandatory |
| seasonCode | String (8) | Mandatory |
| 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 | Mandatory 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) | |
| barcodeInternalValues | Map of StringString | |
| 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) | |
| entranceId | Long | |
| entryQuantity | Integer | |
| externalEntranceCode | String (8) | |
| externalEntranceId | Long | |
| fileId | Long | |
| holderInfo | Map of StringString | |
| holderPhoto | String | |
| isProductCompositionTicket | Boolean | |
| loungeCode | String (8) | |
| performanceCode | String (8) | |
| performanceDateTime | Date | |
| performanceId | Long | |
| price | 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 |
Returns all the events and performances that are eligile to access control from the current operator. Basically, to be returned, a season or a product or a performance must be in RUNNING state inside SecuTix and be authorized for the current operator.
| requestId | Integer | |
| seasonCode | String (8) | if set, returns only the season with the code specified. |
| productCodes | List of String | if set, then season code must be set. Filters the results according to products codes. |
| catalogDetails | List of (PERFORMANCES|TIMESLOTS| ENTRANCES) | if set, return only values of this kind (PERFORMANCES, TIMESLOTS, ENTRANCES) |
| AccessControlCatalogResult | ||
| seasons | List of Season | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| Season | ||
| endDate | Date | |
| products | List of Product | All the active products of the season accessible to control through the current access control operator. |
| startDate | Date | |
| internalName | String | Internal name of the object. |
| code | String (8) | |
| id | long | |
| Product | ||
| performance | List of Performance | Defined if and only if the product is an event. |
| spaceName | String | If the product is explicitely associated to a space, here is its name. |
| timeslots | List of Timeslot | Defined if an only if the product is a dated pass. |
| internalName | String | Internal name of the object. |
| code | String (8) | |
| id | long | |
| Performance | ||
| A Performance's code, in this API, is the code of the parent event followed by an index. | ||
| duration | Integer | Duration, in minutes. |
| entrances | List of Entrance | |
| externalEntrances | List of Entrance | |
| openingGatesTime | Date | |
| spaceName | String | |
| startTime | Date | |
| code | String (8) | |
| id | long | |
| Entrance | ||
| An entrance to the venue associated to the performance. | ||
| internalName | String | Internal name of the object. |
| code | String (8) | |
| id | long | |
| Timeslot | ||
| duration | Integer | In minutes. |
| startTime | Date | |
| 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 | Mandatory |
| ControlledTicket | ||
| acIdentifier | String | Mandatory 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) | Mandatory |
| checkFlow | (IN|OUT) | Mandatory 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 | Mandatory |
| controlResult | (OK|FAIL|OFFLINE_OK| OFFLINE_FAIL) | Mandatory |
| countingProduct | boolean | |
| deviceCode | String (8) | |
| failureReason | String | Mandatory 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 | |