Complex type

EstimatedTimetableRequestStructure

Defined in OpRa/SIRI/xsd/siri_estimatedTimetable_service.xsd:117

Type for Type for Functional Service Request for Estimated Timetable.

Base type

AbstractFunctionalServiceRequestStructure

Used by elements

EstimatedTimetableRequest

Content model

Type structure

  • inherited from AbstractRequestStructure 1 item
  • 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.

  • Defined here
  • groupEstimatedTimetableTopicGroup 1..1

    Parameters that specify the content to be returned.

    • PreviewInterval 0..1 PositiveDurationType

      Forward duration for which journeys should be included. For subscriptions, this duration is a continuously rolling window from the present time. For immediate requests, this duration is measured from the time of the request.

    • 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.

    • 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)

  • groupEstimatedTimetableRequestPolicyGroup 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)

    • EstimatedTimetableDetailLevel 0..1 EstimatedTimetableDetailEnumerationdefault calls

      Level of detail to include in response. Default is 'normal'. (SIRI 2.0)

  • Extensions 0..1 ExtensionsStructure

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

Properties

Attributes

1
AttributeTypeUseDocumentation
version VersionString optional
default: 2.1

Version number of request. Fixed