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

From XING Events Developer Documentation
Jump to: navigation, search
Line 1: Line 1:
{{TOCright}}
 
 
 
'''Object type: '''<tt>event</tt>
 
'''Object type: '''<tt>event</tt>
  

Revision as of 11:22, 29 November 2010

Object type: event

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

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.
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
description
String
RWC
The description of the event.
optional (Default: null)
selectedEndDate Date RWC
The end date of the event.
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.amiando.com/<identifier>.html.
optional (Default: random and unique string of 7 uppercase alphanumerics)
organisatorDisplayName String RWC
The visible name of the organisator of the event. optional (Default: name of host (see hostId))
partnerEventUrl String RWC
The url of the event on the partner page. optional (Default: null)
visibility String RWC
invitationOnly, private or public. optional (Default: public)
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)
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)
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.

Methods

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}

Create

Call POST /api/event/create
Parameters All properties marked with C. Required are hostId and sourceCountry.
Description This request will create an event and will return the internal id. 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.NoCountry
com.amiando.Event.UnsupportedCountry
com.amiando.Event.NoLanguage
com.amiando.Event.UnsupportedLanguage
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.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.

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}.
Errors See General Errorcodes.

Activate

Call POST /api/event/<id>/activate
Parameters none
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.

Enumerate ticket category ids

Call GET /api/event/<id>/ticketCategories
Description This request will return all the specified internal ids of the event's ticket categories.
Response {"ticketCategories":{...}, "success":true}.
Errors See General Errorcodes.

Enumerate payment ids

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.

Grant Permission

Call POST /api/event/<id>/grantPermission
Parameters apiKeyIdToGrantPermissionTo
Description This request will request api permission for the given user object.
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.

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
ApiKey
Data Synchronization Sync Interface