Skip to end of metadata
Go to start of metadata

Defines the required metadata to call geocoding API.

Definition

public class GeocodingRequest : SignableRequest

Summary

The following table summarizes the members exposed in this class.

Public Constructors

GeocodingRequest Constructor() Initializes a new instance of the GeocodingRequest class.

Public Properties

Address address (required) — The address that you want to geocode.*
Bounds bounds (optional) — The bounding box of the viewport within which to bias geocode results more prominently. (For more information see Viewport Biasing below.) The bounds and region parameters will only influence, not fully restrict, results from the geocoder.
Language language (optional) — The language in which to return results. See the supported list of domain languages. Note that we often update supported languages so this list may not be exhaustive. If language is not supplied, the geocoder will attempt to use the native language of the domain from which the request is sent wherever possible.
Location latlng (required) — The textual latitude/longitude value for which you wish to obtain the closest, human-readable address.* If you pass a latlng, the geocoder performs what is known as a reverse geocode. See Reverse Geocoding for more information.
Region region (optional) — The region code, specified as a ccTLD ("top-level domain") two-character value. (For more information see Region Biasing below.) The bounds and region parameters will only influence, not fully restrict, results from the geocoder.

Protected Methods

GetQueryStringParameters() Generate the query string parameters.

Public Constructors

public GeocodingRequest()

Public Properties

public string Address { get; set; }

address (required) — The address that you want to geocode.*

public Location[] Bounds { get; set; }

bounds (optional) — The bounding box of the viewport within which to bias geocode results more prominently. (For more information see Viewport Biasing below.) The bounds and region parameters will only influence, not fully restrict, results from the geocoder.

public string Language { get; set; }

language (optional) — The language in which to return results. See the supported list of domain languages. Note that we often update supported languages so this list may not be exhaustive. If language is not supplied, the geocoder will attempt to use the native language of the domain from which the request is sent wherever possible.

public Location Location { get; set; }

latlng (required) — The textual latitude/longitude value for which you wish to obtain the closest, human-readable address.* If you pass a latlng, the geocoder performs what is known as a reverse geocode. See Reverse Geocoding for more information.

public string Region { get; set; }

region (optional) — The region code, specified as a ccTLD ("top-level domain") two-character value. (For more information see Region Biasing below.) The bounds and region parameters will only influence, not fully restrict, results from the geocoder.

Protected Methods

protected QueryStringParametersList GetQueryStringParameters()

Generate the query string parameters.

Return Types

The query string parameters.
  • No labels