The categories resource can be accessed by means of the URL
http://HOST/webservice/INSTANCE/CALENDAR/categories
where
HOST
, INSTANCE
, and CALENDAR
need to
be replaced with suitable values. Always all categories of the calendar
concerned are returned.
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
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:
<element name="categories" xmlns="http://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>
name
: Category name (default value for the languages not explicitly specified)name_de
: Category name in German languagename_en
: Category name in English languagename_fr
: Category name in French languageThe web service call
curl http://agenda.infopark.de/webservice/wstest/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 & Leisure</name> <name_de>Sport:Sport & Freizeit</name_de> <name_en>Sports:Sports & Leisure</name_en> <name_fr>Sport:Sport & Loisir</name_fr> </category> </categories>