Operator

• Description
• Examples
• Schema

Operator entity presents information about certain agency or provider. It could be a bus operator, a rail agency, or a mobility provider for shared vehicles.

Description

id
required

string

The unique identifier for an operator.

name
required

one of

Name of the operator.

#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 operator.

#1

string

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

#2

object

Texts for different languages.

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

language
required

string

Default language for the operator. It should be used by default in responses if no specific language is requested, or if there are no translations for the requested language.

timezone
required

string

Timezone where the operator operates. All route timetable times, that belong to the operator, are defined in this timezone.

web

string

Website of the operator.

phone

one of

Phone number(s) of the operator.

#1

string

Defines only one main phone number of the operator.

{
  "phone": "+1234567890"
}

#2

[]object

Defines various phone numbers of the operator.

{
  "phone": [
    {
      "phoneType": "support",
      "value": "+1234567890"
    },
    {
      "phoneType": "information",
      "value": "+0987654321"
    }
  ]
}

phoneType
required

enum

Type of the phone number.

main
support
information

value
required

string

Phone number.

email

one of

Email address(es) of the operator.

#1

string

Defines only one main email address of the operator.

#2

[]object

Defines various email addresses of the operator.

emailType
required

enum

Type of the email.

main
support
information

value
required

string

Email address.

loc

one of

Location of the operator.

#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.

graphics

[]object

Graphics that are accociated with the stop.

kind

enum

Kind of the graphic.

icon

graphic

string

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

Examples

#1

{
  "id": "A01",
  "name": "Agency 01",
  "language": "en",
  "timezone": "Europe/Berlin"
}

#2

{
  "id": "A02",
  "name": "Agency 02",
  "language": "en-US",
  "timezone": "Europe/Paris",
  "phone": [
    {
      "phoneType": "information",
      "value": "54321"
    },
    {
      "phoneType": "support",
      "value": "12345"
    }
  ]
}

#3

{
  "id": "A03",
  "name": {
    "en": "Agency 03",
    "de": "Verkehrsbetriebe 03"
  },
  "language": "de",
  "timezone": "Europe/Madrid",
  "phone": [
    {
      "phoneType": "information",
      "value": "54321"
    },
    {
      "phoneType": "support",
      "value": "12345"
    }
  ],
  "loc": [
    52.525517,
    13.4153366
  ]
}

Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/vchezganov/cityvehiclespec/schema/operator.json",
  "title": "Operator",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique identifier for an operator.",
      "type": "string"
    },
    "name": {
      "description": "Name of the operator.",
      "$ref": "definitions.json#/$defs/translation"
    },
    "description": {
      "description": "Description of the operator.",
      "$ref": "definitions.json#/$defs/translation"
    },
    "language": {
      "description": "Default language for the operator. It should be used by default in responses if no specific language is requested, or if there are no translations for the requested language.",
      "type": "string"
    },
    "timezone": {
      "description": "Timezone where the operator operates. All route timetable times, that belong to the operator, are defined in this timezone.",
      "type": "string"
    },
    "web": {
      "description": "Website of the operator.",
      "type": "string"
    },
    "phone": {
      "description": "Phone number(s) of the operator.",
      "oneOf": [
        {
          "description": "Defines only one main phone number of the operator.",
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "description": "Defines various phone numbers of the operator.",
            "type": "object",
            "properties": {
              "phoneType": {
                "description": "Type of the phone number.",
                "enum": [
                  "main",
                  "support",
                  "information"
                ]
              },
              "value": {
                "description": "Phone number.",
                "type": "string"
              }
            },
            "required": [
              "phoneType",
              "value"
            ],
            "uniqueItems": true
          }
        }
      ]
    },
    "email": {
      "description": "Email address(es) of the operator.",
      "oneOf": [
        {
          "description": "Defines only one main email address of the operator.",
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "description": "Defines various email addresses of the operator.",
            "type": "object",
            "properties": {
              "emailType": {
                "description": "Type of the email.",
                "enum": [
                  "main",
                  "support",
                  "information"
                ]
              },
              "value": {
                "description": "Email address.",
                "type": "string"
              }
            },
            "required": [
              "emailType",
              "value"
            ],
            "uniqueItems": true
          }
        }
      ]
    },
    "loc": {
      "description": "Location of the operator.",
      "$ref": "definitions.json#/$defs/location"
    },
    "graphics": {
      "description": "Graphics that are accociated with the stop.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "description": "Kind of the graphic.",
            "enum": [
              "icon"
            ]
          },
          "graphic": {
            "$ref": "definitions.json#/$defs/graphicReference"
          }
        }
      }
    }
  },
  "required": [
    "id",
    "name",
    "language",
    "timezone"
  ]
}