Address Data
columnName |
Format |
Description |
---|---|---|
Action |
String [79] |
Shows the value specified in the Action input field for this call. For more information on this input field see Input. |
AddressLine1 |
String [79] |
The formatted first address line. |
AddressLine2 |
String [79] |
The formatted second address line. |
AddressLine3 |
String [79] |
The formatted third address line. |
AddressLine4 |
String [79] |
The formatted fourth address line. |
AddressLine5 |
String [79] |
The formatted fifth address line. |
AddressLine6 |
String [79] |
The formatted sixth address line. |
AddressLine7 |
String [79] |
The formatted seventh address line. |
AddressLine8 |
String [79] |
The formatted eighth address line. |
AlternativeContext |
String [79] |
Shows the value specified in the AlternativeContext input field for this call. For more information, see Input. |
AlternativeIndex |
String [79] |
Shows the value specified in the AlternativeIndex input field for this call. For more information on this input field see Input. |
Alternatives.InContext |
String [79] |
A comma-delimited list of the possible values for the field you searched on which fit the context of fields you have already committed. For information on context see What Is Context?. |
Alternatives.InContext.Count |
String [79] |
The number of "in context" results returned by your search. For information on context see What Is Context?. |
Alternatives.OutContext |
String [79] |
A comma-delimited list of the possible values for the field you searched on which do not fit the context of fields you have already committed. For information on context see What Is Context?. |
Alternatives.OutContext.Count |
String [79] |
The number of "out of context" results returned by your search. For information about context, see What Is Context?. |
ApartmentLabel |
String [79] |
Apartment designator (such as STE or APT). For example: 123 E Main St. APT 3 |
ApartmentNumber |
String [79] |
Apartment number. For example: 123 E Main St. APT 3 |
Building |
String [79] |
The name of a building. |
City |
String [79] |
The city name. |
Country |
String [79] |
Shows the value specified in the Country input field for this call. For more information about this input field, see Input. |
Country |
String [79] |
The two- or three-character ISO code, or English name of the country. For a list of ISO codes, see ISO Country Codes and Module Support. |
Department |
String [79] |
The name of a distinct part of anything arranged into divisions. For example, the Finance Department in a corporation. |
Field.n.CommitFlag |
String [79] |
Indicates whether you have chosen a value for field n (i.e. "committed" a value). One of the following:
|
Field.n.Index |
String [79] |
An index value used to refer to field n, where n is 0 though 10. For example, for U.S. addresses the index value of the ZIP field is "0". |
Field.n.Name |
String [79] |
The name of the address element contained in field n, where n is 0 through 10. For example, for U.S. addresses Field.0.Name is ZIP. |
Field.n.Value |
String [79] |
The value that has been committed to field n, where n is 0 through 10. This field is blank on the init call. |
FieldIndex |
String [79] |
Shows the value specified in the FieldIndex input field for this call. For more information on this input field see Input. |
FirmName |
String [79] |
The name of a company. For example: Pitney Bowes |
HouseNumber |
String [79] |
House number. For example: 123 E Main St. Apt 3 |
POBox |
String [79] |
The post office box number. If the address is a rural route address, the rural route box number will appear here. |
PostalCode |
String [79] |
The postal code. In the U.S. this is the ZIP Code™. |
PostalCode.AddOn |
String [79] |
The 4-digit add-on part of the ZIP + 4® Code. For example, in the ZIP Code™ 60655-1844, 1844 is the 4-digit add-on. (U.S. addresses only.) |
PostalCode.Base |
String [79] |
The 5-digit ZIP Code™. For example 20706 (U.S. addresses only.) |
Principality |
String [79] |
An area within a country. For example, England, Scotland, and Wales are principalities. This field will normally be blank. |
SearchFieldIndex |
String [79] |
The index value of the field searched in the previous search action. |
SearchValue |
String [79] |
Shows the value specified in the SearchValue input field for this call. For more information on this input field see Input. |
SessionId |
String [79] |
Shows the value specified in the SessionId input field for this call. For more information on this input field see Input. |
StateProvince |
String [79] |
The state or province abbreviation. |
StreetName |
String [79] |
Street name. For example: 123 E Main St. Apt 3 |
StreetSuffix |
String [79] |
Street suffix. For example: 123 E Main St. Apt 3 |
SubCity |
String [79] |
A district or suburb. The subcity is used in countries where it is common to include the district or suburb within the address. For example, 27 Crystal Way In this case, "Bradley Stoke" is the subcity. |
SubStreet |
String [79] |
The second street address used to identify an address. Substreets are used in countries where it is common to give two street names in the address. For example, 12 The Mews In this example, "High Street" is the substreet. Substreets can be used to precisely identify the delivery location. In the example, "The Mews" may be a small street that needs another street identification to properly locate the address, so "High Street" is included. In this case, "High Street" is the main or known street. |
USCountyName |
String [79] |
For U.S. addresses, the name of the county where the address is located. |