Ergebnisparameter
Klicken Sie hier, um diese Seite mit vollem Kontext anzuzeigen.

 

Ergebnisparameter

Im Folgenden werden alle Parameter beschrieben, die in der Ausgabe ausgegeben werden können. Welche Parameter konkret ausgegeben werden hängt von mehreren Faktoren ab, u.a. Benutzerrechte, "komplett"- oder "Ausgabefelder"-Parameter, etc..

Die möglichen Ausgabedatentypen lauten:

 

Das JSON-Ergebnis ist wie folgt aufgebaut:

Das XML-Ergebnis hat den Aufbau:

 

Auch wenn nicht immer alle Felder ausgespielt werden, z.B. weil nur das Feld "TITEL" angefragt wird, sind folgende Daten für freigegebene Veranstaltungen Pflichtfelder im CMS und entsprechend immer mit Werten versehen:

Alle anderen Informationen sind optional und können leer sein.

 

Die Spalten XML und JSON geben an, in welchen Ausgabeformaten die konkreten Infos ausgespielt werden.

Die allgemeinen Infos im Ergebnis lauten:

 

Parameter Typ Beschreibung Beispiel JSON XML
ANFRAGEZEIT date1

Serverzeit zu Beginn der Anfrage

 2020-07-23 14:07:26   X
AUSGABEZEIT date1 Serverzeit zu der das Ergebnis ausgegeben wird 2020-07-23 14:07:26   X
DAUER float Dauer der Abfrage in Sekunden 0,4511   X
ERGEBNISANZAHL (XML)
ANZAHLERGEBNIS (JSON)		 int Anzahl der ausgegebenen Treffer 100 X X
ENDEZEITPUNKT date1 Letzte Startzeit aller im ausgegebenen Ergebnis ausgegebenen Veranstaltungen

2020-07-23 20:00:00

 X X
GESAMTZAHL (XML)
ANZAHLGESAMT (JSON)		 int Gesamtzahl der Treffer einer Abfrage 1900 X X
STARTZEITPUNKT date1 Erste Startzeit aller im ausgegebenen Ergebnis ausgegebenen Veranstaltungen

2020-07-23 00:00:00

 X X
VERSION int In dieser Abfrage verwendete Versionsnummer der Schnittstelle 2   X

 

Die Felder in der Ausgabe haben folgende Bedeutung:

 

Parameter Typ Beschreibung Beispiel JSON XML
ABGESAGT bool Der konkret ausgegebene Termin der Veranstaltung ist abgesagt 0 X  
AKTUELLERTAG date Alle Datuminfos zum konkreten Termin einer Veranstaltung

<AKTUELLERTAG BEGINN="00:00" 
ENDE="23:59" ABGESAGT="0" AUSVERKAUFT="0">2020-07-23</AKTUELLERTAG>

   X
ALTER_BIS int Alter, bis wann eine Veranstaltung geeignet ist 5; 0 bedeuted "egal" X X
ALTER_VON int Alter, ab wann eine Veranstaltung geeignet ist 12; 0 bedeuted "egal" X X
ANMERKUNG string Anmerkung

Weitere Infos und Karte unter xxxx

 X X
ART int ID der Veranstaltungsart 9 X  
ART string Name der Veranstaltungsart, mit ID als Attribute Aufführung   X
AUSVERKAUFT bool Der konkret ausgegebene Termin der Veranstaltung ist ausverkauft 1 X  
BESCHREIBUNG string Beschreibungstext zur Veranstaltung

Das Konfuzius-Institut Nürnberg-Erlangen zeigt die erste Einzelausstellung...

 X X
BILDER div. Bilder zur Veranstaltung, max. drei Stück JSON:
Array aus Bildinformationen mit folgenden Werten:
  • on: Originalname der Datei
  • sn: Servername bzw. URL zum Bild
  • c: Copyrightinfo
  • b: Bildbreite für das unter sn ausgegebene Bild
  • h: Bildhöhe für das unter sn ausgegebene Bild
  • ob: Originalbreite des Ursprungsbildes
  • oh: Originalhöhe des Ursprungsbildes
  • f: Fotograf des Bildes
  • alt: Alternativtext zum Bild

Die nächsten zwei Werte geben die linke und obere Koordinate für den 4:3 Ausschnitt des Listenbildes an.
Der letzte Wert ist die Nummer des Listenbildes beginnend bei 1

 

XML:

