Clone wiki

BibSonomy / documentation / api / methods / ListOfUsersForGroup

List of users for a group

Method GET
URL https://www.bibsonomy.org/api/groups/[groupname]/users/

Query string

  • generic parameters can be found here

Status codes

  • 200 ok + bibsonomy/users+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/group1/users/"

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibsonomy stat="ok">
  <users start="0" end="5">
    <user name="mbork" href="https://www.bibsonomy.org/users/mbork"/>
    <user name="user1" href="https://www.bibsonomy.org/users/user1"/>
    <user name="user2" href="https://www.bibsonomy.org/users/user2"/>
    <user name="user3" href="https://www.bibsonomy.org/users/user3"/>
    <user name="user4" href="https://www.bibsonomy.org/users/user4"/>
  </users>
</bibsonomy>

XML Schema

<!--
  this type encapsulates a list of users
-->
<xsd:complexType name="UsersType">
  <xsd:sequence>
    <xsd:element name="user" type="UserType" 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 user
-->
<xsd:complexType name="UserType">
  <xsd:sequence>
    <xsd:element name="groups" type="GroupsType" minOccurs="0" maxOccurs="1">
  </xsd:sequence>
  <xsd:attribute name="name" type="xsd:string" use="required"/>
  <!-- link to details page -->
  <xsd:attribute name="href" type="xsd:anyURI"/>
</xsd:complexType>

Updated