From 38ca94ca4babdf237ff1c8c9fcc554ca37f328e3 Mon Sep 17 00:00:00 2001 From: Tu-Tho Thai Date: Tue, 24 Mar 2026 15:09:27 +0100 Subject: [PATCH 1/3] Improve documentation of the repository (#204) General improvement of the documentation for this SIRI repository: - Moving the file readme.md to the root - Editing the file readme.md to add information on branches, versions, how to use the XSD and contribute - Addition of changelog.md --- CHANGELOG.md | 480 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 131 ++++++++++++++ docs/README.md | 37 ---- 3 files changed, 611 insertions(+), 37 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 README.md delete mode 100644 docs/README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..a75c6ce0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,480 @@ +# Changelog + +## v2.2 + +This is a minor release. + +Changes to v2.2 include: +* Addition of SIRI-CA via siri_controlAction_service.xsd +* Changes to SIRI-SX + * change of cardinality of ScopeType, + * addition of FacilityLocation in AffectedFacilityStructure +* Addition of restrictions for PositiveDurationType + +In the repository, there were also non-functional changes such as: +* Addition of readme.md +* Corrections of some typos +* General improvement of the XSD documentation + +--- +## v2.1 + +This is a minor release. + +Changes to v2.1 include: +* Removal of blank in FareClassEnumeration +* Change in OPERATING DAY +* Bug fixes + +In the repository, there were also non-functional changes such as: +* Addition of examples for DataSource in ET +* Addition of checks for Pull requests via the GitHub actions +* Corrections of some typos +* General improvement of the XSD documentation + +--- +## v2.0q + +Changes made against SIRI 2.0p for SIRI 2.0q by VDV-Ums +2018-11-13 - D. Rubli, K. Grimme + +ifopt\ifopt_stop-v0.3.xsd +- Enum "ferrytPort" in StopPlaceTypeEnumeration changed to "ferryPort" + +siri_model\siri_reference-v2.0.xsd +- "PublishedLineName" inside "PublishedLineGroup" changed to "unbounded" to allow multiple definitions for different languages due to the xml:lang-Attribute +- "DestinationName" inside "PublishedLineGroup" changed to "unbounded" to allow multiple definitions for different languages due to the xml:lang-Attribute + +siri_model\siri_situationActions-v2.0.xsd: +- ActionsStructure.ActionsGroup.PublishToTvAction changed to unbounded +- ActionsStructure.ActionsGroup.NotifyBySmsAction changed to unbounded +- PublishToDisplayAction added to ActionsGroup +- ActionsStructure.ActionsGroup.PublishToTvAction.Ceefax and Teletext: annotation switched + +siri_model\siri_situationAffects-v2.0.xsd +- Wrapped "AffectedInterchanges" node around AffectedInterchange in AffectedCallStructure +- "PublishedLineName" inside "LineGroup" and "AffectedVehicleJourneyStructure" changed to "unbounded" to allow multiple definitions for different languages due to the xml:lang-Attribute +- "Route" inside "AffectedVehicleJourneyStructure" is now optional since all of its content are optional + +siri_model\siri_situationReasons-v2.0.xsd: +- MiscellaneousReasonEnumeration TPEC-code of "altercation" changed from pti19_1_Alias_6 to pti19_1_Alias_7 because TPEC-code pti19_1_Alias_6 was wrongly doubled in use for "emergencyServicesCall" and "altercation" +- MiscellaneousReasonEnumeration TPEC-code of "illVehicleOccupants" changed from pti19_1_Alias_7 to pti19_1_Alias_8 +- MiscellaneousReasonEnumeration TPEC-code of "undefinedProblem" changed from pti19_27 to pti19_255 +- MiscellaneousSubReasonEnumeration TPEC-code value "assault" added according to recommendation document and Datex2 +- EquipmentReasonEnumeration TPEC-code pti21_6_Alias_2 "defectiveTrain" added according to recommendation document +- EquipmentReasonEnumeration TPEC-code pti21_8_Alias_10 "leveCrossingFailure" changed to "levelCrossingFailure" according to recommendation document +- EquipmentReasonEnumeration TPEC-code pti21_8_Alias_11 "trafficManagementSystemFailure" added according to recommendation document +- EquipmentReasonEnumeration TPEC-code pti21_12_Alias_1 value changed from "oveheadWireFailure" to "overheadWireFailure" according to recommendation document +- EquipmentSubReasonEnumeration TPEC-code value "defectiveTrain" added according to recommendation document +- EquipmentSubReasonEnumeration TPEC-code value "leveCrossingFailure" changed to "levelCrossingFailure" according to recommendation document +- EquipmentSubReasonEnumeration TPEC-code value "trafficManagementSystemFailure" added according to recommendation document +- EquipmentSubReasonEnumeration TPEC-code value "oveheadWireFailure" changed to "overheadWireFailure" according to recommendation document +- EnvironmentReasonEnumeration TPEC-code pti22_13_Alias_1 "flashFloods" added according to recommendation document +- EnvironmentReasonEnumeration TPEC-code pti22_19_Alias_1 "mudslide" added according to recommendation document +- EnvironmentReasonEnumeration TPEC-code pti22_19_Alias_2 "rockfalls" added according to recommendation document +- EnvironmentReasonEnumeration TPEC-code pti22_19_Alias_3 "subsidence" added according to recommendation document +- EnvironmentReasonEnumeration TPEC-code pti22_19_Alias_4 "earthquakeDamage" added according to recommendation document +- EnvironmentReasonEnumeration TPEC-code pti22_3_Alias_3 "avalanches" added according to TPEG document +- EnvironmentReasonEnumeration TPEC-code pti22_13_Alias_1 "flashFloods" added according to recommendation document +- EnvironmentSubReasonEnumeration TPEC-code value "lighteningStrike" changed to "lightningStrike" according to recommendation document +- EnvironmentSubReasonEnumeration TPEC-code value "mudslip" changed to "mudslide" according to recommendation document and Datex2 + +siri_model\siri_situationServiceTypes-v1.0.xsd: +- ReportTypeEnumeration TPEC-code "2_27_1_Alias_2" changed to "27_1_Alias_2" according to recommendation document +- ReportTypeEnumeration TPEC-code "2_27_1_Alias_3" changed to "27_1_Alias_3" according to recommendation document + +siri_model\siri_situation-v2.0.xsd: +- RelatedToEnumeration Enum value "correctionTo" added according to recommendation document +- WorkflowStatusEnumeration Enum value "pendingApproval" added according to recommendation document +- AudienceEnumeration Enum value "authorities" added according to recommendation document +- AudienceEnumeration Enum value "transportOperators" added according to recommendation document +- Severity changed from mandatory to optional as mentioned in XSD annotation and recommendation + +xsd\siri_situationExchange_service.xsd: +- SituationExchangeServiceCapabilitiesStructure.TopicFiltering "FilterByKeword" changed to "FilterByKeyword" according to recommendation document + +--- +## v2.0 + +Changes to SIRI schema v2.0 since v1.4 + +2015.05.13 Bug fix (from french feedback) SIRI 2.0p +- replacement of "NotifyExtension" (appearing 10 times) with "SiriExtension" in siri_wsConsumer.wsdl in order to ensure compatibility with the Document version + +2015.05.13 Bug fix (from SG7 feedback) SIRI 2.0o +- update annotation in siri.xsd and and siri_all_functionalService.xsd (to add siri__facilityMonitoring_service.xsd ...) +- siri.xsd: move of a SituationExchangeDelivery, renamed IncludedSituationExchangeDelivery, before other complemented service deliveries. +- siri_situationExchange_service.xsd: addition of IncludedSituationExchangeDelivery element +2015.05.11 Bug fix (from SG7 skype meeting on May 11th 2015) SIRI 2.0o +- Allow multiple tags within an extension (reapply lost chnage from 2012.06.18 SIRI 2.0d) - siri_utility.xsd +- siri_estimatedVehicleJourney.xsd : in EstimatedTimetableAlterationGroup, addition of FramedVehicleJourneyRef as an alternative to DatedVehicleJourneyRef (choice) and deprecation of DatedVehicleJourneyRef and EstimatedVehicleJourneyCode +- siri_datedVehicleJourney.xsd : DatedVehicleJourneyCode is now optional +- siri.xsd: SituationExchangeDelivery now can be provided as a complement to any other Service delivery (and can still be provided standalone)... note that the SituationExchangeDelivery must be after the other Delivery to get a validating, non-ambiguous XSD. +- siri_estimatedVehicleJourney.xsd : EstimatedVehicleJourneyStructure brought back to SIRI 2.0k situation + - Replacement of EstimatedJourneyInfoGroup by JourneyEndTimesGroup + - Replacement of inclusion of siri_journey.xsd by siri_monitoredVehicleJourney.xsd + - Replacement of EstimatedRealtimeInfoGroup by journeyProgressGroup + - Replacement of OperationalInfoGroup by TrainOperationalInfoGroup +2015.02.10 Bug fix (from french feedback) +- [fr] siri_wsProducer-Framework.xsd: use of siri:CheckStatusRequestStructure instead of siri:RequestStructure for checkStatus (one addition non mandatory version attribute) +- [fr] siri_wsProducer.wsdl: use of siri:CheckStatusRequestStructure instead of siri:RequestStructure for checkStatus (one addition non mandatory version attribute) +- [fr] siri_wsConsumer-Framework.xsd: update type of NotifySubscriptionTerminated to siri:SubscriptionTerminatedNotificationStructure (instead of TerminateSubbscriptionREquest !) + +2014.11.17 Correction (from french feedback) +- [fr] fix RPC-Document compatibility issue for GetSiri in Document WSDL (siri_wsProducer-Services.xsd): addition of Request/Answer wrapper +- [fr] fix WSDL Document issue: GetCapability was using Answer instead of Request (siri_wsProducer-DiscoveryCapability.xsd) +- [fr] fix RPC-Document compatibility issue for LinesDiscovery,ConnectionLinksDiscovery,StopPointsDiscovery in Document WSDL (siri_wsProducer-DiscoveryCapability.xsd): deletion of useless «xxxAnswerInfo» wrapper + +2014.06.20 Correction and revisions from Stenungsund +- [Part2] + - [fx] Document SubscriptionTerminatedNotification and add error code. (siri-requests.xsd) + - [fx] StopDiscovery response. Add RouteDirection. Rename JourneyPattern/Stops to JourneyPattern/StopsInPattern SubscriptionTerminatedNotification and add error code. (siri-requests.xsd) + - [de] Add Extensions to discovery requests. (siri_discovery.xsd) + +- [Part3] + - [ch] Add origin display whereever destination display as per Cologne meeting (siri-Journey.xsd, siri-DatedVehicleJourney.xsd, + - [xh] Add OriginAtDestination wherever destination display as per Cologne meeting (siri-Journey.xsd) + - [fx] Set default on new DetailLevels on ConnectionMonitoring and EstimatedJourney for backwards compatability. (siri_connectionMonitoring_ervice.xsd siri_EstimatedTimetable_service.xsd + - [ch] Add recordedCall to Estimated jouernesy to allow times for passed stops to be included. iri_EstimatedVehicleJourney.xsd + +- [Part5 SituationExchange] + - [de] Add missing AffectedFacility that was in document but missing from schema. VehicleJourney, STop & StopComponent siri_situationAffects.xsd. + - Temporal filter siri_situationExchange_service.xsd. + - [de] Add temporal filter to request with ValidityPeriod in siri_situationExchange_service.xsd. + - [se] Add end time precision to halfopen time rangefor input a siri_time.xsd. + - [se] Add end time status to halfopen time range output siri_time.xsd. + - [fr] Add additional small delay bands siri_situation.xsd + - [de] Add IncludeOnly-IfInPublicationWindow to situation request temporal filter siri_situationExchange_service.xsd. + - [fx] StopPlaceFilterGroup: add missing component ref and facility that was in doc but missing from schema siri_situationExchange_service.xsd. + - [fx] Add missing AccessFeature type to AFfectedStopPlaceComponent siri_situationAffects.xsd. + - [fx] Correct cardinality on FacilitRef on request to match doc siri_situationExchaneg_service.xsd. + - [fx] Correct spec to include projection attributes for AFfectedStopPlaceComponent doc. + - [doc] Document FacilityRef as part of request doc + - [doc] Document Access Mode as part of request doc + - [doc] Document Scope as part of request doc + - [doc] Document RoadFilter and Accessibility need filter as part of request doc + - [doc] Correct Documentation of AfFfectedRoads as part of Delivery doc + - [doc/fx] Correct Documentation of capability Matrix and update in schemas well siri_situationExchange_service.xsd. + - [doc/fx] Correct Documentation of Reason codes and correct in schema siri_reasons.xsd + - [doc] Add Annex D to Doc on GTFS real-time mapping + + 2014.05.26 Changes to answer comment from the EU ballot +- [fr] Addition of SubscriptionTerminatedNotification (XSD and WSDL SOAP Web Services(RPC/Document & WSDL2)) + - File siri_common_services.xsd: Addition of SubscriptionTerminatedNotification (SubscriptionTerminatedNotification element + SubscriptionTerminatedNotificationStructure ) + - File siri.xsd: addition of SubscriptionTerminatedNotification in servicesResponseGroup + - Update of siri_wsConsumer-Document.wsdl, siri_wsConsumer.wsdl, siri_wsConsumer-WSDL2.wsdl to add a NotifyTerminateSubscription + - File siri_wsConsumer-Framework.xsd: Addition of WsSubscriptionTerminatedNotificationStructure and NotifySubscriptionTerminated +- [fr] Added ParameterName [0..*] to ParametersIgnoredErrorStructure (siri_request_errorConditions.xsd) +- [fr] Added ExtensionName [0..*] to UnknownExtensionsErrorStructure (siri_request_errorConditions.xsd) +- [fr] Added InvalidRef [0..*] to InvalidDataReferencesErrorStructure (siri_request_errorConditions.xsd) +- [fr] Added Vesion attribute (non mandatory) to CheckStatus request (siri_common_services.xsd) +- [fr] ChangeBeforeUpdates not anymore mandatory in EstimatedTimetableSubscriptionPolicyGroup +- [fr] added optional RecordedAtTime to EstimatedVehicleJourney +- [fr] added ConnectionLinksDiscovery service to WSDL (RPC/Document & WSDL2) (and siri_wsProducerDicoveryCapability.xsd) + + 2013.06.26 French comments (compatibility issue) +- [fr] Change SOAP Web Service namesapce to http://wsdl.siri.org.uk (previously http://wsdl.siri.org.uk/siri) +- [fr] update EstimatedVehicleJourney in order to have it consistent with MonitoredVehicleJourney and Siri 2.0 + - use JourneyEndTimesGroup in place of EstimatedJourneyInfoGroup + - use JourneyProgressGroup in place of EstimatedRealtimeInfoGroup + - use TrainOperationalInfoGroup in place of OperationalInfoGroup + - addCallRailGroup (containing PlateformTraversal ) and CallRealTime to EstimatedCall + +2013.02.20 WG3 SG meeting Munich +- [se] Add JourneyEndNamesInfoGroup to EstimatedDirectionAtStop to DestinationDisplayAtStop -- This makes destination name available on EstimatedJourney. +- [us] Rename ProgrssStatusEnumeration to CallStatusENumeration to avoid confusion. +- [fr] Add FramedVehicleJourney references as alternative wherever a simple VehicleJourneyRef exists and deprecate use of simple reference. + - DatedVehicleJourney - identifier group. + - FacilityMonitoring - FacilityLocation. + - SituationExchangeService - SituationFilterGroup. + - SituationExchangeService - AffectedVehicleJourneyRef. +- [ch] StopTimeTableCancellation - Add Reason code to be consistet with St- opMonitoring. +- [de] ArrivalTimesDepartureGroup - add ExpectedArrivalPredictionQuality element. +- [fr] MonitoredStopVisit Cancellation make VisitNo LineRef DirectionRef optional. +- [fr] EstimatedTimetable, COnnectionMonitoring add detailed level to reqyest +- [fr] Make AdditionalVersionRefS to OperationalInfoGroup. +- [fr] Add JourneyPatternName The JourneyPatternInfoGroup. +- + 2013.02.11 +- [SE] Align documentation and XSD. See comments in individual xsd-files. +- [SE] Add StopNotice and StopNoticeCancellation to StopMonitoringDelivery. +- [SE] Revise ProductionTimetableDelviery to correct ServcieJourneyInterchange to include visit numbers. +- [FR] Updated with latest WDSL from CD. + + + 2012.08.01 -- SIRI 2.0e.1. +- [DE] Align documentation and XSD using GT's amendments. +- [FR] Update WDSL and add WSDL2.. Add WSDl chapter by CD to gudie.. +- [DE] Add Delegation elements to more mesages. +- [US] Revise Siri Lite chapter. +- [DE] Revise commends on Prediction quality based on CB's comments + + 2012.06.18 -- SIRI 2.0d.2. +- [CH] Allow multiple tags within an extension +- [CH] Make most NL String elements unbounded to allow for NL translations. x dx + - Add IncludeTranslations to RequestPolicy. + - Add Translations to Cpabilities +- [DE] Add PredictionQuality elements to MonitoredVehicleJourney Onward Call. & EstimatedVehcielJourney +- [FR] Add GroupOfLinesRef to JourneyPattenrInforGroup on MonitoredVehcile Joruney and elsewhere +- [FR] Add Extensions tag to EstimatedTimetableSubscriptionRequest x tx +- [FR] Add Extensions tag to FacilityMonitoringSubscriptionRequest x +- [FR] Add Extensions tag to SituationExchangeSubscriptionRequest x +- [FR] Add Extensions tag to ConnectionMonitoringSubscriptionRequest x- tx +- [FR] Add Extensions tag to Connection|TimetableSubscriptionRequest x tx +- [FR] Add Extensions tag to VehicleMonitoringSubscriptionRequest x tx +- [FR] Add Extensions tag to Terminate SubscriptionRequest x tx +- [DE] Correct EstimatedTimetable EstimatedServiceJourneyInterchange x tx +- [US] Add SIRILite chapter to manual. +- [DE] Add DelegatorAddress and DelegatorRef to servicerequest and service response. x tx +- [SE] Correct latestExopectedArrivalTime +- [SE] Add Vehicle Status: add additional arrival and departure states + +2012.05.31 -- SIRI 2.0d.1. +- [MTA] Discovery Revise StopLine discovery to include line direction x +- [MTA] Discovery Revise Line discovery to include Direction/Line x +- [MTA] Correcct typo in name of RouteDirection x +- [Init] Add DriverRef to vehiclejourney x tx + +2012.06.11 -- SIRI 2.0c.1. +- Relax typing on NotifcationRef to be normalized string x +- Add wsdl subdirectory for wsd .xsds- x + +2012.06.08 -- WSDL [FR] x +- In siri-wsProducer-Document.xsd rename StopMonitoringType and StopMonitoringMultipleType to StopMonitoringRequestType to StopMonitoringMultipleRequestType (for more consistent naming) +- Add comment to point out that usage of SOAP Fault are now deprecated +- Add comment to point out that usage of MultipleStopMonitoring is now deprecated (utilise GetSiriService) +- Addition of a Document Wrapped encoding style fully compatible with the RPC Style (Producer and Consumer) +- Add GetSiriService in RPC and Document Wrapped mode +- Addition of StopDiscovery and LineDiscovery +- Cleaning of xmlns:xxx in siri_wsProducer-Document +- Suppression of comments on and (for http://www.validwsdl.com/ compliance) .. in poducer and producer-Document WSDL +- Rename of Port/Binding/Service in order to clearly diffirentiate them +- Change to + + +2012.05.17 -- SIRI 2.0b.3 +- [MTA] Add filtering to StopPoints and Lines Discovery requests by point + radius x +- [MTA] Add filtering to Lines Discovery request by LineRef and Direction x +- [MTA] Add stops in pattern to Lines Discovery, with OnwardLinkShap and LineDetailParameter x +- [NeTEx] Add StopAreaRef & url to annotated stop on StopDiscovery x +- [General] Correct capability definition + +2012.04.18 -- SIRI 2.0b.2 +- [VDV] Add ValidUntil to individual SIRI-CM MonitoredFeederArrival x e +- [VDV] Add ValidUntil to individual SIRI-SM MonitoredStopVisit x e +- [MTA] Add DistanceFromStop and NumberOfStopsAway to to MonitoredCall & OnwardsCall x tx + +2012.03.23 -- SIRI 2.0b.1 +- [MTA] Add filtering to StopPoints request by point + radius + +2012.03.23 +- WDSL + - Add explicit namespace to body x + - Use a SIRI namespace http://wsdl.siri.org.uk/siri x + - Correct GetStopTimentable to have soapAction x + - Turn annotations into comments x + - Use FaultLiteral x +- SIRI 2.0a + - Changes to framework + - [VDV] Add DataReady to CheckStatus response x. tx. +- JourneyInfo group SIRI-ST SIRI-SM SIRI-VM SIRI-PT SIRI-ET MonitoredJourney, etc + - [VDV] Add PublicContact & Operations contact to JourneyInfo group in x tx + - [VDV] Add ViaPriority to ViaNames using a new ViaNameStructure x tx + - [VDV] at DirectionAtOrigin name to JourneyInfo SIRI-PT, SIRI-ET, SIRI-SM. SIRI-VM + - [VDV] Add EstimatedServiceInterchange to EstimatedTimetableDelivery x tx. + - [VDV] Add ServiceJourneyInterchange to ProductionTimetableDelivery SIRI PT x tx +- Changes to MonitoredVehicleJourney SIRI-SM SIRI-VM + - [VDV, SE] Add EarliestExpectedArrivalTimeForVehicle to Arrival Times Group x tx + - [VDV] Add ProvisionalExpectedDepartureTime to Departure Times Group x tx + - [VDV, SE] Add latesExpectedArrivalTimeForVehicle to Departure Times Group x tx + - [SE] Add Aimed and expected Platform assignments to CALLs including a reference code. + - [FR] Add FirstOrLastJourney to JourneyTimesGroup x.tx. + - [FR] add ArrivalOperatorRefs and DepartureOperatorRefs to Call arrival and Departure + - [VDV] Add Velocity to MonitoredVehicleJourney JoueyProgerssGroup SIRI-SM and SIRI-VM + - [FR] Add AimedLatestPassengerAccessTime to MonitoredCall & OnwardsCall x tx + - [MTA,FR,UK] Add ArrivalProximityText & DepartureProximityText to MonitoredCall & OnwardsCall x tx + - [FR, MTA] Add Velocity to Journey & VelocityType x tx +- StopMonitoringRequest SIRI-SM + - [VDV] Add Minimum-StopVisits¬PerVia to STopMonitoringRequestPolicy x tx + - [VDV] Add HasMinimum-StopVisits¬Via to STopMonitoringCapabilities x tx +- StopMonitoringDelivery SIRI-SM + - [FR] Add Service Exception element + - [VDV] Add delivery variant to LineNote- + - [MTA] Add MaximumNumberOfCalls to VehiclelMonitoring request +- StopMonitoringDelivery SIRI-SX + - Upgrade to DatexII- +- ConnectionMonitoringDelivery SIRI-CM - - + - [VDV] Add SuggestedWaitDecisionTime to MonitoredFeederArrival SIRI-CM x tx +- Enabling SIRI Lite + - [MTA, UK] Add optional authenitication Key to Servce Request TODO + - [MTA, UK] Add optional name to StopMonitoring response x tx + - [MTA, UK] Add optional name to VehicleMonitoring response x tx +- Discovery services + - [Fr] Add location to stop discovery x. - +- General Framework + - [VDV] Add ErrorNumber to Error Structure SIRI - All + - [VDV] Add new error conditions + - UnknownParticipant- Recipient for a message to be distributed is unknown. +SIRI v2.0 + - UnknownEndpoint- Endpoint to which a message is to be distributed is unknown. +SIRI v2.0 + - EndpointDeniedAccess- Distribution message could not be delivered because not authorised.. +SIRI v2.0 + - EndpointNotAvailable- Recipient of a message to be distributed is not available. +SIRI v2.0 + - UnapprovedKey- User authorisation Key is not enabled. +SIRI v2.0 + - InvalidDataReferences- Request contains references to identifiers that are not known. +SIRI v2.0 + - ParametersIgnored- Request contained parameters that were not supported by the producer. A response has been provided but some parameters have been ignored. +SIRI v2.0 + - UnknownExtensions- Request contained extensions that were not supported bu the producer. A response has been provided but some or all extensions have been ignored.. +SIRI v2.0 + - [FR] Add DistanceUnits & Velocity Units to ServiceRequestContext x tx- +- General improvements to internal structure maintainability + - Tidy up comments. x tx. + - Improve modularisation (eg permissions/model permissions) to avoid circuloar refs x + - Separate subdirectories for common request, model and core elements x + - Separate out some model elements into separate packages x + - Separate out model journeys from SIRI service packagaes x + - Separate out discovery models from discovery services x + +---- +## v1.4a + +2011-04-18 Corrections - New cumulative fix version 1.4a + Minor corrections arising from user feedback + + (a) siri_generalMessage_service.xsd (line 221) Missing extension point in InfoMessageStructure in Robin Vettier Ixxi.biz + (i) - Add to general message request x + (ii) and siri_generalMessage_service.xsd subscription structure x + (iii) Missing type: Assign a type of normalizedString to formatRef x dx + + (b) siri_requests.xsd (line 814) ErrorConditionStructure should not be abstract . Fix from RV ixxi.biz- + made abstract x + + (c) siri_journey.xsd (l.1015). FramedVehicleJourneyRef isn't mandatory in MonitoredCall SIRI-SM answer according to CEN TS (prCEN/TS 15531-3:2006 (E) p.56). Make optional. RV ixxx.com + made optional Fix from RV ixxi.biz x ?? + + (d) siri_productionTimetable_service.xsd Type on request ValidityPeriod start and end should be datetime not time + - - Change to ClosedTimestampRange instead of ClosedDateeRange x tx. + - Fix Subscription request to be an element and to have IncrementalUpdate parameter Extensions x + + (e) siri_situation.xsd AffectedVehicleJourney should allow multiple journeys. Brian Ferris onebusaway.org>, x + + (f) ifopt_location.xsd Correct siri: namespace x + + (g) Fix up examples + - (i) correct estimated timetable request, production timetable request, stop monitoring request, stop monitoring eprmissions. drop flat examples tx. + - (ii) Add examples for facility monitorign and situation exchange ex + - + (h) Drop vestigial As Flatgroup alternative coding tx + - siri_connectionTimetable_service.xsd- InterchangeHourneys x tx + - siri_estimatedTimetable_service.xsd- EstimatedCalls --> x tx + - siri_productionTimetable_service.xsd- DatedCalls --> x tx + - + (i) Add missing type + - siri_requests.xsd- formatRef x +- - DATEXIISchema_1_0_1_0.xsd modelBaseversion +- - + (j)siri_facility.xsd TidyUp empty ValidityConditionGroup x + + (g) Add xmlSPy project spp. x + +--- +## v1.3 SIRI-SX & SIRI-FM + +2009-03-31 Corrections + (a) siri.xsd Correct cardinality on SIRI-SX request & SIRI-FM request to be many x + (b) siriSg.xsd Remove unnecessary groups for decoupled version x tx. + +2009-03-31 Corrections + (a) StopMonitoring + Change the element type of MaximumNumberOfCalls.Previous, MaximumNumberOfCalls.Onwards from xsd:positiveInteger to xsd:nonNegativeInteger x tx. + and clarify handling of + MaximumNumberOfCalls : If calls are to be returned, maximum number of calls to include in response. If absent, exclude all calls. tx. + Previous : Maximum number of previous calls to include. Zero for none. Only applies if MaximumNumberOfCalls specified. Zero for none. If MaximumNumber of Calls specified but MaximumNumberOfCalls.previous absent, include all previous calls. tx. + Onwards : Maximum number of onwards calls to include. Zero for none. Only applies if MaximumNumberOfCalls specified. Zero for none. If MaximumNumber of Calls specified but MaximumNumberOfCalls.Onwards absent, include all onwards calls. tx. + + (b) siriSg.xsd Remove uneccessary groups for decoupled version + +2009-03-03 Corrections + (a) siri.xsd Correct cardinality on SIRI-SX request & SIRI-FM request to be many x + (b) siriSg.xsd Correct cardinality on servcierequest & subscription request to be many x + +2009-09-18 Siricommon - allow empty Terminate subscription response x + (a) Relax mandatory on in siri_common x + +2008-11-18 Revise FM servics + (a) Revise daytypes in siri_time.xsd x + +2008-11-17 Revise to support substitution groups + (a) Make all requests subtypes of abstract request. Add Subst elements x + (b) Introduce AbstractFunctionalServiceRequest, AbstractCapabilityServiceRequest, AbstractDiscoveryRequest as common supertypes. revised versiosn of siri_requests.xsd, siri_journey.xsd and siri_permissions.xsd, siri-All and siribase + (c) add SiriSg and Siri_base.xsd packages + +2008-11-12 Corrections to the Caridnailities on the siri_discovery services x + (a) Change min maxes on >LineRef, StopPoints, Features etc etc x + +2008-10-08 Corrections to the SIRI service + (a) Add SubscriberRef to TerminateSubscriptionRequest x tx. + +2008-10-06 Corrections to the SIRI service + (a) Correct StopTimetable SubscriptionRequest to use group x + (b) Correct cardinality on AnnotatedStopPointRef in StopPointDelivery x + +2008-10-01 Corrections to the SIRI-SX service + (a) Add StatusFilterGroup to SIRI-SX request with Verification, Progress and Reality + (b) add Predictability + +2008-09-30 Corrections to the SIRI-SX service + (a) Make Undefined and Unknown reason codes strinsg so they do not require content + (b) Extensions change defaults to lax, type =#any to simplify binding + +2008-07-07 Corrections to the SIRI-SX service + (a) Allow link projection and start / end offset. + (b) Introduce a separate AffectedSection to handle this (refines SectionRef) + used on AffectedRoute + (c) Allow a link projection & Offset on connection Link via AffectedPathLink + (d) Add an AfFfectedRoad to hold basic road details + (e) Correct SX request to be predctability not nature + (f) Add Scope to SX request + +2008-07-05 Corrections to the SIRI-SX service + (a) SIRI_SX Rename AccessibilityDisruption to AccessibilityAssessment & reuse ifopt defs + +2008-07-05 Corrections toi the SIRI-SX service + (a) SIRI_SX Add missing SituationRecord to RoadSituation + (b) SIRI_SX correct type to be participant ref not participant pair ref--> x + (c) Allow zero PT or Road Situation elements in a delivery x + (d) Affects Line group corrected to ref a lineref and not a route ref x + (e) Add missing scopeType to Situation classifier group x + (f) Add other subreasons x + (g) add secondary reasons x + +2008 05 08 StopMonitoring service + (a) Correct type on FeatureRef in Stop monitoring x + (b) Add StopMonitoringMultipleRequest x tx + (c) Add optional MonitoringRef to StopMonitoringDelivery so that can return id even if no data x tx. + +2008 03 27 + Fix up ifopt & ACSB version numbers to match ifopt 0.4 x + +2008-03-26 EstimatedTimetable Production Timetable Service Service + Add wrapper tag for Line + Direction to help binding to Axisx x tx. + Wraps multiple instances x + ** Note this will break strict Compaptibility with 1.0 + +2008 03 12 + Add comments for elements and arrtributes that lacked them x + Correct wdsl errors x + Strip out degree character x + BeyondHorizon type corrected x + +2008 02 12 + Add SIRI-SX revisions & Datex2 harmonisation features + +2007 10 17 + Add Situation Exchange & Facility Exchange services. x tx + Added a siri_all.xsd, ifopt_allStopPlace.xsd, acsp_all.xsd packages to force explicit declaration of all elements in an imported namespace on the first reference. This overcomes a limitation of some XML tools that only pick up thos elements on the first import and ignotre all subsequent imports. + +2007 04 17 + Name Space improvements + revise to use explicit namespaces x + Change name space : http://www.siri.org.uk/ to www.siri.org.uk/siri x.tx. + + harmonise Facility Monitoring + Revise SpecialNeeds to use acsb package x. + Use Ifopt facility etc x. + Factor out Extensions to utility file x. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..966a056c --- /dev/null +++ b/README.md @@ -0,0 +1,131 @@ +# SIRI (Service interface for real-time information relating to public transport operations) XML schema +**(C) 2006-2026 NeTEx, CEN, Crown Copyright** + + +## Overview 🔍 + +SIRI is a European Norm (EN) and CEN Technical Specification (CEN/TS). It is published as a series referenced as EN 15531 and CEN/TS 15531. It is dedicated to the exchange of real-time data for public transportation between different computer systems and open data. It is based on Transmodel V6.2 (EN 12896 series) and relates to NeTEx (CEN/TS 16614 series). + +SIRI services are: +- Discovery, general services to retrieve references for other services (e.g., list of lines) +- Production Timetable (SIRI-PT), for the provision of information on the planned progress of vehicles operating a specific service, identified by the vehicle time of arrival and departure at specific stops on a planned route for a particular Operational Day, +- Estimated Timetable (SIRI-ET), for the provision of information on the actual progress of Vehicle Journeys operating specific service lines, detailing expected arrival and departure times at specific stops on a planned route, +- Stop Monitoring (SIRI-SM), for a stop-centric view of vehicle arrivals and departures at a designated stop, +- Vehicle Monitoring (SIRI-VM), for the provision of information on the current location and status of a set of vehicles, +- Connection Monitoriting (SIRI-CM), for the provision of information about the expected arrival of a feeder vehicle to the operator of a connecting distributor service, +- General Message (SIRI-GM), for the exchange informative messages between identified individuals in free or an arbitrary structured format, +- Facility Monitoring (SIRI-FM), for the exchange of information about alterations to the availability of facilities for passengers among systems, including equipment monitoring, real-time management and dissemination systems, +- Situation Exchange (SIRI-SX), for the exchange of data about situations caused by planned and unplanned incidents and events, with situations being actual or potential perturbations to normal operation of a public transport network, +- Control Actions (SIRI-CA), for the exchange of information about decision made concerning the real-time management of the operation of a transport system as performed by operators while operating the services. + +_Note : Many SIRI concepts are taken directly from Transmodel. The definitions and explanation of these concepts are extracted directly from the respective standard and reused in SIRI, sometimes with adaptions in order to fit the SIRI context._ + +### Repository content 📚 + +This repository contains the XML Schemas (XSD) for: +- Core +- Part 1 (Context and Framework) +- Part 2 (Communications) +- Part 3 (Functional Service Interfaces: Production Timetable, Estimated Timetable, Stop Monitoring, Vehicle Monitoring, Connection Monitoring, General Message) +- Part 4 (Functional Service Interfaces: Facility Monitoring) +- Part 5 (Functional Service Interfaces: Situation Exchange) +- Part 6 (Functional Service Interfaces: Control Actions) + +### Respository structure 📁 + +In each branch, we have: +- The folder `xsd` in which all the XML schemas can be found, +- The folder `examples` in which all examples can be found, +- At the root folder, `Siri.spp` which is the project for XMLSpy and `Siri.xpr` for Oxygen. + +The `xsd` folder is sub-divided as follow: +- at the root, the XSD for all SIRI services, +- `gml` for all geometry-related elements, +- `siri` for the common framework, +- `siri_model` for all components of SIRI services, +- other complementary sub-folders. + +### Branches 🌿 + +|**Branch**|**Description**|**Maintenance status**|**Link**| +|----------|---------------|--------|--------| +|v2.2|The latest version of the XML Schema that matches the CEN documentation|Bug fixes only|[Direct link](https://github.com/SIRI-CEN/SIRI)| +|v2.1|The previous version of the XML Schema that matches the CEN documentation (without the Control Actions)|Not maintained|[Direct link](https://github.com/SIRI-CEN/SIRI/tree/v2.1)| +|v2.3-wip|All the upcoming work to improve v2.2|In development|In development|[Direct link](https://github.com/SIRI-CEN/SIRI/tree/v2.3-wip)| +|v3.0-wip|All the upcoming work preparing the migration from CEN/TS to CEN/EN for the entire SIRI series|Not yet published|[Direct link](https://github.com/SIRI-CEN/SIRI/tree/v3.0-wip)| + +All other branches are considered as feature branches, meaning that they are used for development only and are to be deleted once a Pull Request is merged. See below for more details on contributions. + +**Important notes:** +- Any branch marked `wip` is a non-stable branch. +- For a specific XML Schema matching a published CEN document, use `releases`. + +---- + +## Getting started 🛠️ + +### Main root schemas + +1. **siri.xsd** +Embeds SIRI: +- Common services +- Functional services +- RequestGroup and ResponseGroup + +2. **siri_all_functionalServices.xsd** +Embeds all of SIRI functional services with direct links with the XML Schema of each SIRI service (General Message, Estimated Timetable, Stop Monitoring, Situation Exchange, Control Action, etc.). + +### How to navigate the schemas + +The schema is systematically divided into small modular files. Generally, for each SIRI service you should refer to their own XML Schema named **service_xxxx_service.xsd** which leads the embedded components for that given service. + +### XML examples + +The XML examples are sorted by SIRI Service. In each service folder, you will have the same structure: +- capabilities, +- request, +- response, +- subscription request. + +---- + +## How to contribute 🖊️ + +### Starting a discussion 💬 + +Either for a modelling question or a request for change, please start a discussion using the [GitHub issues](https://github.com/SIRI-CEN/SIRI/issues). +In your issue, make sure that: +- The title is a clear summary of your question / request for change, +- The content sufficiently details: + - The context, + - The elements / features you want to discuss, +- If relevant, include extracts of your NeTEx file. + +### Making a change 🚀 + +1. Identify which branch you need to target: + - v2.3-wip for all changes that will apply to SIRI v2.2 (e.g., bug fixes, typos, improvement of certain features without breaking changes, etc.) + - v3.0-wip for all changes that will apply when SIRI migrates to EN (e.g., deprecation of features, refactor of certain elements, breaking changes including new features, etc.) _Not yet published_ +2. Create a feature branch with a clear name that identifies the SIRI service when relevant (e.g., sx_addedconcept) +3. Work on the changes and do the Pull Request + +For new features, the decision between targetting v2.3-wip or v3.0-wip will be made by the group. + +---- + +## Changelog 📰 + +### Releases +| Release Number | Release Date | Description | Link | +| -------------- | ------------- | ---------------------------------------------- | ------------- | +| v2.0q | October 2022 | Before the release of the documentation for the 2022 revision | [Code](https://github.com/SIRI-CEN/SIRI/releases/tag/v2.0r) | +| v2.1 | October 2022 | Release matching the CEN documentation for Part 1 to 5 as of 2022 revision | [Code](https://github.com/SIRI-CEN/SIRI/releases/tag/v2.1) | +| v2.2 | October 2025 | Addition of SIRI-CA, which is Part 6 in CEN documentation and was published in 2024 | [Code](https://github.com/SIRI-CEN/SIRI/releases/tag/v2.2) | + +**Important notes:** +- Releases (and their tags) are a snapshot of the corresponding working branch in time. +- For any official reference to a SIRI version, it is recommended to point to a 2-digit version (e.g., v1.3, v2.0). + +### Comprehensive version history + +The comprehensive versions history is available in [CHANGELOG.md](https://github.com/SIRI-CEN/SIRI/blob/v2.2/CHANGELOG.md). diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 51e9e47a..00000000 --- a/docs/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# SIRI (Service interface for real-time information relating to public transport operations) XML schema -**(C) 2006-2025 NeTEx, CEN, Crown Copyright** - -## Schemas for: - -- Core -- Part 1 (Context and Framework) -- Part 2 (Communications) -- Part 3 (Functional Service Interfaces: Production Timetable, Estimated Timetable, Stop Monitoring, Vehicle Monitoring, Connection Monitoring, General Message) -- Part 4 (Functional Service Interfaces: Facility Monitoring) -- Part 5 (Functional Service Interfaces: Situation Exchange) -- Part 6 (Functional Service Interfaces: Control Actions) - -## Overview - -SIRI is a European standard and that enables real-time information about public transportation to be shared between different computer systems. -SIRI was established as European standard in October 2006. It is a CEN (Comité Européen de Normalisation) norm and Technical Specification. - -## Folder structure 📁 - -In each branch, we have: -- The folder `xsd` in which all the XML schemas can be found -- The folder `examples` in which all examples can be found -- At the root folder, `Siri.spp` which is the project for XMLSpy and `Siri.xpr` for Oxygen - -## Branches 🌿 -|**Branch**|**Description**|**Link**| -|----------|---------------|--------| -|v2.2|The latest version of the XML Schema that matches the CEN documentation|[Direct link](https://github.com/SIRI-CEN/SIRI)| -|v2.1|The previous version of the XML Schema that matches the CEN documentation (without the Control Actions)|[Direct link](https://github.com/SIRI-CEN/SIRI/tree/2.1)| -|integration|All the upcoming work that goes with the revision of SIRI, matching the next round of CEN documentation|[Direct link](https://github.com/SIRI-CEN/SIRI/tree/integration)| - -## How to contribute - -When you want to suggest a change to SIRI XSD, please target: -- Master for any bug fixes or typos -- Integration for any functional changes From 53b9ea0afc26919d434de365a507d5b101a65f02 Mon Sep 17 00:00:00 2001 From: haeckerbaer <54021300+haeckerbaer@users.noreply.github.com> Date: Tue, 24 Mar 2026 16:09:47 +0000 Subject: [PATCH 2/3] fix typo in element name DriverScope (#205) --- xsd/siri_controlAction_service.xsd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xsd/siri_controlAction_service.xsd b/xsd/siri_controlAction_service.xsd index 072dafe1..06581c79 100644 --- a/xsd/siri_controlAction_service.xsd +++ b/xsd/siri_controlAction_service.xsd @@ -884,7 +884,7 @@ If false each subscription response will contain the full information as specifi if TRUE means that it is a message sent to a sent to a GARAGE to ask for repair of a VEHICLE. - + Identification of the DRIVER From 2d0a216a9a5b45f5d5749dd6378ad2acba12e277 Mon Sep 17 00:00:00 2001 From: Tim Rivett <56296031+tim-rivett@users.noreply.github.com> Date: Wed, 13 May 2026 06:51:43 +0100 Subject: [PATCH 3/3] Spelling correction in siri_requests.xsd (#211) corrected spellings in Documentation tags --- xsd/siri/siri_requests.xsd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xsd/siri/siri_requests.xsd b/xsd/siri/siri_requests.xsd index 785a6242..e0261b8d 100644 --- a/xsd/siri/siri_requests.xsd +++ b/xsd/siri/siri_requests.xsd @@ -145,7 +145,7 @@ Roads and road transport - Type for Authticated SIRI Request. + Type for Authenticated SIRI Request. @@ -155,7 +155,7 @@ Roads and road transport - Elemenst for authecticiation. (since SIRI 2.0) + Elements for authentication. (since SIRI 2.0)