Place

• Description
• Examples
• Schema

Place entity presents information about certain places. It could a bus stop, a train station, an access point, a group of places, a rack with shared bikes, etc.

Description

#1
required

object

Public transit stop, for example, train station, bus stop, etc

id
required

string

Unique identifier for the stop

name
required

one of

Name of the stop.

#1
required

string

Text in main language. Translation can be specified using Translation entities.

#2
required

object

Texts for different languages.

{
  "en": "Train Station",
  "de": "Bahnhof"
}

description

one of

Description of the stop.

#1

string

Text in main language. Translation can be specified using Translation entities.

#2

object

Texts for different languages.

{
  "en": "Train Station",
  "de": "Bahnhof"
}

loc
required

one of

Location of the stop.

#1
required

[number, number, number]

Array of coordinates.

[0]
required

number

Longitude.

[1]
required

number

Latitude.

[2]

number

Altitude in meters.

#2
required

object

Object of coordinates.

{
  "lon": 52.423412,
  "lat": 42.423413,
  "alt": 100
}

lon
required

number

Longitude.

lat
required

number

Latitude.

alt

number

Altitude in meters.

web

string

Website of the stop.

features

one of

Features of the stop. If the stop belongs to some groups, it gets all features of the groups.

#1

[]enum

List of place features.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

#2

object

Place features to be additionally included or excluded to inherited ones.

include

[]enum

Features to be included additionally to inherited ones.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

exclude

[]enum

Features to be excluded additionally to inherited ones.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

timezone

string

Timezone of the stop.

places

[]string

List of unique place identifiers that are linked to the stop.

graphics

[]object

Graphics that are accociated with the stop.

kind

enum

Kind of the graphic.

icon
2D
3D

graphic

string

Graphic identifier or relative path (with or without extension) to a graphic file.

#2
required

object

Access point to other places, for example, entrance or exit

id
required

string

Unique identifier for the place.

name
required

one of

Name of the access point.

#1
required

string

Text in main language. Translation can be specified using Translation entities.

#2
required

object

Texts for different languages.

{
  "en": "Train Station",
  "de": "Bahnhof"
}

description

one of

Description of the access point.

#1

string

Text in main language. Translation can be specified using Translation entities.

#2

object

Texts for different languages.

{
  "en": "Train Station",
  "de": "Bahnhof"
}

loc
required

one of

Location of the access point.

#1
required

[number, number, number]

Array of coordinates.

[0]
required

number

Longitude.

[1]
required

number

Latitude.

[2]

number

Altitude in meters.

#2
required

object

Object of coordinates.

{
  "lon": 52.423412,
  "lat": 42.423413,
  "alt": 100
}

lon
required

number

Longitude.

lat
required

number

Latitude.

alt

number

Altitude in meters.

direction

enum

Direction defines if the access point is only for entering or exit. By default, it is for both.

onlyEnter
onlyExit

features

one of

Features of the access point. If the access point belongs to some groups, it gets all features of the groups.

#1

[]enum

List of place features.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

#2

object

Place features to be additionally included or excluded to inherited ones.

include

[]enum

Features to be included additionally to inherited ones.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

exclude

[]enum

Features to be excluded additionally to inherited ones.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

#3
required

object

Parking lot for cars, bikes, etc.

id
required

string

Unique identifier for the parking lot.

name
required

one of

Name of the parking lot.

#1
required

string

Text in main language. Translation can be specified using Translation entities.

#2
required

object

Texts for different languages.

{
  "en": "Train Station",
  "de": "Bahnhof"
}

description

one of

Description of the parking lot.

#1

string

Text in main language. Translation can be specified using Translation entities.

#2

object

Texts for different languages.

{
  "en": "Train Station",
  "de": "Bahnhof"
}

loc
required

one of

