Please enable JavaScript to view this site.

Navigation: Schema: CompanyInfo > Tables

routePlannerDescriptionShortest

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

Base XPath: /s:Envelope/s:Body/tns:routePlannerDescriptionShortestResponse/tns:route/tns:item

Filters on API Server: postcodefrom- postcodeto- english

Parameters of Table Function

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

english

boolean

 

 

postcodefrom

string

 

 

postcodeto

string

 

 

 

Table Function Columns

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

Name

Data Type

Label

Required

Documentation

DESCRIPTION

string

Description

 

 

DISTANCE

int32

Distance

 

 

TIME

int32

Time

 

 

 

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