OpenMenu API - crosswalk

Access to crosswalks and their connections to an OpenMenu.

Call

http://openmenu.com/api/v1/crosswalk?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

  • uuid

    OpenMenu ID of the menu to retrieve information about format: OpenMenu ID required if crosswalk not passed

  • crosswalk

    Crosswalk ID to search for and return OpenMenu ID for (not dependant on the crosswalk company) format: string required if uuid not passed

Return Values

  • openmenu_id

    the OpenMenu ID for the restaurant format: UUID v4

  • crosswalk_id

    the Accuracy value for the restaurant format: alpha-numeric

  • crosswalk_company

    company name issuing the crosswalk ID format: string

  • crosswalk_url

    direct URL to the crosswalk source format: url

  • date_updated

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

Return Status Codes

  • 200

    successful call

  • 204

    call resulted in an empty resultset

  • 400

    api key is missing

  • 417

    missing required parameters

  • 401

    incorrect API key

Sample Response

Notes

  • either crosswalk or uuid must be passed
  • uuid takes precedence in call