Wiki
Clone wikiBibSonomy / documentation / api / methods / ListOfAllUsers
List of all users
Method | GET |
---|---|
URL | https://www.bibsonomy.org/api/users |
Status codes
-
200 ok + bibsonomy/users+xml
-
400 bad request
- 401 Unauthorized
-
403 Forbidden
-
500 Internal Server Error
Example
XML
Request:
curl -XGET --user username:apikey "https://www.bibsonomy.org/api/users?end=2"
Response:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <bibsonomy stat="ok"> <users start="0" end="2" next="https://www.bibsonomy.org/api/users?start=2&end=4"> <user name="user1" href="https://www.bibsonomy.org/api/users/user1"> <groups start="0" end="0"/> </user> <user name="user2" href="https://www.bibsonomy.org/api/users/user2"> <groups start="0" end="0"/> </user> </users> </bibsonomy>
JSON
Request: curl -XGET --user username:apikey "https://www.bibsonomy.org/api/users?end=2&format=json"
Response:
{ "users" : { "user" : [ { "groups" : {"start":0, "end":0},"name":"user1","href":"https://www.bibsonomy.org/api/users/user1" }, { "groups" : {"start":0, "end":0},"name":"user2","href":"https://www.bibsonomy.org/api/users/user2" } ], "start" : 0, "end" : 2, "next" : "https://www.bibsonomy.org/api/users?start=2&end=4" }, "stat" : "ok" }
XML Schema
<!-- this type encapsulates a list of users --> <xsd:complexType name="UsersType"> <xsd:sequence> <xsd:element maxOccurs="unbounded" minOccurs="0" name="user" type="UserType" /> </xsd:sequence> <xsd:attribute name="start" type="positiveIntegerIncludingZero" use="required" /> <xsd:attribute name="end" type="positiveIntegerIncludingZero" 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" /> <xsd:attribute name="href" type="xsd:anyURI" /> </xsd:complexType>
Updated