[ Whereis® API Home ] [ JSON API Home ] [ Object Index ] [ Geometry Types ]

Defines a route handle, as returned from a previous route request. When used as a geometry type, the API will retrieve the route geometry for this handle and render it on the map as a polyline.

Format

{
	"id": <string>,
	"expiry": <string>
}

Parameters

Parameter

Type

Mandatory?

Description

id

string

Y

ID of the route, as returned from a route request

expiry

string

Y

Expiry date and time, as returned from a route request

NOTES

If you need a circular shape defined by distance, see <oval>.