1. BibSonomy Avatar BibSonomy
  2. General
  3. BibSonomy

Wiki

Clone wiki

BibSonomy / documentation / api / methods / ListOfAllPersons

View History

List of all persons

Method GET
URL https://www.bibsonomy.org/api/persons

Status codes

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

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibsonomy stat="ok">
  <persons>
      <person personId="personId1">
          <mainName firstName="Max" lastName="Mustermann"/>
          <user name="user1"/>
      </person>
      <person personId="personId2">
          <mainName firstName="Max" lastName="Muster"/>
          <user name="user2"/>
      </person>
  </persons>
</bibsonomy>

JSON

Request: curl -XGET --user username:apikey "https://www.bibsonomy.org/api/persons&format=json"

Response:

{
    "persons" : {
        "person" : [
            {
                "mainName" : { "firstName": "Max", "lastName": "Mustermann" },
                "user" : { "name" : "user1" },
                "personId" : "personId1"
            },
            {
                "mainName" : { "firstName": "Max", "lastName": "Muster" },
                "user" : { "name" : "user2" },
                "personId" : "personId2"
            }
        ]
    },
    "stat" : "ok"
}

XML Schema

<!--
  this type encapsulates a list of persons
-->
<xsd:complexType name="PersonsType">
    <xsd:sequence>
        <xsd:element maxOccurs="unbounded" minOccurs="0" name="person" type="PersonType" />
    </xsd:sequence>
</xsd:complexType>

<!--
  a person
-->
<xsd:complexType name="PersonType">
    <xsd:complexContent>
        <xsd:extension base="LinkableType">
            <xsd:sequence>
                <xsd:element name="mainName" type="PersonNameType" />
                <xsd:element name="names" type="PersonNameType" minOccurs="0" maxOccurs="unbounded" />
                <xsd:element name="user" type="UserType" minOccurs="0" />
            </xsd:sequence>
            <xsd:attribute name="college" type="xsd:string" />
            <xsd:attribute name="academicDegree" type="xsd:string" />
            <xsd:attribute name="personId" type="xsd:string" />
            <xsd:attribute name="homepage" type="xsd:anyURI" />
            <xsd:attribute name="email" type="xsd:string" />
            <xsd:attribute name="orcid" type="xsd:string" />
            <xsd:attribute name="gender" type="GenderType" />
        </xsd:extension>
    </xsd:complexContent>
</xsd:complexType>

Updated