Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b55d9f32ec | |||
| 79c900e320 | |||
| 0e87c510b3 | |||
| 2552204da2 | |||
| 5eb6f623be | |||
| d8acf84b44 | |||
| e574358ea9 | |||
| 698248487a | |||
| b8eaad4bbd | |||
| a1aeb7e79f | |||
| a734dea17a | |||
| e7f307f243 | |||
| 727641f49f | |||
| b17efa3e5d |
@@ -1,6 +1,6 @@
|
|||||||
# backend-data-contracts
|
# backend-data-contracts
|
||||||
|
|
||||||
This repository is the single source of truth for all schema definitions used across the Owlboard backend communication and storage services. Language specific types are generated here and published to the Gitea package repository linked to the repo.
|
This repository is the single source of truth for all schemata definitions used across the Owlboard backend communication and storage services. Language specific types are generated here and published to the Gitea package repository linked to the repo.
|
||||||
|
|
||||||
## Directory Structure
|
## Directory Structure
|
||||||
|
|
||||||
|
|||||||
190
schemas/data-ingress/darwin-data/darwin-TS.json
Normal file
190
schemas/data-ingress/darwin-data/darwin-TS.json
Normal file
@@ -0,0 +1,190 @@
|
|||||||
|
{
|
||||||
|
"$id": "https://schema.owlboard.info/data-ingress/darwin/TS.schema.json",
|
||||||
|
"$schema": "https://json-schema.org/draft-07/schema#",
|
||||||
|
"title": "DarwinTSData",
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"rid",
|
||||||
|
"ssd",
|
||||||
|
"locs",
|
||||||
|
"rf"
|
||||||
|
],
|
||||||
|
"additionalProperties": false,
|
||||||
|
"properties": {
|
||||||
|
"rid": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "RID",
|
||||||
|
"description": "The RID of the service that the data applies to"
|
||||||
|
},
|
||||||
|
"uid": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "UID",
|
||||||
|
"description": "The UID of the timetable entry for this service"
|
||||||
|
},
|
||||||
|
"ssd": {
|
||||||
|
"type": "string",
|
||||||
|
"format": "date",
|
||||||
|
"name": "Service Start Date",
|
||||||
|
"description": "The date on which the service commences"
|
||||||
|
},
|
||||||
|
"rf": {
|
||||||
|
"type": "boolean",
|
||||||
|
"name": "isReverseFormation",
|
||||||
|
"description": "Whether the service is running in reverse formation"
|
||||||
|
},
|
||||||
|
"lr": {
|
||||||
|
"type": "object",
|
||||||
|
"name": "Late Reason",
|
||||||
|
"description": "Late Reason Object",
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"c"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"c": {
|
||||||
|
"type": "integer",
|
||||||
|
"name": "Reason code",
|
||||||
|
"description": "The reason code for the delay"
|
||||||
|
},
|
||||||
|
"t": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "TIPLOC",
|
||||||
|
"description": "The TIPLOC where the delay occurred"
|
||||||
|
},
|
||||||
|
"n": {
|
||||||
|
"type": "boolean",
|
||||||
|
"name": "Near",
|
||||||
|
"description": "Whether the delay occurred NEAR the TIPLOC, otherwise at the TIPLOC"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"locs" : {
|
||||||
|
"type": "array",
|
||||||
|
"items": {"$ref": "#/definitions/location"}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"definitions": {
|
||||||
|
"location": {
|
||||||
|
"type": "object",
|
||||||
|
"required": ["t"],
|
||||||
|
"properties": {
|
||||||
|
"t": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "TIPLOC",
|
||||||
|
"description": "The TIPLOC of the location"
|
||||||
|
},
|
||||||
|
"wta": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Working Time of Arrival",
|
||||||
|
"description": "The scheduled arrival time from the working timetable"
|
||||||
|
},
|
||||||
|
"wtd": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Working Time of Departure",
|
||||||
|
"description": "The scheduled departure time from the working timetable"
|
||||||
|
},
|
||||||
|
"pta": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Public Time of Arrival",
|
||||||
|
"description": "The scheduled arrival time from the public timetable"
|
||||||
|
},
|
||||||
|
"ptd": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Public time of departure",
|
||||||
|
"description": "The scheduled departure time from the public timetable"
|
||||||
|
},
|
||||||
|
"wtp": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Working pass time",
|
||||||
|
"description": "The scheduled pass time from the working timetable"
|
||||||
|
},
|
||||||
|
"d": {
|
||||||
|
"name": "Departure data",
|
||||||
|
"$ref": "#/definitions/forecastTime"
|
||||||
|
},
|
||||||
|
"a": {
|
||||||
|
"name": "Arrival data",
|
||||||
|
"$ref": "#/definitions/forecastTime"
|
||||||
|
},
|
||||||
|
"p": {
|
||||||
|
"name": "Pass data",
|
||||||
|
"$ref": "#/definitions/forecastTime"
|
||||||
|
},
|
||||||
|
"plt": {
|
||||||
|
"name": "Platform data",
|
||||||
|
"$ref": "#/definitions/platformStatus"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"forecastTime": {
|
||||||
|
"type": "object",
|
||||||
|
"name": "Forecast/Actual Time",
|
||||||
|
"properties": {
|
||||||
|
"et": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Estimated Time",
|
||||||
|
"description": "The estimated time of this event"
|
||||||
|
},
|
||||||
|
"at": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Actual Time",
|
||||||
|
"description": "The actual time of this event"
|
||||||
|
},
|
||||||
|
"wet": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Working Estimated Time",
|
||||||
|
"description": "The estimated 'working' time"
|
||||||
|
},
|
||||||
|
"atRem": {
|
||||||
|
"type": "boolean",
|
||||||
|
"name": "AT Removal",
|
||||||
|
"description": "If true, previous AT given was not valid, delete it"
|
||||||
|
},
|
||||||
|
"del": {
|
||||||
|
"type": "boolean",
|
||||||
|
"name": "Delayed",
|
||||||
|
"description": "If this train is delayed (Display delayed if no ET/AT)"
|
||||||
|
},
|
||||||
|
"src": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Data source",
|
||||||
|
"description": "The source of this data (Darwin/Trust/CIS etc)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"platformStatus": {
|
||||||
|
"type": "object",
|
||||||
|
"name": "PlatformData",
|
||||||
|
"required": [
|
||||||
|
"sup"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"sup": {
|
||||||
|
"type": "boolean",
|
||||||
|
"name": "Suppressed",
|
||||||
|
"description": "Whether the platform is suppressed (hidden to public)"
|
||||||
|
},
|
||||||
|
"n": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Platform Number",
|
||||||
|
"description": "The platform at which this event will occur"
|
||||||
|
},
|
||||||
|
"src": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Data source",
|
||||||
|
"description": "The name of the source of the platform data"
|
||||||
|
},
|
||||||
|
"c": {
|
||||||
|
"type": "boolean",
|
||||||
|
"name": "Platform Confirmed",
|
||||||
|
"description": "Whether the platform has been confirmed by local CIS"
|
||||||
|
},
|
||||||
|
"cisSup": {
|
||||||
|
"type": "boolean",
|
||||||
|
"name": "CIS suppressed",
|
||||||
|
"description": "Whether the local CIS has suppressed the platform (not needed to determine whether to suppress or not)"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
118
schemas/data-ingress/darwin-data/darwin-association.json
Normal file
118
schemas/data-ingress/darwin-data/darwin-association.json
Normal file
@@ -0,0 +1,118 @@
|
|||||||
|
{
|
||||||
|
"$id": "https://schema.owlboard.info/data-ingress/darwin/association.schema.json",
|
||||||
|
"$schema": "https://json-schema.org/draft-07/schema#",
|
||||||
|
"title": "DarwinAssocData",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"service_name": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Name of the service submitting the update"
|
||||||
|
},
|
||||||
|
"service_id": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "ID of the service sending the message - usually a hostname"
|
||||||
|
},
|
||||||
|
"data_type": {
|
||||||
|
"type": "string",
|
||||||
|
"const": "raw",
|
||||||
|
"description": "The type of data contained in this message object"
|
||||||
|
},
|
||||||
|
"sent_timestamp": {
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Unix timestamp representing the time the message was sent"
|
||||||
|
},
|
||||||
|
"data_kind": {
|
||||||
|
"type": "string",
|
||||||
|
"const": "darwin-association",
|
||||||
|
"description": "The data type contained in the message. Currently supported PIS: PIS Data, Timetable: CIF or VSTP Data, Knowledgebase: Station Data"
|
||||||
|
},
|
||||||
|
"payload": {
|
||||||
|
"type": "array",
|
||||||
|
"additionalItems": false,
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"mr",
|
||||||
|
"ar",
|
||||||
|
"t",
|
||||||
|
"c",
|
||||||
|
"s",
|
||||||
|
"mt",
|
||||||
|
"at"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"mr": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Main RID",
|
||||||
|
"description": "The main RID of this association object"
|
||||||
|
},
|
||||||
|
"ar": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Associated RID",
|
||||||
|
"description": "The associated RID of this association object"
|
||||||
|
},
|
||||||
|
"t": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "TIPLOC",
|
||||||
|
"description": "The location at which this association applies"
|
||||||
|
},
|
||||||
|
"c": {
|
||||||
|
"enum": ["JJ", "VV", "LK", "NP"],
|
||||||
|
"name": "Category",
|
||||||
|
"description": "The type of association"
|
||||||
|
},
|
||||||
|
"s": {
|
||||||
|
"type": "string",
|
||||||
|
"format": "date",
|
||||||
|
"name": "SSD",
|
||||||
|
"description": "SSD Generated from the Main RID"
|
||||||
|
},
|
||||||
|
"mt": {
|
||||||
|
"name": "Main Times",
|
||||||
|
"description": "Timings that apply to the main RID",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"wta": { "type": "string" },
|
||||||
|
"wtd": { "type": "string" },
|
||||||
|
"wtp": { "type": "string" },
|
||||||
|
"pta": { "type": "string" },
|
||||||
|
"ptd": { "type": "string" }
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"at": {
|
||||||
|
"name": "Associated Times",
|
||||||
|
"description": "Timings that apply to the associated RID",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"wta": { "type": "string" },
|
||||||
|
"wtd": { "type": "string" },
|
||||||
|
"wtp": { "type": "string" },
|
||||||
|
"pta": { "type": "string" },
|
||||||
|
"ptd": { "type": "string" }
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"can": {
|
||||||
|
"name": "Cancelled",
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Whether this association is cancelled"
|
||||||
|
},
|
||||||
|
"del": {
|
||||||
|
"name": "Deleted",
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Whether this association is deleted"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"service_name",
|
||||||
|
"service_id",
|
||||||
|
"data_type",
|
||||||
|
"data_kind",
|
||||||
|
"sent_timestamp",
|
||||||
|
"payload"
|
||||||
|
],
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
66
schemas/data-ingress/darwin-data/darwin-ow.json
Normal file
66
schemas/data-ingress/darwin-data/darwin-ow.json
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
{
|
||||||
|
"$id": "https://schema.owlboard.info/data-ingress/darwin/OW.schema.json",
|
||||||
|
"$schema": "https://json-schema.org/draft-07/schema#",
|
||||||
|
"title": "DarwinOwData",
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"i",
|
||||||
|
"d"
|
||||||
|
],
|
||||||
|
"additionalProperties": false,
|
||||||
|
"properties": {
|
||||||
|
"i": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "ID",
|
||||||
|
"description": "Unique ID of the incident message"
|
||||||
|
},
|
||||||
|
"c": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Category",
|
||||||
|
"description": "Category of the incident message"
|
||||||
|
},
|
||||||
|
"s": {
|
||||||
|
"type": "integer",
|
||||||
|
"name": "Severity",
|
||||||
|
"description": "The severity of the incident"
|
||||||
|
},
|
||||||
|
"l": {
|
||||||
|
"type": "array",
|
||||||
|
"name": "locations",
|
||||||
|
"description": "CRS Locations at which the message applies",
|
||||||
|
"additionalItems": false,
|
||||||
|
"items": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "CRS",
|
||||||
|
"description": "CRS Location where this message applies"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"d": {
|
||||||
|
"type": "boolean",
|
||||||
|
"name": "Delete",
|
||||||
|
"description": "If true, the message is to be deleted"
|
||||||
|
},
|
||||||
|
"m": {
|
||||||
|
"type": "object",
|
||||||
|
"name": "Message",
|
||||||
|
"description": "The message properties",
|
||||||
|
"properties": {
|
||||||
|
"l": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "href",
|
||||||
|
"description": "URL where further information can be found"
|
||||||
|
},
|
||||||
|
"lt": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "href-text",
|
||||||
|
"description": "Text that should be displayed as part of the href"
|
||||||
|
},
|
||||||
|
"m": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Message text",
|
||||||
|
"description": "The text to be displayed"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
229
schemas/data-ingress/darwin-data/darwin-schedule.json
Normal file
229
schemas/data-ingress/darwin-data/darwin-schedule.json
Normal file
@@ -0,0 +1,229 @@
|
|||||||
|
{
|
||||||
|
"$id": "https://schema.owlboard.info/data-ingress/darwin/schedule.schema.json",
|
||||||
|
"$schema": "https://json-schema.org/draft-07/schema#",
|
||||||
|
"title": "DarwinScheduleData",
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"service_name": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Name of the service submitting the update"
|
||||||
|
},
|
||||||
|
"service_id": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "ID of the service sending the message - usually a hostname"
|
||||||
|
},
|
||||||
|
"data_type": {
|
||||||
|
"type": "string",
|
||||||
|
"const": "raw",
|
||||||
|
"description": "The type of data contained in this message object"
|
||||||
|
},
|
||||||
|
"sent_timestamp": {
|
||||||
|
"type": "integer",
|
||||||
|
"description": "Unix timestamp representing the time the message was sent"
|
||||||
|
},
|
||||||
|
"data_kind": {
|
||||||
|
"type": "string",
|
||||||
|
"const": "darwin-schedule",
|
||||||
|
"description": "The data type contained in the message. Currently supported PIS: PIS Data, Timetable: CIF or VSTP Data, Knowledgebase: Station Data"
|
||||||
|
},
|
||||||
|
"payload": {
|
||||||
|
"type": "array",
|
||||||
|
"additionalItems": false,
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"additionalProperties": false,
|
||||||
|
"required": [
|
||||||
|
"rid",
|
||||||
|
"uid",
|
||||||
|
"ssd",
|
||||||
|
"tid",
|
||||||
|
"toc",
|
||||||
|
"isp",
|
||||||
|
"isc",
|
||||||
|
"l"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"rid": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Service RID",
|
||||||
|
"maxLength": 16
|
||||||
|
},
|
||||||
|
"uid": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "Service UID",
|
||||||
|
"maxLength": 10
|
||||||
|
},
|
||||||
|
"ssd": {
|
||||||
|
"type": "string",
|
||||||
|
"format": "date",
|
||||||
|
"description": "Date on which the service commences"
|
||||||
|
},
|
||||||
|
"tid": {
|
||||||
|
"name": "train_id",
|
||||||
|
"type": "string",
|
||||||
|
"minLength": 4,
|
||||||
|
"maxLength": 4,
|
||||||
|
"description": "The signalling headcode of the service"
|
||||||
|
},
|
||||||
|
"toc": {
|
||||||
|
"type": "string",
|
||||||
|
"minLength": 2,
|
||||||
|
"maxLength": 2,
|
||||||
|
"description": "The two character code for the operating TOC"
|
||||||
|
},
|
||||||
|
"sts": {
|
||||||
|
"type": "string",
|
||||||
|
"maxLength": 1,
|
||||||
|
"name": "status",
|
||||||
|
"description": "The 'status' of the service"
|
||||||
|
},
|
||||||
|
"qt": {
|
||||||
|
"name": "qtrain",
|
||||||
|
"description": "qtrain?",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": false
|
||||||
|
},
|
||||||
|
"d": {
|
||||||
|
"name": "deleted",
|
||||||
|
"description": "Whether the schedule is deleted",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": false
|
||||||
|
},
|
||||||
|
"isp": {
|
||||||
|
"name": "is_passenger",
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Whether the service is a passenger service"
|
||||||
|
},
|
||||||
|
"isc": {
|
||||||
|
"name": "is_charter",
|
||||||
|
"type": "boolean",
|
||||||
|
"description": "Whether the service is a charter service"
|
||||||
|
},
|
||||||
|
"sid": {
|
||||||
|
"name": "rsid",
|
||||||
|
"type": ["string", "null"],
|
||||||
|
"maxLength": 10
|
||||||
|
},
|
||||||
|
"q": {
|
||||||
|
"name": "qtrain",
|
||||||
|
"description": "True if the service is scheduled but not activated (if not activated, presumed not running)",
|
||||||
|
"type": "boolean",
|
||||||
|
"default": false
|
||||||
|
},
|
||||||
|
"tc": {
|
||||||
|
"name": "trainCat",
|
||||||
|
"description": "Train Category",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"cr": {
|
||||||
|
"name": "cancel_reason",
|
||||||
|
"type": ["integer", "null"],
|
||||||
|
"description": "The reason code for the services cancellation"
|
||||||
|
},
|
||||||
|
"cl": {
|
||||||
|
"name": "cancel_location",
|
||||||
|
"type": "string",
|
||||||
|
"description": "The location at which the service was cancelled"
|
||||||
|
},
|
||||||
|
"cn": {
|
||||||
|
"name": "cancel_near",
|
||||||
|
"description": "Whether the incident happened 'near' cancel_location, or AT cancel_location (default, false, at location)"
|
||||||
|
},
|
||||||
|
"l": {
|
||||||
|
"type": "array",
|
||||||
|
"minItems": 2,
|
||||||
|
"items": {
|
||||||
|
"type": "object",
|
||||||
|
"required": ["tpl", "lr", "s"],
|
||||||
|
"properties": {
|
||||||
|
"tpl": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The locations TIPLOC",
|
||||||
|
"maxLength": 7,
|
||||||
|
"minLength": 4
|
||||||
|
},
|
||||||
|
"rd": {
|
||||||
|
"name": "rdelay",
|
||||||
|
"description": "Route Delay",
|
||||||
|
"type": "integer"
|
||||||
|
},
|
||||||
|
"p": {
|
||||||
|
"name": "platform",
|
||||||
|
"description": "Scheduled platform",
|
||||||
|
"type": "string",
|
||||||
|
"maxLength": 4
|
||||||
|
},
|
||||||
|
"lr": {
|
||||||
|
"name": "loc_role",
|
||||||
|
"description": "The role of the location (Orig, Call, Pass, Dest)",
|
||||||
|
"enum": ["ORIG", "CALL", "PASS", "DEST"]
|
||||||
|
},
|
||||||
|
"s": {
|
||||||
|
"name": "seq",
|
||||||
|
"description": "The sequence in the service at which this location occours",
|
||||||
|
"type": "integer",
|
||||||
|
"minimum": 1,
|
||||||
|
"maximum": 2147483647
|
||||||
|
},
|
||||||
|
"pta": {
|
||||||
|
"description": "Public timetable arrival",
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"ptd": {
|
||||||
|
"description": "Public timetable departure",
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"wta": {
|
||||||
|
"description": "Working timetable arrival",
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"wtd": {
|
||||||
|
"description": "Working timetable arrival",
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"wtp": {
|
||||||
|
"description": "Working timetable pass",
|
||||||
|
"type": "string",
|
||||||
|
"format": "date-time"
|
||||||
|
},
|
||||||
|
"c": {
|
||||||
|
"name": "can",
|
||||||
|
"description": "Whether the service is cancelled at this location",
|
||||||
|
"default": false,
|
||||||
|
"type": "boolean"
|
||||||
|
},
|
||||||
|
"a": {
|
||||||
|
"name": "activities",
|
||||||
|
"type": "string",
|
||||||
|
"maxLength": 12
|
||||||
|
},
|
||||||
|
"fid": {
|
||||||
|
"description": "Unique formation indentifier (Maps to formation feed)",
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"al": {
|
||||||
|
"name": "avg_loading",
|
||||||
|
"description": "Average loading at this location",
|
||||||
|
"type": "integer"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"required": [
|
||||||
|
"service_name",
|
||||||
|
"service_id",
|
||||||
|
"data_type",
|
||||||
|
"data_kind",
|
||||||
|
"sent_timestamp",
|
||||||
|
"payload"
|
||||||
|
],
|
||||||
|
"additionalProperties": false
|
||||||
|
}
|
||||||
@@ -31,18 +31,21 @@
|
|||||||
"additionalItems": false,
|
"additionalItems": false,
|
||||||
"items": {
|
"items": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"required": ["c", "lR", "cR"],
|
"required": ["c"],
|
||||||
"properties": {
|
"properties": {
|
||||||
"c": {
|
"c": {
|
||||||
"type": "integer",
|
"type": "integer",
|
||||||
|
"name": "code",
|
||||||
"description": "The 'code' that the late/cancel reason maps to"
|
"description": "The 'code' that the late/cancel reason maps to"
|
||||||
},
|
},
|
||||||
"lR": {
|
"lr": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
"name": "Late Reason",
|
||||||
"description": "The lateReason string for the item"
|
"description": "The lateReason string for the item"
|
||||||
},
|
},
|
||||||
"cR": {
|
"cr": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
"name": "Cancellation Reason",
|
||||||
"description": "The cancelReason string for the item"
|
"description": "The cancelReason string for the item"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
30
schemas/data-ingress/network-rail/networkRailCorpus.json
Normal file
30
schemas/data-ingress/network-rail/networkRailCorpus.json
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
{
|
||||||
|
"$id": "https://schema.owlboard.info/data-ingress/network-rail/networkRailCorpus.schema.json",
|
||||||
|
"$schema": "https://json-schema.org/draft-07/schema#",
|
||||||
|
"title": "networkRailCorpus",
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"t",
|
||||||
|
"n"
|
||||||
|
],
|
||||||
|
"additionalProperties": false,
|
||||||
|
"properties": {
|
||||||
|
"t": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "TIPLOC",
|
||||||
|
"description": "The TIPLOC Code of the location"
|
||||||
|
},
|
||||||
|
"n": {
|
||||||
|
"type": "string",
|
||||||
|
"name": "Name",
|
||||||
|
"description": "The human readable name of the location"
|
||||||
|
},
|
||||||
|
"nc": {
|
||||||
|
"type": "integer",
|
||||||
|
"name": "NLC",
|
||||||
|
"description": "The national location code of the location",
|
||||||
|
"minimum": 0,
|
||||||
|
"maximum": 999999
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,365 +0,0 @@
|
|||||||
{
|
|
||||||
"$id": "https://schema.owlboard.info/data-ingress/pushport16-schedule.schema.json",
|
|
||||||
"$schema": "https://json-schema.org/draft-07/schema#",
|
|
||||||
"title": "PushPortSchedule",
|
|
||||||
"description": "Consolidated object definition for Darwin Schedule messages",
|
|
||||||
"definitions": {
|
|
||||||
"originPoint": {
|
|
||||||
"description": "Merged Origin (OR / OPOR). The starting point of the journey.",
|
|
||||||
"required": [
|
|
||||||
"wtd",
|
|
||||||
"tpl"
|
|
||||||
],
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"tpl": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "TIPLOC"
|
|
||||||
},
|
|
||||||
"act": {
|
|
||||||
"type": "string",
|
|
||||||
"default": " ",
|
|
||||||
"description": "Current Activity Codes"
|
|
||||||
},
|
|
||||||
"planAct": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Planned Activity Codes"
|
|
||||||
},
|
|
||||||
"can": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false,
|
|
||||||
"description": "Cancelled flag"
|
|
||||||
},
|
|
||||||
"fid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique identifier of the formation data (v3) "
|
|
||||||
},
|
|
||||||
"pta": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Public Scheduled Time of Arrival"
|
|
||||||
},
|
|
||||||
"ptd": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Public Scheduled Time of Departure"
|
|
||||||
},
|
|
||||||
"avgLoading": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Average Loading value based on long-term averages (v3) "
|
|
||||||
},
|
|
||||||
"wta": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Working Scheduled Time of Arrival (Optional)"
|
|
||||||
},
|
|
||||||
"wtd": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Working Scheduled Time of Departure (Required)"
|
|
||||||
},
|
|
||||||
"fd": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "False Destination TIPLOC (Passenger only)"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"callingPoint": {
|
|
||||||
"description": "Merged Intermediate Point (IP / OPIP). An intermediate stop requiring dwell time.",
|
|
||||||
"required": [
|
|
||||||
"wta",
|
|
||||||
"wtd",
|
|
||||||
"tpl"
|
|
||||||
],
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"tpl": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "TIPLOC"
|
|
||||||
},
|
|
||||||
"act": {
|
|
||||||
"type": "string",
|
|
||||||
"default": " ",
|
|
||||||
"description": "Current Activity Codes"
|
|
||||||
},
|
|
||||||
"planAct": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Planned Activity Codes"
|
|
||||||
},
|
|
||||||
"can": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false,
|
|
||||||
"description": "Cancelled flag"
|
|
||||||
},
|
|
||||||
"fid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique identifier of the formation data (v3) "
|
|
||||||
},
|
|
||||||
"pta": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Public Scheduled Time of Arrival"
|
|
||||||
},
|
|
||||||
"ptd": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Public Scheduled Time of Departure"
|
|
||||||
},
|
|
||||||
"avgLoading": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Average Loading value based on long-term averages (v3) "
|
|
||||||
},
|
|
||||||
"wta": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Working Scheduled Time of Arrival (Required)"
|
|
||||||
},
|
|
||||||
"wtd": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Working Scheduled Time of Departure (Required)"
|
|
||||||
},
|
|
||||||
"rdelay": {
|
|
||||||
"type": "integer",
|
|
||||||
"default": 0,
|
|
||||||
"description": "Route delay value"
|
|
||||||
},
|
|
||||||
"fd": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "False Destination (Passenger only)"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"passPoint": {
|
|
||||||
"description": "Intermediate Passing Point (PP). Purely operational.",
|
|
||||||
"required": [
|
|
||||||
"wtp",
|
|
||||||
"tpl"
|
|
||||||
],
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"tpl": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "TIPLOC"
|
|
||||||
},
|
|
||||||
"act": {
|
|
||||||
"type": "string",
|
|
||||||
"default": " ",
|
|
||||||
"description": "Current Activity Codes"
|
|
||||||
},
|
|
||||||
"planAct": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Planned Activity Codes"
|
|
||||||
},
|
|
||||||
"can": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false,
|
|
||||||
"description": "Cancelled flag"
|
|
||||||
},
|
|
||||||
"fid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique identifier of the formation data (v3) "
|
|
||||||
},
|
|
||||||
"wtp": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Working Scheduled Time of Passing (Required)"
|
|
||||||
},
|
|
||||||
"rdelay": {
|
|
||||||
"type": "integer",
|
|
||||||
"default": 0,
|
|
||||||
"description": "Route delay value"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false
|
|
||||||
},
|
|
||||||
"destinationPoint": {
|
|
||||||
"description": "Merged Destination (DT / OPDT). The termination point of the journey.",
|
|
||||||
"required": [
|
|
||||||
"wta",
|
|
||||||
"tpl"
|
|
||||||
],
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"tpl": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "TIPLOC"
|
|
||||||
},
|
|
||||||
"act": {
|
|
||||||
"type": "string",
|
|
||||||
"default": " ",
|
|
||||||
"description": "Current Activity Codes"
|
|
||||||
},
|
|
||||||
"planAct": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Planned Activity Codes"
|
|
||||||
},
|
|
||||||
"can": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false,
|
|
||||||
"description": "Cancelled flag"
|
|
||||||
},
|
|
||||||
"fid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique identifier of the formation data (v3) "
|
|
||||||
},
|
|
||||||
"pta": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Public Scheduled Time of Arrival"
|
|
||||||
},
|
|
||||||
"ptd": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Public Scheduled Time of Departure"
|
|
||||||
},
|
|
||||||
"avgLoading": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Average Loading value based on long-term averages (v3) "
|
|
||||||
},
|
|
||||||
"wta": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Working Scheduled Time of Arrival (Required)"
|
|
||||||
},
|
|
||||||
"wtd": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Working Scheduled Time of Departure (Optional)"
|
|
||||||
},
|
|
||||||
"rdelay": {
|
|
||||||
"type": "integer",
|
|
||||||
"default": 0,
|
|
||||||
"description": "Route delay value"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"service_name": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Name of the service submitting the update"
|
|
||||||
},
|
|
||||||
"service_id": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "ID of the service sending the message - usually a hostname"
|
|
||||||
},
|
|
||||||
"data_type": {
|
|
||||||
"type": "string",
|
|
||||||
"const": "raw",
|
|
||||||
"description": "The type of data contained in this message object"
|
|
||||||
},
|
|
||||||
"sent_timestamp": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "Unix timestamp representing the time the message was sent"
|
|
||||||
},
|
|
||||||
"data_kind": {
|
|
||||||
"type": "string",
|
|
||||||
"const": "PushPort16Schedule",
|
|
||||||
"description": "The data type contained in the message. Currently supported PIS: PIS Data, Timetable: CIF or VSTP Data, Knowledgebase: Station Data"
|
|
||||||
},
|
|
||||||
"payload": {
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"rid",
|
|
||||||
"uid",
|
|
||||||
"trainId",
|
|
||||||
"ssd",
|
|
||||||
"toc",
|
|
||||||
"locations"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"rid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Rail Identifier - Unique value for the service"
|
|
||||||
},
|
|
||||||
"uid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique ID - Unique value for the timetable entry - maps to Network Rail CIF schedules"
|
|
||||||
},
|
|
||||||
"ssd": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "date",
|
|
||||||
"description": "Service Start Date - The date the service commences"
|
|
||||||
},
|
|
||||||
"trainId": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Headcode"
|
|
||||||
},
|
|
||||||
"toc": {
|
|
||||||
"type": "string",
|
|
||||||
"minLength": 2,
|
|
||||||
"maxLength": 2,
|
|
||||||
"description": "Train Operator (ATOC Code)"
|
|
||||||
},
|
|
||||||
"rsid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Retail Service ID"
|
|
||||||
},
|
|
||||||
"status": {
|
|
||||||
"type": "string",
|
|
||||||
"default": "P",
|
|
||||||
"description": "P = Permanent, L = Long Term, S = Short Term"
|
|
||||||
},
|
|
||||||
"trainCat": {
|
|
||||||
"type": "string",
|
|
||||||
"default": "OO",
|
|
||||||
"description": "Train Category"
|
|
||||||
},
|
|
||||||
"isPassenger": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": true,
|
|
||||||
"description": "Declares the service as a passenger service"
|
|
||||||
},
|
|
||||||
"isActive": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false,
|
|
||||||
"description": "UNKNOWN"
|
|
||||||
},
|
|
||||||
"isCharter": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false,
|
|
||||||
"description": "Declares the service as a charter service"
|
|
||||||
},
|
|
||||||
"cancelReason": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "Cancellation Reason code"
|
|
||||||
},
|
|
||||||
"cancelLocation": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Location at which the train was cancelled - Only valid when 'cancelReason' is defined, and even then optional"
|
|
||||||
},
|
|
||||||
"locations": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": false,
|
|
||||||
"description": "Merged and flattened location objects",
|
|
||||||
"properties": {
|
|
||||||
"OR": {
|
|
||||||
"type": "array",
|
|
||||||
"description": "OR/OPOR Values - Trains Origin",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/definitions/originPoint"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"IP": {
|
|
||||||
"type": "array",
|
|
||||||
"description": "IP/OPIP Values - Intermediate Points",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/definitions/callingPoint"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"PP": {
|
|
||||||
"type": "array",
|
|
||||||
"description": "Passing Points (Non-stop)",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/definitions/passPoint"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"DT": {
|
|
||||||
"type": "array",
|
|
||||||
"description": "DT/OPDT Values - Trains Destination",
|
|
||||||
"items": {
|
|
||||||
"$ref": "#/definitions/destinationPoint"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"service_name",
|
|
||||||
"service_id",
|
|
||||||
"data_type",
|
|
||||||
"sent_timestamp"
|
|
||||||
],
|
|
||||||
"additionalProperties": false
|
|
||||||
}
|
|
||||||
@@ -1,241 +0,0 @@
|
|||||||
{
|
|
||||||
"$id": "https://schema.owlboard.info/data-ingress/pushport-schedule.schema.json",
|
|
||||||
"$schema": "https://json-schema.org/draft-07/schema#",
|
|
||||||
"title": "PushPortSchedule",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"service_name": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Name of the service submitting the update"
|
|
||||||
},
|
|
||||||
"service_id": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "ID of the service sending the message - usually a hostname"
|
|
||||||
},
|
|
||||||
"data_type": {
|
|
||||||
"type": "string",
|
|
||||||
"const": "PushPortSchedule",
|
|
||||||
"description": "The type of data contained in this message object"
|
|
||||||
},
|
|
||||||
"sent_timestamp": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "Unix timestamp representing the time the message was sent"
|
|
||||||
},
|
|
||||||
"data_kind": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"pis",
|
|
||||||
"timetable",
|
|
||||||
"knowledgebase",
|
|
||||||
"darwin_schedule",
|
|
||||||
"darwin_ts",
|
|
||||||
"darwin_ref"
|
|
||||||
],
|
|
||||||
"description": "The data type contained in the message. Currently supported PIS: PIS Data, Timetable: CIF or VSTP Data, Knowledgebase: Station Data"
|
|
||||||
},
|
|
||||||
"payload": {
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"rid",
|
|
||||||
"uid",
|
|
||||||
"trainId",
|
|
||||||
"ssd",
|
|
||||||
"toc",
|
|
||||||
"locations"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"rid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique service ID"
|
|
||||||
},
|
|
||||||
"uid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique schedule ID - maps to NR CIF"
|
|
||||||
},
|
|
||||||
"trainId": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Train Headcode"
|
|
||||||
},
|
|
||||||
"ssd": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "date",
|
|
||||||
"description": "Schedule Start Date (When the service commences)"
|
|
||||||
},
|
|
||||||
"toc": {
|
|
||||||
"type": "string",
|
|
||||||
"minLength": 2,
|
|
||||||
"maxLength": 2,
|
|
||||||
"description": "TOC Code"
|
|
||||||
},
|
|
||||||
"isPassenger": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "If service is for passengers",
|
|
||||||
"default": true
|
|
||||||
},
|
|
||||||
"isCharter": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "If train is charter service",
|
|
||||||
"default": false
|
|
||||||
},
|
|
||||||
"status": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"train",
|
|
||||||
"bus",
|
|
||||||
"ship"
|
|
||||||
],
|
|
||||||
"default": "train"
|
|
||||||
},
|
|
||||||
"isDelayedDelivery": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "If message is sent as part of Darwin service recovery"
|
|
||||||
},
|
|
||||||
"cancelReason": {
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
],
|
|
||||||
"description": "Reason code for cancellation"
|
|
||||||
},
|
|
||||||
"isDeleted": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Whether schedule should be deleted",
|
|
||||||
"default": false
|
|
||||||
},
|
|
||||||
"locations": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "object",
|
|
||||||
"required": [
|
|
||||||
"tpl",
|
|
||||||
"seq"
|
|
||||||
],
|
|
||||||
"properties": {
|
|
||||||
"tpl": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "TIPLOC of location"
|
|
||||||
},
|
|
||||||
"seq": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "The order of the stop for sorting and handling repeated TIPLOCs"
|
|
||||||
},
|
|
||||||
"wta": {
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"wtd": {
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"wtp": {
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"pta": {
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"ptd": {
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"plat": {
|
|
||||||
"type": [
|
|
||||||
"string",
|
|
||||||
"null"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"isCancelled": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false
|
|
||||||
},
|
|
||||||
"isSupressed": {
|
|
||||||
"type": "boolean",
|
|
||||||
"default": false,
|
|
||||||
"description": "Defines whether the service should be hidden to the public"
|
|
||||||
},
|
|
||||||
"activities": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"pass": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates that the train does not stop, it only passes this location"
|
|
||||||
},
|
|
||||||
"pickUpDropOff": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates the train stops for passengers to board and alight"
|
|
||||||
},
|
|
||||||
"requestStop": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates if the train stops only when required"
|
|
||||||
},
|
|
||||||
"pickUpOnly": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicated the service picks up passengers only"
|
|
||||||
},
|
|
||||||
"dropOffOnly": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates the service drops off passengers only"
|
|
||||||
},
|
|
||||||
"tokenExchange": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates if the train stops for exhanging a token/staff or similar"
|
|
||||||
},
|
|
||||||
"vehiclesAttached": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates if vehicles are attached at this location"
|
|
||||||
},
|
|
||||||
"vehiclesDetached": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates if vehicles are detached at this location"
|
|
||||||
},
|
|
||||||
"trainCrewChange": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates if train stops to exchange crew at this location"
|
|
||||||
},
|
|
||||||
"changeLocomotive": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates if train stops to exchange locomotive at this location"
|
|
||||||
},
|
|
||||||
"changeEnds": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates if the train reverses or driver changes ends at this location"
|
|
||||||
},
|
|
||||||
"staffStop": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates that the train stops for staff use only"
|
|
||||||
},
|
|
||||||
"unadvertised": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates that the stop is not advertised to the public"
|
|
||||||
},
|
|
||||||
"passesAnotherTrain": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicates if the train stops to pass another train on a single line crossing point"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"service_name",
|
|
||||||
"service_id",
|
|
||||||
"data_type",
|
|
||||||
"sent_timestamp"
|
|
||||||
],
|
|
||||||
"additionalProperties": true
|
|
||||||
}
|
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
{
|
|
||||||
"$id": "https://schema.owlboard.info/data-ingress/pushport-ts.schema.json",
|
|
||||||
"$schema": "https://json-schema.org/draft-07/schema#",
|
|
||||||
"title": "PushPortTS",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"rid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Unique ID for the train service (eg. 2026022217610103)",
|
|
||||||
"pattern": "^[0-9]{15}$"
|
|
||||||
},
|
|
||||||
"uid": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Schedule ID - The permanent ID for the schedule in the static timetable"
|
|
||||||
},
|
|
||||||
"ssd": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "date",
|
|
||||||
"description": "Scheduled Start Data, the date the train service started its journey"
|
|
||||||
},
|
|
||||||
"isDelayed": {
|
|
||||||
"type": "boolean",
|
|
||||||
"description": "Indicated if the message is delayed due to PushPort service disruption"
|
|
||||||
},
|
|
||||||
"lateReason": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "Reason the train is late (Maps to textual reason)"
|
|
||||||
},
|
|
||||||
"cancelReason": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "Reason the train is cancelled (Maps to textual reason)"
|
|
||||||
},
|
|
||||||
"locations": {
|
|
||||||
"type": "array",
|
|
||||||
"description": "A list of one or more locations where the train has recorded a movement or forecast",
|
|
||||||
"items": { "$ref": "https://schema.owlboard.info/data-ingress/pushport-ts-location.schema.json" }
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
{
|
|
||||||
"$id": "https://schema.owlboard.info/data-ingress/pushport-ts-location.schema.json",
|
|
||||||
"$schema": "https://json-schema.org/draft-07/schema#",
|
|
||||||
"title": "PushPortTSLocation",
|
|
||||||
"type": "object",
|
|
||||||
"required": ["tpl"],
|
|
||||||
"definitions": {
|
|
||||||
"TSTime": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"at": {"type": "string", "description": "Actual time"},
|
|
||||||
"et": {"type": "string", "description": "Estimated time"},
|
|
||||||
"wet": {"type": "string", "description": "Working estimated time"},
|
|
||||||
"src": {"type": "string", "description": "Data source (TD/Darwin/etc)"},
|
|
||||||
"atClass": {"type": "string", "description": "Time source Automatic/Manual"},
|
|
||||||
"delayed": {"type": "boolean", "description": "is train delayed with no estimated time"},
|
|
||||||
"srcInst": {"type": "string", "description": "Source instance (what caused the update)"},
|
|
||||||
"atRemoved": {"type": "boolean", "description": "Whether a previous 'at' was reported in error and should be removed"}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"properties": {
|
|
||||||
"tpl": {"type": "string", "description": "TIPLOC for the location"},
|
|
||||||
"wta": {"type": "string", "description": "Scheduled working time arrival"},
|
|
||||||
"wtd": {"type": "string", "description": "Scheduled working time departure"},
|
|
||||||
"wtp": {"type": "string", "description": "Scheduled working time pass"},
|
|
||||||
"pta": {"type": "string", "description": "Scheduled public arrival time"},
|
|
||||||
"ptd": {"type": "string", "description": "Scheduled public departure time"},
|
|
||||||
"arr": {"$ref": "#/definitions/TSTime"},
|
|
||||||
"dep": {"$ref": "#/definitions/TSTime"},
|
|
||||||
"pass": {"$ref": "#/definitions/TSTime"},
|
|
||||||
"plat": {
|
|
||||||
"type": "object",
|
|
||||||
"description": "Platform data",
|
|
||||||
"properties": {
|
|
||||||
"value": {"type": "string", "description": "Platform number/letter"},
|
|
||||||
"platsrc": {"type": "string", "enum": ["A", "M", "P"], "description": "Source of data Automatic/Manual/Planned"},
|
|
||||||
"platsup": {"type": "boolean", "description": "Is platform suppressed from public display"},
|
|
||||||
"cisPlatsup": {"type": "boolean", "description": "Whether CIS or Darwin Workstation has supressed the platform"},
|
|
||||||
"conf": {"type": "boolean", "description": "Whether platform has been confirmed by the local CIS"}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"suppr": {"type": "boolean", "description": "Whether location is supressed"},
|
|
||||||
"length": {"type": "integer", "description": "Train length (no. of coaches)"},
|
|
||||||
"detachFront": {"type": "boolean","description": "Indicated if coaches will detatch from front"},
|
|
||||||
"detachRead": {"type": "boolean", "description": "Indicates if coaches will detatch from rear"},
|
|
||||||
"attachFront": {"type": "boolean", "description": "Indicates if coaches will attach to front"},
|
|
||||||
"attachRear": {"type": "boolean", "description": "Indicates if coaches will be attached to rear"},
|
|
||||||
"adhoc": {"type": "boolean", "description": "Whether this is an ad-hoc stop"}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user