GroupStop Data Type

A group of stopLocations, which can share a common Stoptime

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   Name of the StopLocation, if provided
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 Returns the centroid of all stops and areas belonging to this location group.
geometry Geometry   The geometry of the stop.

For fixed-schedule stops this will return the same data as getCoordinate().

For flex stops this will return the geometries of the stop or group of stops.

partOfStation boolean required
locations array of StopLocation   Returns all the locations belonging to this location group.
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,
  "locations" : [ {
    "id" : {
      "feedId" : "...",
      "id" : "..."
    },
    "geometry" : {
      "envelope" : { },
      "length" : 12345.0,
      "geometryType" : "...",
      "boundary" : { },
      "rectangle" : true,
      "centroid" : { },
      "simple" : true,
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "coordinate" : { },
      "precisionModel" : { },
      "envelopeInternal" : { },
      "boundaryDimension" : 12345,
      "dimension" : 12345,
      "area" : 12345.0,
      "empty" : true,
      "userData" : { },
      "numGeometries" : 12345,
      "numPoints" : 12345,
      "SRID" : 12345,
      "coordinates" : [ { }, { } ]
    },
    "lon" : 12345.0,
    "parentStation" : {
      "name" : { },
      "childStops" : [ { }, { } ],
      "lat" : 12345.0,
      "lon" : 12345.0,
      "coordinate" : { },
      "code" : "...",
      "description" : { },
      "url" : { },
      "priority" : "ALLOWED",
      "timezone" : "...",
      "transfersNotAllowed" : true,
      "geometry" : { },
      "id" : { }
    },
    "netexVehicleSubmode" : { },
    "wheelchairAccessibility" : "NOT_POSSIBLE",
    "stationOrStopId" : {
      "feedId" : "...",
      "id" : "..."
    },
    "code" : "...",
    "timeZone" : "...",
    "lat" : 12345.0,
    "platformCode" : "...",
    "fareZones" : [ {
      "name" : "...",
      "id" : { }
    }, {
      "name" : "...",
      "id" : { }
    } ],
    "index" : 12345,
    "description" : { },
    "gtfsVehicleType" : "SUBWAY",
    "name" : { },
    "partOfStation" : true,
    "coordinate" : { },
    "url" : { },
    "priority" : "PREFERRED",
    "firstZoneAsString" : "..."
  }, {
    "id" : {
      "feedId" : "...",
      "id" : "..."
    },
    "geometry" : {
      "envelope" : { },
      "length" : 12345.0,
      "geometryType" : "...",
      "boundary" : { },
      "rectangle" : true,
      "centroid" : { },
      "simple" : true,
      "interiorPoint" : { },
      "factory" : { },
      "valid" : true,
      "coordinate" : { },
      "precisionModel" : { },
      "envelopeInternal" : { },
      "boundaryDimension" : 12345,
      "dimension" : 12345,
      "area" : 12345.0,
      "empty" : true,
      "userData" : { },
      "numGeometries" : 12345,
      "numPoints" : 12345,
      "SRID" : 12345,
      "coordinates" : [ { }, { } ]
    },
    "lon" : 12345.0,
    "parentStation" : {
      "name" : { },
      "childStops" : [ { }, { } ],
      "lat" : 12345.0,
      "lon" : 12345.0,
      "coordinate" : { },
      "code" : "...",
      "description" : { },
      "url" : { },
      "priority" : "PREFERRED",
      "timezone" : "...",
      "transfersNotAllowed" : true,
      "geometry" : { },
      "id" : { }
    },
    "netexVehicleSubmode" : { },
    "wheelchairAccessibility" : "NO_INFORMATION",
    "stationOrStopId" : {
      "feedId" : "...",
      "id" : "..."
    },
    "code" : "...",
    "timeZone" : "...",
    "lat" : 12345.0,
    "platformCode" : "...",
    "fareZones" : [ {
      "name" : "...",
      "id" : { }
    }, {
      "name" : "...",
      "id" : { }
    } ],
    "index" : 12345,
    "description" : { },
    "gtfsVehicleType" : "AIRPLANE",
    "name" : { },
    "partOfStation" : true,
    "coordinate" : { },
    "url" : { },
    "priority" : "DISCOURAGED",
    "firstZoneAsString" : "..."
  } ],
  "id" : {
    "feedId" : "...",
    "id" : "..."
  }
}