OpenMenu API - updates

Find what OpenMenu's have been been added, removed and changed.

Call

http://openmenu.com/api/v1/updates?key=[API_KEY] + parameters

Parameters

  • key

    developers key for access to the API format: api key required

  • output

    format of the output response format: xml | json (default: xml) not required

  • offset

    offset of results to get (paging) format: integer (max 100) (default: 0) not required

  • country

    country to limit update results to format: ISO 3166-1 alpha-2 not required

  • bt

    business type to limit results to ( [f]ranchisee | [c]orporate | [i]ndependent ) format: f | c | i not required

  • type

    type of update to limit results to ( [n]ew | [u]pdate | [d]elete ) format: n | u | d not required

Return Values

  • openmenu_id

    the OpenMenu ID for the restaurant format: UUID v4

  • accuracy

    the Accuracy value for the restaurant format: numeric 1-9

  • date_updated

    date of last update format: yyyy-mm-dd hh:mm:ss (ISO 8601)

  • date_added

    date the restaurant was registered with OpenMenu format: yyyy-mm-dd hh:mm:ss (ISO 8601)

  • registrar

    registrar in control of the restaurant format: string

  • omf_file_url

    OpenMenu URL for the restaurant format: 11 - 120 characters starting with http://

  • type

    what type of update/change is this format: new | update | delete

Return Status Codes

  • 200

    successful call

  • 304

    updates have not been modified based on 'if-modified-since' header sent

  • 400

    api key is missing

  • 401

    incorrect API key

Sample Response

Notes

  • order by: date updated is descending
  • call supports If-Modified-Since header
  • country and bt are filters to the updates stream