Service: ProductionPublicService
Version: 1_14 (other versions, change log, ZUMSTEIN_V3.12-SNAPSHOT) Deprecated. This version is frozen and still supported.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnpsb/external-remoting/com.secutix.facade.production.v1_14.ProductionPublicService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnpsb/backend-apis/productionPublicService/v1_14/{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.Production public service. This service responsibility is the production of printable elements, that is, mostly
tickets and documents. This service handle the proper generation of those elements, and the transfer of their content
to the calling service.
Methods:
cancelTicketResales
Cancel tickets that put on resale.
Parameters
| ticketIds | List of Long | The Ids of tickets. |
| contactNumber | String (20) | The number of contact who resell tickets. |
Return value
| WebMethodResult |
|
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
createDefaultDocuments
Creates default documents for an order. Information contained in the DocumentInformation may override some values
of the newShipmentOptions
Parameters
| shipmentOptions | ShipmentOptions | the options to create the new shipments. |
| pointOfSalesId | long | Mandatory
|
| actionKinds | List of String | the actionsKind of the order |
| documentTuning | DocumentsInformation | |
| ShipmentOptions |
|
| addRarDocument | boolean | |
| contactAddressId | Long | |
| contactId | Long | |
| email | String | |
| emailDocumentTypeId | Long | |
| orderId | Long | |
| rarNumber | String | |
| shipmentModeId | Long | |
| DocumentsInformation |
|
| allDocuments | List of DocumentInformation | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| DocumentInformation |
|
| addressId | Long | |
| contactId | Long | |
| documentToSendId | Long | |
| documentTypeId | Long | |
| email | String | |
| isImmediate | boolean | |
| operation | (ADD|MODIFY|REMOVE|
SKIPPED) | |
| rarRefNumber | String | |
| shipmentModeId | Long | |
| withTickets | boolean | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
Return value
| CreatedDocumentsInformation |
|
| allDocuments | List of CreatedDocumentInformation | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| CreatedDocumentInformation |
|
| documentId | Long | |
| isEmailContent | boolean | |
| isRarDocument | boolean | |
| shipmentId | long | |
| status | String | |
| addressId | Long | |
| contactId | Long | |
| documentToSendId | Long | |
| documentTypeId | Long | |
| email | String | |
| isImmediate | boolean | |
| operation | (ADD|MODIFY|REMOVE|
SKIPPED) | |
| rarRefNumber | String | |
| shipmentModeId | Long | |
| withTickets | boolean | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
createReprintShipment
Creates shipments to reprint/duplicate tickets and documents
Parameters
| shipmentOptions | ShipmentOptions | the options to create the new shipments. orderId must be filled if documents are provided |
| pointOfSalesId | long | Mandatory
|
| ticketIds | List of Long | id of the tickets |
| documentIds | List of Long | id of the documents |
| creationCause | (PRINT|REPRINT|DUPLICATE|
PRINT_FILE|INVALIDATE) | |
| invalidationCause | (NOT_CANCELLED|REFUNDED|
LOSS|THEFT|OTHER|
EBO_CANCELLED|FORBIDDEN|
REPRINT|PRINT_KO|
CHANGE_RFID|INVALIDATE) | |
Return value
| ShipmentsData |
|
| data | List of ShipmentData | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| ShipmentData |
|
| contactAddressId | Long | |
| contactId | Long | |
| documentsIds | List of Long | |
| emailId | Long | |
| id | long | |
| rarDocumentId | Long | |
| referenceNumber | String | |
| shipmentModeId | Long | |
| shipmentModeTypeEnum | (HANDED_AT_BO|
HANDED_POSTPONED|
LEFT_AT_CONTROL|BY_MAIL|
BY_RECOMMANDED_MAIL|
BY_BROKER|BY_EMAIL|
PRINT_AT_HOME|DHL|FEDEX|
MOBILE|LOAD_BADGE|
LOAD_RFID_CARD|ELECTRONIC|
BLOCKCHAIN) | |
| ticketIds | List of Long | |
getAvailableTicketSupports
Retrieve the available tickets supports for the given list of tickets identified by their IDs
Parameters
| ticketIds | List of Long | list of technical identifier of the tickets to be considered |
Return value
| AvailableTicketSupportsResult |
|
| availableTicketSupports | List of AvailableTicketSupports | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| AvailableTicketSupports |
|
| cardNumber | String | |
| cardTypes | List of CardTypeData | |
| firstName | String | |
| lastName | String | |
| ticketId | Long | |
| ticketSupportData | List of TicketSupportData | |
| CardTypeData |
|
| cardTypeId | Long | |
| code | String (8) | |
| control | String | |
| externalName | String | |
| logoUrl | String (255) | |
| printable | Boolean | |
| TicketSupportData |
|
| name | String | |
| ticketSupport | (THERMAL|ETICKET|PAPER_A4|
PASSBOOK|MOBILE|
BLOCKCHAIN|BADGE|RFID|
PR_RFID_CARD|
DEMAT_BADGE) | |
getCards
Parameters
| culturalContactNumbers | Collection of String | |
Return value
| CardsDataResult |
|
| cards | List of CardData | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| CardData |
|
| cardNumber | String | |
| cardTypeData | CardTypeData | |
| lastUsedDate | Date | |
| linkedContactNumber | String (20) | |
getDocuments
Retrieve the given document data for documents identified by their IDs. The same processing applied in
{@link #getDocument(long, String)} is applied for each document, except for inexistent documents. If a document
cannot be found in the system, nothing will be returned for this element. Meaning that the returned list will
contain less elements than requested.
For performance reasons, this method will only consider the
Parameters
| documentIds | List of Long | list of technical identifier of the documents to consider. |
| contactNumber | String (20) | contact number of contact linked to the documents by the shipments. |
Return value
| PrintableDocumentsData |
|
| documents | List of PrintableDocumentData | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| PrintableDocumentData |
|
| data | byte | |
| filename | String | |
| mimetype | String | |
| EMPTY_ID | long | |
| id | long | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
getFileSummaryDocument
Parameters
| fileId | Long | |
| contactNumber | String (20) | |
| contactAddresId | Long | |
Return value
PrintableDocumentsData
getThermalPrintableTickets
Returns all the tickets in the specified shipment, with all details required for thermal printing on the
configured hardware.
Parameters
| requestId | Long | optional |
| shipmentId | Long | |
Return value
| ThermalPrintableTicketsResult |
|
| cuttingSet | Set of Long | |
| shipmentId | Long | |
| thermalPrintableTickets | List of ThermalPrintableTicket | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| ThermalPrintableTicket |
|
| cuttingMode | (NONE|AFTER_EACH_TICKET|
AFTER_EACH_ORDER|
AT_THE_END_OF_MASS_PRINTING) | |
| data | byte | Binary data to be printed. |
| dataEncoding | (ISO_8859_1|UTF_8|
BINARY) | Encoding of {@link #data} |
| id | long | Id of the ticket or document. |
| metadata | Map of StringString | contains the same metadata as in JMS version, see twiki |
| mimeType | String | Mime type of {@link #data} |
| printableType | (TICKET|DOCUMENT) | Type of the printable |
| readableReference | String | comprehensible information to identify the printable |
getTicketTemplates
This method is used to get available ticket templates of each product for a point of sales by applications that
desire to produce ticket themselves.
Parameters
| posId | Long | |
| productIds | List of Long | |
Return value
| TicketTemplateResult |
|
| productTicketTemplates | List of ProductTicketTemplate | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| ProductTicketTemplate |
|
| productId | Long | |
| ticketTemplate | byte | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
getTickets
Retrieve the given ticket data for tickets identified by their IDs. The same processing applied in
{@link #getTicket(long, String)} is applied for each ticket, except for inexistent tickets. If a ticket cannot be
found in the system, nothing will be returned for this element. Meaning that the returned list will contain less
elements than requested.
For performance reasons, this method will only consider the first {@link #MAX_ELEMENTS} elements. If more tickets
are requested, they will be ignored.
Parameters
| ticketIds | List of Long | list of technical identifier of the tickets to consider. |
| contactNumber | String (20) | contact number of contact is allowed to download the tickets. |
| beneficiaries | List of TicketBeneficiaryData | list of beneficiaries for the tickets; optional. |
| ticketSupports | List of (THERMAL|ETICKET|PAPER_A4|
PASSBOOK|MOBILE|
BLOCKCHAIN|BADGE|RFID|
PR_RFID_CARD|
DEMAT_BADGE) | |
| questionnaireAnswers | List of AnswerQuestionnaire | |
| TicketBeneficiaryData |
|
| beneficiaryBirthPlace | String | |
| beneficiaryBirthRegion | String | |
| beneficiaryBirthdate | Date | |
| beneficiaryCountryCode | String (8) | |
| beneficiaryFirstname | String | Mandatory
|
| beneficiaryIdNumber | String | |
| beneficiaryLastname | String | Mandatory
|
| ticketId | long | Mandatory
|
| AnswerQuestionnaire |
|
| answerQuestions | List of AnswerQuestion | Mandatory
|
| ticketId | Long | Mandatory
|
| AnswerQuestion |
|
| answerCodes | List of String | Mandatory
|
| questionCode | String (8) | Mandatory
|
Return value
| PrintableTicketsData |
|
| tickets | List of PrintableTicketData | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| PrintableTicketData |
|
| barcode | String (8) | |
| cardVisualId | String | |
| containerIdentifier | String | |
| humanReadableBarcode | String (8) | |
| state | (CONTROLLED|
CONTROLLED_OUT|PRINTED|
NOT_PRINTED|INVALIDATED|
CANCELLED|EXPORTED) | |
| taxNumber | String | |
| ticketSupport | (THERMAL|ETICKET|PAPER_A4|
PASSBOOK|MOBILE|
BLOCKCHAIN|BADGE|RFID|
PR_RFID_CARD|
DEMAT_BADGE) | |
| data | byte | |
| filename | String | |
| mimetype | String | |
| EMPTY_ID | long | |
| id | long | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
getTicketsToResell
Get the list of tickets to resell.
Parameters
| itemIds | List of Long | the list of item ids |
| performanceIds | List of Long | the list of performance ids |
| date | Date | |
| privateBucketIdentifier | String | Identifier (as a string) of the bucket in which the private resales are stored. If empty means general public. |
Return value
| TicketResaleGroups |
|
| date | Date | |
| ticketResaleGroups | List of TicketResaleGroup | |
| expectedException | boolean | |
| statusMessage | String | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| TicketResaleGroup |
|
| areaId | Long | |
| audienceSubCategoryId | Long | |
| blockId | Long | |
| itemId | Long | |
| performanceId | Long | |
| quantity | Integer | |
| seatCategoryId | Long | |
| ticketResaleSeats | List of TicketResaleSeat | |
| unitAmount | Integer | |
| TicketResaleSeat |
|
| endValidityDate | Date | |
| movementId | Long | |
| realAmount | Integer | |
| remark | String | |
| resaleState | (OPEN|PROCESSING|RESOLD|
INVALIDATED|CANCELED) | |
| seatDefinition | SeatDefinition | |
| seatId | Long | |
| startValidityDate | Date | |
| SeatDefinition |
|
| UNDEFINED | String | |
| areaId | Long | |
| areaKind | (INDIFFERENT|BOX) | |
| available | boolean | |
| blockId | Long | |
| contingentId | Long | |
| number | String | |
| physicalSeatId | Long | |
| rotation | int | |
| row | String | |
| scenePanoLink | String | |
| scenePhotoLink | String | |
| seatCategoryId | Long | |
| x | int | |
| y | int | |
loadTicketsOnCard
Load tickets on badge/RFID card.
Parameters
| ticketDefinitions | List of TicketBeneficiaryData | |
| containerIdentifier | String | container identifier used to update tickets |
| questionnaireAnswers | List of AnswerQuestionnaire | |
| cardLoadingQuestions | List of SimpleQuestion | list of answers for questions required by the card type (Eg. SWISSPASS requires zip code) |
| SimpleQuestion |
|
| answer | String | |
| key | String | |
| translation | String | |
Return value
| LoadTicketOnCardResult |
|
| cardTypeId | Long | |
| questions | List of SimpleQuestion | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
resellTickets
Put list of tickets to resale.
Parameters
| tickets | List of TicketResaleData | The list of ticket data that contains ticket Id and resale amount. |
| contactNumber | String (20) | The number of contact who buying tickets. |
| paymentMethodId | Long | The payment method Id |
| remark | String | The remark of the resale tickets. |
| privateBucketIdentifier | String | Identifier (as a string) of the bucket in which the private resales are stored. If empty means general public. |
| TicketResaleData |
|
| ticketId | Long | |
| unitAmount | Integer | |
Return value
WebMethodResult