Address Class
Address Class
Contains constituent parts of an address—which may include street line, city, secondary city, subdivision, postal code, country/region—and/or a complete, unparsed address.
Public Class Address Inherits System.Object
[C#]
public class Address : System.Object
Public Properties
Name | Description |
---|---|
AddressLine | The street line of an address. The AddressLine property is the most precise, official line for an address relative to the postal agency servicing the area specified by the PrimaryCity, SecondaryCity, or PostalCode properties. Typical use of this element would be to enclose a street address, private bag, or any other similar official address. |
CountryRegion | The country or region name of an address. |
FormattedAddress | The complete, unparsed address. |
PostalCode | The post code, postal code, or ZIP Code of an address. |
PrimaryCity | The name of the city of an address. |
SecondaryCity | The name of the secondary city of an address in the United Kingdom. |
Subdivision | The subdivision name within the country or region for an address. This element is also commonly treated as the first order administrative subdivision, but in some cases it is the second, third, or fourth order subdivision within a country, dependency, or region. |
Remarks
The Address class is used with the FindAddressSpecification.InputAddress property as input to the FindServiceSoap.FindAddress method.
For an address to be valid for use with the FindAddress method, it must contain one of the following:
At least one context element such as PrimaryCity, SecondaryCity, PostalCode, or Subdivision property. (The AddressLine property is optional.)
A FormattedAddress property.
If all properties are sent, the method uses the AddressLine and context properties. If the PrimaryCity property is null or if it is passed without any context properties, the method uses the FormattedAddress property.
The Address class is returned from the FindServiceSoap.ParseAddress method.
If available for the specified latitude and longitude coordinate, the Address class is returned from the FindServiceSoap.GetLocationInfo method if the GetInfoOptions.IncludeAddresses property is True.
If available for the specified entity type and properties, the Address class is returned from the FindByID, FindByProperty, FindNearby and FindNearRoute methods of the FindServiceSoap class.
The Address class is also used as a property of the Location object.
The following table shows how the parts of an address in the following countries or regions map to the properties of the Address class.
Property |
Austria, Belgium, Denmark, Finland, France, Germany, Greece, Luxembourg, Norway, Sweden, Switzerland, Taiwan, and The Netherlands |
Australia and Brazil |
Canada |
Italy, Portugal, and Spain |
Hong Kong |
Puerto Rico |
Singapore and New Zealand |
United Kingdom |
United States |
---|---|---|---|---|---|---|---|---|---|
AddressLine |
Street Address |
Street Address |
Street Address |
Street Address |
Street Address |
Street Address |
Street Address |
Address Line 1 |
Street Address |
PrimaryCity |
City |
City |
City |
City |
City |
City |
City |
Address Line 2 |
City |
SecondaryCity |
City |
||||||||
Subdivision |
State |
Province |
Province |
Territory |
County |
State |
|||
PostalCode |
Postcode |
Postal Code |
Postal Code |
Postcode |
Postal code |
Postcode |
Postcode |
ZIP Code |
See Also
FindAddressSpecification.InputAddress Property | FindServiceSoap Class | GetInfoOptions.IncludeAddresses Property | Location Class