Files
api-schemas/schemas/api/trains/TrainDetails.json
2026-05-03 00:38:48 +01:00

224 lines
7.9 KiB
JSON

{
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "TrainDetailsResponse",
"$defs": {
"ServiceLocation": {
"type": "object",
"description": "A specific location along the services journey",
"additionalProperties": false,
"properties": {
"t": {
"type": "string",
"title": "TIPLOC",
"description": "The TIPLOC of the location"
},
"r": {
"type": "string",
"enum": ["ORIG", "CALL", "PASS", "DEST"],
"title": "Location Role",
"description": "The role of this location in the journey"
},
"s": {
"type": "integer",
"title": "Sequence Number",
"description": "The sequence at which this location sits in the schedule"
},
"act": {
"title": "activities",
"description": "Activities carried out at this location",
"type": "string"
},
"p": {
"title": "Platform",
"type": "string",
"description": "The platform that this event takes place"
},
"pc": {
"title": "Platform Changed",
"type": "boolean"
},
"pcn": {
"title": "Platform Confirmed",
"type": "boolean"
},
"ps": {
"title": "Platform Surpressed",
"description": "Whether platform data is surpressed",
"type": "boolean"
},
"can": {
"title": "Cancelled",
"description": "Whether this location is cancelled in the journey",
"type": "boolean"
},
"al": {
"type": "integer",
"title": "Average Loading",
"description": "The average loading at this location"
},
"fid": {
"type": "string",
"title": "Formation ID",
"description": "The formation ID at this location"
},
"pta": {
"type": "string",
"format": "date-time",
"title": "Public time of arrival"
},
"wta": {
"type": "string",
"format": "date-time",
"title": "Working time of arrival"
},
"wtp": {
"type": "string",
"format": "date-time",
"title": "Working time of pass"
},
"ptd": {
"type": "string",
"format": "date-time",
"title": "Public time of departure"
},
"wtd": {
"type": "string",
"format": "date-time",
"title": "Working time of departure"
},
"eta": {
"type": "string",
"format": "date-time",
"title": "Estimated time of arrival"
},
"etd": {
"type": "string",
"format": "date-time",
"title": "Estimated time of departure"
},
"etp": {
"type": "string",
"format": "date-time",
"title": "Estimated time of pass"
},
"ata": {
"type": "string",
"format": "date-time",
"title": "Actual time of arrival"
},
"atd": {
"type": "string",
"format": "date-time",
"title": "Actual time of departure"
},
"atp": {
"type": "string",
"format": "date-time",
"title": "Actual time of pass"
}
},
"required": ["t", "r", "s", "act"]
}
},
"type": "object",
"required": ["header", "locations"],
"additionalProperties": false,
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"properties": {
"r": {
"type": "string",
"title": "RID",
"description": "The RID of the service",
"maxLength": 16
},
"u": {
"title": "UID",
"description": "The UID of the service",
"type": "string"
},
"s": {
"title": "SSD",
"description": "The SSD of the service",
"type": "string",
"format": "date"
},
"h": {
"title": "train_id",
"description": "Headcode",
"maxLength": 4,
"minLength": 4,
"type": "string"
},
"t": {
"title": "TOC",
"description": "The TOC operating the service",
"type": "string",
"maxLength": 3,
"minLength": 2
},
"st": {
"title": "Status",
"description": "Train status",
"type": "string"
},
"cr": {
"title": "Cancel Reason",
"type": "integer"
},
"cl": {
"title": "Cancel Location",
"type": "string",
"maxLength": 7
},
"cn": {
"title": "Cancel Near",
"description": "Whether the train was cancelled NEAR the 'cancel_loation', else at the 'cancel_location'",
"type": "boolean"
},
"dr": {
"title": "Delay Reason",
"type": "integer"
},
"dl": {
"title": "Delay Location",
"type": "string",
"maxLength": 7
},
"dn": {
"title": "Delay Near",
"description": "Whether the train was delayed NEAR the 'delay_loation', else at the 'delay_location'",
"type": "boolean"
},
"ip": {
"title": "is_passenger",
"description": "Whether this is a passenger service",
"type": "boolean"
},
"ic": {
"title": "is_charter",
"description": "Whether this is a charter service",
"type": "boolean"
},
"rs": {
"title": "RSID",
"description": "Retail Service ID",
"type": "string"
}
},
"required": ["r", "s", "h", "t", "ip", "ic"]
},
"locations": {
"type": "array",
"additionalItems": false,
"items": {
"$ref": "#/$defs/ServiceLocation"
}
},
"pis": {
"description": "PIS data for the service (if available)"
}
}
}