Wiki

Clone wiki

BibSonomy / documentation / api / methods / DetailsForPerson

Details for person

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

Status codes

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

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibsonomy stat="ok">
    <person personId="personid" homepage="https://www.bibsonomy.org">
        <mainName firstName="Max" lastName="Mustermann"/>
        <user name="username"/>
    </person>
</bibsonomy>

JSON

Request:

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

Response:

{
    "person" : {
        "mainName" : { "firstName": "Max", "lastName": "Mustermann" },
        "user" : { "name" : "user1" },
        "personId" : "personId1"
    },
    "stat" : "ok"
}

XML Schema

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