Please enable JavaScript to view this site.

Navigation: Schema: CompanyInfo > Tables

internationalAddressSearchInteractive

Catalog: CompanyInfo

Schema: CompanyInfo

This is a read-only table function. The Company.info API may not support changing the data or the Invantive SQL driver for Company.info does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Company.info API.

Topic: internationalAddressSearchInteractive

Base XPath: /s:Envelope/s:Body/tns:internationalAddressSearchInteractiveResponse/tns:out

Filters on API Server: organization- building- street- housenr- pobox- locality- postcode- province- country- language- country_format

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function internationalAddressSearchInteractive. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

building

string

 

 

country_format

string

 

 

country

string

 

 

housenr

string

 

 

language

string

 

 

locality

string

 

 

organization

string

 

 

pobox

string

 

 

postcode

string

 

 

province

string

 

 

street

string

 

 

 

Table Function Columns

The columns of the table function internationalAddressSearchInteractive are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

COUNTRY_ISO3

string

 

 

 

RESULT_ITEM_ADDRESS_BUILDING

string

 

 

 

RESULT_ITEM_ADDRESS_CONTACT

string

 

 

 

RESULT_ITEM_ADDRESS_COUNTRY

string

 

 

 

RESULT_ITEM_ADDRESS_COUNTRYSPECIFIC_LOCALITY

string

 

 

 

RESULT_ITEM_ADDRESS_DELIVERY_ADDRESS

string

 

 

 

RESULT_ITEM_ADDRESS_DEPARTMENT

string

 

 

 

RESULT_ITEM_ADDRESS_FORMATTED_ADDRESS

string

 

 

 

RESULT_ITEM_ADDRESS_HOUSENR

string

 

 

 

RESULT_ITEM_ADDRESS_LOCALITY

string

 

 

 

RESULT_ITEM_ADDRESS_MATCHRATE

decimal

 

 

 

RESULT_ITEM_ADDRESS_ORGANIZATION

string

 

 

 

RESULT_ITEM_ADDRESS_POBOX

string

 

 

 

RESULT_ITEM_ADDRESS_POSTCODE

string

 

 

 

RESULT_ITEM_ADDRESS_PROVINCE

string

 

 

 

RESULT_ITEM_ADDRESS_STREET

string

 

 

 

RESULT_ITEM_ELEMENT_MATCH_STATUS

string

 

 

 

RESULT_ITEM_ELEMENT_RESULT_STATUS

string

 

 

 

VALIDATION_STATUS

string

 

 

 

 

15-06-2022 23:19 Version 22.1.46-BETA+3385