Wiki
Clone wikiBibSonomy / documentation / api / methods / ListOfAllGroups
List of all groups
Method | GET |
---|---|
URL | https://www.bibsonomy.org/api/groups |
Query string
- generic parameters can be found here
Status codes
-
200 ok + bibsonomy/groups+xml
-
400 bad request
- 401 Unauthorized
-
403 Forbidden
-
500 Internal Server Error
Example
Request:
curl -XGET --user username:apikey "https://www.bibsonomy.org/api/groups?end=5"
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bibsonomy stat="ok"> <groups start="0" end="5" next="https://www.bibsonomy.org/api/groups?start=5&end=10"> <group name="group1" realname="name1" href="https://www.bibsonomy.org/api/groups/group1"/> <group name="group2" realname="name2" href="https://www.bibsonomy.org/api/groups/group2"/> <group name="group3" realname="" href="https://www.bibsonomy.org/api/groups/group3"/> <group name="group4" realname="" href="https://www.bibsonomy.org/api/groups/group4"/> <group name="group5" realname="name5" href="https://www.bibsonomy.org/api/groups/group5"/> </groups> </bibsonomy>
XML Schema
<!-- this type encapsulates a list of groups --> <xsd:complexType name="GroupsType"> <xsd:sequence> <xsd:element name="group" type="GroupType" 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> <!-- a group --> <xsd:complexType name="GroupType"> <xsd:sequence> <xsd:element maxOccurs="unbounded" minOccurs="0" name="user" type="UserType" /> </xsd:sequence> <xsd:attribute name="name" type="xsd:string" use="required" /> <xsd:attribute name="realname" type="xsd:string" /> <xsd:attribute name="homepage" type="xsd:anyURI" /> <xsd:attribute name="description" type="xsd:string" /> <!-- link to details page --> <xsd:attribute name="href" type="xsd:anyURI" /> </xsd:complexType>
Updated