Service: ExternalAccessControlService
Version: 1_1 (other versions, change log, null) 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/tnci/external-remoting/com.secutix.facade.control.v1_1.ExternalAccessControlService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnci/backend-apis/externalAccessControlService/v1_1/{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 access control service.
Methods:
burnTicket
Retrieves the ticket marked by the given barcode / and or taxnumber from the sales channel in context. If the
ticket is printed (or not printed) --> controls it OK else --> FAIL. Returns history of control.
Parameters
| requestId | Integer | TODO |
| barCodeOrTaxNumber | String | |
Return value
| ControlledTicketResult |
|
| controlledTicketData | ControlledTicketData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| ControlledTicketData |
|
| barcode | String (8) | |
| containerIdentifier | String | |
| containerTicket | boolean | |
| controlOperations | List of ControlOperation | |
| duplicate | boolean | |
| printingDateTime | Date | |
| state | (VALID|CANCELLED) | |
| taxNumber | String | |
| ticketKind | String | |
| ticketMedium | (CONTENT|E_TICKET|THERMAL|
MOBILE) | |
| ControlOperation |
|
| controlOperationType | (OK|OFFLINE_OK|FAIL|
OFFLINE_FAIL|
INVALIDATED_TICKET|
CANCELLED_TICKET) | |
| operationDateTime | Date | |
exportList
Parameters
| requestId | Integer | |
| listType | (GREY|BLACK|WHITE) | |
| ticketType | (ALL|THIRD_PARTY) | |
| seasonCode | String (8) | |
| productCodes | List of String | |
| paginationStart | String | |
| nbMaxResults | Long | |
Return value
| AccessControlListResult |
|
| accessControlListData | AccessControlListData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | 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 | |
| entranceCode | String (8) | |
| entryQuantity | Integer | |
| holderFirstname | String | |
| holderLastName | String | |
| holderPhoto | URL | |
| performanceDateTime | Date | |
| performanceId | Long | |
| productCode | String (8) | |
| productId | Long | |
| row | String | |
| seatNumber | String | |
| seatQualityCode | String (8) | |
| taxNumber | String | |
| ticketMedium | (CONTENT|E_TICKET|THERMAL|
MOBILE) | |
| ticketState | (VALID|CANCELLED) | |
| validityDate | Date | |
| validityDays | Integer | |
getCatalog
Parameters
| requestId | Integer | |
| seasonCode | String (8) | |
| productCode | String (8) | |
| validityStartDate | Date | |
| validityEndDate | Date | |
Return value
| CatalogResult |
|
| barcodeID | Integer | |
| internalName | String | |
| internalRequestId | Integer | |
| itemControlDatas | List of ItemControlData | |
| requestState | AsynchronousMethodResult.
AsynchronousMethodState | |
| seasonCode | String (8) | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| EntranceControlData |
|
| code | String (8) | |
| internalName | String | |
| AudienceSubCatControlData |
|
| code | String (8) | |
| internalName | String | |
| ProductControlData |
|
| barcodeId | Integer | Internal SecuTix use only. |
| code | String (8) | |
| duration | Integer | |
| eventControlData | List of EventControlData | |
| internalName | String | |
| numberValidDays | Integer | |
| EventControlData |
|
| barcodeId | Integer | |
| code | String (8) | |
| internalName | String | |
| organizationDayStartTime | Date | |
| performances | List of PerformanceTreatedData | |
| tolerance | long | |
| PerformanceTreatedData |
|
| duration | TimeSpan | |
| openingTime | TimeSpan | |
| performanceId | Integer | |
| processDateTime | Date | |
| space | String | |
| start | Date | |
| tolerance | long | |
getControlledTicket
Retrieve the given ticket data identified by its barcode OR taxnumber.
A list of operations is associated to the data:
if ticket is invalidated, an invalidation operation, with last ticket update time as dateTime.
if ticket is cancelled, a cancellation operation, with last ticket update time as dateTime.
Parameters
| requestId | Integer | TODO |
| barCodeOrTaxNumber | String | |
Return value
ControlledTicketResult
importControlledTicket
Parameters
| ControlledTicket |
|
| acIdentifier | String | |
| additionnalInfo | String | |
| barcode | String (8) | |
| controlDate | Date | |
| controlResult | (OK|FAIL|OFFLINE_OK|
OFFLINE_FAIL) | |
| failureReason | String | |
| gateCode | String (8) | |
| sectorCode | String (8) | |
Return value
| WebMethodResult |
|
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |