Clone wiki

BibSonomy / documentation / api / methods / DetailsForGroup

Details for group

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

Query string

  • generic parameters can be found here

Status codes

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

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibsonomy stat="ok">
    <group name="group1" realname="name1" href="https://www.bibsonomy.org/api/groups/group1"/>
</bibsonomy>

XML Schema

<!--
  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