Data Description

These are the descriptions of the fields included in the data we make available. All data is presented in JSON format.

List Format

In these data definitions, many of the models contain lists of elements. These lists follow a standard format:

• each element in the list is a distinct element, usually either a sub-document or a string (i.e., the list is not a single string containing a comma-separated list of elements)
• zero or more elements can be in the list

Location Field Descriptions

A location consists of a JSON document containing the following information:

• id: the unique name of this location as used in the REST API and in the menu links. This is alpha-numeric.
• factualId: the factual ID mapping for this location
• outOfBusiness: indicates if the location is in business or out of business (i.e., closed). Valid values: true or false
  • NOTE: This field has been deprecated. While we still expose the field as to not disrupt existing publisher integrations, all values for outOfBusiness will be false.
• businessType: the type of business for the location
• publishedAt: the date the location was published
• general
  
  • name: the name of the location
  • timeZone: time zone of the location
  • desc: general description of the location
  • website: location's existing website
• location: address, directions, and other information about the physical location of the location
  
  • address1: physical street address of the location
  • address2: physical street address of the location
  • city: city of the location
  • region: region of the location (state, province, territory, etc.)
  • postcode: postal code of the location
  • country: the country in which the location resides
  • latitude: the latitude of the location
  • longitude: the longitude of the location
• phones: a map of phone name to phone numbers. Each number is a 10 digit number with no dashes or spaces and no 1 at the beginning.
  
  • main: location's main number
  • fax: location's fax number
• Hours: the daily opening and closing hours for a business

Sample Location Data

Here is a sample of what the location data would look like.

{
  "id" : "abc-kitchen",
  "general" : {
    "name" : "ABC Kitchen",
    "timeZone" : "EST",
    "desc" : null,
    "website" : "http://www.abchome.com/systemPage/services/restaurants/abckitchen/tabid/893/Default.aspx"
  },
  "location" : {
    "address1" : "35 East 18th Street",
    "address2" : null,
    "city" : "New York",
    "region" : "NY",
    "postcode" : "10003"
  },
  "phones" : {
    "main" : "2124755829",
    "fax" : "2125983020"
  }
}

[ {
  "id" : "abc-kitchen",
  "general" : {
    "name" : "ABC Kitchen",
    "timeZone" : "EST",
    "desc" : null,
    "website" : "http://www.abchome.com/systemPage/services/restaurants/abckitchen/tabid/893/Default.aspx"
  },
  "location" : {
    "address1" : "35 East 18th Street",
    "address2" : null,
    "city" : "New York",
    "region" : "NY",
    "postcode" : "10003"
  },
  "phones" : {
    "main" : "2124755829",
    "fax" : "2125983020"
  }
},
{
  "id" : "les-halles",
  "general" : {
    "name" : "Les Halles",
    "timeZone" : "EST",
    "desc" : null,
    "website" : "http://leshalles.net/"
  },
  "location" : {
    "address1" : "411 Park Avenue South",
    "address2" : null,
    "city" : "New York",
    "region" : "NY",
    "postcode" : "10016"
  },
  "phones" : {
    "main" : "2126794111",
    "fax" : "2122132065"
  }
},
{
  "id" : "les-halles-2",
  "general" : {
    "name" : "Les Halles",
    "timeZone" : "EST",
    "desc" : null,
    "website" : "http://leshalles.net/"
  },
  "location" : {
    "address1" : "15 John Street",
    "address2" : null,
    "city" : "New York",
    "region" : "NY",
    "postcode" : "10038"
  },
  "phones" : {
    "main" : "2122858585",
    "fax" : "2127913280"
  }
} ]