Location of the parking lot`.

#1
required

[number, number, number]

Array of coordinates.

[0]
required

number

Longitude.

[1]
required

number

Latitude.

[2]

number

Altitude in meters.

#2
required

object

Object of coordinates.

{
  "lon": 52.423412,
  "lat": 42.423413,
  "alt": 100
}

lon
required

number

Longitude.

lat
required

number

Latitude.

alt

number

Altitude in meters.

kind

[]object

lotType
required

enum

bike
car

capacity
required

string

Capacity of the parking lot.

web

string

Website of the parking lot.

features

one of

Features of the parking lot.

#1

[]enum

List of place features.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

#2

object

Place features to be additionally included or excluded to inherited ones.

include

[]enum

Features to be included additionally to inherited ones.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

exclude

[]enum

Features to be excluded additionally to inherited ones.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

#4
required

object

Group of places, for example, the central station containing different places like stops, access points, parking lots.

id
required

string

Unique identifier for the group.

name
required

one of

Name of the group.

#1
required

string

Text in main language. Translation can be specified using Translation entities.

#2
required

object

Texts for different languages.

{
  "en": "Train Station",
  "de": "Bahnhof"
}

description

one of

Description of the group.

#1

string

Text in main language. Translation can be specified using Translation entities.

#2

object

Texts for different languages.

{
  "en": "Train Station",
  "de": "Bahnhof"
}

loc

one of

Location of the group if any.

#1

[number, number, number]

Array of coordinates.

[0]
required

number

Longitude.

[1]
required

number

Latitude.

[2]

number

Altitude in meters.

#2

object

Object of coordinates.

{
  "lon": 52.423412,
  "lat": 42.423413,
  "alt": 100
}

lon
required

number

Longitude.

lat
required

number

Latitude.

alt

number

Altitude in meters.

web

string

Website of the group.

features

one of

Features of the group. All places in the group will inherit these features.

#1

[]enum

List of place features.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

#2

object

Place features to be additionally included or excluded to inherited ones.

include

[]enum

Features to be included additionally to inherited ones.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

exclude

[]enum

Features to be excluded additionally to inherited ones.

wheelchair_access
elevator
upstairs_escalator
downstairs_escalator

places
required

[]string

List of unique place identifiers that belong to the group.

Examples

#1

{
  "id": "01",
  "name": "Stop 01",
  "description": {
    "en": "Bus stop for interregional trips",
    "de-de": "Bushaltestelle für interregionale Reisen"
  },
  "loc": [
    13.404954,
    52.520008,
    34
  ],
  "stopType": "parent",
  "timezone": "Europe/Berlin",
  "features": [
    "wheelchair_access",
    "elevator",
    "upstairs_escalator"
  ],
  "accessPoints": [
    {
      "id": "01-ap01",
      "name": "West side entrance",
      "loc": [
        12.345678,
        87.654321
      ],
      "features": [
        "downstairs_escalator"
      ]
    }
  ],
  "childStops": [],
  "icon": "",
  "graphics": {
    "format": "geojson",
    "data": {
      "type": "Feature",
      "properties": {},
      "geometry": {
        "coordinates": [
          [
            [
              13.368270255270005,
              52.52573885487206
            ],
            [
              13.36928032987069,
              52.52428739765102
            ],
            [
              13.369625881706838,
              52.52428335452754
            ],
            [
              13.369708947053311,
              52.524160039088116
            ],
            [
              13.37039340549967,
              52.524162060655414
            ],
            [
              13.370293727085027,
              52.52428335452754
            ],
            [
              13.370635956307524,
              52.52427931140406
            ],
            [
              13.369632526935476,
              52.52573885487206
            ],
            [
              13.36928032987069,
              52.52573885487206
            ],
            [
              13.369190619297001,
              52.525866208857366
            ],
            [
              13.368542709603389,
              52.52586823034653
            ],
            [
              13.36862577494847,
              52.525734811882614
            ],
            [
              13.368270255270005,
              52.52573885487206
            ]
          ]
        ],
        "type": "Polygon"
      }
    }
  }
}

#2

{
  "id": "02",
  "name": "Stop 02",
  "loc": [
    13.404954,
    52.520008,
    0
  ],
  "stopType": "parent",
  "timezone": "Europe/Berlin",
  "features": [
    "wheelchair_access",
    "elevator",
    "upstairs_escalator"
  ],
  "accessPoints": [
    {
      "id": "02-ap01",
      "name": "West side entrance",
      "loc": [
        12.345678,
        87.654321
      ],
      "features": {
        "exclude": [
          "upstairs_escalator"
        ],
        "include": [
          "downstairs_escalator"
        ]
      }
    }
  ],
  "childStops": [
    {
      "id": "02-child01",
      "name": "Platform 1",
      "description": "Has no features",
      "loc": {
        "lon": 12.345678,
        "lat": 87.654321
      },
      "features": []
    }
  ]
}

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/vchezganov/cityvehiclespec/schema/place.json",
  "title": "Place",
  "oneOf": [
    {
      "description": "Public transit stop, for example, train station, bus stop, etc",
      "$ref": "place/transit_stop.json"
    },
    {
      "description": "Access point to other places, for example, entrance or exit",
      "$ref": "place/access_point.json"
    },
    {
      "description": "Parking lot for cars, bikes, etc.",
      "$ref": "place/parking_lot.json"
    },
    {
      "description": "Group of places, for example, the central station containing different places like stops, access points, parking lots.",
      "$ref": "place/place_group.json"
    }
  ]
}