Hyperpath GET

Hyperpath exposes a web service. Requests can be sent to Hyperpath with the HTTP GET method.

The web address where Hyperpath is listening is set in the configuration file of the software by the parameter WebServiceAddress” (→ Hyperpath configuration).

The parameter treq defines the request type. Depending on the request type, several other parameters may or may not be relevant (→ Hyperpath GET).

The structure of the HTTP GET request is valid for all request types.

Request types

Request type Response format Response example
getInitInfo XML InitInfo.xsd (right-click to download)
findPath XML Solution.xsd (right-click to download)
costMatrix XML  
contourLines XML  
getModOpt XML / JSON getModOpt_schema.json (right-click to download)
getStopLines JSON SendStopLines_schema.json (right-click to download)
getPois JSON  

The parameters listed are valid for all request types.

Important:  For the getInitInfo request, the only parameter required is treq.

Parameter Description

treq

 

reqi

 

ip

Client IP address.

lang

 

timeout

 

tdes

 

tdat

 

mode

 

smod

Code of the second mode of transport for intermodal requests (example: park and ride).

Type: String
Default: null

astr

 

ecst

 

verb

 

rzip

 

useFixedCost

 

labelCorrecting

 

useClusterPrecomputation

 

The parameters listed have a suffix (the placeholder chararcter is #) based on a progressive number starting from 1 The numbered suffix univocally identifies a specific point of the request.

The first point is the origin, the last point is the destination. All other points are the sorted way points.

Parameter Description

pxco#

 
pyco#  
wait#  
pray#  
addr#  
stid#  
fnid#  
prog#

Relative position along the street associated to the n-th point of the path request, starting from the From node.

Example:

Number

wait#

pray#

Point type

1

0

0

Origin

2

20

0

Hard way point

3

0

500

Soft way point

4

0

0

Hard way point

5

0

0

Destination

Data type: Decimal

Unit of measure: [share]

Default value: null

The parameters listed have a suffix (the placeholder chararcter is *) based on a generic string. The string suffix univocally identifies a specific point (origin or destination) of the routing matrix.

Important:  All these parameters are mandatory.

Parameter Description
oxco*  
oyco*  
dxco*  
dyco*  

 

Parameter Description

cl_xcoo

 

cl_ycoo

 

cl_bbxco1

 

cl_bbyco1

 

cl_bbxco2

 

cl_bbyco2

 

cl_costType

 

cl_zeroLevel

 

cl_deltaLevel

 

cl_clRows

 

cl_clCols

 

cl_inputPoints

 

cl_defaultSpeed

 
Parameter Description

xcoo

 

ycoo

 

radius

 

idno

Sets the identifier of the stop.

Data type: String

Default value: ""

ndep

 

The parameters listed are associated to valid a general maximum value (mcoe) defined in the XML output of the getInitInfo request.

Important:  For an optional parameter, the default value is set to null or to a specific value. For a mandatory parameter, the default value is indicated as Not applicable.

Important:  The default value pref(mode).x means that for the parameter x the default value is that of the mode of the current request (→ Hyperpath GET > Hyperpath GET).

Parameter Description

voft

 

vofd

 

lspe

 

mspe

 

lnwt

 

tort

 

rtrn

 

ltrn

 

muhs

 

mhds

 

uslo

 

dslo

 

chup

 

chdw

 

lev9

lev8

lev7

lev6

lev5

lev4

lev3

lev2

lev1

lev0

 

custom attributes

 

evnt

 

tsta

 

htsta

 

cdyn

 

midt

 

bdyn

 

disa

 

These parameters are used only for public transport paths.

All of these parameters are optional.

The default value “pref(mode).x” means that for the parameter x the default value is that of the mode of the current request.

Parameter Description

hypp

 

dhyp

 

wspe

 

ride

 

wait

 

walk

 

tran

 

sys#

 

erut#

 

excl#

 

treq=getinfo

http://hostname/?treq=getInitInfo

treq=findpath, single route

http://hostname/?treq=findPath&aevnt=1&voft=20&vofd=0&lspe=0&mspe=80
&lnwt=0&tort=0&rtrn=0&ltrn=0&muhs=0&mdhs=0&uslo=0&dslo=0&chup=0
&chdw=0.05&lev1=0&lev2=0&lev3=0&lev4=0&lev5=0&tlzr=99999&tunn=0
&brdg=0&urbn=0&npav=1&toll=0.1&cont=0&prio=0&pxco1=12.53742
&pyco1=41.89669&addr1=12.53742%2C+41.89669&wait1=0&pxco2=12.4927
&pyco2=41.89319&addr2=12.4927%2C+41.89319&wait2=0&mode=auto&tdes=0
&tdat=2012-9-3+10%3A0%3A00&lang=en

treq=findpath, single route with two interim stops

http://hostname/?treq=findPath&voft=20&vofd=0&lspe=0&mspe=80&lnwt=0
&tort=0&rtrn=0&ltrn=0&muhs=0&mdhs=0&uslo=0&dslo=0&chup=0&chdw=0.05
&lev1=0&lev2=0&lev3=0&lev4=0&lev5=0&tlzr=99999&tunn=0&brdg=0&urbn=0
&npav=1&toll=0.1&cont=0&prio=0&pxco1=12.53742&pyco1=41.89669
&addr1=12.53742%2C+41.89669&wait1=0&pxco2=12.53416&pyco2=41.89274
&addr2=12.53416%2C+41.89274&wait2=5&pxco3=12.50812&pyco3=41.89271
&addr3=12.50812%2C+41.89271&wait3=10&pxco4=12.4927&pyco4=41.89319
&addr4=12.4927%2C+41.89319&wait4=0&mode=auto&tdes=0&tdat=2012-9-3+
10%3A0%3A00&lang=en

treq=costMatrix, 1:N routing

http://hostname/?treq=costMatrix&voft=20&vofd=0&lspe=0&mspe=80&lnwt=0
&tort=0&rtrn=0&ltrn=0&muhs=0&mdhs=0&uslo=0&dslo=0&chup=0&chdw=0.05
&lev1=0&lev2=0&lev3=0&lev4=0&lev5=0&tlzr=99999&tunn=0&brdg=0&urbn=0
&npav=1&toll=0.1&cont=0&prio=0&oxcoorig_A=12.53732&oycoorig_A=41.89679
&dxcodest_A=12.55361&dycodest_A=41.91469&dxcodest_B=12.6131
&dycodest_B=41.93515&dxcodest_C=12.15394&dycodest_C=41.90578&mode=auto
&tdes=0&tdat=2012-9-3+10%3A0%3A00

treq=costMatrix, N:M routing

http://hostname/?treq=costMatrix&voft=20&vofd=0&lspe=0&mspe=80&lnwt=0
&tort=0&rtrn=0&ltrn=0&muhs=0&mdhs=0&uslo=0&dslo=0&chup=0&chdw=0.05
&lev1=0&lev2=0&lev3=0&lev4=0&lev5=0&tlzr=99999&tunn=0&brdg=0&urbn=0
&npav=1&toll=0.1&cont=0&prio=0&oxcoorig_A=12.53732&oycoorig_A=41.89679
&oxcoorig_B=12.61106&oycoorig_B=41.9361&oxcoorig_C=12.55681&oycoorig_C=
41.86046&dxcodest_A=12.55361&dycodest_A=41.91469&dxcodest_B=12.6131
&dycodest_B=41.93515&dxcodest_C=12.15394&dycodest_C=41.90578&mode=auto
&tdes=0&tdat=2012-9-3+10%3A0%3A00

treq=findPath, excluding public transport lines erut1, erut2, and erut3

http://hostname/?treq=findPath&mode=PuT&voft=12&vofd=0&lspe=0&mspe=80&lnwt=0
&tort=0&rtrn=0&ltrn=0&muhs=0&mdhs=0&uslo=1&dslo=0&chup=0&chdw=0
&lev1=1&lev2=0.5&lev3=0.1&lev4=0&lev5=0&lev6=0&lev7=0&lev8=0
&bikeimpedance=0&pavementimp=0&pushbikeimp=0&scenicroute=0&evnt=1
&astr=-1&useClusterPrecomputation=1&useFixedCost=0&labelCorrecting=-1
&pxco1=8.428867502894724&pyco1=49.00594082153634&addr1=8.42887%2C+49.00594&wait1=0
&pxco2=8.339131340335992&pyco2=49.00513828662031&addr2=8.33913%2C+49.00514&wait2=0&tdes=1
&verb=2&tdat=2017-10-9+15%3A37%3A00&lang=it&rzip=0
&erut1="03093_NL 3-(1_2) nach Karlsruhe Marktplatz;NL 3-(1_2) nach Karlsruhe Marktplatz;R”8
&erut2="03094_NL 4-(1_6) nach Karlsruhe Marktplatz;NL 4-(1_6) nach Karlsruhe Marktplatz;H"
&erut3="04112;NL 12-(1_1) nach Durlach Turmberg;R"

treq=findPath, with public trasport type sys1

http://hostname/?treq=findPath&mode=PuT&voft=12&vofd=0&lspe=0&mspe=80&lnwt=0
&tort=0&rtrn=0&ltrn=0&muhs=0&mdhs=0&uslo=1&dslo=0&chup=0&chdw=0
&lev1=1&lev2=0.5&lev3=0.1&lev4=0&lev5=0&lev6=0&lev7=0&lev8=0
&bikeimpedance=0&pavementimp=0&pushbikeimp=0&scenicroute=0&evnt=1
&astr=-1&useClusterPrecomputation=1&useFixedCost=0&labelCorrecting=-1
&pxco1=8.428867502894724&pyco1=49.00594082153634&addr1=8.42887%2C+49.00594&wait1=0
&pxco2=8.339131340335992&pyco2=49.00513828662031&addr2=8.33913%2C+49.00514&wait2=0&tdes=1
&verb=2&tdat=2017-10-9+15%3A37%3A00&lang=it&rzip=0
&sys1=10000"

treq=findPath, with exclusion of links 123, 99 and 56 through excl1

http://hostname/?treq=findPath&mode=PuT&voft=12&vofd=0&lspe=0&mspe=80&lnwt=0
&tort=0&rtrn=0&ltrn=0&muhs=0&mdhs=0&uslo=1&dslo=0&chup=0&chdw=0
&lev1=1&lev2=0.5&lev3=0.1&lev4=0&lev5=0&lev6=0&lev7=0&lev8=0
&bikeimpedance=0&pavementimp=0&pushbikeimp=0&scenicroute=0&evnt=1
&astr=-1&useClusterPrecomputation=1&useFixedCost=0&labelCorrecting=-1
&pxco1=8.428867502894724&pyco1=49.00594082153634&addr1=8.42887%2C+49.00594&wait1=0
&pxco2=8.339131340335992&pyco2=49.00513828662031&addr2=8.33913%2C+49.00514&wait2=0&tdes=1
&verb=2&tdat=2017-10-9+15%3A37%3A00&lang=it&rzip=0&excl1=123>10002365,99>10002367,56>10002368"