Due to PCI compliant reasons we're going to turn off support for TLS v1.0 on all of our servers.
Please check/update you API implementations to support TLS v1.2 until 29.06.2018

REST API Tickets

From XING Events Developer Documentation
Jump to: navigation, search

This page contains information about all properties and methods regarding tickets.

Properties

Attributes: R - accessible in read requests W - accessible in write (update) requests C - accessible in create requests

Property
Type
Attributes Description
id
Integer
R--
The internal id of this object.
paymentId
Integer
R--
The internal id of the associated payment.
participantId
Integer
R--
The internal id of the associated participant.
displayIdentifier
String
R--
The public identifier of the ticket.
identifier
String
R--
The identifier used in the barcode of the ticket.
firstName
String
RW-
The first name of the ticket holder.
lastName String
RW-
The last name of the ticket holder.
email String
RW-
The email of the ticket holder.
company String
RW-
The company of the ticket holder.
doubleOptIn String
RW-
Gets or sets the double opt-in status of the participant of this ticket.
"FALSE": User did not select the checkbox (or double opt-in field wasn't available in the shop)
"WAITING": User ticked the checkbox but didn't click the link in the mail yet.
Date/Time value: If the user clicked on the link (did the full double opt-in) this value represents the date and time of that interaction.
originalPrice Money R--
The gross price of a ticket of this ticket category.
amiandoFee Money R--
The XING Events fee for this ticket (depending on your settings the fee was added on top or included in the original price).
discountAmount Money R--
If the buyer used a promotion code in his purchase, the discounted amount will be provided here.
ticketRevenue Money R--
The ticket revenue (gross) is calculated as follows: Original ticket price - discounts from used promotion codes - ticketing fees (if fees are included in the original price)
productPrice Money R--
The price of the product, if there was a product purchase.
productFee Money R--
The fee of the product purchase.
ticketFee Money R--
Fee for this type of ticket (deprecated).
eventSenseFee Money R--
The fee for EventSense(R) (deprecated).
cancelled Date R--
The date of the cancelation or null.
checked Boolean R--
Wheather the ticket is checked (guest entered the event) or not.
lastChecked Date R--
The last time the ticket was checked.
ticketType String RW-
The type of the ticket. Details
userData Array of UserData R--
This array holds user data objects. User data objects hold additional values, which are asked when a user buys a ticket. These fields can be added to any event by the host.
If your event is a registration event, you will find the user data objects in the associated payment.
ticketCategoryIds Array of Integer R--
This array holds all ticket category ids of a ticket. This array always holds just one element (only by now deprecated events could have multiple entries).

Methods

Read

Call GET /api/ticket/<id>
Description This request will return the ticket object with the specified internal id. The response contains all properties marked with R.
Response {"ticket":{"firstName": ...},"success":true}.
Errors See General Errorcodes.

Update

Important information: To use this call you need to sign a "data processing agreement". Please contact our support or your account manager if you didn't sign this agreement yet. As long as no "data processing agreement" is signed these calls will return the error: com.amiando.api.rest.DataProcessingAgreementMissing

Call POST /api/ticket/<id>
Parameters All properties marked with W.
Description This request will update the properties of the ticket with the internal id <id>. Only properties which are provided as parameters will be updated.
Response {"success":true}.
Errors See General Errorcodes.

Find

Call GET /api/ticket/find
Description You can either perform a simple search by assigning only the query parameter (and optionally the eventId parameter), or a advanced search by assigning one or more other parameters (faster).

This method will only return the first 100 tickets found.
If you need all tickets bought for one particular event, use the Event's Enumerate payments method which will return all purchases of the event. After having all the payment IDs, retrieve all the tickets bought in that payment using the Enumerate tickets function.
As an alternative you can also iterate over all participants of the event to get all participants (=tickets): Enumerate participants.

Parameters eventId — Id of the associated event. If you don't assign this parameter, the ticket search will include all events you have permission to.
query — can contain any event or ticket property
firstName — first nameof the ticket holder
lastName — last name of the ticket holder
email — email of the ticket holder
company — company of the ticket holder
displayIdentifier — the identifier of the ticket displayed below the QR code
ticketIdentifier — the ticket's identifier (the scanned QR code)
paymentId — paymentId of the associated payment
paymentIdentifier — paymentIdentifier (invoice number) of the associated payment
Response {"ids":[...],"success":true}

Check

Call POST /api/ticket/check
Description This request will set the checked property to true and the lastChecked property to the current date. Returns the ticket if a ticket was found.
Parameters You have to provide either the identifier or the displayIdentifier parameter.
identifier — the ticket's identifier (the scanned barcode)
displayIdentifier — the ticket's displayIdentifier (e.g. 1234-5678-9012)
readOnly — whether you want to set the checked and the lastChecked property or not (default: false)
All follwing parameters are optional:
checkedDate — The date/time the check-in happened (Default: current time)
tool — The name of the tool calling this API (e.g. "Company Check-In iOS v2.5")
device — A name of the device that is calling this API (e.g. "iPad 1234", "Hostess A", "Entrance A", "Main Entrance")
source — The source how the ticket identifier was identified. Valid values are: SEARCH, PASSBOOK, MOBILE_TICKET, ETICKET, PAPER_TICKET
Response {"ticket":{...},"success":true}.
Errors com.amiando.api.rest.InvalidDavaluationSource

com.amiando.api.rest.InvalidParam
General Errorcodes

Reset

Call POST /api/ticket/reset
Description This request will set the checked property to false. The lastChecked property will not be changed. Returns the ticket if a ticket was found.
Parameters You have to provide either the identifier or the displayIdentifier parameter.
identifier — the ticket's identifier (the scanned barcode)
displayIdentifier — the ticket's displayIdentifier (e.g. 1234-5678-9012)
All follwing parameters are optional:
checkedDate — The date/time the check-in happened (Default: current time)
tool — The name of the tool calling this API (e.g. "Company Check-In iOS v2.5")
device — A name of the device that is calling this API (e.g. "iPad 1234", "Hostess A", "Entrance A", "Main Entrance")
source — The source how the ticket identifier was identified. Valid values are: SEARCH, PASSBOOK, MOBILE_TICKET, ETICKET, PAPER_TICKET
Response {"ticket":{...},"success":true}.
Errors com.amiando.api.rest.InvalidParam

See General Errorcodes.

Enumerate tickets

Call GET /api/payment/<id>/tickets
See Enumerate tickets

Enumerate products

Call GET /api/ticket/<id>/products
Description This request will return all existing (ordered) products for this ticket. Be careful there could also be some products belonging to the payment you bought/selected while buying this ticket.
Response {"products": {...}, "success":true}.
Errors See General Errorcodes.


Set UserDataFields

Important information: To use this call you need to sign a "data processing agreement". Please contact our support or your account manager if you didn't sign this agreement yet. As long as no "data processing agreement" is signed this call will return the error: com.amiando.api.rest.DataProcessingAgreementMissing

Call POST /api/ticket/<id>/userData
Description This request will set the given userDataField(s) to the given value(s). You can set fields on ticket level and on buyer level with this call. It is currently not possible to also use this to add additional products to the payment/ticket.
Parameters You have to send an existing <userFieldId> with the volitional value. To get the existing userDataFields you should have a look at the Events.Enumerate_userDataDefinitions call. You can set serveral userDataFileds with one call by separating the parameters with an "&" (e.g. <userFieldId>=foo&<otherUserFieldId>=bar). Sadly updating a user field of type "address" is currently not available.
Response {"success":true}.
Errors See General Errorcodes.

Ticket type

The ticketType property indicates the way the ticket will be / was delivered. Possible values are:

Ticket Type (read value)
Ticket Type (write value)
Description
com.amiando.ticket.type.Badge
Badge
Means that the ticket is a badge.
com.amiando.ticket.type.ETicket
ETicket
Means that the ticket will be sent via email.
com.amiando.ticket.type.Paper
Paper
Means that the ticket is a confirmation.
com.amiando.ticket.type.Confirmation
Confirmation
Means that the payment was bought using prepayment.
com.amiando.ticket.type.OnSite
OnSite
Means that the ticket was bought via EasyEntry.
REST API Contents
Getting Started Get your API key Overview Formats Errors
Data Types Event Participant Payment Ticket
Ticket Categories ProductDefinition Products CodeDefinition
TicketShop Addresses Ticket Types Payment Types
BankAccount UserDataDefinition UserData User
Partner ApiKey
Data Synchronization Sync Interface