All docs This doc
Skip to end of metadata
Go to start of metadata


Overview

The following operations allow you to work with lists. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with lists, see Sample configuration

OperationDescription

createList

Creates a list.

getListRetrieves a specific list.
listListsRetrieves all lists a user has permission to.
updateListUpdates a list by overwriting properties.

Operation details

This section provides further details on the operations related to lists.

Creating a list

The createList operation creates a list.

createList
<wunderlist.createList>
	<title>{$ctx:title}</title>
</wunderlist.createList>
Properties
  • title: The title of the folder.
   Sample request

Following is a sample REST/JSON request that can be handled by the createList operation.

Sample Request for createList
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
	"title": "Sam's List"
}
Related Wunderlist documentation

https://developer.wunderlist.com/documentation/endpoints/list

Retrieving a specific list 

The getList operation retrieves a specific list.

getList
<wunderlist.getList>
	<listId>{$ctx:listId}</listId>
</wunderlist.getList>
Properties
  • listId: The ID of the list whose details would be retrieved.
   Sample request

Following is a sample REST/JSON request that can be handled by the getList operation.

Sample Request for getList
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
	"listId": "164231691"
}
Related Wunderlist documentation

https://developer.wunderlist.com/documentation/endpoints/list

Retrieving all lists a user has permission to

The listLists operation retrieves all lists a user has permission to.

listLists
<wunderlist.listLists>
</wunderlist.listLists>
   Sample request

Following is a sample REST/JSON request that can be handled by the listLists operation.

Sample Request for listLists
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821"
}
Related Wunderlist documentation

https://developer.wunderlist.com/documentation/endpoints/list

Updating a list by overwriting properties

The updateList operation updates a list by overwriting properties.

updateList
<wunderlist.updateList>
	<revision>{$ctx:revision}</revision>
    <title>{$ctx:title}</title>
	<listId>{$ctx:listId}</listId>
</wunderlist.updateList>
Properties
  • revision: Revision of the list to update.
  • title: Title of the folder.
  • listId: The ID of the list to update.
   Sample request

Following is a sample REST/JSON request that can be handled by the updateList operation.

Sample Request for updateList
{
    "apiUrl": "https://a.wunderlist.com",
    "accessToken": "75f42c8c00558ed675a97ce105c957cbcf8bf4c80e925b20df536326ae6a",
    "clientId": "1b5d64550ba2aa022821",
    "listId": "164231691",
	"revision": 1,
    "title": "list updated"
}
Related Wunderlist documentation

https://developer.wunderlist.com/documentation/endpoints/list

Sample configuration

Following is a sample proxy service that illustrates how to connect to Wunderlist with the init operation and use the createList operation. The sample request for this proxy can be found in the createList  sample request.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy name="wunderlist_createList" startOnLoad="true" statistics="disable" trace="disable" transports="https,http" xmlns="http://ws.apache.org/ns/synapse">
   <target>
      <inSequence onError="faultHandlerSeq">
         <property name="apiUrl" expression="json-eval($.apiUrl)"/>
         <property name="clientId" expression="json-eval($.clientId)"/>
         <property name="accessToken" expression="json-eval($.accessToken)"/>
         <property name="title" expression="json-eval($.title)"/>
         <wunderlist.init>
            <apiUrl>{$ctx:apiUrl}</apiUrl>
            <clientId>{$ctx:clientId}</clientId>
            <accessToken>{$ctx:accessToken}</accessToken>
         </wunderlist.init>
         <wunderlist.createList>
            <title>{$ctx:title}</title>
         </wunderlist.createList>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>
  • No labels