Maps SDK for Web
tt.services.placeById
Makes a placeById request using Place by Id API.
The Place by Id service endpoint provides detailed information about the Place found by its identifier (entityId). Currently, Place by Id only supports POI (Points of Interest) ids.
Parameters need to be passed to the constructor.
Response
The response is extended with getTrackingId()
method, which returns the Tracking-ID
associated with the request.
Additionally, the response extends API response by providing toGeoJson()
method, which converts place by id data into
FeatureCollection with Point geometry.
Each point feature represents poi
from the original response. Properties of poi
are mapped into feature properties
Please refer to Difference between API responses and this library's responses section.
Constructor
tt.services.placeById([options], [additionalOptions])
Example
tt.services.fuzzySearch({
key: <Your API key>,
query: "pizza"
}).then(function(response) {
tt.services.placeById({
entityId: response.results[0].id,
key: <Your API key>
}).then(function(placeByIdResult) {
console.log(placeByIdResult);
});
});
Parameters
Name | Description |
---|---|
options
Object default:None |
|
additionalOptions
Object default:None |
Additional options to be passed to the service. |
additionalOptions.abortSignal
Object default:None |
Signal created with abortController. Use AbortController to cancel requests in progress. Example
|
options.entityId
String default:None |
The identifier of a specific POI,
e.g. |
options.key
String default:None |
A valid API Key for the requested service. Key is required to make use of the given service. It can be issued in the Developer Portal. |
options.language
String default:null |
Language code that decides in which language the results should be returned. The value should correspond to one of the supported IETF language codes. The list is available here. The code is case insensitive. |
options.mapcodes
String default:null |
Enables the return of a comma-separted mapcodes list. It can also filter the response to only show selected mapcode types. See Mapcodes in the response. Values: One or more of:
A mapcode represents a specific location, to within a few meters. Every location on Earth can be represented by a mapcode. Mapcodes are designed to be short, easy to recognize, remember, and communicate. Visit the Mapcode project website for more information. Usage examples: Example
|
options.openingHours
String default:None |
The only available option is 'nextSevenDays'. This option shows the opening hours for the next week, starting with the current day in the local time of the POI. Example
|
options.relatedPois
String default:None |
The only available options are This option is used to provide the possibility to return related Points Of Interest. Points Of Interest can be related to each other when one is physically part of another. For example, an airport terminal can physically belong to an airport. This relationship is expressed as a parent/child relationship: the airport terminal is a child of the airport. Usage:
|
options.timeZone
String default:None |
The only available option is This option is used to indicate the mode in which the timeZone object should be returned. The only available option is iana - mode that shows the IANA ID which allows the user
to determine the current time zone for the POI.
Example
|
options.trackingId
String default:uuid |
Sets value of "Tracking-ID" header. Specifies an identifier for the request. If not set by the user, UUID is generated for each call.
|