A place where actual boarding/departing happens. It can be a bus stop on one side of a road or a platform at a train station. Equivalent to GTFS stop location 0 or NeTEx quay.
| 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. |
| platformCode | string | Platform identifier for a platform/stop belonging to a station. This should be just the platform identifier (eg. "G" or "3"). | |
| url | I18NString | URL to a web page containing information about this particular stop. | |
| timeZone | string | ||
| gtfsVehicleType | TransitMode | Used for describing the type of transportation used at the stop. This can be used eg. for deciding how to render a stop when it is used by multiple routes with different vehicle types. | |
| netexVehicleSubmode | object | required | |
| geometry | Geometry | required | 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. |
| priority | StopTransferPriority | required | Get the transfer cost priority for Stop. This will fetch the value from the parent [if parent exist] or return the default value. |
| fareZones | array of FareZone | required | |
| boardingAreas | array of BoardingArea | required | |
Properties inherited from StationElement |
|||
| name | I18NString | required | Name of the station element if provided. |
| code | string | Public facing stop code (short text or number). | |
| description | I18NString | Additional information about the station element (if needed). | |
| coordinate | WgsCoordinate | required | Center point/location for the station element. Returns the coordinate of the parent station, if the coordinate is not defined for this station element. |
| wheelchairAccessibility | Accessibility | required | Returns whether this station element is accessible for wheelchair users. |
| levelName | string | Level name for elevator descriptions | |
| levelIndex | number | Level index for hop counts in elevators. Is null if not set. |
|
| parentStation | Station | Parent station for the station element | |
| partOfStation | boolean | required | Return true if this stop (element) is part of a station, have a parent station. |
Properties inherited from AbstractTransitEntity |
|||
| id | FeedScopedId | ||
Example
{
"index" : 12345,
"platformCode" : "...",
"url" : { },
"timeZone" : "...",
"gtfsVehicleType" : "TRAM",
"netexVehicleSubmode" : { },
"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
} ]
},
"priority" : "PREFERRED",
"fareZones" : [ {
"name" : "...",
"id" : {
"feedId" : "...",
"id" : "..."
}
}, {
"name" : "...",
"id" : {
"feedId" : "...",
"id" : "..."
}
} ],
"boardingAreas" : [ {
"coordinate" : { },
"parentStop" : {
"index" : 12345,
"platformCode" : "...",
"url" : { },
"timeZone" : "...",
"gtfsVehicleType" : "TROLLEYBUS",
"netexVehicleSubmode" : { },
"geometry" : { },
"priority" : "ALLOWED",
"fareZones" : [ { }, { } ],
"boardingAreas" : [ { }, { } ],
"name" : { },
"code" : "...",
"description" : { },
"coordinate" : { },
"wheelchairAccessibility" : "NO_INFORMATION",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : { },
"partOfStation" : true,
"id" : { }
},
"name" : { },
"code" : "...",
"description" : { },
"wheelchairAccessibility" : "POSSIBLE",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : {
"name" : { },
"childStops" : [ { }, { } ],
"lat" : 12345.0,
"lon" : 12345.0,
"coordinate" : { },
"code" : "...",
"description" : { },
"url" : { },
"priority" : "DISCOURAGED",
"timezone" : "...",
"transfersNotAllowed" : true,
"geometry" : { },
"id" : { }
},
"partOfStation" : true,
"id" : {
"feedId" : "...",
"id" : "..."
}
}, {
"coordinate" : { },
"parentStop" : {
"index" : 12345,
"platformCode" : "...",
"url" : { },
"timeZone" : "...",
"gtfsVehicleType" : "MONORAIL",
"netexVehicleSubmode" : { },
"geometry" : { },
"priority" : "DISCOURAGED",
"fareZones" : [ { }, { } ],
"boardingAreas" : [ { }, { } ],
"name" : { },
"code" : "...",
"description" : { },
"coordinate" : { },
"wheelchairAccessibility" : "NOT_POSSIBLE",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : { },
"partOfStation" : true,
"id" : { }
},
"name" : { },
"code" : "...",
"description" : { },
"wheelchairAccessibility" : "NO_INFORMATION",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : {
"name" : { },
"childStops" : [ { }, { } ],
"lat" : 12345.0,
"lon" : 12345.0,
"coordinate" : { },
"code" : "...",
"description" : { },
"url" : { },
"priority" : "PREFERRED",
"timezone" : "...",
"transfersNotAllowed" : true,
"geometry" : { },
"id" : { }
},
"partOfStation" : true,
"id" : {
"feedId" : "...",
"id" : "..."
}
} ],
"name" : { },
"code" : "...",
"description" : { },
"coordinate" : { },
"wheelchairAccessibility" : "NO_INFORMATION",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : {
"name" : { },
"childStops" : [ {
"id" : { },
"geometry" : { },
"lon" : 12345.0,
"parentStation" : { },
"netexVehicleSubmode" : { },
"wheelchairAccessibility" : "POSSIBLE",
"stationOrStopId" : { },
"code" : "...",
"timeZone" : "...",
"lat" : 12345.0,
"platformCode" : "...",
"fareZones" : [ { }, { } ],
"index" : 12345,
"description" : { },
"gtfsVehicleType" : "SUBWAY",
"name" : { },
"partOfStation" : true,
"coordinate" : { },
"url" : { },
"priority" : "RECOMMENDED",
"firstZoneAsString" : "..."
}, {
"id" : { },
"geometry" : { },
"lon" : 12345.0,
"parentStation" : { },
"netexVehicleSubmode" : { },
"wheelchairAccessibility" : "NO_INFORMATION",
"stationOrStopId" : { },
"code" : "...",
"timeZone" : "...",
"lat" : 12345.0,
"platformCode" : "...",
"fareZones" : [ { }, { } ],
"index" : 12345,
"description" : { },
"gtfsVehicleType" : "CABLE_CAR",
"name" : { },
"partOfStation" : true,
"coordinate" : { },
"url" : { },
"priority" : "DISCOURAGED",
"firstZoneAsString" : "..."
} ],
"lat" : 12345.0,
"lon" : 12345.0,
"coordinate" : { },
"code" : "...",
"description" : { },
"url" : { },
"priority" : "ALLOWED",
"timezone" : "...",
"transfersNotAllowed" : true,
"geometry" : {
"empty" : true,
"coordinates" : [ { }, { } ],
"numGeometries" : 12345,
"dimension" : 12345,
"numPoints" : 12345,
"geometryType" : "...",
"boundaryDimension" : 12345,
"area" : 12345.0,
"length" : 12345.0,
"boundary" : { },
"coordinate" : { },
"envelope" : { },
"rectangle" : true,
"centroid" : { },
"simple" : true,
"interiorPoint" : { },
"factory" : { },
"valid" : true,
"precisionModel" : { },
"envelopeInternal" : { },
"userData" : { },
"SRID" : 12345
},
"id" : {
"feedId" : "...",
"id" : "..."
}
},
"partOfStation" : true,
"id" : {
"feedId" : "...",
"id" : "..."
}
}