Veranstaltungen Schnittstelle
Über diese Schnittstelle können Sie Daten zu Veranstaltungen, wie Konzerte, Auftritte und sonstige interessante Ereignisse, beziehen.
Zu beachten ist, dass nur aktuelle und zukünftige Veranstaltungen ausgegeben werden und keine bereits vergangenen.
Beispiele
Im Folgenden sehen Sie Beispiele verschiedener Anfragen anhand von PHP und cURL.
Allgemeine Anfrage
In diesem Beispiel sehen Sie eine allgemeine Anfrage an die Veranstaltungskalender API.
$url = "https://www.optimale-praesentation.de/comm/universal/event";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_TIMEOUT,10);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
"AuthorizationUsername: {username}",
"AuthorizationKey: {key}"));
$output = curl_exec($ch);
curl_close($ch);
Hier sehen Sie den strukturellen Aufbau einer Antwort der Veranstaltungskalender API. Hierbei handelt es sich um ein rein fiktives Event.
{
"api_type": "Event",
"api_version": "1.0",
"status": "success",
"http_status_code": 200,
"data": [
{
"general": {
"event_id": "29",
"organisation_no": "144",
"title": "Karaokeabend",
"description": "Ein gemütlicher Karaokeabend.",
"topic": "Musik",
"registration_required": true,
"image": "http://.../veranstaltung/bild/0000040/29_640h.jpg",
"image_original": "http://.../veranstaltung/bild/0000040/29_1600h.jpg",
"flyer": "http://.../veranstaltung/flyer/0000003/54598.pdf",
"flyer_name": "User aktuelles Angebot",
"press_release": "http://.../veranstaltung/presse/0000003/54598.pdf",
"highlight": true,
"created": "2018-03-15T13:58:37+01:00",
"lastchanged": "2019-01-24T12:04:54+01:00"
},
"selections": [
{
"name": "Ferienkarte",
"subcategory": "August"
},
{
"name": "Karaokekarte",
"subcategory": "10er Karte"
}
],
"location": {
"country": "Deutschland",
"street": "Musterstraße 1",
"meeting_point": "Musterstraße 1",
"postcode": "23730",
"city": "Sierksdorf",
"latitude": 54.094185509,
"longitude": 10.783738960,
"indoor/outdoor": "indoor"
},
"dates": [
{
"date_id": "630683",
"date": "2019-04-13",
"time_begin": "2019-04-13T11:00:00+02:00",
"time_end": "2019-04-13T17:00:00+02:00",
"sold_out": false
}
],
"pricing": {
"currency": "EUR",
"entrance_charge_type": "charged",
"price_starts": "10.00",
"price_to": "20.00",
"additional_fees": "für jeden Song nach Mitternacht",
"pre-sale_booking_office": "Musterstraße 1",
"pre-sale_price": "5"
},
"contact_information": {
"event_organizer": "Mustermann GmbH",
"homepage": "www.example.com",
"email": "max.mustermann@secra.de",
"phone": "01234 567",
"ticket_link": "www.example.com",
"ticket_description": "Ticket kaufen"
}
}
]
}
Anfrage einer spezifischen Veranstaltung
Neben allgemeinen Anfragen können auch Details einzelner Veranstaltungen direkt abgerufen werden.
$url = "https://www.optimale-praesentation.de/comm/universal/event/{event_id}";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_TIMEOUT,10);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
"AuthorizationUsername: {username}",
"AuthorizationKey: {key}"));
$output = curl_exec($ch);
curl_close($ch);
Anfrage der Veranstaltungsthemen
Über den Pfad "/event/topic" ist es möglich sich eine Liste aller für den eigenen Zugang verfügbaren Veranstaltungsthemen ausgeben zu lassen.
$url = "https://www.optimale-praesentation.de/comm/universal/event/topic";
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_TIMEOUT,10);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
"AuthorizationUsername: {username}",
"AuthorizationKey: {key}"));
$output = curl_exec($ch);
curl_close($ch);
Die Antwort auf eine Anfrage an "/event/topic".
{
"api_type": "event",
"api_version": "1.0",
"status": "success",
"http_status_code": 200,
"data": [
{
"organisation_no": "5",
"topics": [
{
"topicId": 1,
"topicName": "Kunst"
},
{
"topicId": 2,
"topicName": "Sport"
},
{
"topicId": 9,
"topicName": "Wandern"
},
{
"topicId": 85,
"topicName": "Alte Handwerke"
}
]
}
]
}
Filter
Es besteht die Möglichkeit Veranstaltungen nach bestimmten Kriterien zu filtern.
Wichtig: Die Filter "date", "date_from" und "date_to" akzeptieren das Datumsformat YYYY-mm-dd. Beispiel: "2019-02-06". Andere Formate oder nicht-existente Daten wie "2019-02-29" werden mit einer Fehlermeldung beantwortet.
Option | Typ | Werte | Erklärung |
---|---|---|---|
organisation_no | int | Fragt nach allen Veranstaltungen einer bestimmen Organisation | |
group_no | string | Nur die Veranstaltungen einer bestimmten Gruppe von Organisationen werden zurück gegeben. Eine "group_no" kann im Gegensatz zu organisation_no aus Zeichen und Ganzzahlen bestehen. Beispiel: "0610fa77c" | |
v | float | Über diesen Parameter kann die gewünschte Version der Schnittstelle angegeben werden | |
highlight | boolean | true, false | Bei Highlights handelt es sich um besonders interessante oder besuchenswerte Veranstaltungen |
topic | string | Das Thema der jeweiligen Veranstaltung. | |
city | string | Die Stadt in welcher die Veranstaltung statt findet | |
date | string | Das Datum der Veranstaltung mit dem Format Y-m-d. Bspw. 2018-12-22 | |
date_from | string | Das Datum zu welchem das Event startet. | |
date_to | string | Das Datum an welchem das Event endet. |