AtlasCT.com
User Manual v5.0

SearchRequest

SearchRequest represent the search request parameters for a global search.


Summary
SearchRequest represent the search request parameters for a global search.
SearchRequest constructor; Creates a new SearchRequest instance by the given address.
SearchRequest constructor; Creates a new SearchRequest instance by the given coordinate.
The search term to execute.
The address of the request.
The coordinate of the request.
ISO ALPHA-3 country code (optional).
ISO 639-3 language code (optional).
The result limit of the request (optional).
The requested poi categories (optional).
The maximum radius (relevent for local search - optional).
The minimum grade for the results (optional).

Constructors

SearchRequest

SearchRequest(string searchTerms
Address address
SettingsRequest settingsRequest)

Creates a new SearchRequest instance by the given address. These are the options to use:

  • searchTerms only.
  • searchTerms and address.
  • address and poiCategories(in SettingsRequest).

Parameters

searchTermsThe search term to execute.
addressThe address of the request.
settingsRequestThe SettingsRequest class represent the settings of the request.

SearchRequest

SearchRequest(string searchTerms
Coordinate coordinate
SettingsRequest settingsRequest)

Creates a new SearchRequest instance by the given coordinate. These are the options to use:

  • searchTerms only.
  • searchTerms and coordinate.
  • coordinate and poiCategories(in SettingsRequest).

Parameters

searchTermsThe search term to execute.
coordinateThe coordinate of the request.
settingsRequestThe SettingsRequest class represent the settings of the request.

Properties

countryCode

string countryCode

ISO ALPHA-3 country code (optional). 

language

string language

ISO 639-3 language code (optional). 

resultsLimit

string resultsLimit

The result limit of the request (optional). 

poiCategories

string poiCategories

The requested poi categories (optional). 

maxRadius

string maxRadius

The maximum radius (relevent for local search - optional). 

minGrade

string minGrade

The minimum grade for the results (optional). 

SearchRequest(string fullSearchRequest)
SearchRequest constructor; Creates a new SearchRequest instance by properties below.t value.
This is the base class of the provided coordinates classes.