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 |
|---|---|---|---|
| platformCode | string | ||
| url | string | ||
| timeZone | TimeZone | ||
| vehicleType | TransitMode | ||
| boardingAreas | array of BoardingArea | ||
| 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 | ||
| 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. | |
| vehicleSubmode | string | ||
Properties inherited from StationElement |
|||
| name | string | required | Name of the station element if provided. |
| code | string | Public facing stop code (short text or number). | |
| description | string | Additional information about the station element (if needed). | |
| coordinate | WgsCoordinate | Center point/location for the station element. Returns the coordinate of the parent station, if the coordinate is not defined for this station element. | |
| wheelchairBoarding | WheelChairBoarding | 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 TransitEntity |
|||
| id | FeedScopedId | ||
Example
{
"platformCode" : "...",
"url" : "...",
"timeZone" : {
"rawOffset" : 12345,
"DSTSavings" : 12345,
"availableIDs" : [ "...", "..." ],
"default" : { },
"displayName" : "...",
"ID" : "..."
},
"vehicleType" : "MONORAIL",
"boardingAreas" : [ {
"coordinate" : { },
"parentStop" : {
"platformCode" : "...",
"url" : "...",
"timeZone" : { },
"vehicleType" : "AIRPLANE",
"boardingAreas" : [ { }, { } ],
"priority" : "PREFERRED",
"fareZones" : [ { }, { } ],
"geometry" : { },
"vehicleSubmode" : "...",
"name" : "...",
"code" : "...",
"description" : "...",
"coordinate" : { },
"wheelchairBoarding" : "POSSIBLE",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : { },
"partOfStation" : true,
"id" : { }
},
"name" : "...",
"code" : "...",
"description" : "...",
"wheelchairBoarding" : "NOT_POSSIBLE",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : {
"name" : "...",
"coordinate" : { },
"code" : "...",
"description" : "...",
"url" : "...",
"priority" : "PREFERRED",
"timezone" : { },
"childStops" : [ { }, { } ],
"lat" : 12345.0,
"lon" : 12345.0,
"geometry" : { },
"id" : { }
},
"partOfStation" : true,
"id" : {
"feedId" : "...",
"id" : "..."
}
}, {
"coordinate" : { },
"parentStop" : {
"platformCode" : "...",
"url" : "...",
"timeZone" : { },
"vehicleType" : "MONORAIL",
"boardingAreas" : [ { }, { } ],
"priority" : "RECOMMENDED",
"fareZones" : [ { }, { } ],
"geometry" : { },
"vehicleSubmode" : "...",
"name" : "...",
"code" : "...",
"description" : "...",
"coordinate" : { },
"wheelchairBoarding" : "NOT_POSSIBLE",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : { },
"partOfStation" : true,
"id" : { }
},
"name" : "...",
"code" : "...",
"description" : "...",
"wheelchairBoarding" : "NO_INFORMATION",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : {
"name" : "...",
"coordinate" : { },
"code" : "...",
"description" : "...",
"url" : "...",
"priority" : "RECOMMENDED",
"timezone" : { },
"childStops" : [ { }, { } ],
"lat" : 12345.0,
"lon" : 12345.0,
"geometry" : { },
"id" : { }
},
"partOfStation" : true,
"id" : {
"feedId" : "...",
"id" : "..."
}
} ],
"priority" : "DISCOURAGED",
"fareZones" : [ {
"name" : "...",
"id" : {
"feedId" : "...",
"id" : "..."
}
}, {
"name" : "...",
"id" : {
"feedId" : "...",
"id" : "..."
}
} ],
"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
},
"vehicleSubmode" : "...",
"name" : "...",
"code" : "...",
"description" : "...",
"coordinate" : { },
"wheelchairBoarding" : "NO_INFORMATION",
"levelName" : "...",
"levelIndex" : 12345.0,
"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" : "POSSIBLE",
"lat" : 12345.0,
"id" : { },
"coordinate" : { },
"vehicleType" : "TROLLEYBUS"
}, {
"geometry" : { },
"parentStation" : { },
"platformCode" : "...",
"name" : "...",
"partOfStation" : true,
"lon" : 12345.0,
"firstZoneAsString" : "...",
"description" : "...",
"vehicleSubmode" : "...",
"fareZones" : [ { }, { } ],
"priority" : "PREFERRED",
"timeZone" : { },
"url" : "...",
"code" : "...",
"wheelchairBoarding" : "NOT_POSSIBLE",
"lat" : 12345.0,
"id" : { },
"coordinate" : { },
"vehicleType" : "TROLLEYBUS"
} ],
"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" : "..."
}
},
"partOfStation" : true,
"id" : {
"feedId" : "...",
"id" : "..."
}
}