User Tools

Site Tools


connections-api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Last revision Both sides next revision
connections-api [2014/12/27 16:06]
jposeika [Response code]
connections-api [2014/12/27 16:19]
jposeika [Response code]
Line 355: Line 355:
 |2700|Listing of bookshelf successful| |2700|Listing of bookshelf successful|
 |61|User not logged in or not specified| |61|User not logged in or not specified|
 +
 +===== bookshelfMoveItem:​ move an item from one bookshelf to another =====
 +Move an item from one bookshelf to another
 +
 +==== Input ====
 +  * URL for XML output: https://​secure.chilifresh.com/​api/​connections/​
 +  * URL for JSON output: https://​secure.chilifresh.com/​api/​connections/​json/​
 +  * Method: POST
 +  * Parameters:
 +
 +|**Parameter** |**Type (size)** |**Mandatory** |
 +|action|**bookshelfMoveItem** |Yes|
 +|account|Integer (10)|Yes|
 +|from_shelf|Integer (10)|Yes|
 +|to_shelf|Integer (10)|Yes|
 +|item_id|Integer (10)|Yes|
 +|session_id|Yes|
 +|location|Variable characters (40)|If applicable|
 +|api_key|Variable characters (40)|Yes|
 +
 +==== Output ====
 +
 +
 +**XML output example:**
 +<​code>​
 +<?xml version="​1.0"?>​
 +<​response>​
 + <​response_code>​2800</​response_code>​
 + <​response_description>​Item moved successfully</​response_description>​
 + <​response_time>​Sat,​ 27 Dec 2014 17:​16:​55</​response_time>​
 +</​response>​
 +</​code>​
 +
 +==== Response code ====
 +|**Code** |**Code description** |
 +|2800|Item moved successfully|
 +|2801|Could not move item to other bookshelf|
 +|2802|Target shelf does not belong to session user|
 +|60|Session invalid, expired or empty|
 ====== Account-related errors ====== ====== Account-related errors ======
 |**Error code** |**Error description** | |**Error code** |**Error description** |
connections-api.txt ยท Last modified: 2014/12/27 16:29 by jposeika