Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SnapToRoads

SnapToRoads matches GPS trace to roads most likely traveled on.

Request Syntax


POST /snap-to-roads?key=Key HTTP/1.1
Content-type: application/json

{
   "SnappedGeometryFormat": "string",
   "SnapRadius": number,
   "TracePoints": [ 
      { 
         "Heading": number,
         "Position": [ number ],
         "Speed": number,
         "Timestamp": "string"
      }
   ],
   "TravelMode": "string",
   "TravelModeOptions": { 
      "Truck": { 
         "GrossWeight": number,
         "HazardousCargos": [ "string" ],
         "Height": number,
         "Length": number,
         "Trailer": { 
            "TrailerCount": number
         },
         "TunnelRestrictionCode": "string",
         "Width": number
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

Key

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

Length Constraints: Minimum length of 0. Maximum length of 1000.

Request Body

The request accepts the following data in JSON format.

SnappedGeometryFormat

Chooses what the returned SnappedGeometry format should be.

Default Value: FlexiblePolyline

Type: String

Valid Values: FlexiblePolyline | Simple

Required: No

SnapRadius

The radius around the provided tracepoint that is considered for snapping.

Unit: meters

Default value: 300

Type: Long

Valid Range: Minimum value of 0. Maximum value of 10000.

Required: No

TracePoints

List of trace points to be snapped onto the road network.

Type: Array of RoadSnapTracePoint objects

Array Members: Minimum number of 2 items. Maximum number of 5000 items.

Required: Yes

TravelMode

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

Default Value: Car

Type: String

Valid Values: Car | Pedestrian | Scooter | Truck

Required: No

TravelModeOptions

Travel mode related options for the provided travel mode.

Type: RoadSnapTravelModeOptions object

Required: No

Response Syntax


HTTP/1.1 200
x-amz-geo-pricing-bucket: PricingBucket
Content-type: application/json

{
   "Notices": [ 
      { 
         "Code": "string",
         "Title": "string",
         "TracePointIndexes": [ number ]
      }
   ],
   "SnappedGeometry": { 
      "LineString": [ 
         [ number ]
      ],
      "Polyline": "string"
   },
   "SnappedGeometryFormat": "string",
   "SnappedTracePoints": [ 
      { 
         "Confidence": number,
         "OriginalPosition": [ number ],
         "SnappedPosition": [ number ]
      }
   ]
}