ProductionTimetableRequest

Type

ProductionTimetableRequestStructure

Related elements

Substitution group chain: AbstractFunctionalServiceRequest abstract → AbstractServiceRequest abstract → AbstractRequest abstract

Referenced by: ProductionTimetableSubscriptionRequest, ServiceRequest

Content model

Element structure

inherited from AbstractRequestStructure 1 item
- RequestTimestamp 1..1 xsd:dateTime
  
  Timestamp on request.
inherited from AbstractServiceRequestStructure 1 item
- groupContextualisedRequestEndpointGroup 1..1
  
  Unique reference to request: participant and SIRI service type are given by context. Used on requests that are embedded in the context of another request. Only a message identfiier may be needed.
  - MessageIdentifier 0..1 MessageQualifierStructure
    
    Arbitrary unique reference to this message.
Defined here
groupProductionTimetableTopicGroup 1..1

Parameters that specify the content to be returned.
- ValidityPeriod 0..1 TimetableValidityPeriod
- TimetableVersionRef 0..1 VersionRefStructure
  
  Communicate only differences to the timetable specified by this VERSION of the TIMETABLe.
- OperatorRef 0..unbounded OperatorRefStructure
  
  Filter the results to include journeys for only the specified OPERATORs.
- Lines 0..1
  
  Filter the results to include only vehicles along the given LINEs.
  - LineDirection 1..unbounded LineDirectionStructure
    
    Iinclude only vehicles along the given LINE.
- VehicleMode 0..unbounded VehicleModesEnumeration
  
  Filter the results to include only journeys of the specified VEHICLE MODE. (since SIRI 2.1)
- ProductCategoryRef 0..unbounded ProductCategoryRefStructure
  
  Filter the results to include only journeys of the specified TYPE OF PRODUCT CATEGORY. (since SIRI 2.1)
- StopPointRef 0..unbounded StopPointRefStructure
  
  Filter the results to include only journeys with a CALL at the specified STOP POINT. (since SIRI 2.1)
groupProductionTimetableRequestPolicyGroup 1..1

Parameters that affect the request processing. Mostly act to reduce the number of messages exchanged.
- Language 0..unbounded xsd:languagedefault en
  
  Preferred languages in which to return text values.
- IncludeTranslations 0..1 xsd:booleandefault false
  
  Whether additional translations of text names are to be included in elements. If 'false', then only one element should be returned. Default is 'false'. Where multiple values are returned The first element returned will be used as the default value.
- IncludeInterchanges 0..1 xsd:booleandefault true
  
  Whether SERVICE JOURNEY INTERCHANGE data is to be transmitted or not. Default is 'true'. (since SIRI 2.1)
- IncludeJourneyRelations 0..1 xsd:booleandefault true
  
  Whether JOURNEY RELATION data is to be transmitted or not. Default is 'true'. (since SIRI 2.1)
- IncludeTrainFormations 0..1 xsd:booleandefault true
  
  Whether TRAIN (ELEMENT), COMPOUND TRAIN and TRAIN STOP ASSIGNMENT data is to be transmitted or not. Default is 'true'. (since SIRI 2.1)
- IncrementalUpdates 0..1 xsd:booleandefault false
  
  Whether to return the whole timetable, or just differences from the inidicated version. Default is 'false'.
Extensions 0..1 ExtensionsStructure

Extensions to schema. (Wrapper tag used to avoid problems with handling of optional 'any' by some validators).

Properties

Attributes

1

Attribute	Type	Use	Documentation	Source
`version`	`VersionString`	optional default: `2.1`	Version number of request. Fixed.