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 8: Line 8:
 
Attributes: '''R''' - accessible in read requests '''W''' - accessible in write (update) requests '''C''' - accessible in create requests
 
Attributes: '''R''' - accessible in read requests '''W''' - accessible in write (update) requests '''C''' - accessible in create requests
  
{| cellspacing="0" cellpadding="2" border="0" style="width: 745px;"
+
{| cellspacing="0" cellpadding="2" border="0" style="width: 1024px;"
 
|-
 
|-
 
! bgcolor="#cccccc" align="left" scope="col" | Property<br>  
 
! bgcolor="#cccccc" align="left" scope="col" | Property<br>  
Line 14: Line 14:
 
! bgcolor="#cccccc" align="left" scope="col" | Attributes  
 
! bgcolor="#cccccc" align="left" scope="col" | Attributes  
 
! bgcolor="#cccccc" align="left" scope="col" | Description<br>
 
! bgcolor="#cccccc" align="left" scope="col" | Description<br>
 +
! bgcolor="#cccccc" align="left" scope="col" | <br>
 
|-valign="top"
 
|-valign="top"
 
| id<br>  
 
| id<br>  
Line 19: Line 20:
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
 
| The internal id of this object.<br>
 
| The internal id of this object.<br>
 +
|
 
|-valign="top"
 
|-valign="top"
 
| disagio<br>  
 
| disagio<br>  
 
| [[REST_API_Formats#String|String]]<br>  
 
| [[REST_API_Formats#String|String]]<br>  
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
| The disagio of the ticket shop.
+
| The disagio of the ticket.  
 +
|
 
|-valign="top"
 
|-valign="top"
 
| ticketBaseFee<br>  
 
| ticketBaseFee<br>  
Line 29: Line 32:
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
 
| The base fee of the ticket shop.
 
| The base fee of the ticket shop.
 +
|
 
|-valign="top"
 
|-valign="top"
 
| productDisagio<br>  
 
| productDisagio<br>  
Line 34: Line 38:
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
 
| The disagio for products sold through this ticket shop.
 
| The disagio for products sold through this ticket shop.
 +
|
 
|-valign="top"
 
|-valign="top"
 
| feeInclusive  
 
| feeInclusive  
Line 39: Line 44:
 
| <tt>RW-</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.
 +
| Default: <tt>false</tt>
 
|-valign="top"
 
|-valign="top"
 
| shipmentFeeInclusive  
 
| shipmentFeeInclusive  
Line 44: Line 50:
 
| <tt>RW-</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.
 +
| Default: <tt>false</tt>
 
|-valign="top"
 
|-valign="top"
 
| commercial  
 
| commercial  
Line 49: Line 56:
 
| <tt>RW-</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>.
 +
| Default: <tt>true</tt>
 
|-valign="top"
 
|-valign="top"
 
| salesTax  
 
| salesTax  
Line 54: Line 62:
 
| <tt>RW-</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.
 +
| Default: depends on country
 
|-valign="top"
 
|-valign="top"
 
| availableLimit  
 
| availableLimit  
Line 59: Line 68:
 
| <tt>RW-</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.
 +
| Default: <tt>null</tt>
 
|-valign="top"
 
|-valign="top"
 
| showAvailableTickets  
 
| showAvailableTickets  
Line 64: Line 74:
 
| <tt>RW-</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.
 +
| Default: <tt>true</tt>
 
|-valign="top"
 
|-valign="top"
 
| currency
 
| currency
Line 69: Line 80:
 
| <tt>RW-</tt><br>  
 
| <tt>RW-</tt><br>  
 
| The currency of the ticket shop.
 
| The currency of the ticket shop.
 +
| Default: <tt>EUR</tt>
 
|-valign="top"
 
|-valign="top"
 
| cancelationPossible
 
| cancelationPossible
Line 74: Line 86:
 
| <tt>RW-</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?
 +
| Default: <tt>false</tt>
 
|-valign="top"
 
|-valign="top"
 
| numTicketsSold  
 
| numTicketsSold  
Line 79: Line 92:
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
 
| The global number of sold tickets for this ticket shop.
 
| The global number of sold tickets for this ticket shop.
 +
|
 
|-valign="top"
 
|-valign="top"
 
| totalIncome
 
| totalIncome
Line 84: Line 98:
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
 
| The total amount of income generated with this ticket shop.
 
| The total amount of income generated with this ticket shop.
 +
|
 
|-valign="top"
 
|-valign="top"
 
| totalFees
 
| totalFees
Line 89: Line 104:
 
| <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"
 
|-valign="top"
 
| collectUserData
 
| collectUserData
Line 94: Line 110:
 
| <tt>RW-</tt><br>  
 
| <tt>RW-</tt><br>  
 
| Should user data be collected in the ticketshop?
 
| Should user data be collected in the ticketshop?
 +
| Default: <tt>false</tt>
 
|-valign="top"
 
|-valign="top"
 
| maxPossibleNumberOfParticipants
 
| maxPossibleNumberOfParticipants
Line 99: Line 116:
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
 
| The maximum number of participants for this event.
 
| The maximum number of participants for this event.
 +
|
 
|}
 
|}
  

Revision as of 14:08, 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. A ticketshop will automatically be created when you create an event. That's why you only have read and update access, but no create access. If you delete the related event, the ticketshop will also be deleted.

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.
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. Default: false
shipmentFeeInclusive Boolean RW-
Wether the shipment fee will be included in the ticket price or not. Default: false
commercial Boolean RW-
Wether the event is a commercial event. Only commercial events have salesTax. Default: true
salesTax Integer RW-
For commercial events, the sales tax. 1% = 100, 19% = 1900. Default: depends on country
availableLimit Integer RW-
The global number of available tickets across all ticket categories. Default: null
showAvailableTickets Boolean RW-
Wether the number of available tickets will be shown in the ticket shop or not. Default: true
currency Currency RW-
The currency of the ticket shop. Default: EUR
cancelationPossible Boolean RW-
Do you want to allow the cancelation of ticket pruchases? Default: false
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? Default: false
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.
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