VORSCHAUBILD gibt die Nummer des Listenbildes an, beginnen mit 0.

Nodes mit der URL zum Bild und folgenden Attributen als Informationen:

  • ALT: Alternativtext zum Bild
  • OBEN: Obere Koordinate des 4:3 Ausschnittes
  • LINKS: Linke Koordinate des 4:3 Ausschnittes
  • NACHWEIS: Copyrightinfo
  • BREITE: Bildbreite für das unter sn ausgegebene Bild
  • HOEHE: Bildhöhe für das unter sn ausgegebene Bild
  • FOTOGRAF: Fotograf des Bildes
  • ORIGINALBREITE: Originalbreite des Ursprungsbildes
  • ORIGINALHOEHE: Originalhöhe des Ursprungsbildes
 X X
DATUM array Datumsangaben bzw. Öffnungszeiten

Objekt 1:

Alle Einzeltermine als Objekte mit allen Infos zu den Terminen. Kann auch nur aus dem Key bestehen, welches den Startzeitpunkt  (ISO-Format) angibt. Weitere Werte

  • E: Endezeitpunkt (ISO)
  • EIN: Einlassuhrzeit
  • AB: Abgesagt (bool)
  • AUS: Ausverkauft (bool)
  • VVK: VVK-Link für diesen konkreten Termin

Beispiel:

"2020-07-14T17:00": {
 "E": "2020-07-14 17:40",

"EIN":"16:00",

"AUS":1,

 "VVK": "https://xxxx.de?bla02"

 },

"2020-07-14T17:40": {

 "E": "2020-07-14 18:20",

"AB":1,

 "VVK": "https://xxxx.de?bla=2"

}

 

Objekt 2:

Informationen zu Terminwiederholungen.

SCHEMATYP: Art der Wiederholung

  • 0: keine
  • 1: täglich
  • 2: wöchentlich

Bei SCHEMATYP 1:

TAEGLICHTYP:

  1: jeden TAEGLICHXTEN Tag wiederholen

  2: Wiederholung nur wochentags

Beispiel:

{

 "SCHEMATYP": 1,

 "TAEGLICHTYP": 2,

 "TAEGLICHXTEN": 1,

 "ZEITRAUMENDE": "2020-09-29"

}

Heisst: Wiederholung an den Wochentagen (d.h. nicht Samstags und Sonntags), bis zum 29.09.2020

 

Bei SCHEMATYP 2:

WOCHEXTE: jede xte Woche wiederholen

WOMO, WODI, etc.: Wiederholung findet Montags, Dienstags, etc. statt

WOTERMINE: Objekte mit den Öffnungszeiten an den einzelnen Tagen, max. 2 Beginn- und Endezeiten pro Tag (B1+E1 & B2+E2), Endezeiten sind optional

Beispiel:

{

 "SCHEMATYP": 2,

 "WOCHEXTE": 4,

 "WOMO": 0,

 "WODI": 1,

 "WOMI": 0,

 "WODO": 1,

 "WOFR": 0,

 "WOSA": 0,

 "WOSO": 0,

 "WOTERMINE": "{\"Di\":{\"B1\":\"12:00\",\"E1\":\"15:00\",\"B2\":\"18:00\",\"E2\":
\"21:30\"},\"Do\":{\"B1\":\"15:00\",\"E1\":\"\",\"B2\":\"\",\"E2\":\"\"}}",

 "ZEITRAUMENDE": "2020-12-22"

}

Heisst: jede 4.Woche, Dienstags und Donnerstags, Dienstag 12 bis 15 und 18 bis 21:30, Donnerstags ab 15 Uhr

ZEITRAUMENDE: Datum des letzten Wiederholungstages

 

 

 

 X  
DATUMENDE date1 Endezeitpunkt des konkreten Veranstaltungstermins

2020-07-23 22:00:00

 X  
DATUMSTART date1 Startzeitpunkt des konkreten Veranstaltungstermins

2020-07-23 08:00:00, kann NULL sein

 X  
EINLASS time Einlassuhrzeit des konkreten Veranstaltungstermins 18:00:00, kann NULL sein X  
EINTRITT int "Eintritt frei"-Markierung 1: Eintritt frei
0: kostenpflichtig		 X X
ERSTERTERMIN date1 Erster Veranstaltungstermin dieser Veranstaltung

2020-07-16 00:00:00

 X X
