Amiando EventSense(R) XML API
From Amiando Developer Wiki
(Redirected from EventSense)
Contents |
Description
Your users want to know which events they should attend? Get access to exclusive and highly targeted event content from the amiando event database.
amiando provides a REST interface to query either a list of events or a single event. This means that method calls are made over the internet by sending HTTP GET or POST requests to the amiando server. Nearly any computer language can be used to communicate over HTTP with the REST server.
|
Your account will have to be activated to use eventSense XML with live data. See "How to get started?" section below. |
How to get started?
How to get started? |
|
List of Events
You will get the event list as an xml file by calling the following url:
http://www.amiando.com/rest/events
When you already have an amiando Partner Account add the parameter partnerKey followed by your shared secret key (displayed in your partner account):
http://www.amiando.com/rest/events?partnerKey=Your 40-digit shared secret key
Request Parameters
You can also add parameters to the initial request:
| Parameter | Description | Default | Maximum | Required |
|---|---|---|---|---|
| page | choose the page you want to get | 0 | optional | |
| pageSize | how many items should be displayed on this page | 50 | 100 | optional |
| country | the country that the event should be in (if you have more than one category they'll be OR linked) | null | optional | |
| type | the type that the event should be in (if you have more than one category they'll be OR linked), see list of event types | null | optional | |
| category | the category that the event should be in (if you have more than one category they'll be OR linked), see list of category types | null | optional | |
| modifiedSince | get only events modified since the given date (unix timestamp) | null | optional | |
| lang | get only events with the specified language (de, en, fr, es) | null | optional | |
| zipCode | zip code of the center of the radius search (use in conjunction with country) | null | optional | |
| latitude | latitude of the center of the radius search (use in conjunction with longitude) | null | optional | |
| longitude | latitude of the center of the radius search (use in conjunction with latitude) | null | optional | |
| radius | radius for the radius search in meters | null | optional |
Example Request
http://www.amiando.com/rest/events?page=3&pageSize=30&country=DE&country=AT&type=EVENT_TYPE_OTHER&category=CATEGORY_OTHER
Example Request (Radius search with zip code and country)
http://www.amiando.com/rest/events?zipCode=94575&country=DE&radius=200000
Example Request (Radius search with longitude and latitude)
http://www.amiando.com/rest/events?latitude=48.651806&longitude=13.248825&radius=200000
Return XML Attributes
| Attribute | Description | Available |
|---|---|---|
| currentPage | the page you are currently on | always |
| firstPage | the number of the first page | always |
| lastPage | the number of the last page | always |
| totalResults | the number of items total | always |
Example Return XML
<events
currentPage="3"
firstPage="0"
lastPage="7"
totalResults="237">
<event>
please see "single event"
</event>
...
</events>
Single Event
You can also request the informations regarding only to a single event by calling the url:
http://www.amiando.com/rest/events/{identifier}
Return XML Parameters
| Parameter | Type | Description | Available |
|---|---|---|---|
| identifier | string | unique public identifier of the event | always |
| id | integer | unique id (internal) of the event | always |
| title | string | title of the event | always |
| selectedDate | date | date the event takes place (ISO 8601 format) | always |
| endDate | date | end date of the event (ISO 8601 format) | optional |
| url | string | url of the event | always |
| contact | node | holds information about the contact for this event | always |
| hostName | string | name of the host (child node of contact) | always |
| infoEmail | string | email address to contact the host (child node of contact) | always |
| infoTelephone | string | telephone number to contact the host (child node of contact) | optional |
| infoFax | string | fax number to contact the host (child node of contact) | optional |
| shortDescription | string | short description of the event (max 255 characters) | always |
| description | string | long description of the event | optional |
| location | node | holds information about the location for this event | optional |
| description | string | description of the event location (child node of location) | optional |
| name | string | name of the event location (child node of location) | optional |
| street | string | street address of the event location (child node of location) | optional |
| city | string | city of the event location (child node of location) | optional |
| zipCode | string | Zipcode of the event location (child node of location) | optional |
| country | string | country of the event location (ISO 3166-1 alpha-2 format, child node of location) | optional |
| longitude | double | longitude of the event location (child node of location) | optional |
| latitude | double | latitude of the event location (child node of location) | optional |
| mainImage | node | the associated image | optional |
| url | string | URL of the image. Note that you can modify the width and height parameters if you need to get the image in different sizes. The aspect ratio of the image will never be changed. (child node of mainImage) | always |
| copyright | string | copyright information for the image (child node of mainImage) | always |
| lastModified | date | the date when the event was last modified | always |
| status | string | selling status: STATUS_SALE_OVER, STATUS_SELLING, STATUS_SOLD_OUT, STATUS_DEACTIVATED or STATUS_NOT_YET_SOLD | always |
| premium | node | information about premium listing | optional |
Example Return XML
<event>
<identifier>amiando_1</identifier>
<id>75549825</id>
<title>1 Jahr amiando Birthday-Bash</title>
<selectedDate>2008-10-03T00:00:21</selectedDate>
<url>http://de.amiando.com/amiando_1.html</url>
<contact>
<hostName>amiando AG</hostName>
<infoEmail>contact@amiando.com</infoEmail>
<infoTelephone>+498955273590</infoTelephone>
<infoFax>+4989552735910</infoFax>
</contact>
<shortDescription>The 1 year birthday party of the amiando AG</shortDescription>
<description>Dear friends and partners, we want to celebrate the
birthday of amiando with you! There will be lots of beer and
food, so please feel free to stop by! Yours, amiando AG
</description>
<location>
<description>The Gallopprennbahn in Munich</description>
<name>Galopprennbahn München</name>
<street>Graf-Lehndorff-Straße 36</street>
<city>München</city>
<zipCode>81929</zipCode>
<country>DE</country>
</location>
<mainImage>
<url>http://de.amiando.com/eventxml/eventSenseImage.xml?eventId=75549825&width=240&height=180</url>
<copyright>Copyright 2009 amiando AG</copyright>
</mainImage>
<lastModified>2008-10-03T00:00:21</lastModified>
<status>STATUS_SELLING</status>
<premium type="featured" />
</event>
