REST API Events

Object type: event

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

For an example of the calls needed to create an event, see our example in the How-To section: Create an event with ticketing

Properties

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

Property	Type	Attributes	Description	Required/Optional
id	Integer	R--	The internal id of this object.
hostId	Integer	R-C	The internal id of the user, who will be the host of the event.	required
title	String	RWC	The title of the event.	required
country	Country	RWC	The country where the event will be held. This also determines the initial currency of the ticketshop.	required
selectedDate	Date	RWC	The start date of the event.	required
selectedEndDate	Date	RWC	The end date of the event.	optional (Default: null)
eventURL	URL	R--	The URL of the event page.
description	String	RWC	The long description of the event (HTML allowed).	optional (Default: null)
shortDescription	String	RWC	The short description of the event. Max 200 characters	optional (Default: null)
timezone	Timezone	RWC	The timezone of the event.	optional (Default: Europe/Berlin)
language	Language	RWC	The language of the event.	optional (Default: null)
identifier	String	RWC	The public identifier of the event. The event page will be accessible at www.xing-events.com/<identifier>.html.	optional (Default: random and unique string of 7 uppercase alphanumerics)
internalReference	String	RWC	Here you can specify any reference to identify this event (e.g. the event ID in your own event management software). Maximum 50 characters allowed.	optional
activated	Boolean	R--	Returns false if the event is still in draft mode.
eventType	String	RWC	The type of wording used in the event. Can either be TICKETS (for ticket sale events) or REGISTRATION (for registration form events)
organisatorDisplayName	String	RWC	The visible name of the organizer of the event.	optional (Default: name of host (see hostId))
organizerEmail	Email	RWC	Contact email for the ticket buyers	optional (Default: null)
partnerEventUrl	String	RWC	The url of your own event page if you do not want to use the XING Events event page to sell your tickets (there you should include our ticketshop IFrame).	optional (Default: null)
visibility	String	RWC	private or public Deprecated! Use the detailed information publishSearchEngines, visibilityOnXing and allowSharing	optional (Default: public)
deactivateEventPage	Boolean	RWC	Should the XING Events event page (https://www.xing-events.com/<identifier>.html) be available. If set to true, the page will show a 404.	optional (Default: false)
publishSearchEngines	Boolean	RWC	Should this event be visible to search engines?	optional (Default: true)
searchEngineTags	String	RWC	comma separated keywords if publishSearchEngines is true.	optional (Default: null)
makePublicInAPI	Boolean	RWC	Deprecated! Use the detailed information visibilityOnXing.	optional (Default: true)
visibilityOnXing	Boolean	RWC	Set the visibility setting of your Event page on XING. Possible values are: all (page is visible logged-in and logged-out) xing_members (page is only visible logged-in) private (page is only visible to the organizer, attendees and invited XING users)	optional (Default: all)
allowSharing	Boolean	RWC	Show sharing to social networks options to ticket buyers.	optional (Default: true)
location	String	RWC	The location of the event.	optional (Default: null)
locationDescription	String	RWC	The detailed description of the location of the event.	optional (Default: null)
longitude	Double	RWC	The longitude of the event.	optional (Default: 0)
latitude	Double	RWC	The latitude of the event.	optional (Default: 0)
street	String	RWC	The street of the event.	optional (Default: null)
street2	String	RWC	The street (2. field) of the event.	optional (Default: null)
zipCode	String	RWC	The zip code of the location of the event.	optional (Default: null)
city	String	RWC	The city where the event will be held.	optional (Default: null)
state	String	RWC	The state where the event will be held.	optional (Default: null)
isOnlineEvent	Boolean	RWC	True, if this event is an "online event" and is not taking place at a specific location.	optional (Default: false)
type	EventTypeEnum	RWC	The type of the event (Concert, Conference, ...)	optional (Default: null)
industry	IndustryEnum	RWC	The industry of the event (Academia, Acounting,...)	optional (Default: null)
logo	URL	R--	Link to logo image. Recommend image size: 1500 x 1500 pixel, minimum size 320 x 320 pixel. To upload a new picture, see Logo upload.
banner	URL	R--	Link to the banner image for the event page (must be 984 x 311 pixel). To upload a new picture, see Banner upload.
cancellationOption	CancellationOptionEnum	RWC	Are cancellation of purchases allowed in this event	optional (Default: NotAllowed)
products	array of products	R--	List of products availble in this event. Deprecated! Please use the "Enumerate product definition" function instead.
creationTime	Date	R--	The timestamp, when the event was created.
lastModified	Date	R--	The timestamp, when the event was last modified.

Objects

Objects inside an event object can be accessed through URLs like /api/event/<id>/<object>. For example /api/event/345543/ticketShop.

Name	Description
ticketShop	Detailed information about the ticketshop of the event.
ticketTypes	Detailed information about the ticketTypes of the event.

Methods

Find

Call	GET /api/event/find
Parameters	identifier — public identifier of the event to find title — title (or part of title) of the event to find A maximum of 100 search results will be returned by this call.
Response	{"ids":[...],"success":true}
Errors	See General Errorcodes.

Read

Call	GET /api/event/<id>
Description	This request will return the event object with the specified internal id. The response contains all properties marked with R.
Response	{"event":{"title": ...}, "success":true}. If you try to request an event that is archived by now (older then 3 to 4 years) the API will return a 403 {"success": false,"errors": ["com.amiando.api.rest.NotAuthorized"]}
Errors	See General Errorcodes.

Create

Call	POST /api/event/create
Parameters	All properties marked with C. Required are hostId, title, country and selectedDate.
Description	This request will create a ticket sale event and will return the internal id (the creation of registration form events is not available by the API). The internal id can be used for read or update requests.
Response	{"id":<internal id>,"success":true}.
Errors	com.amiando.Event.IdentifierExists com.amiando.Event.DateIsPast com.amiando.Event.EndDateBeforeDate com.amiando.Event.NoTitle com.amiando.Event.NoCountry com.amiando.Event.UnsupportedCountry com.amiando.Event.UnsupportedLanguage com.amiando.api.rest.InvalidVisibility See General Errorcodes.

Update

Call	POST /api/event/<id>
Parameters	All properties marked with W.
Description	This request will update the properties of the event with the internal id <id>. Only properties which are provided as parameters will be updated.
Response	{"success":true}.
Errors	com.amiando.Event.IdentifierExists com.amiando.Event.DateIsPast com.amiando.Event.EndDateBeforeDate com.amiando.Event.NoTitle com.amiando.Event.NoCountry com.amiando.Event.UnsupportedCountry com.amiando.Event.UnsupportedLanguage com.amiando.api.rest.InvalidVisibility See General Errorcodes.

Delete

Call	DELETE /api/event/<id>
Description	This request will try to delete the event with the specified internal id. The event may not be deleted if it has already sold tickets. In this case, the response contains deleted:false otherwise deleted:true.
Response	{"deleted":true, "success":true}.
Errors	See General Errorcodes.

Exists

Call	GET /api/event/exists
Parameters	identifier — public identifier of the event to check
Description	This request will check if the identifier with the unique <identifier> already exists. If it does, this identifier can't be used for creating new events.
Response	{"exists":true,"success":true}

Activate

Call	POST /api/event/<id>/activate
Parameters	deleteDemoPayments — if set to "true" any existing test purchase made in this event will get deleted (default: false)
Description	This request will activate the event specified by the given id.
Response	{"success":true}
Errors	com.amiando.Event.AlreadyActivated com.amiando.Event.EndDateBeforeDate com.amiando.Event.NoLanguage com.amiando.Event.UnsupportedLanguage com.amiando.Event.NoTimezone com.amiando.Event.NoTitle com.amiando.TicketShop.NoTicketCategories com.amiando.TicketShop.NoBillingAddress com.amiando.TicketShop.NoBankAccount com.amiando.TicketShop.NoPaymentType com.amiando.TicketShop.NoTicketType See also General Errorcodes.

Grant Permission

Call	POST /api/event/<id>/grantPermission
Parameters	apiKeyIdToGrantPermissionTo
Description	This request will give a new api key permission to this event object. This call can only be executed if your apiKey has the right to access the events of this user (must be "user api key" for host of this event).
Response	{"success":true} and HTTP Status 201 - the permission was created {"success":true} and HTTP Status 200 - the permission already existed
Errors	com.amiando.api.rest.InvalidApiKey See also General Errorcodes.

Logo upload

Call	POST /api/event/<id>/logo
Parameters	Content-Type (Header value): Set a valid image content type in the header ("image/jpeg" or "image/png") Post the file content as a binary stream with the request.
Description	This request will update the logo image for this event. Recommend image size: 1500 x 1500 pixel, minimum size 320 x 320 pixel. Sample call: curl -i "https://www.xing-events.com/api/event/{eventId}/logo?apikey={apiKey}&version=1" -H "Content-Type: image/jpeg" --data-binary @path/to/file.jpg
Response	{"success":true, "logo":"<URL to uploaded logo>"}
Errors	com.amiando.Event.InvalidContentType The content type must be "image/jpeg" or "image/png" com.amiando.api.rest.BinaryDataMissing If no binary data was provided in the call. See General Errorcodes.

Banner upload

Call	POST /api/event/<id>/banner
Parameters	Content-Type (Header value): Set a valid image content type in the header ("image/jpeg" or "image/png") Post the file content as a binary stream with the request.
Description	This request will update the banner for the event page. (must be 984 x 311 pixel) Sample call: curl -i "https://www.xing-events.com/api/event/{eventId}/banner?apikey={apiKey}&version=1" -H "Content-Type: image/jpeg" --data-binary @path/to/file.jpg
Response	{"success":true, "banner":"<URL to uploaded banner>"}
Errors	com.amiando.Event.InvalidContentType The content type must be "image/jpeg" or "image/png" com.amiando.api.rest.BinaryDataMissing If no binary data was provided in the call. See General Errorcodes.

Create participant/ticket

See Create Participant to create a new participant/ticket for an event.

Create codeDefinitions

See Create CodeDefinition to create promotions codes for an event.

Find promotion code

See Find code to search for existing promotion codes in an event.

Enumerate codeDefinitions

Call	GET /api/event/<id>/codeDefinitions
Description	This request will return the IDs of all existing code definitions of the event.
Response	{"codeDefinitions":[...], "success":true}.
Errors	See General Errorcodes.

Enumerate ticket categories

Call	GET /api/event/<id>/ticketCategories
Description	This request will return all the specified internal IDs of the event's ticket categories.
Parameters	resultType: With this parameter set to full the returned object will contain the whole ticket category objects. If this value is set to ids, only the ticket category ids are returned (default).
Response	{"ticketCategories":[...], "success":true}.
Errors	See General Errorcodes.

Enumerate payment types

Call	GET /api/event/<id>/paymentTypes
Description	This request will return the PaymentType objects belonging to the event with the specified internal id. The response contains all properties marked with R at Payment Types.
Response	{"results": "availablePaymentTypes": ["TICKETTYPE_ETICKET", ...]" paymentTypes":[{"id": ...},...], "success":true}.
Errors	See General Errorcodes.

Enumerate userDataDefinitions

Call	GET /api/event/<id>/userData
Description	This request will return all existing UserDataDefinitions. UserData values are the custom fields of this event defined by the host to request from each ticket buyer during the registration process.
Response	{"userData":{...}, "success":true}.
Errors	See General Errorcodes.

Enumerate product definitions

Call	GET /api/event/<id>/productDefinitions
Description	This request will return all IDs of the existing ProductDefinitions for this event.
Parameters	resultType: With this parameter set to full the returned object will contain the whole ProductDefinitions objects. If this value is set to ids, only the ticket category ids are returned (default).
Response	{"productDefinitions": {...}, "success":true}.
Errors	See General Errorcodes.

Enumerate products

Call	GET /api/event/<id>/products
Description	This request will return all existing products for this event. This call id deprecated, please use Enumerate product definitions instead.
Response	{"products": {...}, "success":true}.
Errors	See General Errorcodes.

Enumerate participants

Call	GET /api/event/<id>/participants
Parameters	resultType: With this parameter set to full the returned object will contain the whole participant objects. If this value is set to ids, only the participant ids are returned (default). ids: If the resultType is set to full you can additionally specify a comma separated list of participant IDs to the call which will filter the returned objects. This is usefull if you want to get details about multiple participants of this event at once. pageSize: if resultType=full is used, this call returns only so many participants as stated in this parameter (default and maximum value is 500). page: if resultType=full is used, this call returns a maximum of 500 participants. If more participants exists, use this parameter to select the page you want to receive. Example: "pageSize=100&page=0" will return the first 100 participants. "pageSize=100&page=1" will return participant number 101 to 200.
Description	This request will return all the internal ids of the event's participants. It will only return participants that finished the registration process, so no participant in the pre-registration or invited/imported states. Therefor all participants returned in this enumeration have the status Accepted, Canceled or declined. For a list of all participant statuses read Participant Status.
Response	{"participant":[...], "success":true}. If the parameter resultType=full is used, the response will contain additional information about the current page: {"lastPage": ..., "totalResults":..., "currentPage":..., "success": true, "participants":[{...},...,{...}]}
Errors	See General Errorcodes.

Enumerate payments

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