GenericLocation Data Type

Represents a location that is to be used in a routing request. It can be either a from, to, or intermediate location. This has to be resolved to a vertex or a collection of vertices before routing can start.

Properties
name data type constraints description
label string   A label for the place, if provided. This is pass-through information and does not affect routing in any way.
stopId FeedScopedId   Refers to a specific element in the OTP model. This can currently be a Stop or StopCollection.
lat number   Coordinates of the location. These can be used by themselves or as a fallback if placeId is not found.
lng number  
coordinate Coordinate   Returns this as a Coordinate object.
specified boolean required

Example

{
  "label" : "...",
  "stopId" : {
    "feedId" : "...",
    "id" : "..."
  },
  "lat" : 12345.0,
  "lng" : 12345.0,
  "coordinate" : {
    "x" : 12345.0,
    "y" : 12345.0,
    "z" : 12345.0,
    "m" : 12345.0,
    "valid" : true
  },
  "specified" : true
}