Categories Resource Reference

The categories resource can be accessed by means of the URL https://HOST/webservice/CALENDAR/categories where HOST and CALENDAR need to be replaced with suitable values. Always all categories of the calendar concerned are returned.

Search parameters for categories

api_key

Type: String. Specifies the API key. No default value exists. A valid API key must be specified for each query. Example:

../categories?api_key=abcdef

Categories result

The fact that a request that was processed without any errors is indicated by the HTTP status code 200. In this case, an XML document is returned that has the following structure:

XML format of the categories result document

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

Data fields of a category

  • name: Category name (default value for the languages not explicitly specified)
  • name_de: Category name in German language
  • name_en: Category name in English language
  • name_fr: Category name in French language

Sample categories result document

The web service call

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

produces the following result:

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