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

REST API ProductDefinition

From XING Events Developer Documentation
Jump to: navigation, search

This page contains information about the properties regarding the product definitions. A product definition describes the available additional products offered in an event.

Additional products can be offered in an event in four different representation forms:

  • Checkbox
  • Drop down
  • Radio button
  • Donation (this field gives the buyer the possibility to enter an amount of his choice)

To get the ID of the product definitions in an event use: Events.Enumerate product definitions


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 product definition.
available
Integer
R--
The amount of products of this type that are still available to the ticket buyers (not available for the donation type).
type
String
R--
The type of the product. This can either be "PAYMENT" meaning that this product is offered per payment or "TICKET" if the product is offered per ticket.
title
String
R--
The title/name of the product as it is shown to the ticket buyer.
vat
Percentage
R--
The VAT for this product (only available if different from the event VAT). 1.5% = 150, 19% = 1900.
options Array of Product Options
R--
In this array the options the ticket buyer can choose from is listed. In case of a checkbox or donation field this always only contains one item. Radio buttons and drop down boxes may contain multiple items.

Methods

Read

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


Product Options

The options property returns an array of Product Option objects. These objects provide the ID and further information of the product option made available to the ticket buyer. If a ticket buyer has bought a product you will find this ID in the payment/ticket/participant information of that buying process identifying what product exactly the user chose.
In case of a checkbox or donation field this always only contains one item. Radio buttons and drop down boxes may contain multiple items.
These are the properties of this objects:

Property
Type
Description
productDefinitionOptionName
String
The title/name of this product option as shown to the ticket buyer (e.g. one item in a drop down box).
productDefinitionOptionId
Integer
Is internal ID of this option (this is the ID you will get if you read what product a ticket buyer has selected).
available
Integer
The amount of products of this type that are still available to the ticket buyers (not available for the donation type).
price
Money
The price of the product (not available for the donation type).
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
Partner ApiKey
Data Synchronization Sync Interface