{
  "$schema": "http://json-schema.org/schema#",
  "$schemaVersion": "0.0.1",
  "$id": "https://smart-data-models.github.io/dataModel.Transportation/FareCollectionSystem/schema.json",
  "title": "Smart Dta Models - FareCollectionSystem",
  "description": "A public transit fare collection system Data Model",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons"
    },
    {
      "$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons"
    },
    {
      "properties": {
        "type": {
          "type": "string",
          "description": "Property. NGSI entity type. It has to be FareCollectionSystem",
          "enum": [
            "FareCollectionSystem"
          ]
        },
        "destinationStopName": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. The name of the destination bus stop corresponding to this observation."
        },
        "occupancyLevel": {
          "type": "string",
          "enum": [
            "Red",
            "Yellow",
            "Green"
          ],
          "description": "Property. Model:'https://schema.org/Text'. Occupancy level in the public transit bus corresponding to this observation. 'Red' indicates the congestion level in the bus is HIGH, 'Yellow' indicates the congestion level in the bus is MODERATE and 'Green' indicates the congestion level in the bus is LOW."
        },
        "travelDistance": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. The distance between the origin bus stop and the destination bus stop corresponding to this observation."
        },
        "passengerCount": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. Number of passengers travelling in the public transit bus corresponding to this observation. This count is computed based on the realtime ticketing transactions in the public transit bus."
        },
        "transactionType": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Type of the transaction corresponding to this observation. For Eg - Issue, ReIssue, Entry, Exit etc."
        },
        "ticketTypeCode": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Unique ticket type code of the corresponding trip."
        },
        "originStopName": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. The name of the origin bus stop corresponding to this observation."
        },
        "entryAreaCode": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Area code of the passenger boarding stop (used by the fare collection agency). For example, whether the stop is city-bus-service stop or brts stop or other service type stop etc."
        },
        "cardId": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Unique ticket Id of the transaction or Id of the smart card used in the transaction."
        },
        "stage": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. Total number of stages from the origin bus stop to the destination bus stop."
        },
        "equipmentId": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Unique Id of the equipment corresponding to this observation."
        },
        "direction_id": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. Indicates the direction of travel of the vehicle corresponding to this observation, can be referenced from the GTFS static feed trips.txt. SameAs: 'direction_id' field from GTFS Realtime message-TripDescriptor (https://developers.google.com/transit/gtfs-realtime/reference#message-tripdescriptor)"
        },
        "equipmentSequenceNumber": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. Sequence number for the given equipment."
        },
        "shiftOfOperation": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Shift of operation of the public transit vehicle operated by the fare collection agency/ public transit agency or the employee corresponding to this observation. Indicated as '1' when the vehicle operates in the first shift, '2' when the vehicle operates in the second shift and '3' when the vehicle operates in the third shift."
        },
        "route_id": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Route Id assigned to the route on which the bus/vehicle corresponding to the bus in this observation is currently plying on. SameAs: 'route_id' field from GTFS Realtime message-TripDescriptor (https://developers.google.com/transit/gtfs-realtime/reference#message-tripdescriptor)"
        },
        "trip_id": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Trip Id/Trip name alloted to the bus corresponding to this observation, in consideration to the time of the day and the direction of the trip on the given routeId. SameAs: 'trip_id' field from GTFS Realtime message-TripDescriptor (https://developers.google.com/transit/gtfs-realtime/reference#message-tripdescriptor)"
        },
        "originStopCategory": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Type of the origin bus stop corresponding to this observation."
        },
        "vehicle_label": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. User visible label, i.e., something that must be shown to the passenger to help identify the correct vehicle. SameAs: 'label' field from GTFS Realtime message-VehicleDescriptor (https://developers.google.com/transit/gtfs-realtime/reference#message-vehicledescriptor)"
        },
        "fareForChild": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. The fare for a child in the journey corresponding to this observation."
        },
        "transactionDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Property. Model:'https://schema.org/Text'. Date-time of the transaction corresponding to this observation."
        },
        "destinationStopId": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Unique Id of the bus stop at which the passenger deboards from the bus corresponding to this observation."
        },
        "originDestinationCode": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. The code for the origin and destination stops corresponding to this observation."
        },
        "currentTripCount": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. The current count of trips made by the vehicle corresponding to this observation on the given day of operation."
        },
        "equipmentTypeCode": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Unique code indicating the type of equipment used in the transaction (used by fare collection agency).ENUM [1B, 42, 02, 08, 41] 1B - POS, 42 - HTT, 02- Mobile, 08- Fare Gate, 41- Pole Validator",
          "enum": [
            "1B",
            "42",
            "02",
            "08",
            "41"
          ]
        },
        "destinationStopCategory": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Type of the destination bus stop corresponding to this observation."
        },
        "transactionVehicleNum": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. Code used by fare collection agency for the vehicle number corresponding to the transaction."
        },
        "fareForAdult": {
          "type": "number",
          "description": "Property. Model:'https://schema.org/Number'. The fare for an adult in the journey corresponding to this observation."
        },
        "observationDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Property. Model:'https://schema.org/Text'. Last reported time of observation."
        },
        "equipmentCompanyCode": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Company/Agency code for the transaction equipment (used by fare collection agency). For example, 103 - CBS (city bus service),102 - BRTS etc."
        },
        "transactionTypeDescription": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Description of the transaction type. Explanation of various transactionTypeId codes used in the data."
        },
        "exitAreaCode": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Area code of the passenger alighting stop (used by the fare collection agency). For example, whether the stop is city-bus-service stop or BRTS stop or other service type stop etc."
        },
        "equipmentType": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Type of equipment or the name of the equipment corresponding to this observation."
        },
        "equipmentStopId": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Stop Id (BRTS) at which the equipment corresponding to this transaction is installed."
        },
        "originStopId": {
          "type": "string",
          "description": "Property. Model:'https://schema.org/Text'. Unique Id of the bus stop at which the passenger boards into the bus corresponding to this observation."
        }
      }
    }
  ],
  "required": [
    "id",
    "type"
  ]
}