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 Products

From XING Events Developer Documentation
Jump to: navigation, search

This page contains information about all properties and methods regarding products. It is important to know that a product can belong to a ticket or to a payment. If the product belongs to a ticket you can buy/get for every ticket any of these products (e.g. you buy five tickets at once you can buy for each ticket one of these additional products). If the product belongs to a payment you can buy only one for each purchase (e.g. you buy five tickets at once you can buy only one of these additional products).

The available products in an event can be retrieved here: Events.Enumerate product definitions.
The products the attendee selected during his registration can be retrieved here: Payments.Enumerate products and Tickets.Enumerate products or directly from the attribute provided on the participant object: Participants.ProductInformation

Properties

Attributes: R - accessible in read requests W - accessible in write (update) requests C - accessible in create requests

Property
Type
Attributes Description
productCategoryOptionName
String
R--
The name of the choosen option of this product category.
productCategoryOptionId
Integer
R--
The id of the choosen option of this product category.
productCategoryName
String
R--
The nameof the product category the product belongs to.
productCategoryId
Integer
R--
The id of the product category the product belongs to.
productId
Integer
R--
The id of this product.
type String
R--
PAYMENT or TICKET, depending where this product belongs to.
checked String
RW-
The status weather this product is checked true or not false.


Methods

Read

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

Check

Call POST /api/product/<id>/check
Description This request will set the checked property to true. Returns the ticket if a ticket was found.
Parameters all parameters are optional:
tool — The name of the tool calling this API (e.g. "Company Check-In iOS v2.5")
device — A name of the device that is calling this API (e.g. "iPad 1234", "Hostess A", "Entrance A", "Main Entrance")
source — The source how the ticket identifier was identified. Valid values are: SEARCH, PASSBOOK, MOBILE_TICKET, ETICKET, PAPER_TICKET
Response {"product": {"productCategoryOptionName": ...},"success":true}.
Errors com.amiando.api.rest.InvalidDavaluationSource

com.amiando.api.rest.InvalidParam
General Errorcodes

Reset

Call POST /api/product/<id>/reset
Description This request will set the checked property to false. Returns the product if a product was found.
Parameters all parameters are optional:
tool — The name of the tool calling this API (e.g. "Company Check-In iOS v2.5")
device — A name of the device that is calling this API (e.g. "iPad 1234", "Hostess A", "Entrance A", "Main Entrance")
source — The source how the ticket identifier was identified. Valid values are: SEARCH, PASSBOOK, MOBILE_TICKET, ETICKET, PAPER_TICKET
Response {"product": {"productCategoryOptionName": ...},"success":true}.
Errors 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
Partner ApiKey
Data Synchronization Sync Interface