action tfl_line_route_by_mode {
  label: "Gets all lines and their valid routes for given modes, including the name and id of the originating and terminating stops for each route"
  provider: tfl
  method: GET
  path: "/Line/Mode/{modes}/Route"
  encoding: json
  input: {
    type: "object"
    properties: {
      modes: {
        type: "array"
        items: {
          type: "string"
        }
      }
      serviceTypes: {
        type: "array"
        items: {
          type: "string"
          enum: ["Regular", "Night"]
        }
      }
    }
    required: ["modes"]
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      type: "object"
      properties: {
        created: {
          type: "string"
          format: "date-time"
        }
        crowding: {
          type: "object"
          properties: {
            passengerFlows: {
              type: "array"
              description: "Busiest times at a station (static information)"
              items: {
                type: "object"
                properties: {
                  timeSlice: {
                    type: "string"
                    description: "Time in 24hr format with 15 minute intervals e.g. 0500-0515, 0515-0530 etc."
                  }
                  value: {
                    type: "integer"
                    format: "int32"
                    description: "Count of passenger flow towards a platform"
                  }
                }
              }
            }
            trainLoadings: {
              type: "array"
              description: "Train Loading on a scale 1-6, 1 being \"Very quiet\" and 6 being \"Exceptionally busy\" (static information)"
              items: {
                type: "object"
                properties: {
                  direction: {
                    type: "string"
                    description: "Direction in regards to Journey Planner i.e. inbound or outbound"
                  }
                  line: {
                    type: "string"
                    description: "The Line Name e.g. \"Victoria\""
                  }
                  lineDirection: {
                    type: "string"
                    description: "Direction of the Line e.g. NB, SB, WB etc."
                  }
                  naptanTo: {
                    type: "string"
                    description: "Naptan of the adjacent station"
                  }
                  platformDirection: {
                    type: "string"
                    description: "Direction displayed on the platform e.g. NB, SB, WB etc."
                  }
                  timeSlice: {
                    type: "string"
                    description: "Time in 24hr format with 15 minute intervals e.g. 0500-0515, 0515-0530 etc."
                  }
                  value: {
                    type: "integer"
                    format: "int32"
                    description: "Scale between 1-6, 
\n             1 = Very quiet, 2 = Quiet, 3 = Fairly busy, 4 = Busy, 5 = Very busy, 6 = Exceptionally busy"
                  }
                }
              }
            }
          }
        }
        disruptions: {
          type: "array"
          items: {
            type: "object"
            description: "Represents a disruption to a route within the transport network."
            properties: {
              additionalInfo: {
                type: "string"
                description: "Gets or sets the additionaInfo of this disruption."
              }
              affectedRoutes: {
                type: "array"
                description: "Gets or sets the routes affected by this disruption"
                items: {
                  type: "object"
                  description: "keep old RouteSection name so as not to break contract"
                  properties: {
                    destinationName: {
                      type: "string"
                      description: "The name of the Destination StopPoint"
                    }
                    direction: {
                      type: "string"
                      description: "Inbound or Outbound"
                    }
                    id: {
                      type: "string"
                      description: "The Id of the route"
                    }
                    isEntireRouteSection: {
                      type: "boolean"
                      description: "Whether this represents the entire route section"
                    }
                    lineId: {
                      type: "string"
                      description: "The Id of the Line"
                    }
                    lineString: {
                      type: "string"
                      description: "The co-ordinates of the route's path as a geoJSON lineString"
                    }
                    name: {
                      type: "string"
                      description: "Name such as \"72\""
                    }
                    originationName: {
                      type: "string"
                      description: "The name of the Origin StopPoint"
                    }
                    routeCode: {
                      type: "string"
                      description: "The route code"
                    }
                    routeSectionNaptanEntrySequence: {
                      type: "array"
                      items: {
                        type: "object"
                        properties: {
                          ordinal: {
                            type: "object"
                            additionalProperties: true
                          }
                          stopPoint: {
                            type: "object"
                            additionalProperties: true
                          }
                        }
                      }
                    }
                    validFrom: {
                      type: "string"
                      format: "date-time"
                      description: "The DateTime that the Service containing this Route is valid from."
                    }
                    validTo: {
                      type: "string"
                      format: "date-time"
                      description: "The DateTime that the Service containing this Route is valid until."
                    }
                    via: {
                      type: "object"
                      additionalProperties: true
                    }
                  }
                }
              }
              affectedStops: {
                type: "array"
                description: "Gets or sets the stops affected by this disruption"
                items: {
                  type: "object"
                  additionalProperties: true
                }
              }
              category: {
                type: "string"
                description: "Gets or sets the category of this dispruption."
                enum: ["Undefined", "RealTime", "PlannedWork", "Information", "Event", "Crowding", "StatusAlert"]
              }
              categoryDescription: {
                type: "string"
                description: "Gets or sets the description of the category."
              }
              closureText: {
                type: "string"
                description: "Text describing the closure type"
              }
              created: {
                type: "string"
                format: "date-time"
                description: "Gets or sets the date/time when this disruption was created."
              }
              description: {
                type: "string"
                description: "Gets or sets the description of this disruption."
              }
              lastUpdate: {
                type: "string"
                format: "date-time"
                description: "Gets or sets the date/time when this disruption was last updated."
              }
              summary: {
                type: "string"
                description: "Gets or sets the summary of this disruption."
              }
              type: {
                type: "string"
                description: "Gets or sets the disruption type of this dispruption."
              }
            }
          }
        }
        id: {
          type: "string"
        }
        lineStatuses: {
          type: "array"
          items: {
            type: "object"
            properties: {
              created: {
                type: "string"
                format: "date-time"
              }
              disruption: {
                type: "object"
                additionalProperties: true
              }
              id: {
                type: "integer"
                format: "int32"
              }
              lineId: {
                type: "string"
              }
              modified: {
                type: "string"
                format: "date-time"
              }
              reason: {
                type: "string"
              }
              statusSeverity: {
                type: "integer"
                format: "int32"
              }
              statusSeverityDescription: {
                type: "string"
              }
              validityPeriods: {
                type: "array"
                items: {
                  type: "object"
                  description: "Represents a period for which a planned works is valid."
                  properties: {
                    fromDate: {
                      type: "string"
                      format: "date-time"
                      description: "Gets or sets the start date."
                    }
                    isNow: {
                      type: "boolean"
                      description: "If true is a realtime status rather than planned or info"
                    }
                    toDate: {
                      type: "string"
                      format: "date-time"
                      description: "Gets or sets the end date."
                    }
                  }
                }
              }
            }
          }
        }
        modeName: {
          type: "string"
        }
        modified: {
          type: "string"
          format: "date-time"
        }
        name: {
          type: "string"
        }
        routeSections: {
          type: "array"
          items: {
            type: "object"
            description: "Description of a Route used in Route search results."
            properties: {
              destination: {
                type: "string"
                description: "The Id (NaPTAN code) or the Destination StopPoint"
              }
              destinationName: {
                type: "string"
                description: "The name of the Destination StopPoint"
              }
              direction: {
                type: "string"
                description: "Inbound or Outbound"
              }
              name: {
                type: "string"
                description: "Name such as \"72\""
              }
              originationName: {
                type: "string"
                description: "The name of the Origin StopPoint"
              }
              originator: {
                type: "string"
                description: "The Id (NaPTAN code) of the Origin StopPoint"
              }
              routeCode: {
                type: "string"
                description: "The route code"
              }
              serviceType: {
                type: "string"
                description: "Regular or Night"
              }
              validFrom: {
                type: "string"
                format: "date-time"
                description: "The DateTime that the Service containing this Route is valid from."
              }
              validTo: {
                type: "string"
                format: "date-time"
                description: "The DateTime that the Service containing this Route is valid until."
              }
            }
          }
        }
        serviceTypes: {
          type: "array"
          items: {
            type: "object"
            properties: {
              name: {
                type: "string"
              }
              uri: {
                type: "string"
              }
            }
          }
        }
      }
    }
  }
}