StopLocation Data Type

A StopLocation describes a place where a vehicle can be boarded or alighted, which is not necessarily a marked stop, but can be of other shapes, such as a service area for flexible transit. StopLocations are referred to in stop times.

Abstract Type
Subtypes
FlexStopLocation, Stop, FlexLocationGroup
Properties
name data type constraints description
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.
parentStation Station  
platformCode string  
name string   Name of the StopLocation, if provided
partOfStation boolean required
lon number required
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.
description string  
vehicleSubmode string  
fareZones array of FareZone  
priority StopTransferPriority  
timeZone TimeZone  
url string  
code string   Short text or a number that identifies the location for riders. These codes are often used in phone-based reservation systems to make it easier for riders to specify a particular location. The stop_code can be the same as id if it is public facing. This field should be left empty for locations without a code presented to riders.
wheelchairBoarding WheelChairBoarding  
lat number required
id FeedScopedId   The ID for the StopLocation
coordinate WgsCoordinate   Representative location for the StopLocation. Can either be the actual location of the stop, or the centroid of an area or line.
vehicleType TransitMode  

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "geometry" : {
    "length" : 12345.0,
    "numGeometries" : 12345,
    "precisionModel" : {
      "scale" : 12345.0,
      "floating" : true,
      "maximumSignificantDigits" : 12345,
      "type" : { },
      "offsetX" : 12345.0,
      "offsetY" : 12345.0
    },
    "interiorPoint" : {
      "boundaryDimension" : 12345,
      "x" : 12345.0,
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "simple" : true,
      "numPoints" : 12345,
      "dimension" : 12345,
      "boundary" : { },
      "geometryType" : "...",
      "coordinateSequence" : { },
      "empty" : true,
      "y" : 12345.0,
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "envelopeInternal" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "valid" : true
    },
    "rectangle" : true,
    "area" : 12345.0,
    "boundary" : { },
    "boundaryDimension" : 12345,
    "numPoints" : 12345,
    "coordinates" : [ {
      "x" : 12345.0,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    }, {
      "x" : 12345.0,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    } ],
    "dimension" : 12345,
    "envelopeInternal" : {
      "width" : 12345.0,
      "null" : true,
      "diameter" : 12345.0,
      "area" : 12345.0,
      "minY" : 12345.0,
      "height" : 12345.0,
      "maxX" : 12345.0,
      "maxY" : 12345.0,
      "minX" : 12345.0
    },
    "empty" : true,
    "coordinate" : {
      "x" : 12345.0,
      "y" : 12345.0,
      "z" : 12345.0,
      "m" : 12345.0,
      "valid" : true
    },
    "centroid" : {
      "boundaryDimension" : 12345,
      "x" : 12345.0,
      "coordinates" : [ { }, { } ],
      "coordinate" : { },
      "simple" : true,
      "numPoints" : 12345,
      "dimension" : 12345,
      "boundary" : { },
      "geometryType" : "...",
      "coordinateSequence" : { },
      "empty" : true,
      "y" : 12345.0,
      "length" : 12345.0,
      "numGeometries" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "area" : 12345.0,
      "envelopeInternal" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "userData" : { },
      "envelope" : { },
      "valid" : true
    },
    "factory" : {
      "precisionModel" : { },
      "SRID" : 12345,
      "coordinateSequenceFactory" : { }
    },
    "SRID" : 12345,
    "simple" : true,
    "userData" : { },
    "geometryType" : "...",
    "envelope" : { },
    "valid" : true
  },
  "parentStation" : {
    "name" : "...",
    "coordinate" : { },
    "code" : "...",
    "description" : "...",
    "url" : "...",
    "priority" : "PREFERRED",
    "timezone" : {
      "rawOffset" : 12345,
      "DSTSavings" : 12345,
      "availableIDs" : [ "...", "..." ],
      "default" : { },
      "displayName" : "...",
      "ID" : "..."
    },
    "childStops" : [ {
      "geometry" : { },
      "parentStation" : { },
      "platformCode" : "...",
      "name" : "...",
      "partOfStation" : true,
      "lon" : 12345.0,
      "firstZoneAsString" : "...",
      "description" : "...",
      "vehicleSubmode" : "...",
      "fareZones" : [ { }, { } ],
      "priority" : "RECOMMENDED",
      "timeZone" : { },
      "url" : "...",
      "code" : "...",
      "wheelchairBoarding" : "NO_INFORMATION",
      "lat" : 12345.0,
      "id" : { },
      "coordinate" : { },
      "vehicleType" : "FUNICULAR"
    }, {
      "geometry" : { },
      "parentStation" : { },
      "platformCode" : "...",
      "name" : "...",
      "partOfStation" : true,
      "lon" : 12345.0,
      "firstZoneAsString" : "...",
      "description" : "...",
      "vehicleSubmode" : "...",
      "fareZones" : [ { }, { } ],
      "priority" : "RECOMMENDED",
      "timeZone" : { },
      "url" : "...",
      "code" : "...",
      "wheelchairBoarding" : "POSSIBLE",
      "lat" : 12345.0,
      "id" : { },
      "coordinate" : { },
      "vehicleType" : "FUNICULAR"
    } ],
    "lat" : 12345.0,
    "lon" : 12345.0,
    "geometry" : {
      "coordinate" : { },
      "geometryType" : "...",
      "dimension" : 12345,
      "length" : 12345.0,
      "coordinates" : [ { }, { } ],
      "boundary" : { },
      "empty" : true,
      "area" : 12345.0,
      "boundaryDimension" : 12345,
      "numGeometries" : 12345,
      "numPoints" : 12345,
      "precisionModel" : { },
      "interiorPoint" : { },
      "rectangle" : true,
      "envelopeInternal" : { },
      "centroid" : { },
      "factory" : { },
      "SRID" : 12345,
      "simple" : true,
      "userData" : { },
      "envelope" : { },
      "valid" : true
    },
    "id" : {
      "feedId" : "...",
      "id" : "..."
    }
  },
  "platformCode" : "...",
  "name" : "...",
  "partOfStation" : true,
  "lon" : 12345.0,
  "firstZoneAsString" : "...",
  "description" : "...",
  "vehicleSubmode" : "...",
  "fareZones" : [ {
    "name" : "...",
    "id" : {
      "feedId" : "...",
      "id" : "..."
    }
  }, {
    "name" : "...",
    "id" : {
      "feedId" : "...",
      "id" : "..."
    }
  } ],
  "priority" : "DISCOURAGED",
  "timeZone" : {
    "rawOffset" : 12345,
    "DSTSavings" : 12345,
    "availableIDs" : [ "...", "..." ],
    "default" : { },
    "displayName" : "...",
    "ID" : "..."
  },
  "url" : "...",
  "code" : "...",
  "wheelchairBoarding" : "POSSIBLE",
  "lat" : 12345.0,
  "id" : {
    "feedId" : "...",
    "id" : "..."
  },
  "coordinate" : { },
  "vehicleType" : "TRAM"
}