Backpack API

List Items

List

POST /ws/page/#{page_id}/lists/#{list_id}/items/list

Items are ordered by completeness and position.

Request

<request>
  <token>202cb962ac59075b964b07152d234b70</token>
</request>

Response

Status: 200 OK

<response success='true'>
  <items>
    <item id='1' list_id='1' completed='false'>Hello world!</item>
    <item id='2' list_id='1' completed='false'>More world!</item>
    <item id='3' list_id='1' completed='true'>Done world!</item>
  </items>
</response>

Create

POST /ws/page/#{page_id}/lists/#{list_id}/items/add

Add a new item to a list.

Request

<request>
  <token>202cb962ac59075b964b07152d234b70</token>
  <item><content>I'm a new item!</content></item>
</request>

Response

Status: 200 OK

<response success='true'>
  <item id='5' list_id='1' completed='false'>I'm a new item!</item>
</response>

Update

POST /ws/page/#{page_id}/lists/#{list_id}/items/update/#{id}

Change a list item.

Request

<request>
  <token>202cb962ac59075b964b07152d234b70</token>
  <item><content>I'm an updated item!</content></item>
</request>

Response

Status: 200 OK

<response success='true' />

Toggle

POST /ws/page/#{page_id}/lists/#{list_id}/items/toggle/#{id}

Toggle the item from complete to incomplete or back.

Request

<request>
  <token>202cb962ac59075b964b07152d234b70</token>
</request>

Response

Status: 200 OK

<response success='true' />

Destroy

POST /ws/page/#{page_id}/lists/#{list_id}/items/destroy/#{id}

Remove an item from the list.

Request

<request>
  <token>202cb962ac59075b964b07152d234b70</token>
</request>

Response

Status: 200 OK

<response success='true' />

Move

POST /ws/page/#{page_id}/lists/#{list_id}/items/move/#{id}

Move an item lower or higher in a list or to the top or bottom. The direction parameters are move_lower, move_higher, move_to_bottom, and move_to_top.

Request

<request>
  <token>202cb962ac59075b964b07152d234b70</token>
  <direction>move_higher</direction>
</request>

Response

Status: 200 OK

<response success='true' />