Route Match Extension API Developer's Guide

Reading a Route Match Extension API Response

The Route Match Extension API has one response type with the following structure.

Response for the Matchroute Resource

The resource matchroute.json provides a response that includes the following components:
  • A RouteLinks object that wraps information on sections of the matched route
  • A TracePoints object that wraps details of GPS trace points included in the route match
  • A Warnings object that wraps information about section of the matched route where traffic regulation violations may have occurred
  • A MapVersion object that contains information on the map version you used when computing the response
Example response structure for the matchroute.json resource:
{
  "RouteLinks" : [
    {
      "linkId" : ...,
      "functionalClass" : ...,
      "shape" : "latitude1 longitude1 latitude2 longitude2 ...",
      "linkLength" : ...
    },
    ...
  ],
  "TracePoints" : [
    {
      "lat" : ...,
      "lon" : ...,
      "elevation" : ...,
      "speedMps" : ...,
      "headingDegreeNorthClockwise" : ...,
      "latMatched" : ...,
      "lonMatched" : ...,
      "linkIdMatched" : ...,
      "confidenceValue" : ...,
      "matchDistance" : ...,
      "routeLinkSeqNrMatched" : ...,
      "timestamp" : ...,
      "headingMatched" : ...,
      "minError" : ...

    },
    ...
  ],
  "Warnings" : [
    {
      "category" : ...,
      "routelinkSeqnum" : ...,
      "waypointseqnum" : ...,
      "text" : "..."
    },
    ...
  ],
  "MapVersion" : "..."
}