Maps SDK for Web

Name	Description
options Object default:None	Options to be passed to the search call, or an array of such options objects to perform a batch request.
options.key Required 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.limit Number default:10	The maximum number of responses that will be returned. Represents the maximum number of responses that will be returned per request. The maximum value is 100.
options.protocol "http" \| "https" default:"https"	The protocol type to be used in the calls. Represents the type of protocol used to perform a service call.
options.relatedPois String default:None	The only available options are `off`, `child`, `parent`, `all`. 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: If the value `child` or `parent` is given, a related POIs with a specified relation type will be returned in the Response. If the value `all` is given, then both child and parent relations are returned. Example `// search for airport terminals inculding their related Points Of Interest. tt.services.fuzzySearch({ query: 'airport terminal', relatedPois: 'all' }).then(handleResults);`
options.timeZone String default:None	The only available option is `iana`. 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 `// search for cinemas including their opening hours and IANA ID. tt.services.fuzzySearch({ query: 'cinema', openingHours: 'nextSevenDays', timeZone: 'iana' }).then(handleResults);`
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. It can be used to trace a call. The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'. An example of the format that matches this regular expression is UUID: (e.g. 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1). For details check RFC 4122. If specified, it is replicated in the Tracking-ID Response header. It is only meant to be used for support and does not involve tracking of you or your users in any form.

options
Object
default:None

Options to be passed to the search call, or an array of such options objects to perform a batch request.

options.key Required
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.limit
Number
default:10

The maximum number of responses that will be returned.

Represents the maximum number of responses that will be returned per request. The maximum value is 100.

options.protocol
"http" | "https"
default:"https"

The protocol type to be used in the calls.

Represents the type of protocol used to perform a service call.

options.relatedPois
String
default:None

The only available options are off, child, parent, all.

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:

If the value child or parent is given, a related POIs with a specified relation type will be returned in the Response.
If the value all is given, then both child and parent relations are returned.

Example

// search for airport terminals inculding their related Points Of Interest.
tt.services.fuzzySearch({
  query: 'airport terminal',
  relatedPois: 'all'
}).then(handleResults);

options.timeZone
String
default:None

The only available option is iana.

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

// search for cinemas including their opening hours and IANA ID.
tt.services.fuzzySearch({
  query: 'cinema',
  openingHours: 'nextSevenDays',
  timeZone: 'iana'
}).then(handleResults);

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.

It can be used to trace a call.
The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'.
An example of the format that matches this regular expression is UUID: (e.g. 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1). For details check RFC 4122.
If specified, it is replicated in the Tracking-ID Response header.
It is only meant to be used for support and does not involve tracking of you or your users in any form.

Maps SDK for Web

Search

Constructor

Search([options])

Parameters

Example

Example