connections:api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
connections:api [2016/05/24 15:40] jposeika [profileDeletePicture: delete particular user's picture] |
connections:api [2016/05/25 06:34] (current) jposeika [New features requiring documentation] |
||
|---|---|---|---|
| Line 3252: | Line 3252: | ||
| - | ====== New features requiring documentation ====== | ||
| ===== Profile editing functions ===== | ===== Profile editing functions ===== | ||
| Line 3338: | Line 3337: | ||
| ==== profileChangeRead: set or change user's "Current read" item ==== | ==== profileChangeRead: set or change user's "Current read" item ==== | ||
| - | **Input:** | + | === Input === |
| - | * session_id | + | * URL for XML output: https://secure.chilifresh.com/api/connections/ |
| - | * item_id [ISBN or UPC] OR | + | * URL for JSON output: https://secure.chilifresh.com/api/connections/json/ |
| - | * cf_item_id | + | * Method: POST |
| + | * To be used when retrieving information for any item | ||
| + | * Parameters: | ||
| - | Output: success [item_title, item_author, item_id, cf_item_id] or fail message | + | |
| + | |**Parameter** |**Type (size)** |**Mandatory** |**Description **| | ||
| + | |action|profileChangeRead |Yes| API call| | ||
| + | |isbn|ISBN, UPC or other identifier of item |No| Identifier of the item| | ||
| + | |cf_item_id|ChiliFresh ID of the item |No| ChiliFresh identifier of the item| | ||
| + | |session_id|Variable characters (100)|Yes| Session ID from logged in user| | ||
| + | |||
| + | |||
| + | **XML output example:** | ||
| + | <code> | ||
| + | <?xml version="1.0"?> | ||
| + | <response> | ||
| + | <response_code>3096</response_code> | ||
| + | <response_description>Read changed successfully</response_description> | ||
| + | <response_time>Tue, 24 May 2016 16:09:16</response_time> | ||
| + | <item_id>1148103</item_id> | ||
| + | <isbn>9782070529292</isbn> | ||
| + | <title>Harry Potter a l'ecole des sorciers ; Harry Potter et la chambre des secrets ; Harry Potter et le prisonnier d'Azkaban -- coffret 3 volumes</title> | ||
| + | <author></author> | ||
| + | </response> | ||
| + | </code> | ||
| + | |||
| + | |||
| + | === Response code === | ||
| + | |**Code** |**Code description** | | ||
| + | |3096|Read changed successfully| | ||
| + | |60|Session invalid, expired or empty| | ||
| ==== profileDeleteRead: delete user's "Current read" item ==== | ==== profileDeleteRead: delete user's "Current read" item ==== | ||
| - | **Input:** | + | === Input === |
| - | * session_id | + | * URL for XML output: https://secure.chilifresh.com/api/connections/ |
| + | * URL for JSON output: https://secure.chilifresh.com/api/connections/json/ | ||
| + | * Method: POST | ||
| + | * To be used when retrieving information for any item | ||
| + | * Parameters: | ||
| - | Output: success or fail message | ||
| + | |**Parameter** |**Type (size)** |**Mandatory** |**Description **| | ||
| + | |action|profileDeleteRead |Yes| API call| | ||
| + | |session_id|Variable characters (100)|Yes| Session ID from logged in user| | ||
| + | |||
| + | |||
| + | **XML output example:** | ||
| + | <code> | ||
| + | <?xml version="1.0"?> | ||
| + | <response> | ||
| + | <response_code>3097</response_code> | ||
| + | <response_description>Current read deleted successfully</response_description> | ||
| + | <response_time>Tue, 24 May 2016 16:11:50</response_time> | ||
| + | </response> | ||
| + | </code> | ||
| + | |||
| + | |||
| + | === Response code === | ||
| + | |**Code** |**Code description** | | ||
| + | |3097|Current read deleted successfully| | ||
| + | |60|Session invalid, expired or empty| | ||
| ==== profileDeleteAccount: delete user's ChiliFresh account ==== | ==== profileDeleteAccount: delete user's ChiliFresh account ==== | ||
| **Input:** | **Input:** | ||
connections/api.1464122453.txt.gz · Last modified: 2016/05/24 15:40 by jposeika
Page Tools
