The Places (Search) API provides various resources that represent entrypoints into the places service. Search & Discovery Entrypoints provide the fundamental entrypoints of the Places (Search) API and are the first step in the User Flow. Additional Entrypoints occasionally occur before or after the typical user flow.
For each of the entrypoints below, there is a description of several aspects: Resource URI, Resource Parameters, HTTP Method, Request Example, Response Example, Response Media Type, and Representation Modifiers.
- Resource URI – identifies the appropriate coding to be included in a request header in order to use the resource (along with some of the parameters). For example, with the Search Resource URI as
/discover/search?q=...&[at=...], a developer needs to include
/discover/searchwith the parameters of
at. To see how to organize each resource and the resulting parameters, see the Request Example for reach resource.
- Resource Parameters – are base parameters for each resource. Each resource has different parameters with differing levels of requirement which is explained under each respective resource.
- HTTP Method – indicates the desired action to be performed on the identified resource.
- Request Example – Is an example showing the proper way to send a request for the given Resource. Note that the each example includes the Resource URI, the appropriate parameters for that Resource URI (for example
atfor the Search resource), the authorization credentials,
app_code, and some additional standardized REST parameters (like
prettyfor pretty printing).
- Response Media Type- is the appropriate Media Type for that Resource. Media types are additional resources that work with their parent resource to offer additional optional information or usability.
- Representation Modifiers- API media types allow applications to adjust the presentation of the returned response to suit their needs. Applications can activate the various tailoring options by passing a series of options as additional query string parameters to the request. For each Resource there is listed a number of parameters that are appropriate for that particular Resource.
- Response Example – is an example response from the Places (Search) API servers for the given Resource Entrypoint (for example for the “search” Resource Entrypoint). This information is represented in the JSON representation.