Zur Übersicht

URL-Synopsis

   http://api.golem.de/api/special/list/?key=developerkey&format=resultformat
   http://api.golem.de/api/special/list/?key=developerkey   
  

Function

Returns a list of article special categories.

Arguments

Name Datatype Meaning Default value
developerkey String A valid developer key Value required
resultformat String The format of the result set (Allowed values: json or xml) json

Returns

The result data is encoded in UTF-8.

Name Datatype Meaning
success Boolean Indicates, wether the request could be successfully handle (true) or not (false).
data Array The list of articles, if the request was sucessful
errorCode Integer The error code, if the request was not successful
errorMessage String The error message, if the request was not successful

Data Array

The data represents the list of articles. Each article is represented by a single record. Each record consists of:

Name Datatype Meaning
name String(60) The name of the special category
short String The short name of the special. Used as Identifier.
url String The URL to the special category view

Error codes

Code Meaning
1 Internal Data access error

Test output with the single resultset as JSON

{"__className":"stdClass","data":[{"name":"Lorem ipsum","shortname":"lo","url":
"http://www.golem.de/lo"},{"name":"Lorem ipsum","shortname":"lo","url":"http://
www.golem.de/lo"},{"name":"Lorem ipsum","shortname":"lo","url":"http://www.gole
m.de/lo"},{"name":"Lorem ipsum","shortname":"lo","url":"http://www.golem.de/lo"
},{"name":"Lorem ipsum","shortname":"lo","url":"http://www.golem.de/lo"},{"name
":"Lorem ipsum","shortname":"lo","url":"http://www.golem.de/lo"},{"name":"Lorem
 ipsum","shortname":"lo","url":"http://www.golem.de/lo"},{"name":"Lorem ipsum",
"shortname":"lo","url":"http://www.golem.de/lo"},{"name":"Lorem ipsum","shortna
me":"lo","url":"http://www.golem.de/lo"},{"name":"Lorem ipsum","shortname":"lo"
,"url":"http://www.golem.de/lo"}],"success":true}
  

Test output with the resultset as XML

<?xml version="1.0" encoding="UTF-8"?>
<golemderesult>
<success>1</success>
<data>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
<record>
<name>Lorem ipsum</name>
<shortname>lo</shortname>
<url>http://www.golem.de/lo</url>
</record>
</data>
</golemderesult>
  


Zur Übersicht