This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
covers:api [2011/06/30 08:06] jposeika [Output] |
covers:api [2011/06/30 08:16] jposeika [Output] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Covers (RESTful) API ====== | ====== 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. | + | Using Covers API you can retrieve data on ChiliFresh covers. It has output available in XML and JSON. |
- | ====== User functions ====== | + | ===== Covers availability data ===== |
==== Input ==== | ==== Input ==== | ||
* URL for XML output: https://content.chilifresh.com/api/ | * URL for XML output: https://content.chilifresh.com/api/ | ||
Line 9: | Line 9: | ||
* Method: GET | * Method: GET | ||
- | * Parameters: | + | ==== Parameters ==== |
|**Parameter**|**Type (size)**|**Mandatory**|**Description**| | |**Parameter**|**Type (size)**|**Mandatory**|**Description**| | ||
|isbn|Variable characters (20)|Yes|Item's ISBN, UPC or other ID| | |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.| | + | |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.| |
Line 26: | Line 26: | ||
|response|item_id|ISBN, UPC or other item ID|If //isbn// parameter present|ISBN, UPC or other item ID| | |response|item_id|ISBN, UPC or other item ID|If //isbn// parameter present|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_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|small_cover_url|URL |If //small_cover_exists// is 1, this parameter includes displays cover 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_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|medium_cover_url|URL |If //medium_cover_exists// is 1, this parameter includes displays cover 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_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| | + | |response|large_cover_url|URL |If //large_cover_exists// is 1, this parameter includes displays cover URL|If //large_cover_exists// is 1, this parameter includes displays cover URL| |
|**Block //response// ends**| | | | | | |**Block //response// ends**| | | | | | ||
Line 53: | Line 53: | ||
</response> | </response> | ||
</code> | </code> | ||
- | -- | + | ---- |
**JSON input example:** | **JSON input example:** |