GetPlace
Finds a place by its unique ID. A PlaceId
is returned by other search
operations.
Note
A PlaceId is valid only if all of the following are the same in the original
search request and the call to GetPlace
.
-
Customer AWS account
-
AWS Region
-
Data provider specified in the place index resource
Request Syntax
GET /places/v0/indexes/IndexName
/places/PlaceId
?key=Key
&language=Language
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- IndexName
-
The name of the place index resource that you want to use for the search.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[-._\w]+$
Required: Yes
- Key
-
The optional API key to authorize the request.
Length Constraints: Minimum length of 0. Maximum length of 1000.
- Language
-
The preferred language used to return results. The value must be a valid BCP 47
language tag, for example, en
for English.This setting affects the languages used in the results, but not the results themselves. If no language is specified, or not supported for a particular result, the partner automatically chooses a language for the result.
For an example, we'll use the Greek language. You search for a location around Athens, Greece, with the
language
parameter set toen
. Thecity
in the results will most likely be returned asAthens
.If you set the
language
parameter toel
, for Greek, then thecity
in the results will more likely be returned asΑθήνα
.If the data provider does not have a value for Greek, the result will be in a language that the provider does support.
Length Constraints: Minimum length of 2. Maximum length of 35.
- PlaceId
-
The identifier of the place to find.
While you can use PlaceID in subsequent requests, PlaceID is not intended to be a permanent identifier and the ID can change between consecutive API calls. Please see the following PlaceID behaviour for each data provider:
-
Esri: Place IDs will change every quarter at a minimum. The typical time period for these changes would be March, June, September, and December. Place IDs might also change between the typical quarterly change but that will be much less frequent.
-
HERE: We recommend that you cache data for no longer than a week to keep your data data fresh. You can assume that less than 1% ID shifts will release over release which is approximately 1 - 2 times per week.
-
Grab: Place IDs can expire or become invalid in the following situations.
-
Data operations: The POI may be removed from Grab POI database by Grab Map Ops based on the ground-truth, such as being closed in the real world, being detected as a duplicate POI, or having incorrect information. Grab will synchronize data to the Waypoint environment on weekly basis.
-
Interpolated POI: Interpolated POI is a temporary POI generated in real time when serving a request, and it will be marked as derived in the
place.result_type
field in the response. The information of interpolated POIs will be retained for at least 30 days, which means that within 30 days, you are able to obtain POI details by Place ID from Place Details API. After 30 days, the interpolated POIs(both Place ID and details) may expire and inaccessible from the Places Details API.
-
Required: Yes
-
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Place": {
"AddressNumber": "string",
"Categories": [ "string" ],
"Country": "string",
"Geometry": {
"Point": [ number ]
},
"Interpolated": boolean,
"Label": "string",
"Municipality": "string",
"Neighborhood": "string",
"PostalCode": "string",
"Region": "string",
"Street": "string",
"SubMunicipality": "string",
"SubRegion": "string",
"SupplementalCategories": [ "string" ],
"TimeZone": {
"Name": "string",
"Offset": number
},
"UnitNumber": "string",
"UnitType": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request was denied because of insufficient access or permissions. Check with an administrator to verify your permissions.
HTTP Status Code: 403
- InternalServerException
-
The request has failed to process because of an unknown server error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource that you've entered was not found in your AWS account.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied because of request throttling.
HTTP Status Code: 429
- ValidationException
-
The input failed to meet the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: