Route Matrix

The Route Matrix API returns the travel time and distance for a matrix of origins and destinations. It does not provide any detailed information about the route. The limit of origins and destinations is 10 * 10.

Requires add-on license

GET /route/matrix

Resource URL

https://pcmiler.alk.com/apis/rest/v1.0/Service.svc/route/matrix

Parameters

Required parameters are highlighted in yellow.

Request

API KEY
GET

Response

Route Matrix Response

Data Element Description Data Type Value/Example
Origins A collection of Geocoded origins. List of GeocodeOutputLocation Object
Destinations A collection of Geocoded destination. List of GeocodeOutputLocation Object
MatrixInfo A series of geographic coordinate points that make up a route. List of List of RouteMatrixInfo Object

RouteMatrixInfo

Data Element Description Data Type Value/Example
Success Indicate if route is success or not.
boolean
Errors Route errors
List of Errors Object
Time Route time
string
Distance Route distance
string

Errors

Data Element Description Data Type Value/Example
Type Indicates whether the error is an exception or warning
Enum
Warning Exception
Code Error code
Enum
LegacyErrorCode The legacy error code with is an integer valued code that would have been returned in PC*MILER Web Services v25 and earlier.
Int
Description The detailed error description.
string