FACEBOOK string URL zur Facebookseite der Veranstaltung Entspricht dem facebook-Link unter LINKS X X
FAMILIEN bool Familienveranstaltung 1 X X
INTERKULTUR bool Interkulturelle Veranstaltung 1 X X
INTERNETSEITE string URL zur Internetseite der Veranstaltung Entspricht dem webseite-Link unter LINKS X X
INTERNETSEITEREIHE string URL zur Internetseite der Reihe der Veranstaltung Entspricht dem webseitereihe-Link unter LINKS X X
KATEGORIE array Array aus ID's der Veranstaltungskategorien [9,1] X  
KATEGORIEN array Array aus Nodes mit den Namen der Veranstaltungskategorien und-unterkategorien, jeweils mit der ID der (Unter-)Kategorie als Attribut Film / Multimedia   X
KINDER bool Veranstaltung für Kinder 1 X X
KURZTITEL string Kurzversion des Titels Star Wars IV X X
LINKS array Array mit Links bzw. Nodes zur Veranstaltung

Folgendes Linktypen gibt es:

  • webseite
  • webseitereihe (d.h. Webseite der Veranstaltungsreihe)
  • video
  • facebook
  • twitter
  • instagram
  • anmeldung (d.h. Anmeldelink)
  • stream
  • sonstige
 X X
OEFFNUNGSZEITEN div. Datumsangaben bzw. Öffnungszeiten

Bis jetzt nur Ausgabedaten kompatibel zum Veranstaltungskalender

Version 1!

Passende Ausgabe für Version 2 wird bei Bedarf noch umgesetzt und Dokumentation dann entsprechend angepasst.

 

Subnodes abhänging vom Attribut "TYP":

1: genau ein einzelner Termin

2: beliebige Termine zu beliebigen Zeiten / Tagen

3: Zeitraum (hauptsächlich Ausstellungen)

Bei TYP = 1:

Einzelne Node, Wert ist das Veranstaltungsdatum, Attribute die zusätzlichen Informationen. ENDE, EINLASS und VVKLINK können leer sein.

 <DATUM BEGINN="16:00" ENDE="16:45" EINLASS="" ABGESAGT="0"
 AUSVERKAUFT="0" VVKLINK="">

 <![CDATA[2020-07-23]]>

</DATUM>

Bei TYP = 2:

DATUM1: Datum des ersten Termins

DATUM2: Datum des letzten Termins

Beliebig viele Nodes mit Terminen, entsprechend TYP = 1

Bei TYP = 3:

DATUM1: Datum des ersten Termins

DATUM2: Datum des letzten Termins

AUSNAHMEN: Liste mit Datums, an denen geschlossen ist

OFFENETAGE: Nodes mit den geöffneten Tagen

<OFFENERTAG BEGINN="10:00" ENDE="18:00" EINLASS="" ABGESAGT="" 

AUSVERKAUFT="" VVKLINK="">

 <![CDATA[di]]>

</OFFENERTAG>

Heisst: geöffnet Dienstags, 10 bis 18 Uhr

Pro Tag zwei Öffnungszeiten möglich

ABWEICHENDETAGE: einzelne Tage mit geänderten Öffnungszeiten, Format wie bei TYP=1

 

   X
ORT string Kompletter Name des Veranstaltungsortes

Bürgertreff ISAR 12

 X  

ORTSID

 int ID des Veranstaltungsortes 1234 X  

ORTSNAMEEINFACH

 string Name des Veranstaltungsortes

Künstlerhaus im KunstKulturQuartier

 X  

ORTSNAMEZUSATZ

 string Namenszusatzs des Veranstaltungsortes Weißer Saal X  

ORTSNAMEKOMPLETT

 string Kompletter Name (Name & Zusatz) des Veranstaltungsortes

Künstlerhaus im KunstKulturQuartier - Weißer Saal

 X  

ORTSSTRASSENR

 string Strasse und Hausnummer des Veranstaltungsortes

Königstr. 93

 X  

ORTSPLZ

 string Postleitzahl des Veranstaltungsortes

90402

 X  

ORTSORT

 string Ort des Veranstaltungsortes Nürnberg X  

ORTSEMAIL

 string E-Mailadresse des Veranstaltungsortes

kunsthalle@stadt.nuernberg.de

 X  

ORTSINTERNET

 string Webseite des Veranstaltungsortes

http://www.kunstkulturquartier.de/kunsthalle/

 X  

