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
(Undo revision 659 by Fbarnsteiner (Talk))
Line 3: Line 3:
 
'''Object type: '''<tt>ticketShop</tt>
 
'''Object type: '''<tt>ticketShop</tt>
  
This page contains information about all properties and methods regarding the ticket category, a single sub-object of event.
+
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 [[REST_API_Events|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 ==
 
== Properties ==
Line 19: Line 19:
 
| [[REST_API_Formats#Integer|Integer]]<br>  
 
| [[REST_API_Formats#Integer|Integer]]<br>  
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
| Internal id of this object.<br>
+
| The internal id of this object.<br>
 
|
 
|
 
|-valign="top"
 
|-valign="top"
| name<br>  
+
| disagio<br>  
 
| [[REST_API_Formats#String|String]]<br>  
 
| [[REST_API_Formats#String|String]]<br>  
| <tt>RWC</tt><br>  
+
| <tt>R--</tt><br>  
| The name of the category.<br>
+
| The disagio of the ticket.  
| '''required'''
+
|  
 
|-valign="top"
 
|-valign="top"
| price<br>  
+
| ticketBaseFee<br>  
| [[REST_API_Formats#String|String]]<br>
+
| [[REST_API_Formats#Money|Money]]
| <tt>RWC</tt><br>  
+
| <tt>R--</tt><br>  
| The price of the category.<br>
+
| The base fee of the ticket shop.
| '''required'''
+
|  
 
|-valign="top"
 
|-valign="top"
| available<br>  
+
| productDisagio<br>  
| [[REST_API_Formats#Integer|Integer]]<br>
+
| [[REST_API_Formats#Integer|Integer]]
| <tt>RWC</tt><br>
 
| The number of available tickets.<br>
 
| '''required'''
 
|-valign="top"
 
| sold<br>
 
| [[REST_API_Formats#Integer|Integer]]<br>
 
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
| The number of sold tickets.<br>
+
| The disagio for products sold through this ticket shop.
|
+
|  
 
|-valign="top"
 
|-valign="top"
| reservedCount<br>
+
| feeInclusive
| [[REST_API_Formats#Integer|Integer]]<br>
+
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>R--</tt><br>  
+
| <tt>RW-</tt><br>  
| The number of reserved Tickets.<br>
+
| Wether the fee will be included in the ticket price or not.
|
+
| Default: <tt>false</tt>
 
|-valign="top"
 
|-valign="top"
| saleStart<br>
+
| shipmentFeeInclusive
| [[REST_API_Formats#Date|Date]]<br>
+
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
| The start date of the sale.<br>
+
| Wether the shipment fee will be included in the ticket price or not.
|
+
| Default: <tt>false</tt>
 
|-valign="top"
 
|-valign="top"
| saleEnd<br>
+
| commercial
| [[REST_API_Formats#Date|Date]]<br>
+
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
| The end date of the sale.  
+
| Wether the event is a commercial event. Only commercial events have <tt>salesTax</tt>.
|  
+
| Default: <tt>true</tt>
 
|-valign="top"
 
|-valign="top"
| minSell<br>
+
| salesTax
 
| [[REST_API_Formats#Integer|Integer]]
 
| [[REST_API_Formats#Integer|Integer]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
| The minimum tickets that must be bought of the category (per buy process).
+
| For commercial events, the sales tax. 1% = 100, 19% = 1900.
|  
+
| Default: depends on country
 
|-valign="top"
 
|-valign="top"
| maxSell<br>
+
| availableLimit
 
| [[REST_API_Formats#Integer|Integer]]
 
| [[REST_API_Formats#Integer|Integer]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
| The maximum of tickets that can be bought of the category (per buy process).
+
| The global number of available tickets across all ticket categories.
|  
+
| Default: <tt>null</tt>
 +
|-valign="top"
 +
| showAvailableTickets
 +
| [[REST_API_Formats#Boolean|Boolean]]
 +
| <tt>RW-</tt><br>
 +
| Wether the number of available tickets will be shown in the ticket shop or not.
 +
| Default: <tt>true</tt>
 
|-valign="top"
 
|-valign="top"
| defaultValue
+
| currency
| [[REST_API_Formats#Integer|Integer]]
+
| [[REST_API_Formats#Currency|Currency]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
| The default value of the amount-dropdown for this category.
+
| The currency of the ticket shop.
|
+
| Default: <tt>EUR</tt>
 
|-valign="top"
 
|-valign="top"
| minSellRequired
+
| cancelationPossible
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
| Does the user have to buy the minimum selling limit?
+
| Do you want to allow the cancelation of ticket pruchases?
 
| Default: <tt>false</tt>
 
| Default: <tt>false</tt>
|
 
 
|-valign="top"
 
|-valign="top"
| comment
+
| numTicketsSold
| [[REST_API_Formats#String|String]]
+
| [[REST_API_Formats#Integer|Integer]]
| <tt>RWC</tt><br>  
+
| <tt>R--</tt><br>  
| Comment that will be shown on the ticket.
+
| The global number of sold tickets for this ticket shop.
 
|
 
|
 
|-valign="top"
 
|-valign="top"
| ticketDescription
+
| totalIncome
| [[REST_API_Formats#String|String]]
+
| [[REST_API_Formats#Money|Money]]
| <tt>RWC</tt><br>  
+
| <tt>R--</tt><br>  
| Description of the ticket category.
+
| The total amount of income generated with this ticket shop.
 
|
 
|
 
|-valign="top"
 
|-valign="top"
| active
+
| totalFees
| [[REST_API_Formats#Boolean|Boolean]]
+
| [[REST_API_Formats#Money|Money]]
| <tt>RWC</tt><br>  
+
| <tt>R--</tt><br>  
| Wether the ticket category is active (tickets can be bought) or not.
+
| The total amount of fees generated with this ticket shop.
| Default: <tt>true</tt>
 
 
|
 
|
 
|-valign="top"
 
|-valign="top"
| displayPrice
+
| collectUserData
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| [[REST_API_Formats#Boolean|Boolean]]
| <tt>RWC</tt><br>  
+
| <tt>RW-</tt><br>  
| Should the price Option be displayed (registration event only)?
+
| Should user data be collected in the ticketshop?
 
| Default: <tt>false</tt>
 
| Default: <tt>false</tt>
|
 
 
|-valign="top"
 
|-valign="top"
| displayQuantity
+
| maxPossibleNumberOfParticipants
| [[REST_API_Formats#Boolean|Boolean]]
+
| [[REST_API_Formats#Integer|Integer]]
| <tt>RWC</tt><br>  
+
| <tt>R--</tt><br>  
| Should the quantity option be displayed (registration event only)?
+
| The maximum number of participants for this event.
| Default: <tt>false</tt>
 
 
|
 
|
|-valign="top"
 
| priceEditable
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| <tt>R--</tt><br>
 
| Whether the price of the category is editable, or not<br>(returns <tt>true</tt> if the associated event is in demo mode or if no tickets where sold already).
 
 
|}
 
|}
  
 
==Methods==
 
==Methods==
  
===Create===
+
===Read===
 
{| cellspacing="0" cellpadding="2" border="0" style="width: 745px;"
 
{| cellspacing="0" cellpadding="2" border="0" style="width: 745px;"
 
|-valign="top"
 
|-valign="top"
 
| width="100px" | '''Call'''
 
| width="100px" | '''Call'''
| <tt>'''POST''' /api/ticketCategory/create</tt>
+
| <tt>'''GET''' /api/event/<id>/ticketShop</tt>
 
|-valign="top"
 
|-valign="top"
 
| '''Description'''
 
| '''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.
+
| This request will return the ticket shop object of the event with the specified internal id. The response contains all properties marked with '''R'''.
 
|-valign="top"
 
|-valign="top"
 
| '''Response'''
 
| '''Response'''
| <tt>{"id":<internal id>, "success":true}</tt>.
+
| <tt>{"ticketShop":{...}, "success":true}</tt>.
 
|-valign="top"
 
|-valign="top"
 
| '''Errors'''
 
| '''Errors'''
| <tt>[[REST API ErrorCodes#Name_missing|com.amiando.TicketCategory.NameMissing]]</tt><br><tt>[[REST API ErrorCodes#Price_missing|com.amiando.TicketCategory.PriceMissing]]</tt><br><tt>[[REST API ErrorCodes#Price_too_low|com.amiando.TicketCategory.PriceTooLow]]</tt><br><tt>[[REST API ErrorCodes#No_tickets_available|com.amiando.TicketCategory.NoTicketsAvailable]]</tt><br><tt>[[REST API ErrorCodes#Invalid_max_sell|com.amiando.TicketCategory.InvalidMaxSell]]</tt><br><tt>[[REST API ErrorCodes#Max_sell_lower_than_min_sell|com.amiando.TicketCategory.MaxSellLowerThanMinSell]]</tt><br><tt>[[REST API ErrorCodes#Sale_end_before_sale_start|com.amiando.TicketCategory.SaleEndBeforeSaleStart]]</tt><br><tt>[[REST API ErrorCodes#Comment_too_long|com.amiando.TicketCategory.CommentTooLong]]</tt><br><tt>[[REST API ErrorCodes#Cant_edit_price|com.amiando.api.rest.CantEditPrice]]</tt><br>See [[REST API ErrorCodes#General_errorcodes|General Errorcodes]].
+
| See [[REST API ErrorCodes#General_Errorcodes|General Errorcodes]].
 
|}
 
|}
  
Line 150: Line 141:
 
|-valign="top"
 
|-valign="top"
 
| width="100px" | '''Call'''
 
| width="100px" | '''Call'''
| <tt>'''POST''' /api/ticketCategory/<id></tt>
+
| <tt>'''POST''' /api/event/<id>/ticketShop</tt>
 +
|-valign="top"
 +
| '''Parameters'''
 +
| All properties marked with '''W'''.
 
|-valign="top"
 
|-valign="top"
 
| '''Description'''
 
| '''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.
+
| 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.
 
|-valign="top"
 
|-valign="top"
 
| '''Response'''
 
| '''Response'''
Line 159: Line 153:
 
|-valign="top"
 
|-valign="top"
 
| '''Errors'''
 
| '''Errors'''
| <tt>[[REST API ErrorCodes#Name_missing|com.amiando.TicketCategory.NameMissing]]</tt><br><tt>[[REST API ErrorCodes#Price_missing|com.amiando.TicketCategory.PriceMissing]]</tt><br><tt>[[REST API ErrorCodes#Price_too_low|com.amiando.TicketCategory.PriceTooLow]]</tt><br><tt>[[REST API ErrorCodes#No_tickets_available|com.amiando.TicketCategory.NoTicketsAvailable]]</tt><br><tt>[[REST API ErrorCodes#Invalid_max_sell|com.amiando.TicketCategory.InvalidMaxSell]]</tt><br><tt>[[REST API ErrorCodes#Max_sell_lower_than_min_sell|com.amiando.TicketCategory.MaxSellLowerThanMinSell]]</tt><br><tt>[[REST API ErrorCodes#Sale_end_before_sale_start|com.amiando.TicketCategory.SaleEndBeforeSaleStart]]</tt><br><tt>[[REST API ErrorCodes#Comment_too_long|com.amiando.TicketCategory.CommentTooLong]]</tt><br><tt>[[REST API ErrorCodes#Cant_edit_price|com.amiando.api.rest.CantEditPrice]]</tt><br>See [[REST API ErrorCodes#General_errorcodes|General Errorcodes]].
+
| <tt>[[REST_API_ErrorCodes#Can.27t_change_currency|com.amiando.ticketShop.cantChangeCurrency]]</tt><br>See [[REST API ErrorCodes#General_Errorcodes|General Errorcodes]].
|}
 
 
 
===Enumeration===
 
{| cellspacing="0" cellpadding="2" border="0" style="width: 745px;"
 
|-valign="top"
 
| width="100px" | '''Call'''
 
| <tt>'''GET''' /api/event/<id>/ticketCategories</tt>
 
|-valign="top"
 
|
 
| See [[REST_API_Events#Enumerate_ticket_category_ids|Enumerate ticket category ids]]
 
|}
 
 
 
===Read===
 
{| cellspacing="0" cellpadding="2" border="0" style="width: 745px;"
 
|-valign="top"
 
| width="100px" | '''Call'''
 
| <tt>'''GET''' /api/ticketCategory/<id></tt>
 
|-valign="top"
 
| '''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.
 
|-valign="top"
 
| '''Response'''
 
| <tt>{"ticketCategory":{...}, "success":true}</tt>.
 
|-valign="top"
 
| '''Errors'''
 
| See [[REST API ErrorCodes#General_Errorcodes|General Errorcodes]].
 
 
|}
 
|}
 
  
 
[[Category:objectType]]
 
[[Category:objectType]]
  
 
{{Template:RESTNavigation}}
 
{{Template:RESTNavigation}}

Revision as of 09:24, 16 December 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