Categories-Ressource-Referenz

Auf die Categories-Ressource kann man mit der URL https://HOST/webservice/INSTANCE/CALENDAR/categories zugreifen, wobei HOST, INSTANCE und CALENDAR jeweils durch passende Werte ersetzt werden müssen. Es werden immer alle Kategorien des betreffenden Kalenders zurückgegeben.

Categories-Suchparameter

api_key

Typ: String. Gibt den API-Key an. Es gibt keinen Default-Wert. Bei jedem Zugriff muss ein gültiger API-Key angegeben werden. Beispiel:

../categories?api_key=abcdef

Categories-Ergebnis

Die fehlerfreie Verarbeitung der Anfrage wird durch den HTTP-Status-Code 200 angezeigt. In diesem Fall wird als Rückgabe ein XML-Dokument geliefert, das die folgende Struktur hat:

XML-Format des Categories-Ergebnis-Dokuments

<element name="categories" xmlns="https://relaxng.org/ns/structure/1.0">
  <zeroOrMore>
    <element name="category">
      <interleave>
        <element name="name">
          <text/>
        </element>
        <element name="name_de">
          <text/>
        </element>
        <element name="name_en">
          <text/>
        </element>
        <element name="name_fr">
          <text/>
        </element>
      </interleave>
    </element>
  </zeroOrMore>
</element>

Beschreibung der Datenfelder einer Kategorie

  • name: Name der Kategorie (Default-Wert für alle nicht explizit angegebenen Sprachen)
  • name_de: Name der Kategorie in deutscher Sprache
  • name_en: Name der Kategorie in englischer Sprache
  • name_fr: Name der Kategorie in französischer Sprache

Beispiel eines Categories-Ergebnis-Dokuments

Der Web-Service-Aufruf

curl https://agenda.infopark.de/webservice/wstest/cal/categories?api_key=webservicetestapikey

erzeugt das folgende Ergebnis:

<categories>
  <category>
    <name>Sports:Cricket</name>
    <name_de>Sport:Cricket</name_de>
    <name_en>Sports:Cricket</name_en>
    <name_fr>Sport:Cricket</name_fr>
  </category>
  <category>
    <name>Sports:Football</name>
    <name_de>Sport:Fussball</name_de>
    <name_en>Sports:Football</name_en>
    <name_fr>Sport:Football</name_fr>
  </category>
  <category>
    <name>Sports:Sports &amp; Leisure</name>
    <name_de>Sport:Sport &amp; Freizeit</name_de>
    <name_en>Sports:Sports &amp; Leisure</name_en>
    <name_fr>Sport:Sport &amp; Loisir</name_fr>
  </category>
</categories>