covers:api
This is an old revision of the document!
Table of Contents
Covers (RESTful) API
Using Reviews API you can implement reviews into your library's OPAC, web page, iPhone app or anywhere else. It has output available in XML and JSON.
User functions
Input
- URL for XML output: https://content.chilifresh.com/api/
- Method: GET
* Parameters:
| Parameter | Type (size) | Mandatory | Description |
| isbn | Variable characters (20) | Yes | Item's ISBN, UPC or other ID |
| size | Variable characters (50) | No | Options: S - small, M - medium, L - large, \\empty - returns all values. If incorrect size parameter, it is treated as empty. |
Output
- Format: XML, JSON
- Blocks and elements:
| Block | Element | Type (size) | Exists | Description |
| Block response starts | Always | |||
| response | response_code | Integer (1) | Always | Response code 1 - response OK, 0 - missing item ID |
| response | response_description | Text (255) | Always | Brief description of response code |
| response | response_time | Date&time (D, d M Y H:i:s -hhmm) | Always | Example: Thu, 30 Jun 2010 07:25:58 -0500 |
| response | item_id | If isbn parameter present | ISBN, UPC or other item ID | ISBN, UPC or other item ID |
| response | small_cover_exists | 1 or 0 | If size parameter is “S” or empty | 1 if small cover exists, 0 if not |
| response | small_cover_url | URL | If small_cover_exists is 1, this parameter includes displays cover URL | |
| response | medium_cover_exists | 1 or 0 | If size parameter is “M” or empty | 1 if medium cover exists, 0 if not |
| response | medium_cover_url | URL | If medium_cover_exists is 1, this parameter includes displays cover URL | |
| response | large_cover_exists | 1 or 0 | If size parameter is “L” or empty | 1 if large cover exists, 0 if not |
| response | large_cover_url | URL | If large_cover_exists is 1, this parameter includes displays cover URL | |
| Block response ends | ||||
XML output example:
<response> <response_code>1</response_code> <response_description>Response OK</response_description> <response_time>Thu, 30 Jun 2011 07:25:58 -0500</response_time> <item_id>9780578033440</item_id> <small_cover_exists>1</small_cover_exists> <small_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=S</small_cover_url> <medium_cover_exists>1</medium_cover_exists> <medium_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=M</medium_cover_url> <large_cover_exists>1</large_cover_exists> <large_cover_url>http://content.chilifresh.com/?isbn=9780578033440&size=L</large_cover_url> </response>
covers/api.1309438635.txt.gz · Last modified: 2012/04/22 04:55 (external edit)
