BoardingArea Data Type

A place along a platform, where the vehicle van be boarded. Equivalent to GTFS stop location.

Properties
name data type constraints description
coordinate WgsCoordinate required Center point/location for the boarding area. Returns the coordinate of the parent stop, if the coordinate is not defined for this boarding area.
parentStop RegularStop required Returns the parent stop this boarding area belongs to.
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

{
  "coordinate" : { },
  "parentStop" : {
    "index" : 12345,
    "platformCode" : "...",
    "url" : { },
    "timeZone" : "...",
    "gtfsVehicleType" : "MONORAIL",
    "netexVehicleSubmode" : { },
    "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" : [ { }, { } ]
    },
    "priority" : "DISCOURAGED",
    "fareZones" : [ {
      "name" : "...",
      "id" : { }
    }, {
      "name" : "...",
      "id" : { }
    } ],
    "boardingAreas" : [ {
      "coordinate" : { },
      "parentStop" : { },
      "name" : { },
      "code" : "...",
      "description" : { },
      "wheelchairAccessibility" : "POSSIBLE",
      "levelName" : "...",
      "levelIndex" : 12345.0,
      "parentStation" : { },
      "partOfStation" : true,
      "id" : { }
    }, {
      "coordinate" : { },
      "parentStop" : { },
      "name" : { },
      "code" : "...",
      "description" : { },
      "wheelchairAccessibility" : "POSSIBLE",
      "levelName" : "...",
      "levelIndex" : 12345.0,
      "parentStation" : { },
      "partOfStation" : true,
      "id" : { }
    } ],
    "name" : { },
    "code" : "...",
    "description" : { },
    "coordinate" : { },
    "wheelchairAccessibility" : "POSSIBLE",
    "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" : { },
  "wheelchairAccessibility" : "POSSIBLE",
  "levelName" : "...",
  "levelIndex" : 12345.0,
  "parentStation" : {
    "name" : { },
    "childStops" : [ {
      "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" : "ALLOWED",
      "firstZoneAsString" : "..."
    }, {
      "id" : { },
      "geometry" : { },
      "lon" : 12345.0,
      "parentStation" : { },
      "netexVehicleSubmode" : { },
      "wheelchairAccessibility" : "NO_INFORMATION",
      "stationOrStopId" : { },
      "code" : "...",
      "timeZone" : "...",
      "lat" : 12345.0,
      "platformCode" : "...",
      "fareZones" : [ { }, { } ],
      "index" : 12345,
      "description" : { },
      "gtfsVehicleType" : "TROLLEYBUS",
      "name" : { },
      "partOfStation" : true,
      "coordinate" : { },
      "url" : { },
      "priority" : "DISCOURAGED",
      "firstZoneAsString" : "..."
    } ],
    "lat" : 12345.0,
    "lon" : 12345.0,
    "coordinate" : { },
    "code" : "...",
    "description" : { },
    "url" : { },
    "priority" : "PREFERRED",
    "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" : "..."
  }
}