profile

The profile API retrieves information on the current account.

Parameters

api_key (string) Required - The API key for the account
last_updated_at (datetime) Optional - If this parameter is supplied, only company information 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 profile API returns a JSON representation of the current account.

company attributes

The company section of the response contains a single restaurant JSON object with these attributes:

admin_pin - Code for access to admin functionality on the iPads.
billboard_message - Message to show on iPad billboards.
billboard_theme - Theme to use on iPad billboards. See below for valid themes.
device_theme - Theme type to use on the iPads. A value of 0 indicates the light theme, and a value of 1 indicates the dark theme.
id - Unique identifier for the account.
name - Name of the account.
pos_system - Identifier for the POS system in the account. See below for valid identifiers.
updated_at - Date and time that the account was last updated.
url - Account's own URL (may be null)
last_hard_count - Date and time of the last inventory count for the account.
uses_inventory_locations - True if the company segregates inventory by location.

Billboard Themes

0 - Default White
1 - Slate
2 - Caribbean
3 - Blue Steel
4 - Light Gray
5 - Lush Green
6 - Cabin
7 - Tangerine
8 - Valentine
9 - Royal Purple
10 - Blaze

POS systems

0 - No POS system
1 - Micros 3700
2 - Aloha
3 - Micros 9700
4 - Squirrel
5 - Digital Dining
6 - Positouch
7 - Dinerware
8 - Infogenesis
9 - Aspex
10 - PixelPoint
11 - Future
12 - ClubSoft
13 - RPower

Notes

The company/restaurant/id attribute is used by the restaurant_assets API to indicate the account to which each downloadable file belongs.

Sample Request

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

Sample Response

{
  "company": {
    "restaurant": {
      "admin_pin": "9999",
      "billboard_message": "Welcome to Restaurant",
      "billboard_theme": 0,
      "device_theme": 0,
      "id": 160,
      "name": "Restaurant",
      "pos_system": 0,
      "updated_at": "2012-08-24T14:09:38-07:00",
      "url": "",
      "last_hard_count": "2012-08-21T14:09:38-07:00",
      "uses_inventory_locations": false
    }
  }
}