Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following two example URIs are equivalent and return the first 20 of the available locations as the 0th page of locations.

Code Block

/restaurants/search
/restaurants/search?q=&page=0&count=20

An example query URL that returns the third page of results for all locations with Haru in the name:

Code Block

/restaurants/search?q=Haru&page=3&count=100

The following example returns the first 20 of the locations updated since January 18, 2012 at 2:03 pm as the 0th page of locations.

Code Block

/restaurants/search?updatedSince=2012-01-18+14:03

...

  • A map of:
    • query: The original query line sent to the search engine
    • ok: true if the search was a success. false if the search was not a success. If the search was a success , should be truebut no results were found, this value is true.
    • page: Which page these results are on, should match the original query (or be 0 if not defined in the original query)
    • count: Number of results per page, should match the original query (or be 20 if not defined in the original query)
    • total: The full number of results that the search have matched; can be used to calculate total number of pages
    • time: The date/time when the query was performed in Eastern Standard Time (EST).
    • results: A list of maps, each is a location with the keys as defined in Location Field Descriptions.

...