Please enable JavaScript to view this site.

Navigation: Schema: CompanyInfo > Tables

routePlannerGetRoute

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: routePlannerGetRoute

Base XPath: /s:Envelope/s:Body/tns:routePlannerGetRouteResponse/tns:route

Filters on API Server: start_postcode- start_house_number- start_house_number_addition- start_street- start_city- start_country- destination_postcode- destination_house_number- destination_house_number_addition- destination_street- destination_city- destination_country- route_type- language

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function routePlannerGetRoute. 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

destination_city

string

 

 

destination_country

string

 

 

destination_house_number_addition

string

 

 

destination_house_number

int32

 

 

destination_postcode

string

 

 

destination_street

string

 

 

language

string

 

 

route_type

string

 

 

start_city

string

 

 

start_country

string

 

 

start_house_number_addition

string

 

 

start_house_number

int32

 

 

start_postcode

string

 

 

start_street

string

 

 

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

DESCRIPTION_ITEM_DISTANCE

int32

 

 

 

DESCRIPTION_ITEM_TIME

int32

 

 

 

DESTINATION_ADDRESS_ADDRESS_KEY

string

 

 

 

DESTINATION_ADDRESS_CITY

string

 

 

 

DESTINATION_ADDRESS_COUNTRY

string

 

 

 

DESTINATION_ADDRESS_HOUSE_NUMBER_ADDITION

string

 

 

 

DESTINATION_ADDRESS_HOUSE_NUMBER

int32

 

 

 

DESTINATION_ADDRESS_POSTCODE

string

 

 

 

DESTINATION_ADDRESS_STREET

string

 

 

 

DESTINATION_COORDINATES_LATLONG_LATITUDE

decimal

 

 

 

DESTINATION_COORDINATES_LATLONG_LONGITUDE

decimal

 

 

 

DESTINATION_COORDINATES_RD_X

int32

 

 

 

DESTINATION_COORDINATES_RD_Y

int32

 

 

 

MAP

byte[]

 

 

 

START_ADDRESS_ADDRESS_KEY

string

 

 

 

START_ADDRESS_CITY

string

 

 

 

START_ADDRESS_COUNTRY

string

 

 

 

START_ADDRESS_HOUSE_NUMBER_ADDITION

string

 

 

 

START_ADDRESS_HOUSE_NUMBER

int32

 

 

 

START_ADDRESS_POSTCODE

string

 

 

 

START_ADDRESS_STREET

string

 

 

 

START_COORDINATES_LATLONG_LATITUDE

decimal

 

 

 

START_COORDINATES_LATLONG_LONGITUDE

decimal

 

 

 

START_COORDINATES_RD_X

int32

 

 

 

START_COORDINATES_RD_Y

int32

 

 

 

SUMMARY_DISTANCE

int32

 

 

 

SUMMARY_TIME

int32

 

 

 

SUMMARY_TYPE

string

 

 

 

 

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