user_content

Returns a list of user contributed content, including comments, ratings, tags and more, for a given set of search criteria.  User content can be searched by title, or by most recent.

Resource URL

https://api.bibliocommons.com/v1/user_content

Request Parameters

Parameter Type Description Default Required?
title String The ID of a title to return user content about.  If title is not specified, the most recent content will be returned. N/A No
library String If library is set, only contributions from users at the given library ID will be returned.   library is not supported for title searches. N/A No

Response Fields

Response Field Type Description Returned
user Object The user who created this content.  See users Response Fields. Always
title Object The title that this content is associated with.  See titles Response Fields. Always

 

content

 

Object[]

 

The list of content created by this user associated with this title.

 

Always

content_type Object The type of user content, for example comment, rating, tag, etc. Always
id String The ID of the content type.
name String The user-friendly name of the content type.
content_data variable The content data.  The Type returned depends on the value of content_type.  For example if content_type is comment, the return type will be String.  If content_type is rating, the return type will be Number.  If content_type is more complex, the data will be returned as an Object with multiple fields. Always
updated String The date and time that the content was last updated. Always

Example Request

GET https://api.bibliocommons.com/v1/user_content?api_key={key}

Response:

{
  "count": 30,
  "limit": 10,
  "pages": 3,
  "page": 2,
  "user_content": [
    {
      "user": {
        "id": 2342523,
        "name": "booklover57",
        "profile_url": "http://examplepl.bibliocommons.com/collection/show/2342523"
      }
      "title": {
        "id": "612436321",
        "title": "Harry Potter and the Deathly Hallows",
        "format": {
          "id": "BK",
          "name": "Book" 
        }
        "details_url": "http://examplepl.bibliocommons.com/item/show/612436321", 
        "authors": [
          {
            "name": "Rowling, J. K."
          }
        ]
        "isbns": [
          "9781551929767",
          "9781408810606",
          "1408810603",
        ]
      }
      "content": [
        {
          "content_type": {
            "id": "comment",
            "name": "Comment"
          },
          "content_data": "Great book, I couldn't put it down!",
          "timestamp": "2011-09-19T23:07:08Z"
        },
        {
          "content_type": {
            "id": "rating",
            "name": "Rating"
          }
          "content_data": 4.5,
          "timestamp": "2011-09-19T23:07:08Z"
        }
      ]
    },
    {
      "user": {
        "id": 2359232,
        "name": "blue_elephant",
        "profile_url": "http://examplepl.bibliocommons.com/collection/show/2359232"
      }
      "title": {
        "id": "754151321",
        "title": "Harry Potter and the Deathly Hallows",
        "sub_title": "Part 1",
        "format": {
          "id": "DVD",
          "name": "DVD"
        }
        "details_url": "http://examplepl.bibliocommons.com/item/show/754151321",
        "upcs": [
          "883929184507"
        ]
      },
      "content": [
        {
          "content_type": {
            "id": "video",
            "name": "Video"
          }
          "content_data": {
            "url": "http://www.youtube.com/v/ieaf-xfdjai"
          }
          "timestamp": "2011-09-19T20:16:09Z"
        }
      ]
    }
    ...
  ]
}