Return to documentation index

icons

The icons API retrieves a list of all of icons that can be used on the iPads for various purposes.

Parameters

  • api_key (string) Required - The API key for the account
  • last_updated_at (datetime) Optional - If this parameter is supplied, only icons whose last edited date is after the supplied date and time will be returned. The parameter should be formatted as "YYYY-MM-DD HH:MM:SS" and will be interpreted as a UTC date and time value.

Response

The icons API returns a JSON array of icons. Each member of the array includes these attributes:

  • id - Unique identifier.
  • image_url - A URL from which the icon can be retrieved.
  • billboard_image_url - A URL from which a version of the icon for use on billboards can be retrieved.
  • name - The friendly name of the icon.
  • updated_at - The date that this icon was last edited.

Notes

The id attribute is used by other APIs to indicate an icon to display. It is expected that clients will cache a local copy of icons that they have retrieved.

No icon will be delivered in the API unless the user has supplied both a regular URL and a billboard image URL for it.

Icon Specification

A file linked to via the image_url attribute should return an icon which is a square of dimensions 50px by 50px.

The icon itself should be a purely black data source on a zero alpha background. The black area should occupy no more than 90% of the width and no more than 90% of the height of the total area. See the image below for an illustration.

Icon Spec

Sample Request

https://dashboard.onpremisewine.com/icons.json?api_key=ABCDEF123456

Sample Response

{
  "icons": [
    {
      "id": 1,
      "image_url": "https://dashboard.onpremisewine.com/assets/billboard_buttons/0.png",
      "billboard_image_url": "https://dashboard.onpremisewine.com/assets/billboard_buttons_large/0.png",
      "name": "Wine bottle & glass",
      "updated_at": "2013-03-06T08:10:32-07:00",
    },
    {
      "id": 2,
      "image_url": "https://dashboard.onpremisewine.com/assets/billboard_buttons/1.png",
      "billboard_image_url": "https://dashboard.onpremisewine.com/assets/billboard_buttons_large/1.png",
      "name": "Beer bottle & glass",
      "updated_at": "2013-03-06T08:10:32-07:00",
    },
    {
      "id": 3,
      "image_url": "https://dashboard.onpremisewine.com/assets/billboard_buttons/2.png",
      "billboard_image_url": "https://dashboard.onpremisewine.com/assets/billboard_buttons_large/2.png",
      "name": "Spirits glasses",
      "updated_at": "2013-03-06T08:10:32-07:00",
    },
  ]
}