AreaStop Data Type

Location corresponding to a location where riders may request pickup or drop off, defined in the GTFS bundle.

Implemented Interfaces
StopLocation
Properties
name data type constraints description
index number required This is the OTP internal synthetic key, used to reference a StopLocation inside OTP. This is used to optimize routing, we do not access the stop instance only keep the {code index}. The index will not change.

Do NOT expose this index in the APIs, it is not guaranteed to be the same across different OTP instances, use the {code id} for external references.

name I18NString required Defines the name of the location. The name should be the same, which is used in customer communication, eg. the name of the village where the service stops.
description I18NString  
url I18NString  
firstZoneAsString string   This is to ensure backwards compatibility with the REST API, which expects the GTFS zone_id which only permits one zone per stop.
coordinate WgsCoordinate required Representative location for the StopLocation. Can either be the actual location of the stop, or the centroid of an area or line.
geometry Geometry   Returns the geometry of this location, can be any type of geometry.
partOfStation boolean required
Properties inherited from AbstractTransitEntity
id FeedScopedId  

Example

{
  "index" : 12345,
  "name" : { },
  "description" : { },
  "url" : { },
  "firstZoneAsString" : "...",
  "coordinate" : { },
  "geometry" : {
    "envelope" : { },
    "length" : 12345.0,
    "geometryType" : "...",
    "boundary" : { },
    "rectangle" : true,
    "centroid" : {
      "simple" : true,
      "x" : 12345.0,
      "boundaryDimension" : 12345,
      "coordinateSequence" : { },
      "coordinate" : { },
      "geometryType" : "...",
      "y" : 12345.0,
      "empty" : true,
      "dimension" : 12345,
      "coordinates" : [ { }, { } ],
      "boundary" : { },
      "numPoints" : 12345,
      "envelope" : { },
      "length" : 12345.0,
      "rectangle" : true,
      "centroid" : { },
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "precisionModel" : { },
      "envelopeInternal" : { },
      "area" : 12345.0,
      "userData" : { },
      "numGeometries" : 12345,
      "SRID" : 12345
    },
    "simple" : true,
    "interiorPoint" : {
      "simple" : true,
      "x" : 12345.0,
      "boundaryDimension" : 12345,
      "coordinateSequence" : { },
      "coordinate" : { },
      "geometryType" : "...",
      "y" : 12345.0,
      "empty" : true,
      "dimension" : 12345,
      "coordinates" : [ { }, { } ],
      "boundary" : { },
      "numPoints" : 12345,
      "envelope" : { },
      "length" : 12345.0,
      "rectangle" : true,
      "centroid" : { },
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "precisionModel" : { },
      "envelopeInternal" : { },
      "area" : 12345.0,
      "userData" : { },
      "numGeometries" : 12345,
      "SRID" : 12345
    },
    "factory" : {
      "precisionModel" : { },
      "SRID" : 12345,
      "coordinateSequenceFactory" : { }
    },
    "valid" : true,
    "coordinate" : {
      "y" : 12345.0,
      "z" : 12345.0,
      "x" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    },
    "precisionModel" : {
      "offsetX" : 12345.0,
      "scale" : 12345.0,
      "type" : { },
      "floating" : true,
      "offsetY" : 12345.0,
      "maximumSignificantDigits" : 12345
    },
    "envelopeInternal" : {
      "width" : 12345.0,
      "area" : 12345.0,
      "minX" : 12345.0,
      "diameter" : 12345.0,
      "null" : true,
      "height" : 12345.0,
      "maxX" : 12345.0,
      "minY" : 12345.0,
      "maxY" : 12345.0
    },
    "boundaryDimension" : 12345,
    "dimension" : 12345,
    "area" : 12345.0,
    "empty" : true,
    "userData" : { },
    "numGeometries" : 12345,
    "numPoints" : 12345,
    "SRID" : 12345,
    "coordinates" : [ {
      "y" : 12345.0,
      "z" : 12345.0,
      "x" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    }, {
      "y" : 12345.0,
      "z" : 12345.0,
      "x" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    } ]
  },
  "partOfStation" : true,
  "id" : {
    "feedId" : "...",
    "id" : "..."
  }
}