Skip to content

/AWS1/CL_GER=>CALCULATEROUTEMATRIX()

About CalculateRouteMatrix

Use CalculateRouteMatrix to compute results for all pairs of Origins to Destinations. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destinations positions.

Method Signature

IMPORTING

Required arguments:

IT_DESTINATIONS TYPE /AWS1/CL_GERROUTEMATRIXDST=>TT_ROUTEMATRIXDESTINATIONLIST TT_ROUTEMATRIXDESTINATIONLIST

List of destinations for the route.

Route calculations are billed for each origin and destination pair. If you use a large matrix of origins and destinations, your costs will increase accordingly. See Amazon Location's pricing page for more information.

IT_ORIGINS TYPE /AWS1/CL_GERROUTEMATRIXORIGIN=>TT_ROUTEMATRIXORIGINLIST TT_ROUTEMATRIXORIGINLIST

The position in longitude and latitude for the origin.

Route calculations are billed for each origin and destination pair. Using a large amount of Origins in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.

IO_ROUTINGBOUNDARY TYPE REF TO /AWS1/CL_GERROUTEMATRIXBNDRY /AWS1/CL_GERROUTEMATRIXBNDRY

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

Optional arguments:

IO_ALLOW TYPE REF TO /AWS1/CL_GERROUTEMATRIXALWOPTS /AWS1/CL_GERROUTEMATRIXALWOPTS

Features that are allowed while calculating a route.

IO_AVOID TYPE REF TO /AWS1/CL_GERROUTEMATRIXAVOID00 /AWS1/CL_GERROUTEMATRIXAVOID00

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

IV_DEPARTNOW TYPE /AWS1/GERBOOLEAN /AWS1/GERBOOLEAN

Uses the current time as the time of departure.

IV_DEPARTURETIME TYPE /AWS1/GERTSMPWITHTIMEZONEOFF /AWS1/GERTSMPWITHTIMEZONEOFF

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

IO_EXCLUDE TYPE REF TO /AWS1/CL_GERROUTEMATRIXEXCLU00 /AWS1/CL_GERROUTEMATRIXEXCLU00

Features to be strictly excluded while calculating the route.

IV_KEY TYPE /AWS1/GERAPIKEY /AWS1/GERAPIKEY

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

IV_OPTIMIZEROUTINGFOR TYPE /AWS1/GERROUTINGOBJECTIVE /AWS1/GERROUTINGOBJECTIVE

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

IO_TRAFFIC TYPE REF TO /AWS1/CL_GERROUTEMATRIXTRFOPTS /AWS1/CL_GERROUTEMATRIXTRFOPTS

Traffic related options.

IV_TRAVELMODE TYPE /AWS1/GERROUTEMATRIXTRAVELMODE /AWS1/GERROUTEMATRIXTRAVELMODE

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

IO_TRAVELMODEOPTIONS TYPE REF TO /AWS1/CL_GERROUTEMATRIXTRAVE00 /AWS1/CL_GERROUTEMATRIXTRAVE00

Travel mode related options for the provided travel mode.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_GERCALCULATEROUTEMA01 /AWS1/CL_GERCALCULATEROUTEMA01