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 Partner

From XING Events Developer Documentation
Jump to: navigation, search

Object type: partner

Properties

Partner objects provide the following 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 database id of this object.
adminId
Integer
R-C
The user Id of the partner's admin.
required
name
String
RWC
The name of the partner.
required
language
Language
RWC
Choose, in which language the ticketshop and the ticketshop wizard will be shown.
required
defaultCountry
String
RWC
Is used for presetting the country and the currency the events will take place in.
required
subdomain
String
RWC
Has to be used for the requests of files from XING Events. optional
url
String
RWC
The URL of the partner site.
optional
menuCssUrl
String
RWC
Url of CSS file to personalize the event setup menu.
optional
ticketShopCssUrl
String
RWC
Url of CSS file to personalize your event site and ticket shop.
optional
ssoCallback
String
RWC
Url of the SSO (Single Sign On) callback.
optional
referrerPartnerId
Integer
--C
The id of the partner this partner was referred by.
optional

Methods

Read

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

Create

Call POST /api/partner/create
Parameters All properties marked with C. Required are name, adminId, language and defaultCountry.
Description This request will create an partner and will return the internal id.
Response {"id":<internal id>,"success":true}.
com.amiando.Partner.NoLanguage
com.amiando.Partner.UnsupportedLanguage
com.amiando.Partner.InvalidCountry
com.amiando.Partner.NoName
com.amiando.api.rest.ObjectNotFound
com.amiando.api.rest.PartnerAlreadyExists
See General Errorcodes.

Update

Call POST /api/partner/<id>
Parameters All properties marked with W.
Description This request will update the properties of the partner with the internal id <id>. Only properties which are provided as parameters will be updated.
Response {"success":true}.
Errors com.amiando.Partner.NoLanguage
com.amiando.Partner.UnsupportedLanguage
com.amiando.Partner.InvalidCountry
com.amiando.Partner.NoName
See General Errorcodes.

Enumerate Events

Call GET /api/partner/<id>/events
Description This request will return all the specified internal ids of the partner's events.
Response {"events":[...], "id":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