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
(Properties)
 
(17 intermediate revisions by the same user not shown)
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: 935px;"
+
{| cellspacing="0" cellpadding="2" border="0" style="width: 935px;" class="properties"
 
|-
 
|-
 
! bgcolor="#cccccc" align="left" scope="col" | Property<br>  
 
! bgcolor="#cccccc" align="left" scope="col" | Property<br>  
Line 20: 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"
 +
| closeDate<br>
 +
| [[REST_API_Formats#Date|Date]]<br>
 +
| <tt>R--</tt><br>
 +
| The date/time the shop will be closed and no new purchases can be done anymore. This is matching the event's end date or if none is set the event start date plus 7 days.<br>(Side note: This ignores a possibly set value for the <em>registrationEndDate</em> as that one only closes the shop for the public. In theory user might still be able to purchase tickets with a promotion code.)<br>
 +
|
 +
|-valign="top"
 +
| registrationStartDate<br>
 +
| [[REST_API_Formats#Date|Date]]<br>
 +
| <tt>RW-</tt><br>
 +
| The date/time the shop will be open for the public (in case not all categories are hidden by a promotion code anyway). Users would still be able to buy a ticket before this date if you provide them with an unlocking promotion code.<br>If it is not set (default) the shop opens immediately after the event activation.<br>
 +
|
 +
|-valign="top"
 +
| registrationEndDate<br>
 +
| [[REST_API_Formats#Date|Date]]<br>
 +
| <tt>RW-</tt><br>
 +
| The date/time the shop will be closed for the public. Users will still be able to buy a ticket after this date if you provide them with an unlocking promotion code.<br>If it is not set (default) the shop closes at the date provided in the property <em>closeDate</em>.<br>
 +
|
 +
|-valign="top"
 +
| closed<br>
 +
| [[REST_API_Formats#Boolean|Boolean]]<br>
 +
| <tt>R--</tt><br>
 +
| Is true if the event is in the past or cancelled (if event is still in demo mode, this property is always false).<br>
 
|
 
|
 
|-valign="top"
 
|-valign="top"
 
| disagio<br>  
 
| disagio<br>  
| [[REST_API_Formats#String|String]]<br>  
+
| [[REST_API_Formats#Percentage|Percentage]]<br>  
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
| The disagio of the ticket.  
+
| The disagio (percentage fee) in this event.
 
|  
 
|  
 
|-valign="top"
 
|-valign="top"
Line 31: Line 55:
 
| [[REST_API_Formats#Money|Money]]
 
| [[REST_API_Formats#Money|Money]]
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
| The base fee of the ticket shop.
+
| The base fee (gross) per ticket in this event.
 
|  
 
|  
 
|-valign="top"
 
|-valign="top"
Line 37: Line 61:
 
| [[REST_API_Formats#Integer|Integer]]
 
| [[REST_API_Formats#Integer|Integer]]
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
| The disagio for products sold through this ticket shop.
+
| The disagio (percentage fee) for products sold through this ticket shop.
 
|  
 
|  
 
|-valign="top"
 
|-valign="top"
Line 44: Line 68:
 
| <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>
+
| Default: <tt>true</tt>
 
|-valign="top"
 
|-valign="top"
 
| shipmentFeeInclusive  
 
| shipmentFeeInclusive  
Line 67: Line 91:
 
| [[REST_API_Formats#Integer|Integer]]
 
| [[REST_API_Formats#Integer|Integer]]
 
| <tt>RW-</tt><br>  
 
| <tt>RW-</tt><br>  
| The global number of available tickets across all ticket categories. Hidden categories are counted, too.
+
| The global number of available tickets in this event.
 
| Default: <tt>null</tt>
 
| Default: <tt>null</tt>
 
|-valign="top"
 
|-valign="top"
Line 86: Line 110:
 
| <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>
+
| Default: <tt>true</tt>
 +
|-valign="top"
 +
| ticketsEditable
 +
| [[REST_API_Formats#Boolean|Boolean]]
 +
| <tt>RW-</tt><br>
 +
| Is the buyer allowed to edit the ticket data after the purchase
 +
| Default: <tt>true</tt>
 
|-valign="top"
 
|-valign="top"
 
| ticketsTransferable
 
| ticketsTransferable
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| [[REST_API_Formats#Boolean|Boolean]]
 
| <tt>RW-</tt><br>  
 
| <tt>RW-</tt><br>  
| Should tickets be tranferable to another person?
+
| Is it allowed to transfer the ticket to another person after the purchase
| Default: <tt>false</tt>
+
| Default: <tt>true</tt>
 
|-valign="top"
 
|-valign="top"
 
| numTicketsSold  
 
| numTicketsSold  
Line 103: Line 133:
 
| [[REST_API_Formats#Money|Money]]
 
| [[REST_API_Formats#Money|Money]]
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
| The total amount of income generated with this ticket shop.
+
| The total gross amount of income generated with this ticket shop.
 
|
 
|
 
|-valign="top"
 
|-valign="top"
Line 109: Line 139:
 
| [[REST_API_Formats#Money|Money]]
 
| [[REST_API_Formats#Money|Money]]
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
| The total amount of fees generated with this ticket shop.
+
| The total gross amount of fees generated with this ticket shop.
 
|
 
|
 
|-valign="top"
 
|-valign="top"
Line 116: Line 146:
 
| <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>
+
| Default: <tt>true</tt>
 
|-valign="top"
 
|-valign="top"
 
| maxPossibleNumberOfParticipants
 
| maxPossibleNumberOfParticipants
Line 139: Line 169:
 
| [[REST_API_Formats#URL|URL]]
 
| [[REST_API_Formats#URL|URL]]
 
| <tt>RW-</tt><br>  
 
| <tt>RW-</tt><br>  
| URL to additional terms and conditions of the event.
+
| URL to the organizer's terms and conditions.
 +
|
 +
|-valign="top"
 +
| ownPrivacyPolicy
 +
| [[REST_API_Formats#URL|URL]]
 +
| <tt>RW-</tt><br>
 +
| URL to the organizer's privacy policy.
 
|
 
|
 
|}
 
|}
Line 146: Line 182:
  
 
===Read===
 
===Read===
{| cellspacing="0" cellpadding="2" border="0" style="width: 745px;"
+
{| cellspacing="0" cellpadding="2" border="0" style="width: 933px;"
 
|-valign="top"
 
|-valign="top"
 
| width="100px" | '''Call'''
 
| width="100px" | '''Call'''
Line 162: Line 198:
  
 
===Update===
 
===Update===
{| cellspacing="0" cellpadding="2" border="0" style="width: 745px;"
+
{| cellspacing="0" cellpadding="2" border="0" style="width: 933px;"
 
|-valign="top"
 
|-valign="top"
 
| width="100px" | '''Call'''
 
| width="100px" | '''Call'''
Line 177: Line 213:
 
|-valign="top"
 
|-valign="top"
 
| '''Errors'''
 
| '''Errors'''
| <tt>[[REST_API_ErrorCodes#Can.27t_change_currency|com.amiando.ticketShop.cantChangeCurrency]]</tt><br>See [[REST API ErrorCodes#General_Errorcodes|General Errorcodes]].
+
| <tt>[[REST_API_ErrorCodes#Registration_deadline_invalid|com.amiando.ticketshop.registrationDateValidationError]]</tt><br/><tt>[[REST_API_ErrorCodes#Can.27t_change_currency|com.amiando.ticketShop.cantChangeCurrency]]</tt><br/>See [[REST API ErrorCodes#General_Errorcodes|General Errorcodes]].
 
|}
 
|}
  

Latest revision as of 10:29, 9 September 2019

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.
closeDate
Date
R--
The date/time the shop will be closed and no new purchases can be done anymore. This is matching the event's end date or if none is set the event start date plus 7 days.
(Side note: This ignores a possibly set value for the registrationEndDate as that one only closes the shop for the public. In theory user might still be able to purchase tickets with a promotion code.)
registrationStartDate
Date
RW-
The date/time the shop will be open for the public (in case not all categories are hidden by a promotion code anyway). Users would still be able to buy a ticket before this date if you provide them with an unlocking promotion code.
If it is not set (default) the shop opens immediately after the event activation.
registrationEndDate
Date
RW-
The date/time the shop will be closed for the public. Users will still be able to buy a ticket after this date if you provide them with an unlocking promotion code.
If it is not set (default) the shop closes at the date provided in the property closeDate.
closed
Boolean
R--
Is true if the event is in the past or cancelled (if event is still in demo mode, this property is always false).
disagio
Percentage
R--
The disagio (percentage fee) in this event.
ticketBaseFee
Money R--
The base fee (gross) per ticket in this event.
productDisagio
Integer R--
The disagio (percentage fee) for products sold through this ticket shop.
feeInclusive Boolean RW-
Wether the fee will be included in the ticket price or not. Default: true
shipmentFeeInclusive Boolean RW-
Wether the shipment fee will be included in the ticket price or not.
Deprecated! This feature is not supported anymore and will always be set to false
Default: false
commercial Boolean RW-
Wether the event is a commercial event. Only commercial events have salesTax. Default: true
salesTax Percentage RW-
For commercial events, the sales tax. 1% = 100, 19% = 1900. Default: depends on country
availableLimit Integer RW-
The global number of available tickets in this event. 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: true
ticketsEditable Boolean RW-
Is the buyer allowed to edit the ticket data after the purchase Default: true
ticketsTransferable Boolean RW-
Is it allowed to transfer the ticket to another person after the purchase Default: true
numTicketsSold Integer R--
The global number of sold tickets for this ticket shop.
totalIncome Money R--
The total gross amount of income generated with this ticket shop.
totalFees Money R--
The total gross amount of fees generated with this ticket shop.
collectUserData Boolean RW-
Should user data be collected in the ticketshop? Default: true
maxPossibleNumberOfParticipants Integer R--
The maximum number of participants for this event.
numTicketsChecked Integer R--
The number of checked tickets of this ticket shop.
vatId String RW-
The VAT ID of this ticket shop.
ownTermsAndConditions URL RW-
URL to the organizer's terms and conditions.
ownPrivacyPolicy URL RW-
URL to the organizer's privacy policy.

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.registrationDateValidationError
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