action ptv_runs_for_run { label: "View all trip/service runs for a specific run_ref" provider: ptv method: GET path: "/v3/runs/{run_ref}" encoding: json input: { type: "object" properties: { date_utc: { type: "string" format: "date-time" } devid: { type: "string" } expand: { type: "array" items: { type: "string" enum: ["All", "VehicleDescriptor", "VehiclePosition", "None"] } } include_geopath: { type: "boolean" } run_ref: { type: "string" } signature: { type: "string" } token: { type: "string" } } required: ["expand", "run_ref"] additionalProperties: false } output: { type: "object" properties: { runs: { type: "array" description: "Individual trips/services of a route" items: { type: "object" properties: { destination_name: { type: "string" description: "Name of destination of run" } direction_id: { type: "integer" format: "int32" description: "Direction of travel identifier" } express_stop_count: { type: "integer" format: "int32" description: "The number of remaining skipped/express stations for the run/service from a stop" } final_stop_id: { type: "integer" format: "int32" description: "stop_id of final stop of run" } geopath: { type: "array" description: "Geopath of the route" items: { type: "object" properties: {} } } route_id: { type: "integer" format: "int32" description: "Route identifier" } route_type: { type: "integer" format: "int32" description: "Transport mode identifier" } run_id: { type: "integer" format: "int32" description: "Numeric trip/service run identifier. Defaults to -1 when run identifier is Alphanumeric" } run_ref: { type: "string" description: "Alphanumeric trip/service run identifier" } run_sequence: { type: "integer" format: "int32" description: "Chronological sequence of the trip/service run on the route in direction. Order ascendingly by this field to get chronological order (earliest first) of runs with the same route_id and direction_id." } status: { type: "string" description: "Status of metropolitan train run; returns \"scheduled\" for other modes" } vehicle_descriptor: { type: "object" properties: { air_conditioned: { type: "boolean" description: "Indicator if vehicle is air conditioned. May be null. Only available for some tram runs." } description: { type: "string" description: "Vehicle description such as \"6 Car Comeng\", \"6 Car Xtrapolis\", \"3 Car Comeng\", \"6 Car Siemens\", \"3 Car Siemens\". May be null/empty. \n Only available for some metropolitan train runs." } id: { type: "string" description: "Operator identifier of the vehicle such as \"26094\". May be null/empty. Only available for some tram and bus runs." } length: { type: "string" description: "The length of the vehicle. Applies to CIS - Metro Trains" } low_floor: { type: "boolean" description: "Indicator if vehicle has a low floor. May be null. Only available for some tram runs." } operator: { type: "string" description: "Operator name of the vehicle such as \"Metro Trains Melbourne\", \"Yarra Trams\", \"Ventura Bus Line\", \"CDC\" or \"Sita Bus Lines\" . May be null/empty. \n Only available for train, tram, v/line and some bus runs." } supplier: { type: "string" description: "Supplier of vehicle descriptor data." } } } vehicle_position: { type: "object" properties: { bearing: { type: "number" format: "double" description: "Compass bearing of the vehicle when known, clockwise from True North, i.e., 0 is North and 90 is East. May be null. \n Only available for some bus runs." } datetime_utc: { type: "string" format: "date-time" description: "Date and time that the vehicle position data was supplied." } direction: { type: "string" description: "CIS - Metro Train Vehicle Location Direction" } easting: { type: "number" format: "double" description: "CIS - Metro Train Vehicle Location Easting coordinate" } expiry_time: { type: "string" format: "date-time" description: "CIS - Metro Train Vehicle Location data expiry time" } latitude: { type: "number" format: "double" description: "Geographic coordinate of latitude of the vehicle when known. May be null. \n Only available for some bus runs." } longitude: { type: "number" format: "double" description: "Geographic coordinate of longitude of the vehicle when known. \n Only available for some bus runs." } northing: { type: "number" format: "double" description: "CIS - Metro Train Vehicle Location Northing coordinate" } supplier: { type: "string" description: "Supplier of vehicle position data." } } } } } } status: { type: "object" properties: { health: { type: "integer" format: "int32" description: "API system health status (0=offline, 1=online)" enum: [0, 1] } version: { type: "string" description: "API Version number" } } } } } }