Developer Guide (On-Premises)

5.11.0
- 5.9.0
- 5.8.1
- 5.8.0
- 5.16.4
- 5.16.3
- 5.16.2
- 5.16.1
- 5.16.0
- 5.15.0
- 5.14.0
- 5.13.0
- 5.12.0
- 5.10.0

Back Next

AddressElements

The

AddressElements

subelement of

ResultData

contains the following elements:

Key: Contains the record ID or transaction key. The attributes include:
Type. The possible values are RECORD_ID and TRANSACTION_KEY. The default value is RECORD_ID.
Item. Number of items. The range is 1 through 3. The default value is 1.
Country: Contains the country name or the country code based on the configuration for the
CountryType
attribute in
Parameters.xml
. The attributes include:
Type. Type of country information. The possible values are ABBREVIATION, ISO2, ISO3, ISO_NUMBER, NAME_CN, NAME_DA, NAME_DE, NAME_EN, NAME_ES, NAME_FI, NAME_FR, NAME_GR, NAME_HU, NAME_IT, NAME_JP, NAME_KR, NAME_NL, NAME_PL, NAME_PT, NAME_RU, NAME_SA, and NAME_SE. The default value is NAME_EN.
Item. Number of items. The range is 1 through 3. The default value is 1.
Locality: Contains the locality information. The attributes include:
Type. The type of locality information. The possible values are COMPLETE, NAME, PREFERRED_NAME, SORTING_CODE, and ADD_INFO. The default value is COMPLETE.
Item. The number of items. The range is 1 through 6. The default value is 1.
PostalCode: Contains the postal code. The attributes include:
Type. The type of postal code information. The possible values are FORMATTED, UNFORMATTED, BASE, and ADD_ON. The default value is FORMATTED.
Item. The number of items. The range is 1 through 3. The default value is 1.
Province: Contains the province information. The attributes include:
Type. The type of province information. The possible values are COUNTRY_STANDARD, ABBREVIATION, EXTENDED, and ISO. The default value is COUNTRY_STANDARD.
Item. The number of items. The range is 1 through 6. The default value is 1.
Street: Contains the street information. The attributes include:
Type. The type of street information. The possible values are COMPLETE, COMPLETE_WITH_NUMBER, NAME, PRE_DESCRIPTOR, POST_DESCRIPTOR, PRE_DIRECTIONAL, POST_DIRECTIONAL, and ADD_INFO. The default value is COMPLETE.
Item. The number of items. The range is 1 through 6. The default value is 1.
Number: Contains the information such as house or building number. The attributes include:
Type. The type of number information. The possible values are COMPLETE, NUMBER, DESCRIPTOR, and ADD_INFO. The default value is COMPLETE.
Item. The number of items. The range is 1 through 6. The default value is 1.
Building: Contains the building information. The attributes include:
Type. The type of building information. The possible values are COMPLETE, COMPLETE_WITH_SUBBUILDING, NAME, NUMBER, and DESCRIPTOR. The default value is COMPLETE.
Item. The number of items. The range is 1 through 6. The default value is 1.
SubBuilding: Contains the subbuilding information. The attributes include:
Type. The type of building information. The possible values are COMPLETE, NAME, NUMBER, and DESCRIPTOR. The default value is COMPLETE.
Item. The number of items. The range is 1 through 6. The default value is 1.
DeliveryService: Contains the delivery service information. The attributes include:
Type. The type of delivery service information. The possible values are COMPLETE, DESCRIPTOR, NUMBER, and ADD_INFO. The default value is COMPLETE.
Item. The number of items. The range is 1 through 3. The default value is 1.
Organization: Contains the organization information. The attributes include:
Type. The type of organization information. The possible values are COMPLETE, NAME, DESCRIPTOR, and DEPARTMENT. The default value is COMPLETE.
Item. The number of items. The range is 1 through 3. The default value is 1.
Contact: Contains the contact information. The attributes include:
Type. The type of contact information. The possible values are COMPLETE, FIRST_NAME, MIDDLE_NAME, LAST_NAME, NAME, TITLE, FUNCTION, SALUTATION, and GENDER. The default value is COMPLETE.
Item. The number of items. The range is 1 through 3. The default value is 1.
Residue: Contains superfluous or additional information. The attributes include:
Type. The type of contact information. The possible values are NECESSARY, SUPERFLUOUS, and UNRECOGNIZED. The default value is UNRECOGNIZED.
Item. The number of items. The range is 1 through 6. The default value is 1.

Rename Saved Search

Table of Contents

Developer Guide (On-Premises)

Developer Guide (On-Premises)

AddressElements

AddressElements