trips.json

{
  "$id": "https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/provider/trips.json",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Schema for MDS Provider trips payloads",
  "type": "object",
  "definitions": {
    "string": {
      "$id": "#/definitions/string",
      "type": "string",
      "description": "A length-limited string type",
      "maxLength": 255,
      "default": "",
      "examples": [
        "ABC123"
      ],
      "pattern": "^(.*)$"
    },
    "timestamp": {
      "$id": "#/definitions/timestamp",
      "type": "number",
      "description": "Integer milliseconds since Unix epoch",
      "multipleOf": 1.0,
      "minimum": 1514764800000
    },
    "uuid": {
      "$id": "#/definitions/uuid",
      "type": "string",
      "description": "A UUID used to uniquely identifty an object",
      "default": "",
      "examples": [
        "3c9604d6-b5ee-11e8-96f8-529269fb1459"
      ],
      "pattern": "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"
    },
    "version": {
      "$id": "#/definitions/version",
      "type": "string",
      "description": "The version of MDS this data represents",
      "examples": [
        "1.2.0"
      ],
      "pattern": "^1\\.2\\.[0-9]+$"
    },
    "MDS_Feature_Point": {
      "$id": "#/definitions/MDS_Feature_Point",
      "title": "MDS GeoJSON Feature Point",
      "type": "object",
      "required": [
        "type",
        "properties",
        "geometry"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Feature"
          ]
        },
        "id": {
          "oneOf": [
            {
              "type": "number"
            },
            {
              "type": "string"
            }
          ]
        },
        "properties": {
          "type": "object",
          "required": [
            "timestamp"
          ],
          "properties": {
            "timestamp": {
              "$ref": "#/definitions/timestamp"
            },
            "stop_id": {
              "$ref": "#/definitions/uuid"
            },
            "altitude": {
              "type": "number",
              "description": "Altitude above mean sea level in meters"
            },
            "heading": {
              "type": "number",
              "description": "Degrees - clockwise starting at 0 degrees at true North"
            },
            "speed": {
              "type": "number",
              "description": "Estimated speed in meters / sec as reported by the GPS chipset"
            },
            "accuracy": {
              "type": "number",
              "description": "Horizontal accuracy, in meters"
            },
            "hdop": {
              "type": "number",
              "description": "Horizontal GPS or GNSS accuracy value"
            },
            "satellites": {
              "type": "integer",
              "description": "Number of GPS or GNSS satellites"
            }
          }
        },
        "geometry": {
          "$ref": "#/definitions/Point"
        },
        "bbox": {
          "type": "array",
          "minItems": 4,
          "items": {
            "type": "number"
          }
        }
      }
    },
    "Point": {
      "$id": "#/definitions/Point",
      "title": "GeoJSON Point",
      "type": "object",
      "required": [
        "type",
        "coordinates"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Point"
          ]
        },
        "coordinates": {
          "type": "array",
          "minItems": 2,
          "items": [
            {
              "type": "number",
              "minimum": -180.0,
              "maximum": 180.0
            },
            {
              "type": "number",
              "minimum": -90.0,
              "maximum": 90.0
            }
          ],
          "maxItems": 2
        },
        "bbox": {
          "type": "array",
          "minItems": 4,
          "items": {
            "type": "number"
          }
        }
      }
    },
    "currency": {
      "$id": "#/definitions/currency",
      "type": [
        "string",
        "null"
      ],
      "pattern": "^[A-Z]{3}$",
      "default": "USD",
      "description": "An ISO 4217 Alphabetic Currency Code representing currency of the payee. If null, USD cents is implied.",
      "examples": [
        "USD",
        "EUR",
        "GBP"
      ]
    },
    "MDS_FeatureCollection_Route": {
      "$id": "#/definitions/MDS_FeatureCollection_Route",
      "title": "MDS GeoJSON FeatureCollection Route",
      "type": "object",
      "required": [
        "type",
        "features"
      ],
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "FeatureCollection"
          ]
        },
        "features": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MDS_Feature_Point"
          },
          "minItems": 2
        },
        "bbox": {
          "type": "array",
          "minItems": 4,
          "items": {
            "type": "number"
          }
        }
      }
    },
    "propulsion_type": {
      "$id": "#/definitions/propulsion_type",
      "type": "string",
      "description": "The type of propulsion",
      "enum": [
        "combustion",
        "electric",
        "electric_assist",
        "human"
      ]
    },
    "propulsion_types": {
      "$id": "#/definitions/propulsion_types",
      "type": "array",
      "description": "Array of propulsion types, allowing multiple values",
      "items": {
        "$id": "#/definitions/propulsion_types/items",
        "$ref": "#/definitions/propulsion_type"
      },
      "uniqueItems": true
    },
    "vehicle_type": {
      "$id": "#/definitions/vehicle_type",
      "type": "string",
      "description": "The type of vehicle",
      "enum": [
        "bicycle",
        "cargo_bicycle",
        "car",
        "scooter",
        "moped",
        "other"
      ]
    }
  },
  "required": [
    "data",
    "version"
  ],
  "properties": {
    "data": {
      "$id": "#/properties/data",
      "type": "object",
      "description": "The data records in this payload",
      "required": [
        "trips"
      ],
      "properties": {
        "trips": {
          "$id": "#/properties/data/properties/trips",
          "type": "array",
          "title": "The trips payload",
          "items": {
            "$id": "#/properties/data/properties/trips/items",
            "type": "object",
            "title": "The trip item schema",
            "additionalProperties": false,
            "required": [
              "provider_name",
              "provider_id",
              "device_id",
              "vehicle_id",
              "vehicle_type",
              "propulsion_types",
              "trip_id",
              "trip_duration",
              "trip_distance",
              "route",
              "accuracy",
              "start_time",
              "end_time"
            ],
            "properties": {
              "provider_name": {
                "$id": "#/definitions/vehicle/properties/provider_name",
                "$ref": "#/definitions/string",
                "description": "The public-facing name of the Provider"
              },
              "provider_id": {
                "$id": "#/definitions/vehicle/properties/provider_id",
                "$ref": "#/definitions/uuid",
                "description": "The UUID for the Provider, unique within MDS"
              },
              "device_id": {
                "$id": "#/definitions/vehicle/properties/device_id",
                "$ref": "#/definitions/uuid",
                "description": "A unique device ID in UUID format"
              },
              "vehicle_id": {
                "$id": "#/definitions/vehicle/properties/vehicle_id",
                "$ref": "#/definitions/string",
                "description": "The Vehicle Identification Number visible on the vehicle itself"
              },
              "vehicle_type": {
                "$id": "#/definitions/vehicle/properties/vehicle_type",
                "$ref": "#/definitions/vehicle_type",
                "description": "The type of vehicle"
              },
              "propulsion_types": {
                "$id": "#/definitions/vehicle/properties/propulsion_types",
                "$ref": "#/definitions/propulsion_types",
                "description": "The type of propulsion; allows multiple values",
                "minItems": 1
              },
              "trip_id": {
                "$id": "#/properties/data/properties/trips/items/properties/trip_id",
                "description": "A unique ID for each trip",
                "$ref": "#/definitions/uuid"
              },
              "trip_duration": {
                "$id": "#/properties/data/properties/trips/items/properties/trip_duration",
                "type": "integer",
                "description": "The length of time, in seconds, that the trip lasted",
                "default": 0,
                "examples": [
                  600
                ]
              },
              "trip_distance": {
                "$id": "#/properties/data/properties/trips/items/properties/trip_distance",
                "type": "integer",
                "description": "The distance, in meters, that the trip covered",
                "default": 0,
                "examples": [
                  1000
                ]
              },
              "route": {
                "$id": "#/properties/data/properties/trips/items/properties/route",
                "title": "The Route Schema",
                "$ref": "#/definitions/MDS_FeatureCollection_Route"
              },
              "accuracy": {
                "$id": "#/properties/data/properties/trips/items/properties/accuracy",
                "type": "integer",
                "title": "The approximate level of accuracy, in meters, of Points within route",
                "default": 0,
                "examples": [
                  15
                ]
              },
              "start_time": {
                "$id": "#/properties/data/properties/trips/items/properties/start_time",
                "description": "The time the trip began, expressed as a Unix Timestamp",
                "$ref": "#/definitions/timestamp"
              },
              "end_time": {
                "$id": "#/properties/data/properties/trips/items/properties/end_time",
                "description": "The time the trip ended, expressed as a Unix Timestamp",
                "$ref": "#/definitions/timestamp"
              },
              "publication_time": {
                "$id": "#/properties/data/properties/trips/items/properties/publication_time",
                "description": "The time the trip became available through the trips endpoint, expressed as a Unix Timestamp",
                "$ref": "#/definitions/timestamp"
              },
              "parking_verification_url": {
                "$id": "#/properties/data/properties/trips/items/properties/parking_verification_url",
                "type": [
                  "string",
                  "null"
                ],
                "format": "uri",
                "description": "A URL to a photo (or other evidence) of proper vehicle parking",
                "examples": [
                  "https://data.provider.co/parking_verify/1234.jpg"
                ]
              },
              "standard_cost": {
                "$id": "#/properties/data/properties/trips/items/properties/standard_cost",
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The cost, in the currency defined in `currency`, that it would cost to perform that trip in the standard operation of the System. If no currency is given, USD cents is implied.",
                "examples": [
                  500
                ]
              },
              "actual_cost": {
                "$id": "#/properties/data/properties/trips/items/properties/actual_cost",
                "type": [
                  "integer",
                  "null"
                ],
                "description": "The actual cost, in the currency defined in `currency`, paid by the customer of the *mobility as a service* provider. If no currency is given, USD cents is implied.",
                "examples": [
                  520
                ]
              },
              "currency": {
                "$id": "#/properties/data/properties/trips/items/properties/currency",
                "$ref": "#/definitions/currency"
              }
            }
          }
        }
      },
      "additionalProperties": false
    },
    "version": {
      "$id": "#/properties/version",
      "$ref": "#/definitions/version"
    }
  },
  "additionalProperties": false
}