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

Difference between revisions of "REST API TicketShops"

From XING Events Developer Documentation
Jump to: navigation, search
Line 37: Line 37:
 
| feeInclusive  
 
| feeInclusive  
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
 
| Wether the fee will be included in the ticket price or not.
 
| Wether the fee will be included in the ticket price or not.
 
|-valign="top"
 
|-valign="top"
 
| shipmentFeeInclusive  
 
| shipmentFeeInclusive  
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
 
| Wether the shipment fee will be included in the ticket price or not.
 
| Wether the shipment fee will be included in the ticket price or not.
 
|-valign="top"
 
|-valign="top"
 
| commercial  
 
| commercial  
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
 
| Wether the event is a commercial event. Only commercial events have <tt>salesTax</tt>.
 
| Wether the event is a commercial event. Only commercial events have <tt>salesTax</tt>.
 
|-valign="top"
 
|-valign="top"
 
| salesTax  
 
| salesTax  
 
| [[REST_API_Formats#Integer|Integer]]
 
| [[REST_API_Formats#Integer|Integer]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
 
| For commercial events, the sales tax. 1% = 100, 19% = 1900.
 
| For commercial events, the sales tax. 1% = 100, 19% = 1900.
 
|-valign="top"
 
|-valign="top"
 
| availableLimit  
 
| availableLimit  
 
| [[REST_API_Formats#Integer|Integer]]
 
| [[REST_API_Formats#Integer|Integer]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
 
| The global number of available tickets across all ticket categories.
 
| The global number of available tickets across all ticket categories.
 
|-valign="top"
 
|-valign="top"
 
| showAvailableTickets  
 
| showAvailableTickets  
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
 
| Wether the number of available tickets will be shown in the ticket shop or not.
 
| Wether the number of available tickets will be shown in the ticket shop or not.
 
|-valign="top"
 
|-valign="top"
 
| currency
 
| currency
 
| [[REST_API_Formats#Currency|Currency]]
 
| [[REST_API_Formats#Currency|Currency]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
 
| The currency of the ticket shop.
 
| The currency of the ticket shop.
 
|-valign="top"
 
|-valign="top"
 
| cancelationPossible
 
| cancelationPossible
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
 
| Do you want to allow the cancelation of ticket pruchases?
 
| Do you want to allow the cancelation of ticket pruchases?
 
|-valign="top"
 
|-valign="top"
Line 92: Line 92:
 
| collectUserData
 
| collectUserData
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
 
| Should user data be collected in the ticketshop?
 
| Should user data be collected in the ticketshop?
 
|-valign="top"
 
|-valign="top"

Revision as of 13:34, 27 August 2010

Object type: ticketShop

This page contains information about all properties and methods regarding the ticket shop, 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--
The internal id of this object.
disagio
String
R--
The disagio of the ticket shop.
ticketBaseFee
Money R--
The base fee of the ticket shop.
productDisagio
Integer R--
The disagio for products sold through this ticket shop.
feeInclusive Boolean RW-
Wether the fee will be included in the ticket price or not.
shipmentFeeInclusive Boolean RW-
Wether the shipment fee will be included in the ticket price or not.
commercial Boolean RW-
Wether the event is a commercial event. Only commercial events have salesTax.
salesTax Integer RW-
For commercial events, the sales tax. 1% = 100, 19% = 1900.
availableLimit Integer RW-
The global number of available tickets across all ticket categories.
showAvailableTickets Boolean RW-
Wether the number of available tickets will be shown in the ticket shop or not.
currency Currency RW-
The currency of the ticket shop.
cancelationPossible Boolean RW-
Do you want to allow the cancelation of ticket pruchases?
numTicketsSold Integer R--
The global number of sold tickets for this ticket shop.
totalIncome Money R--
The total amount of income generated with this ticket shop.
totalFees Money R--
The total amount of fees generated with this ticket shop.
collectUserData Boolean RW-
Should user data be collected in the ticketshop?
maxPossibleNumberOfParticipants Integer R--
The maximum number of participants for this event.

Methods

Read

Call GET /api/event/<id>/ticketShop
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 {"ticketShop":{...}, "success":true}.
Errors See General Errorcodes.

Update

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