Route Matrix (GET)
Contents
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.
The time and distance for each origin and destination pair are returned in the following order:
- Origin A to destinations (A, B, C …);
- Origin B to destinations (A, B, C …);
- And so on up to 10 origins and 10 destinations per API call.
Requires add-on license
GET /route/matrix
Resource URL
https://pcmiler.alk.com/apis/rest/v1.0/Service.svc/route/matrix
Parameters
With your API key, you can try a Route Matrix request using the form below. The required parameters are marked with an asterisk. You can enter values for any of the optional parameters by first checking the box next to them. Scroll down the page to submit your request.
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 list of RouteMatrixInfo objects that contain the time and distance between each origin and destination. | 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 |