ORTSLAT

 string Breitengrad des Veranstaltungsortes

49.44985580444

 X  

ORTSLNG

 string Längengrad des Veranstaltungsortes

11.08261394501

 X  

ORTSTELEFON

 string Telefonnummer des Veranstaltungsortes

0911 / 231-2853

 X  

ORTSTELEFAX

 string Telefaxnummer des Veranstaltungsortes

0911 / 231-3721

 X  

ORTSVGN

 string Infos zu Haltestellen am Veranstaltungsort

Buslinie 36: Haltestelle Burgstraße

U1/U11: Haltestelle Lorenzkirche, Ausgang in Richtung Hauptmarkt

 X  

ORTSOEFFNUNGSZEITEN

 string Generelle Öffnungszeiten des Veranstaltungsortes

Di-Fr 10-17 Uhr

Sa und So 10-18 Uhr

In der Zeit des Christkindlesmarktes auch Mo 10-17 Uhr

 X  
PREISE div. Eintrittspreis, falls nicht "Eintritt frei"

JSON:

Preisobjekte mit jeweils folgenden Informationen:

  • KAT: Preiskategorienummer (int; z.B. für Theater)
  • ART: Preisart (int)
  • ERM: Ermäßigter Preis (bool)
  • VAL: Betrag (float)
  • INFO: Info zu Preis (string; z.B. "Ermäßigt für Studenten)
  • ARTNAME: Bezeichnung der Preisart (string; z.B. "Eintritt", "Gebühr")

 

XML:

Bis jetzt nur Ausgabedaten kompatibel zum Veranstaltungskalender

Version 1!

Passende Ausgabe für Version 2 wird bei Bedarf noch umgesetzt und Dokumentation dann entsprechend angepasst.

PREIS-NODES mit Betrag bzw. Info als Wert und folgenden Attributen:

  • Nummer: Preiskategorie (int)
  • TYP: Preisart, möglich sind
    • NORMAL
    • ERMAESSIGT

    • ERMAESSIGT_BERECHTIGTE

    • VVK

    • VVK_ERMAESSIGT

    • VVK_ERMAESSIGT_BERECHTIGTE

  • ERMAESSIGT_BERECHTIGTE bzw. VVK_ERMAESSIGT_BERECHTIGTE dient als Infotext für ein vorausgegangenes ERMAESSIGT bzw. VVK_ERMAESSIGT

 X X
PRIVATETAGS string Private Tags dieses Benutzers zu dieser Veranstaltung

Einzelne Begriffe, durch "||" (Doppelpipe) getrennt, kann NULL (JSON) bzw. leer (XML) sein

Beispiel:

"Mehrsprachig||Nicht barrierefrei"

 X X
REIHE string Veranstaltungsreihe, bei mehreren Reihen nur die erste Reihe "Blaue Nacht" X X
REIHEN string Veranstaltungsreihe, bei mehreren Reihen nur die erste Reihe "Kino 3||Online-Veranstaltung" X  
TAGS string Tags zu dieser Veranstaltung

Einzelne Begriffe, durch "||" (Doppelpipe) getrennt, kann NULL (JSON) bzw. leer (XML) sein

Beispiel:

"Für Kinder||Barrierefrei"

 X X
TITEL string Titel der Veranstaltung

Fürth im Übermorgen

 X X
TWITTER string URL zur Twitterseite der Veranstaltung Entspricht dem twitter-Link unter LINKS X X
UNTERTITEL string Untertitel der Veranstaltung

Zukunftsfestival rund um eine enkeltaugliche Stadt

 X X
UNTERART int ID der Veranstaltungsunterart 17 X  
UNTERART string Name der Veranstaltungsunterart, mit ID als Attribute

Markt

   X
VERANSTALTER div Array aus Objekten (JSON) bzw. Nodes (XML) mit Angaben zu den (Co-)Veranstaltern einer Veranstaltung

Eine Veranstaltung kann beliebig viel Veranstalter haben

JSON Beispiel:

{

                    "VERANSTALTERID": 2408,

                    "VERANSTALTERNAME": "KunstKulturQuartier, Filmhaus Nürnberg",

                    "VERANSTALTERSTRASSENR": "Königstr. 93",

                    "VERANSTALTERPLZ": 90402,

                    "VERANSTALTERORT": "Nürnberg",

                    "VERANSTALTEREMAIL": "",

                    "VERANSTALTERINTERNET": "http://www.KunstKulturQuartier.de",

                    "VERANSTALTERANSPRECHPARTNER": [],

                    "VERANSTALTERTELEFON": "0911 / 2315823",

                    "VERANSTALTERTELEFAX": ""

}

XML Beispiel:
<VERANSTALTER ID="2408">

                <NAME>

                    <![CDATA[KunstKulturQuartier, Filmhaus Nürnberg]]>

                </NAME>

                <STRASSE>

                    <![CDATA[Königstr.]]>

                </STRASSE>

                <HAUSNUMMER>

                    <![CDATA[ 93]]>

                </HAUSNUMMER>

                <PLZ>

                    <![CDATA[90402]]>

                </PLZ>

                <ORT>

                    <![CDATA[Nürnberg]]>

                </ORT>

                <EMAIL>

                    <![CDATA[]]>

                </EMAIL>

                <INTERNET>

                    <![CDATA[http://www.KunstKulturQuartier.de]]>

                </INTERNET>

                <TELEFON>

                    <![CDATA[]]>

                </TELEFON>

                <TELEFONVORWAHL>

                    <![CDATA[]]>

                </TELEFONVORWAHL>

                <TELEFAX>

                    <![CDATA[]]>

                </TELEFAX>

                <TELEFAXVORWAHL>

                    <![CDATA[]]>

                </TELEFAXVORWAHL>

                <ANSPRECHPARTNER>

                    <![CDATA[Array]]>

                </ANSPRECHPARTNER>

            </VERANSTALTER>

 X X
VERANSTALTUNGID int ID der Veranstaltung 123546 X  
VERANSTALTUNGSORT strings Angaben zum Veranstaltungsort, Bedeutung der Felder siehe oben

<VERANSTALTUNGSORT ID="13">

            <NAME>

                <![CDATA[Kulturladen Loni-Übler-Haus]]>

            </NAME>

            <NAMEEINFACH>

                <![CDATA[Kulturladen Loni-Übler-Haus]]>

            </NAMEEINFACH>

            <ZUSATZ>

                <![CDATA[]]>

            </ZUSATZ>

            <STRASSE>

                <![CDATA[Marthastraße]]>

            </STRASSE>

            <HAUSNUMMER>

                <![CDATA[ 60]]>

            </HAUSNUMMER>

            <PLZ>

                <![CDATA[90482]]>

            </PLZ>

            <ORT>

                <![CDATA[Nürnberg]]>

            </ORT>

            <EMAIL>

                <![CDATA[loni-uebler-haus@stadt.nuernberg.de]]>

            </EMAIL>

            <INTERNET>

                <![CDATA[http://www.kuf-kultur.de/loni]]>

            </INTERNET>

            <TELEFON>

                <![CDATA[]]>

            </TELEFON>

            <TELEFONVORWAHL>

                <![CDATA[]]>

            </TELEFONVORWAHL>

            <TELEFAX>

                <![CDATA[]]>

            </TELEFAX>

            <TELEFAXVORWAHL>

                <![CDATA[]]>

            </TELEFAXVORWAHL>

            <OEFFENTLICHE>

                <![CDATA[Haltestelle Marthastasse, Linie 5]]>

            </OEFFENTLICHE>

            <OEFFNUNGSZEITEN>

                <![CDATA[Montags, 10 bis 18 Uhr]]>

            </OEFFNUNGSZEITEN>

            <LAT>

                <![CDATA[49.45518112183]]>

            </LAT>

            <LNG>

                <![CDATA[11.11242008209]]>

            </LNG>

</VERANSTALTUNGSORT>

   X
VIDEO string URL mit Link zu einem Video zur Veranstaltung Entspricht dem "video" Link unter LINKS X X
VVKDATUM date Datum für den Start des Vorverkaufs 2020-07-12 X X
VVKINFOS string Infos zum Kartenvorverkauf

Einen kostenlosen Zugang zu Kino 3 haben alle Inhaber*innen einer aktiven

Filmhaus-Freundekarte. Mehr Informationen finden Sie unter 

www.filmhaus.nuernberg.de

 X X
VVKLINK string URL zum allgemeinen Kartenvorverkauf

https://ticket-at-home.de/Home.aspx?shopid=xxx

 X X

VVKUEBLICH

 bool Vorverkauf findet an den üblichen Vorverkaufsstellen (Kulturinfo, etc.) statt 1 X X