Clone wiki

BibSonomy / documentation / api / methods / ListOfFriends

List of all users

Method GET
URL https://www.bibsonomy.org/api/users[username]/friends

Query string

  • generic parameters can be found here
  • ?relation=(incoming|outgoing), default 'incoming'

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/users/username/friends"

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibsonomy stat="ok">
    <users start="0" end="1">
        <user name="username" href="https://www.bibsonomy.org/api/users/username">
            <groups start="0" end="0"/>
        </user>
    </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"/>
  <xsd:attribute name="realname" type="xsd:string"/>
  <xsd:attribute name="email" type="xsd:string"/>
  <xsd:attribute name="homepage" type="xsd:string"/>
  <!-- link to details page -->
  <xsd:attribute name="href" type="xsd:anyURI"/>
</xsd:complexType>

Updated