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 Tickets"

From XING Events Developer Documentation
Jump to: navigation, search
Line 61: Line 61:
 
| [[REST_API_Formats#Currency|Currency]]
 
| [[REST_API_Formats#Currency|Currency]]
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
|  
+
| The fee for EventSense(R).
 
|-valign="top"
 
|-valign="top"
 
| productPrice
 
| productPrice
 
| [[REST_API_Formats#Currency|Currency]]
 
| [[REST_API_Formats#Currency|Currency]]
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
|  
+
| The price of the product, if there was a product purchase.
 
|-valign="top"
 
|-valign="top"
 
| productFee
 
| productFee
 
| [[REST_API_Formats#Currency|Currency]]
 
| [[REST_API_Formats#Currency|Currency]]
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
|  
+
| The fee of the product purchase.
 
|-valign="top"
 
|-valign="top"
 
| discountAmount
 
| discountAmount
 
| [[REST_API_Formats#Currency|Currency]]
 
| [[REST_API_Formats#Currency|Currency]]
 
| <tt>R--</tt><br>  
 
| <tt>R--</tt><br>  
|  
+
| The amount of discount included in this ticket purchase.
 
|-valign="top"
 
|-valign="top"
 
| cancelled
 
| cancelled
Line 83: Line 83:
 
| The date of the cancelation or <tt>null</tt>.
 
| The date of the cancelation or <tt>null</tt>.
 
|}
 
|}
 
== Objects ==
 
Objects inside an ticket object can be accessed through URLs like <tt>/api/ticket/<id>/<object></tt>. For example <tt>/api/ticket/345543/???</tt>.
 
  
 
{| cellspacing="0" cellpadding="2" border="0" style="width: 745px;"
 
{| cellspacing="0" cellpadding="2" border="0" style="width: 745px;"

Revision as of 16:16, 16 July 2010

This page contains information about all properties and methods regarding tickets.

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.
displayIdentifier
String
R--
The public identifier of the ticket.
firstName
String
R--
The first name of the ticket buyer.
lastName String
R--
The last name of the ticket buyer.
email String
R--
The email of the ticket buyer.
ticketFee Currency R--
The fee amount paid for this ticket.
originalPrice Currency R--
The original price of the ticket.
amiandoFee Currency R--
The amiando fee amount paid for this ticket.
ticketRevenue Currency R--
The revenue generated with this ticket.
eventSenseFee Currency R--
The fee for EventSense(R).
productPrice Currency R--
The price of the product, if there was a product purchase.
productFee Currency R--
The fee of the product purchase.
discountAmount Currency R--
The amount of discount included in this ticket purchase.
cancelled Date R--
The date of the cancelation or null.
Name
Description
??? Detailed information about the of the ticket.

Methods

Read

Call GET /api/ticket/<id>
Description This request will return the ticket object with the specified internal id. The response contains all properties marked with R.
Response {"ticket":{"firstName": ...}, "success":true}.
Errors See General Errorcodes.