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 TicketShops

From XING Events Developer Documentation
Jump to: navigation, search

Object type: ticketShop

This page contains information about all properties and methods regarding the ticket category, a single sub-object of event.

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--
Internal id of this object.
name
String
RWC
The name of the category.
required
price
String
RWC
The price of the category.
required
available
Integer
RWC
The number of available tickets.
required
sold
Integer
R--
The number of sold tickets.
reservedCount
Integer
R--
The number of reserved Tickets.
saleStart
Date
RWC
The start date of the sale.
saleEnd
Date
RWC
The end date of the sale.
minSell
Integer RWC
The minimum tickets that must be bought of the category (per buy process).
maxSell
Integer RWC
The maximum of tickets that can be bought of the category (per buy process).
defaultValue Integer RWC
The default value of the amount-dropdown for this category.
minSellRequired Boolean RWC
Does the user have to buy the minimum selling limit? Default: false
comment String RWC
Comment that will be shown on the ticket.
ticketDescription String RWC
Description of the ticket category.
active Boolean RWC
Wether the ticket category is active (tickets can be bought) or not. Default: true
displayPrice Boolean RWC
Should the price Option be displayed (registration event only)? Default: false
displayQuantity Boolean RWC
Should the quantity option be displayed (registration event only)? Default: false
priceEditable Boolean R--
Whether the price of the category is editable, or not
(returns true if the associated event is in demo mode or if no tickets where sold already).

Methods

Create

Call POST /api/ticketCategory/create
Description This request will create an ticket category and will return the internal id. The internal id can be used for read or update requests.
Response {"id":<internal id>, "success":true}.
Errors com.amiando.TicketCategory.NameMissing
com.amiando.TicketCategory.PriceMissing
com.amiando.TicketCategory.PriceTooLow
com.amiando.TicketCategory.NoTicketsAvailable
com.amiando.TicketCategory.InvalidMaxSell
com.amiando.TicketCategory.MaxSellLowerThanMinSell
com.amiando.TicketCategory.SaleEndBeforeSaleStart
com.amiando.TicketCategory.CommentTooLong
com.amiando.api.rest.CantEditPrice
See General Errorcodes.

Update

Call POST /api/ticketCategory/<id>
Description This request will update the properties of the ticket category with the internal id <id>. Only properties which are provided as parameters will be updated.
Response {"success":true}.
Errors com.amiando.TicketCategory.NameMissing
com.amiando.TicketCategory.PriceMissing
com.amiando.TicketCategory.PriceTooLow
com.amiando.TicketCategory.NoTicketsAvailable
com.amiando.TicketCategory.InvalidMaxSell
com.amiando.TicketCategory.MaxSellLowerThanMinSell
com.amiando.TicketCategory.SaleEndBeforeSaleStart
com.amiando.TicketCategory.CommentTooLong
com.amiando.api.rest.CantEditPrice
See General Errorcodes.

Enumeration

Call GET /api/event/<id>/ticketCategories
See Enumerate ticket category ids

Read

Call GET /api/ticketCategory/<id>
Description This request will return the ticket shop object of the event with the specified internal id. The response contains all properties marked with R.
Response {"ticketCategory":{...}, "success":true}.
Errors See General Errorcodes.
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
ApiKey
Data Synchronization Sync Interface