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 94: Line 94:
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
 
| The total amount of fees generated with this ticket shop.
 
| The total amount of fees generated with this ticket shop.
 +
|-valign="top"
 +
| collectUserData
 +
| [[REST_API_Formats#Boolean|Boolean]]
 +
| <tt>RW-</tt><br>
 +
| Should user data be collected in the ticketshop?
 +
|-valign="top"
 +
| maxPossibleNumberOfParticipants
 +
| [[REST_API_Formats#Integer|Integer]]
 +
| <tt>R--</tt><br>
 +
| The maximum number of participants for this event.
 
|}
 
|}
  

Revision as of 07:56, 19 July 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--
paymentBaseFee String R--
ticketBaseFee
Money R--
productDisagio
Integer R--
feeInclusive Boolean RWC
Wether the fee will be included in the ticket price or not.
shipmentFeeInclusive Boolean RWC
Wether the shipment fee will be included in the ticket price or not.
commercial Boolean RWC
Wether the event is a commercial event. Only commercial events have salesTax.
salesTax Integer RWC
For commercial events, the sales tax. 1% = 100, 19% = 1900.
availableLimit Integer RWC
The global number of available tickets across all ticket categories.
showAvailableTickets Boolean RWC
Wether the number of available tickets will be shown in the ticket shop or not.
currency Currency RWC
The currency of the ticket shop.
cancelationPossible Boolean RWC
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.