Wiki
Clone wikiBibSonomy / documentation / api / methods / ListOfAllTags
List of all tags
Method | GET |
---|---|
URL | https://www.bibsonomy.org/api/tags |
Query string
- generic parameters can be found here
?filter=[regex], filters the tags with this regex ?(user|group|viewable)=[username/groupname], tags are owned by specific user or group <?order=(frequency|alph), orders the tags by frequency or alphabetically
Status codes
-
200 ok + bibsonomy/tags+xml
-
400 bad request
- 401 Unauthorized
-
403 Forbidden
-
500 Internal Server Error
Example
Request:
curl -XGET --user username:apikey "https://www.bibsonomy.org/api/tags?end=2&user=mbork"
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bibsonomy stat="ok"> <tags start="0" end="1" next="https://www.bibsonomy.org/api/users?start=2&end=4&user=mbork"> <tag name="tag1" globalcount="13" usercount="5" href="https://www.bibsonomy.org/api/tags/tag1"/> <tag name="tag2" globalcount="23" usercount="15" href="https://www.bibsonomy.org/api/tags/tag2"/> </tags> </bibsonomy>
XML Schema
<!-- this type encapsulated a list of tags --> <xsd:complexType name="TagsType"> <xsd:sequence> <xsd:element name="tag" type="TagType" minOccurs="0" maxOccurs="unbounded"/> </xsd:sequence> <xsd:attribute name="start" type="xsd:positiveInteger" use="required"/> <xsd:attribute name="end" type="xsd:positiveInteger" use="required"/> <xsd:attribute name="next" type="xsd:anyURI"/> </xsd:complexType> <xsd:complexType name="TagType"> <xsd:sequence> <xsd:element maxOccurs="unbounded" minOccurs="0" name="subTags" type="TagsType" /> <xsd:element maxOccurs="unbounded" minOccurs="0" name="superTags" type="TagsType" /> </xsd:sequence> <xsd:attribute name="name" type="xsd:string" use="required"/> <xsd:attribute name="globalcount" type="xsd:positiveInteger"/> <xsd:attribute name="usercount" type="xsd:positiveInteger"/> </xsd:complexType>
Updated