CompanyInfo Data Model
addressReeksParameterSearch |
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: addressReeksParameterSearch
Base XPath: /s:Envelope/s:Body/tns:addressReeksParameterSearchResponse/tns:out
Filters on API Server: province- district- city- street- houseNo- houseNoAddition- page
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function addressReeksParameterSearch. 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 |
|---|---|---|---|---|
city |
string |
☐ |
|
|
district |
string |
☐ |
|
|
houseNo |
int32 |
☐ |
|
|
houseNoAddition |
string |
☐ |
|
|
page |
int32 |
☐ |
|
|
province |
string |
☐ |
|
|
street |
string |
☐ |
|
|
Table Function Columns
The columns of the table function addressReeksParameterSearch are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
EXTRA_GEMEENTE |
string |
Extra Municipality |
|
|
EXTRA_HUISNR |
int32 |
Extra House Number |
|
|
EXTRA_LETTERCOMBINATIE |
string |
Extra Character Combination |
|
|
EXTRA_PLAATS |
string |
Extra City |
|
|
EXTRA_PROVINCIE |
string |
Extra State |
|
|
EXTRA_REEKSINDICATIE |
string |
Extra Sequence Indicator |
|
|
EXTRA_STRAAT |
string |
Extra Street |
|
|
EXTRA_TOEVOEGING |
string |
|
|
|
EXTRA_WIJKCODE |
string |
|
|
|
PAGING_CURPAGE |
int32 |
Paging Current Page |
|
|
PAGING_MAXRESULTS |
int32 |
Paging Maximum Number of Results |
|
|
PAGING_NUMPAGES |
int32 |
Paging Number of Pages |
|
|
PAGING_NUMRESULTS |
int32 |
Paging Number of Results |
|
|
PAGING_PERPAGE |
int32 |
|
|
|
RESULTS_ITEM_CEBUCOCODE |
int32 |
Item Cebuco Code |
|
|
RESULTS_ITEM_GEMEENTECODE |
int32 |
Item Municipality Code |
|
|
RESULTS_ITEM_GEMEENTEID |
int32 |
Item Municipality ID |
|
|
RESULTS_ITEM_GEMEENTENAAM |
string |
Item Municipality Name |
|
|
RESULTS_ITEM_HUISNR_TM |
int32 |
Item House Number upto |
|
|
RESULTS_ITEM_HUISNR_VAN |
int32 |
Item House Number from |
|
|
RESULTS_ITEM_LETTERCOMBINATIE |
string |
Item Character Combination |
|
|
RESULTS_ITEM_PLAATSID |
int32 |
Item City ID |
|
|
RESULTS_ITEM_PLAATSNAAM_EXTRACT |
string |
Item Place Name Extract |
|
|
RESULTS_ITEM_PLAATSNAAM_PTT |
string |
Item Place Name TPG |
|
|
RESULTS_ITEM_PLAATSNAAM |
string |
Item City Name |
|
|
RESULTS_ITEM_PROVINCIECODE |
string |
Item State Code |
|
|
RESULTS_ITEM_PROVINCIENAAM |
string |
Item State Name |
|
|
RESULTS_ITEM_REEKSID |
int32 |
Item Sequence ID |
|
|
RESULTS_ITEM_REEKSINDICATIE |
string |
Item Sequence Indicator |
|
|
RESULTS_ITEM_STRAATID |
int32 |
Item Street ID |
|
|
RESULTS_ITEM_STRAATNAAM_EXTRACT |
string |
|
|
|
RESULTS_ITEM_STRAATNAAM_NEN |
string |
Item Street Name NEN |
|
|
RESULTS_ITEM_STRAATNAAM_PTT |
string |
Item Street Name TPG |
|
|
RESULTS_ITEM_STRAATNAAM |
string |
Item Street Name |
|
|
RESULTS_ITEM_WIJKCODE |
string |
|
|
|
15-06-2022 23:19 Version 22.1.46-BETA+3385
