1. BibSonomy Avatar BibSonomy
  2. General
  3. BibSonomy

Wiki

Clone wiki

BibSonomy / documentation / api / methods / ListOfAllPosts

View History

List of all posts

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

Parameters

  • generic parameters can be found here
  • ?tags=[t1+t2+...+tn]: posts are tagged with these tags
  • ?resourcetype=(publication|bookmark|goldstandardpublication): posts contain a specific resource type
  • ?(user|group|viewable|person)=[username/groupname/personid]: posts are owned by specific user, group or person
  • ?resource=[hash]: posts for a specific resource
  • ?search=[search]: posts that contain the search terms
  • ?sortkey=[sortkey]: key for sorting of the posts. Possible values:
    • date: by added time
    • rank: by search rank
    • title: by title
    • author: by author names
    • pubdate: by publication date
    • entrytype: by entrytype
  • ?sortorder=[sortorder]: order for sorting of the posts. Possible values:
    • asc: descending sort order
    • desc: ascending sort order

Status codes

  • 200 ok
  • 400 bad request
  • 401 Unauthorized
  • 403 Forbidden
  • 500 Internal Server Error

Example

Request: 

curl  -XGET --user username:apikey "https://www.bibsonomy.org/api/posts?resourcetype=bookmark&end=1"

Response: 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibsonomy stat="ok">
    <posts start="0" end="1" next="https://www.bibsonomy.org/api/posts?start=1&amp;end=2&amp;resourcetype=bookmark">
        <post description="" postingdate="2014-09-11T13:11:04.000+02:00" changedate="2014-09-11T13:11:42.000+02:00">
            <user name="username" href="https://www.bibsonomy.org/api/users/username"/>
            <tag name="tag1" href="https://www.bibsonomy.org/api/tags/tag1"/>
            <tag name="tag2" href="https://www.bibsonomy.org/api/tags/tag2"/>
            <tag name="tag3" href="https://www.bibsonomy.org/api/tags/tag3"/>
            <tag name="tag4" href="https://www.bibsonomy.org/api/tags/tag4"/>
            <tag name="tag5" href="https://www.bibsonomy.org/api/tags/tag5"/>
            <bookmark title="very interesting title" url="http://www.google.com" interhash="04aeaf26877742c9c8ac4cc25afa81ae" intrahash="04aeaf26877742c9c8ac4cc25afa81ae" href="https://www.bibsonomy.org/api/users/username/posts/04aeaf26877742c9c8ac4cc25afa81ae"/>
        </post>
    </posts>
</bibsonomy>

XML Schema

<!--
  this type encapsulated a list of posts
-->
<xsd:complexType name="PostsType">
  <xsd:sequence>
    <xsd:element name="post" type="PostType" 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 post
-->
<xsd:complexType name="PostType">
  <xsd:sequence>
    <xsd:element name="user" type="UserType"/>
    <xsd:element name="group" type="GroupType" minOccurs="0" maxOccurs="unbounded"/>
    <!-- Note: a post must have at least one tag -->
    <xsd:element name="tag" type="TagType" maxOccurs="unbounded"/>
    <xsd:element minOccurs="0" maxOccurs="1" name="documents" type="DocumentsType" />
    <xsd:choice>
      <xsd:element name="bookmark" maxOccurs="1" type="BookmarkType" />
      <xsd:element name="bibtex" maxOccurs="1" type="BibtexType" />
      <xsd:element name="publicationFileUpload" maxOccurs="1" type="UploadDataType" />
      <xsd:element name="goldStandardPublication" maxOccurs="1" type="GoldStandardPublicationType" />
    </xsd:choice>
 </xsd:sequence>
 <xsd:attribute name="description" type="xsd:string"/>
 <xsd:attribute name="postingdate" type="xsd:dateTime"/>
 <xsd:attribute name="changedate" type="xsd:dateTime" />
 <xsd:attribute name="score" type="probabilityValue" />
 <xsd:attribute name="confidence" type="probabilityValue" />
</xsd:complexType>

<!--
  a bookmark
-->
<xsd:complexType name="BookmarkType">
 <xsd:attribute name="title" type="xsd:string" use="required" />
  <xsd:attribute name="url" type="xsd:anyURI" use="required"/>

  <!-- hash value identifying this resource -->
  <xsd:attribute name="interhash" type="xsd:string"/>
  <xsd:attribute name="intrahash" type="xsd:string"/>
  <!-- link to all posts of this bookmark -->
  <xsd:attribute name="href" type="xsd:anyURI"/>
</xsd:complexType>

<!--
  a bibtex
-->
<xsd:complexType name="BibtexType">
  <xsd:attribute name="title" type="xsd:string" use="required"/>
  <xsd:attribute name="bibtexKey" type="xsd:string"/>
  <xsd:attribute name="bKey" type="xsd:string"/>
  <xsd:attribute name="misc" type="xsd:string"/>
  <xsd:attribute name="bibtexAbstract" type="xsd:string"/>
  <xsd:attribute name="entrytype" type="xsd:string"/>
  <xsd:attribute name="address" type="xsd:string"/>
  <xsd:attribute name="annote" type="xsd:string"/>
  <xsd:attribute name="author" type="xsd:string"/>
  <xsd:attribute name="booktitle" type="xsd:string"/>
  <xsd:attribute name="chapter" type="xsd:string"/>
  <xsd:attribute name="crossref" type="xsd:string"/>
  <xsd:attribute name="edition" type="xsd:string"/>
  <xsd:attribute name="editor" type="xsd:string"/>
  <xsd:attribute name="howpublished" type="xsd:string"/>
  <xsd:attribute name="institution" type="xsd:string"/>
  <xsd:attribute name="organization" type="xsd:string"/>
  <xsd:attribute name="journal" type="xsd:string"/>
  <xsd:attribute name="note" type="xsd:string"/>
  <xsd:attribute name="number" type="xsd:string"/>
  <xsd:attribute name="pages" type="xsd:string"/>
  <xsd:attribute name="publisher" type="xsd:string"/>
  <xsd:attribute name="school" type="xsd:string"/>
  <xsd:attribute name="series" type="xsd:string"/>
  <xsd:attribute name="volume" type="xsd:string"/>
  <xsd:attribute name="day" type="xsd:string"/>
  <xsd:attribute name="month" type="xsd:string"/>
  <xsd:attribute name="year" type="xsd:string"/>
  <xsd:attribute name="type" type="xsd:string"/>
  <xsd:attribute name="scraperId" type="xsd:positiveInteger"/>
  <xsd:attribute name="url" type="xsd:string"/>

  <!-- hash value identifying this resource -->
  <xsd:attribute name="intrahash" type="xsd:string"/>
  <xsd:attribute name="interhash" type="xsd:string"/>

  <!-- link to all posts of this bibtex -->
  <xsd:attribute name="href" type="xsd:anyURI"/>
</xsd:complexType>

<!--
  a tag
-->
<xsd:complexType name="TagType">
  <xsd:sequence>
    <xsd:element maxOccurs="unbounded" minOccurs="0" name="subTags" type="TagsType" />
    <xsd:element maxOccurs="unbounded" minOccurs="0" name="superTags" type="TagsType" />
  </xsd:sequence>
  <xsd:attribute name="name" type="xsd:string" use="required"/>
  <xsd:attribute name="globalcount" type="xsd:positiveInteger"/>
  <xsd:attribute name="usercount" type="xsd:positiveInteger"/>
</xsd:complexType>

Updated