LocalitiesGeocodeRequest class
Properties
-
address
↔ String?
-
Example: address=224 Rue de Rivoli, Paris
The input string to geocode. Can represent an address, a street, a locality or a postal code.
getter/setter pair
-
components
↔ LocalitiesComponentRestrictions?
-
Example: components=country:fr|country:es
A grouping of places to which you would like to restrict your results. Components can be used to filter over countries. Countries must be passed as an ISO 3166-1 Alpha-2 or Alpha-3 compatible country code. For example: components=country:fr or components=country:fra would restrict your results to places within France and components=country:fr-fr returns locations only in Metropolitan France. Multiple countries must be passed as multiple country:XX filters, with the pipe character (|) as a separator. For example: components=country:gb|country:fr|country:be|country:sp|country:it would restrict your results to city names or postal codes within the United Kingdom, France, Belgium, Spain and Italy.
getter/setter pair
-
countryCodeFormat
↔ CountryCodeFormat?
-
Enum: "alpha2" "alpha3"
Example: countryCodeFormat=alpha2
To specify the format for the short country code expected to be returned in the address_components field. Default is the format used to specify components or alpha2 if no components are specified.
getter/setter pair
-
data
↔ LocalitiesDataTypes?
-
Enum: "standard" "advanced"
Example: data=advanced
Two values for this parameter: standard or advanced. By default, if the parameter is not defined, value is set as standard. The advanced value opens suggestions to worldwide postal codes in addition to postal codes for Western Europe. A dedicated option subject to specific billing on your license is needed to use this parameter. Please contact us if you are interested in using this parameter and you do not have subscribed the proper option yet.
getter/setter pair
-
fields
↔ String?
-
Value: "geometry"
Example: fields=geometry
Used to limit the returning fields when type=address (by default, and for other types localities, all fields are return). Only one field is available: geometry. By using this parameter you will limit content of responses to the geometry part. No address component will be returned.
getter/setter pair
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
language
↔ String?
-
Example: language=en
The language code, using ISO 3166-1 Alpha-2 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, the Localities service will use english as default language. No language necessary for postal_code request.
getter/setter pair
-
latLng
↔ LatLng?
-
Example: latlng=5.2,-2.3
The latlng parameter is used for reverse geocoding, it’s required if the address parameter is missing.
getter/setter pair
-
listSubBuildings
↔ bool?
-
Allows to retrieve all addresses at the same location for a common street number or building.
When list_sub_buildings=true and according to actual addresses at the provided location, results may contain an additional key sub_buildings as a list of address summaries.
It will provide a public_id and a description for every address at the provided location (flats, organisations..).
getter/setter pair
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
