List

Overview

Vendors

The List product integration is supported currently by the RESTful API vendor or by basic App Manager configuration.

User Experience

Screenshots

The following is an overview of the List product integration user interface for reference when configuring it:

Select Filter (the preliminary filtering page is not mandatory)	To Do List with Favorites Selected
To Do List Without Favorites Selected	Links Without Favorites
Favorites with Checkboxes	To Do List with Checkboxes
To Do List with Searchbar

Live Tile

A 1*2 live tile displays the first few items in the list. Items can be configured to link to external URLs.

First Category	Second Category	Only One Category, Without Category Title

To make the live tile active, the borders in the tile must be disabled. This is done by putting the following in the Tile Config code:

"hoverBorderColor": null,

"borderColor": null

Technical Overview

• The API receives as a query parameter a user parameter that receives the user's identifier as configured in the API configuration.
• The API is in the format: https://www.mydomain.com/getListData?user=username
• The API returns a JSON response with the following structure:
  {
      "categories": [
          {
              "categoryTitle": "Semester Dates",
              "filter": "Filter 1",
              "action": "description",
              "itemsArray": [
                  {
                      "itemTitle": "Review semester start date",
                      "description": "Make\nsure you are aware\n\nof the key dates at the stג€¦luding\norientation week, online training and\nmore"
                      "image": "https://exampleImage.png"
                  },
                  {
                      "itemTitle": "Review semester end date",
                      "description": "Ensure you complete all the tasks needed to complete the term successfully"
                      "image": "https://exampleImage.png"
                  }
              ]
          },
          {
              "categoryTitle": "Don't Forget",
              "filter": "Filter 1",
              "action": "none",
              "itemsArray": [
                  {
                      "itemTitle": "Pay your fines and fees"
                      "image": "https://exampleImage.png"
                  },
                  {
                      "itemTitle": "Return library books"
                      "image": "https://exampleImage.png"
                  },
                  {
                      "itemTitle": "Checkout from dorms"
                      "image": "https://exampleImage.png"
                  },
                  {
                      "itemTitle": "Recycle materials"
                      "image": "https://exampleImage.png"
                  }
              ]
          },
          {
              "categoryTitle": "Links",
              "filter": "Filter 2",
              "action": "URL",
              "itemsArray": [
                  {
                      "itemTitle": "Facebook",
                      "url": "https://www.facebook.com"
                      "image": "https://exampleImage.png"
                  },
                  {
                      "itemTitle": "Instagram",
                      "url": "https://www.instagram.com"
                      "image": "https://exampleImage.png"
                  },
                  {
                      "itemTitle": "Google",
                      "url": "https://www.google.com"
                      "image": "https://exampleImage.png"
                  },
                  {
                      "itemTitle": "Twitter",
                      "url": "https://www.twitter.com"
                      "image": "https://exampleImage.png"
                  },
                  {
                      "itemTitle": "Linkedin",
                      "url": "https://www.linkedin.com"
                      "image": "https://exampleImage.png"
                  },
                  {
                      "itemTitle": "Buzzfeed",
                      "url": "https://www.buzzfeed.com"
                      "image": "https://exampleImage.png"
                  }
              ]
          }
      ]
  }

The lists can also be configured directly on the configuration page by selecting Configuration as the vendor.

In order to update the selections via an API, you may create an API that applies the following requirements:

• The API is a POST request in the format: https://www.mydomain.com/updateSelection
• The body of the request must be in the following structure:

Sample Response

The API returns a JSON response of the following structure:

Sample Response